Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/puppetlabs/terraform-google-pe_arch

A Terraform Module to deploy infrastructure for Puppet Enterprise on GCP
https://github.com/puppetlabs/terraform-google-pe_arch

bolt cloud gcp hiera infrastructure puppet puppet-bolt puppet-enterprise terraform terraform-gcp terraform-module

Last synced: about 1 month ago
JSON representation

A Terraform Module to deploy infrastructure for Puppet Enterprise on GCP

Awesome Lists containing this project

README 

        
# google-pe_arch



IaC definitions for three of the supported Puppet Enterprise architectures for Google Cloud Platform



#### Table of Contents



1. [Description](#description)

2. [Setup - The basics of getting started with google-pe_arch](#setup)

    * [What google-pe_arch affects](#what-google-pe_arch-affects)

    * [Setup requirements](#setup-requirements)

    * [Beginning with google-pe_arch](#beginning-with-google-pe_arch)

3. [Usage - Configuration options and additional functionality](#usage)

4. [Limitations - OS compatibility, etc.](#limitations)

5. [Development - Guide for contributing to the module](#development)



## Description



This Terraform module implements as code the infrastructure required to deploy three permutations of the [supported](https://puppet.com/docs/pe/latest/choosing_an_architecture.html) Puppet Enterprise architectures: Standard, Large, and Extra Large, addtionally all architectures can have additional infrastructure provisioned to support a failover replica on Google Cloud Platform. This module is developed to function independently but it is often used in support of [puppetlabs/peadm](https://github.com/puppetlabs/puppetlabs-peadm), brought together by [puppetlabs/autope](https://github.com/puppetlabs/puppetlabs-autope) to facilitate the end-to-end deployment of fully functional stacks of Puppet Enterprise. It sets up native GCP networks and load balancers specifically for containing and managing access to the deployment but avoids a dependence on cloud provided SQL services since Puppet Enterprise has its own facilities for managing and automating PostgreSQL.



### Expectations and support



This Terraform module is intended to be used only by Puppet Enterprise customers actively working with and being guided by Puppet Customer Success teams—specifically, the Professional Services and Solutions Architecture teams. Independent use is not recommended for production environments without a comprehensive understanding of how Terraform works, comfort in the modification and maintenance of Terraform code, and the infrastructure requirements of a full Puppet Enterprise deployment.



This Terraform module is a services-led solution, and is **NOT** supported through Puppet Enterprise's standard or premium support.puppet.com service.



As a services-led solution, Puppet Enterprise customers who are advised to start using this module should get support for it through the following general process.



1. Be introduced to the module through a services engagement or by their Technical Account Manager (TAM).

2. During Professional Services (PS) engagements, the Puppet PS team will aid and instruct in use of the module.

3. Outside of PS engagements, use TAM services to request assistance with problems encountered when using the module, and to inform Puppet Customer Success (CS) teams of planned major maintenance or upgrades for which advisory services are needed.

4. In the absence of a TAM, your Puppet account management team (Account Executive and Solutions Engineer) may be a fallback communication option for requesting assistance, or for informing CS teams of planned major maintenance for which advisory services are needed.



This module is under active development and yet to release an initial version. There is no guarantee yet on a stable interface from commit to commit and those commits may include breaking chnages.



## Setup



### What google-pe_arch affects



Types of things you'll be paying your cloud provider for



* Instances of various sizes

* Load balancers

* Networks



### Setup Requirements



* [GCP Cloud SDK Intalled](https://cloud.google.com/sdk/docs/quickstarts)

* [GCP Application Default Credentials](https://cloud.google.com/sdk/gcloud/reference/auth/application-default/)

* [Git Installed](https://git-scm.com/downloads)

* [Terraform (>= 0.12.20) Installed](https://www.terraform.io/downloads.html)



### Beginning with google-pe_arch



1. Clone this repository

    * `git clone https://github.com/puppetlabs/terraform-google-pe_arch.git && cd terraform-google-pe_arch`

2. Install module dependencies: `terraform init`

3. Initiate plan for the default standard architecture

    * `terraform apply -auto-approve -var "project=example.com" -var "user=john.doe" -var "firewall_allow=[ \"0.0.0.0/0\" ]"`

4. Moments later you'll be presented with a single VM where to install Puppet Enterprise



## Usage



### Example: deploy large architecture with replica and a more restrictive network



This will give you the absolute minimum needed for installing Puppet Enterprise, a single VM plus a specific network for it to reside within and limited to a specific network that have access to the new infrastructure (note: internal network will always be injected into the list)



`terraform apply -auto-approve -var "project=example.com" -var "user=john.doe" -var "firewall_allow=[ \"192.69.65.0/24\" ]" -var "architecture=large" -var "replica=true"`



### Example: destroy stack



The number of options required are reduced when destroying a stack



`terraform destroy -auto-approve -var "project=example.com" -var "user=john.doe"`



## Usage notes



1. For making ssh access work with Terraform's google provider, you will need to add your private key corresponding to the public key in the `ssh_key` parameter to the ssh agent like so:



```bash

> eval `ssh-agent`

> ssh-add 

```



## Limitations



Currently limited to CentOS and VM disk sizes are not configurable