This module handles opinionated Google Cloud Platform Kubernetes Engine cluster creation and configuration with Node Pools, IP MASQ, Network Policy, etc.

The resources/services/activations/deletions that this module will create/trigger are:

• Create a GKE cluster with the provided addons
• Create GKE Node Pool(s) with provided configuration and attach to cluster
• Replace the default kube-dns configmap if stub_domains are provided
• Activate network policy if network_policy is true
• Add ip-masq-agent configmap with provided non_masquerade_cidrs if network_policy is true

There are multiple examples included in the examples folder but simple usage is as follows:

module "gke" { source = "terraform-google-modules/kubernetes-engine/google" project_id = "<PROJECT ID>" name = "gke-test-1" region = "us-central1" zones = ["us-central1-a", "us-central1-b", "us-central1-f"] network = "vpc-01" subnetwork = "us-central1-01" ip_range_pods = "us-central1-01-gke-01-pods" ip_range_services = "us-central1-01-gke-01-services" http_load_balancing = false horizontal_pod_autoscaling = true kubernetes_dashboard = true network_policy = true node_pools = [ { name = "default-node-pool" machine_type = "n1-standard-2" min_count = 1 max_count = 100 disk_size_gb = 100 disk_type = "pd-standard" image_type = "COS" auto_repair = true auto_upgrade = true service_account = "project-service-account@<PROJECT ID>.iam.gserviceaccount.com" }, ] node_pools_labels = { all = {} default-node-pool = { default-node-pool = "true" } } node_pools_taints = { all = [] default-node-pool = [ { key = "default-node-pool" value = "true" effect = "PREFER_NO_SCHEDULE" }, ] } node_pools_tags = { all = [] default-node-pool = [ "default-node-pool", ] } }

Then perform the following commands on the root folder:

• terraform init to get the plugins
• terraform plan to see the infrastructure plan
• terraform apply to apply the infrastructure build
• terraform destroy to destroy the built infrastructure ^: (autogen_docs_start)

• kubectl 1.9.x

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

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

The service account with the following roles:

• roles/compute.viewer on the project
• roles/container.clusterAdmin on the project

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
• Kubernetes Engine API - container.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
• /scripts: Scripts for specific tasks on module (see Infrastructure section on this file)
• /test: Folders with files for testing the module (see Testing section on this file)
• /main.tf: main file for this module, contains all the resources to create
• /variables.tf: all the variables for the module
• /output.tf: the outputs of the module
• /readme.MD: this file

• bundler
• gcloud
• jq 1.5
• terraform-docs 0.3.0

Run

make generate_docs 

The integration tests for this module leverage kitchen-terraform and kitchen-inspec.

The tests will do the following:

• Perform bundle install command
  • Installs kitchen-terraform and kitchen-inspec gems
• Perform kitchen create command
  • Performs a terraform init
• Perform kitchen converge command
  • Performs a terraform apply -auto-approve
• Perform kitchen validate command
  • Performs inspec tests.
    • Shell out to gcloud to validate expected resources in GCP.
    • Shell out to kubectl to validate expected resource in Kubernetes.
    • Shell out to terraform to validate outputs.
• Permos kitchen destroy command
  • Performs a terraform destroy -force

You can use the following command to run the integration test in the root folder

make test_integration

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