This module handles the creation of a GCE instance running Jenkins, configured to run builds on Google Cloud. Creates an instance that can be logged into with the username user and the password bitnami.

This module is meant for use with Terraform 0.12. If you haven't upgraded and need a Terraform 0.11.x-compatible version of this module, the last released version intended for Terraform 0.11.x is v0.1.0.

Please see the examples folder.

• Terraform 0.10.x
• terraform-provider-google plugin v1.8.0
• ruby-2.5.x

In order to execute this module you must have a Service Account with the following project roles:

• roles/compute.admin
• roles/iam.serviceAccountUser
• roles/compute.networkAdmin

In order to operate with the Service Account you must activate the following APIs on the project where the Service Account was created:

• Compute Engine API - compute.googleapis.com

Be sure you have the correct Terraform version (0.10.x), you can choose the binary here:

• https://releases.hashicorp.com/terraform/

The project has the following folders and files:

• /: root folder
• /examples: examples for using this module
• /helpers: scripts used in the build process
• /templates: templates used in the provisioning process
• /test: folders with files for testing the module (see Testing section on this file)
• /main.tf: contains the resources to create
• /variables.tf: all the variables for the module
• /output.tf: the outputs of the module
• /README.md: this file

• bundler
• terraform-docs 0.3.0
• ruby-2.5.x

Run make generate_docs

Integration tests are run through test-kitchen, kitchen-terraform, and InSpec.

One test-kitchen instance is defined:

• simple_example

The test-kitchen instances in test/fixtures/ wrap identically-named examples in the examples directory.

1. Configure the test fixtures
2. Download a Service Account key with the necessary permissions and put it in the module's root directory with the name credentials.json.
3. Add appropriate variables to your environment

export PROJECT_ID="YOUR_PROJECT_ID"
CREDENTIALS_FILE="credentials.json"
export SERVICE_ACCOUNT_JSON=`cat ${CREDENTIALS_FILE}`

4. Run the testing container in interactive mode:

make docker_run

The module root directory will be loaded into the Docker container at /cft/workdir/. 5. Run kitchen-terraform to test the infrastructure:

1. kitchen create creates Terraform state and downloads modules, if applicable.
2. kitchen converge creates the underlying resources. Run kitchen converge <INSTANCE_NAME> to create resources for a specific test case.
3. kitchen verify tests the created infrastructure. Run kitchen verify <INSTANCE_NAME> to run a specific test case.
4. kitchen destroy tears down the underlying resources created by kitchen converge. Run kitchen destroy <INSTANCE_NAME> to tear down resources for a specific test case.

Alternatively, you can simply run CREDENTIALS_FILE="credentials.json" make test_integration_docker to run all the test steps non-interactively.

Each test-kitchen instance is configured with a terraform.tfvars file in the test fixture directory, e.g. test/fixtures/simple_example/terraform.tfvars. For convenience, these files have been symlinked to test/fixtures/shared/terraform.tfvars. Similarly, each test fixture has a variables.tf to define these variables, and an outputs.tf to facilitate providing necessary information for inspec to locate and query against created resources.

Each test-kitchen instance creates a GCP Network and Subnetwork fixture to house resources, and may create any other necessary fixture data as needed.

Run

make generate_docs

The makefile in this project will lint or sometimes just format any shell, Python, golang, Terraform, or Dockerfiles. The linters will only be run if the makefile finds files with the appropriate file extension.

All of the linter checks are in the default make target, so you just have to run

make -s

The -s is for 'silent'. Successful output looks like this

Running shellcheck
Running flake8
Running go fmt and go vet
Running terraform validate
Running hadolint on Dockerfiles
Checking for required files
Testing the validity of the header check
..
----------------------------------------------------------------------
Ran 2 tests in 0.026s

OK
Checking file headers
The following lines have trailing whitespace

The linters are as follows:

• Shell - shellcheck. Can be found in homebrew
• Python - flake8. Can be installed with 'pip install flake8'
• Golang - gofmt. gofmt comes with the standard golang installation. golang is a compiled language so there is no standard linter.
• Terraform - terraform has a built-in linter in the 'terraform validate' command.
• Dockerfiles - hadolint. Can be found in homebrew