Make zone configuration optional when creating a regional cluster

Author: Jberlinsky

cluster_regional.tf

@@ -24,7 +24,7 @@ resource "google_container_cluster" "primary" {
   project     = "${var.project_id}"
 
   region           = "${var.region}"
-  additional_zones = "${var.zones}"
+  additional_zones = ["${coalescelist(compact(var.zones), data.google_compute_zones.available.names)}"]
 
   network            = "${data.google_compute_network.gke_network.self_link}"
   subnetwork         = "${data.google_compute_subnetwork.gke_subnetwork.self_link}"

examples/simple_regional/README.md

@@ -0,0 +1,17 @@
+# Simple Regional Cluster
+
+This example illustrates how to create a simple cluster.
+
+Expected variables:
+- `project_id`
+- `region`
+- `network`
+- `subnetwork`
+- `ip_range_pods`
+- `ip_range_services`
+
+To provision this example, run the following from within this directory:
+- `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

examples/simple_regional/main.tf

@@ -0,0 +1,36 @@
+/**
+ * Copyright 2018 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+locals {
+  credentials_file_path = "${path.module}/sa-key.json"
+}
+
+provider "google" {
+  credentials = "${file(local.credentials_file_path)}"
+  region = "us-east4" # TODO remove
+}
+
+module "gke" {
+  source            = "../../"
+  project_id        = "${var.project_id}"
+  name              = "simple-regional-cluster"
+  regional          = true
+  region            = "${var.region}"
+  network           = "${var.network}"
+  subnetwork        = "${var.subnetwork}"
+  ip_range_pods     = "${var.ip_range_pods}"
+  ip_range_services = "${var.ip_range_services}"
+}

examples/simple_regional/outputs.tf

@@ -0,0 +1,31 @@
+/**
+ * Copyright 2018 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+output "name_example" {
+  description = "Cluster name"
+  value       = "${module.gke.name}"
+}
+
+output "endpoint_example" {
+  sensitive   = true
+  description = "Cluster endpoint"
+  value       = "${module.gke.endpoint}"
+}
+
+output "location_example" {
+  description = "Cluster location"
+  value       = "${module.gke.location}"
+}

examples/simple_regional/variables.tf

@@ -0,0 +1,39 @@
+/**
+ * Copyright 2018 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+variable "project_id" {
+  description = "The project ID to host the cluster in"
+}
+
+variable "region" {
+  description = "The region to host the cluster in"
+}
+
+variable "network" {
+  description = "The VPC network to host the cluster in"
+}
+
+variable "subnetwork" {
+  description = "The subnetwork to host the cluster in"
+}
+
+variable "ip_range_pods" {
+  description = "The secondary ip range to use for pods"
+}
+
+variable "ip_range_services" {
+  description = "The secondary ip range to use for pods"
+}

examples/simple_zonal/main.tf

@@ -20,6 +20,7 @@ locals {
 
 provider "google" {
   credentials = "${file(local.credentials_file_path)}"
+  region      = "${var.region}"
 }
 
 module "gke" {

test/integration/gcloud/Gemfile

@@ -15,6 +15,8 @@
 ruby '2.4.2'
 
 source 'https://rubygems.org/' do
+  gem 'googleauth'
+  gem 'google-api-client'
   gem 'kitchen-terraform', '~> 3.3'
   gem 'kitchen-inspec', :git => 'https://github.com/inspec/kitchen-inspec.git', :ref => '0590f1b'
 end

test/integration/gcloud/run.sh

@@ -27,18 +27,34 @@ function export_vars() {
   export TEST_ID="modules_gke_integration_gcloud_${RANDOM}"
   export KUBECONFIG="${TEMPDIR}/${CLUSTER_TYPE}/${TEST_ID}.kubeconfig"
   if [[ $CLUSTER_TYPE = "regional" ]]; then
+    if [ -f "./regional_config.sh" ]; then
+      source ./regional_config.sh
+    fi
     export CLUSTER_REGIONAL="true"
     export CLUSTER_LOCATION="$REGIONAL_LOCATION"
     export CLUSTER_NAME="$REGIONAL_CLUSTER_NAME"
     export IP_RANGE_PODS="$REGIONAL_IP_RANGE_PODS"
     export IP_RANGE_SERVICES="$REGIONAL_IP_RANGE_SERVICES"
   else
+    if [ -f "./zonal_config.sh" ]; then
+      source ./zonal_config.sh
+    fi
+    if [ -z "${ZONE}" ]; then
+      echo "Can not create a zonal cluster without specifying \$ZONE. Aborting..."
+      exit 1
+    fi
     export CLUSTER_REGIONAL="false"
     export CLUSTER_LOCATION="$ZONAL_LOCATION"
     export CLUSTER_NAME="$ZONAL_CLUSTER_NAME"
     export IP_RANGE_PODS="$ZONAL_IP_RANGE_PODS"
     export IP_RANGE_SERVICES="$ZONAL_IP_RANGE_SERVICES"
   fi
+
+  if [ "${ZONE}" = "" ] && [ "${ADDITIONAL_ZONES}" = "" ]; then
+    export ZONES=""
+  else
+    export ZONES="\"$ZONE\",$ADDITIONAL_ZONES"
+  fi
 }
 
 # Activate test working directory

test/integration/gcloud/sample.sh

@@ -34,11 +34,11 @@ export CLUSTER_NAME="int-test-cluster-01"
 export REGION="us-east4"
 export ZONE="us-east4-a"
 export ADDITIONAL_ZONES='"us-east4-b","us-east4-c"'
-export ZONES="\"$ZONE\",$ADDITIONAL_ZONES"
 export KUBERNETES_VERSION="1.10.6-gke.2"
 export NODE_POOL_SERVICE_ACCOUNT=""
 export REGIONAL_CLUSTER_NAME="int-test-regional-01"
 export REGIONAL_LOCATION="$REGION"
 export ZONAL_CLUSTER_NAME="int-test-zonal-01"
 export ZONAL_LOCATION="$ZONE"
 export CLOUDSDK_AUTH_CREDENTIAL_FILE_OVERRIDE=$CREDENTIALS_PATH
+export GOOGLE_APPLICATION_CREDENTIALS=$CREDENTIALS_PATH

test/integration/gcloud/test/integration/default/inspec/terraform.rb

@@ -12,6 +12,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+require_relative '../../../../test/support/google_cloud.rb'
+
 # Test the name output
 describe command('terraform output name_example') do
   its('stdout.strip') { should eq ENV['CLUSTER_NAME'] }
@@ -34,7 +36,11 @@
 
 # Test the zones output
 describe command('terraform output -json zones_example | jq -cre \'.value\'') do
-  its('stdout.strip') { should eq '[' + ENV['ZONES'] + ']' }
+  if ENV['ZONES'] != ''
+    its('stdout.strip') { should eq '[' + ENV['ZONES'] + ']' }
+  else
+    its('stdout.strip') { should eq google_compute_service.get_region(ENV['PROJECT_ID'], ENV['REGION']).zones.map { |z| z.split("/").last }.to_json }
+  end
 end
 
 # Test the endpoint output

test/integration/gcloud/test/support/google_cloud.rb

@@ -0,0 +1,22 @@
+# Copyright 2018 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'googleauth'
+require 'google/apis/compute_v1'
+
+def google_compute_service
+  Google::Apis::ComputeV1::ComputeService.new.tap do |service|
+    service.authorization = Google::Auth.get_application_default(['https://www.googleapis.com/auth/cloud-platform'])
+  end
+end

test/integration/gcloud/zonal_config.sh

@@ -0,0 +1,25 @@
+#!/bin/bash
+# Copyright 2018 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
+#################################################################
+#   PLEASE FILL THE VARIABLES WITH VALID VALUES FOR TESTING     #
+#   DO NOT REMOVE ANY OF THE VARIABLES                          #
+#################################################################
+
+export ZONE="us-east4-a"
+export ADDITIONAL_ZONES='"us-east4-b","us-east4-c"'
+export ZONAL_LOCATION="$ZONE"
+