Move root Terraform files to ./autogen/ directory, and set up submodule structure

Author: Jberlinsky

Makefile

@@ -24,7 +24,7 @@ DOCKER_TAG_KITCHEN_TERRAFORM ?= ${DOCKER_TAG_BASE_KITCHEN_TERRAFORM}
 DOCKER_IMAGE_KITCHEN_TERRAFORM := cft/kitchen-terraform_terraform-google-kubernetes-engine
 
 # All is the first target in the file so it will get picked up when you just run 'make' on its own
-all: check_shell check_python check_golang check_terraform check_docker check_base_files test_check_headers check_headers check_trailing_whitespace generate_docs
+all: check_shell check_python check_golang check_terraform check_docker check_base_files test_check_headers check_headers check_trailing_whitespace test_helpers generate_docs
 
 # The .PHONY directive tells make that this isn't a real target and so
 # the presence of a file named 'check_shell' won't cause this target to stop
@@ -71,6 +71,10 @@ check_headers:
 	@echo "Checking file headers"
 	@python test/verify_boilerplate.py
 
+.PHONY: test_helpers
+test_helpers:
+	./test/helpers/generate_modules/test_generate_modules.py
+
 # Integration tests
 .PHONY: test_integration
 test_integration:
@@ -85,6 +89,11 @@ test_integration:
 generate_docs:
 	@source test/make.sh && generate_docs
 
+.PHONY: generate
+generate:
+	@pip install -r ./helpers/generate_modules/requirements.txt
+	@./helpers/generate_modules/generate_modules.py
+
 # Versioning
 .PHONY: version
 version:

README.md

@@ -198,13 +198,25 @@ The project has the following folders and files:
 
 - /: root folder
 - /examples: examples for using this module
+- /helpers: Helper scripts
+- /modules: Specific implementations of the module (see Submodules section of this file)
 - /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
 
+## Submodules
+
+To more cleanly handle cases where desired functionality would require complex duplication of Terraform resources (i.e. [PR 51](https://github.com/terraform-google-modules/terraform-google-kubernetes-engine/pull/51)), this repository is divided into multiple submodules. To ensure backwards compatibility with the module before this change, using the root of the repository as the source of a module will default to the [./modules/public-cluster](`public-cluster`) submodule.
+
+The following submodules currently exist:
+
+- [./modules/public-cluster](`public-cluster`), which creates a GKE cluster with its nodes and endpoint publicly accessible.
+
+Submodules, and the reverse-compatible wrapper for the root of the repository, are generated by running `make generate`. When making changes to this repository, please ensure that your change is made in the [./autogen](`autogen`) directory if it is expected to propagate to all submodules.
+
 ## Testing
 
 ### Requirements

auth.tf renamed to autogen/auth.tf

@@ -0,0 +1,151 @@
+/**
+ * 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.
+ */
+
+/******************************************
+  Get available zones in region
+ *****************************************/
+data "google_compute_zones" "available" {
+  project = "${var.project_id}"
+  region  = "${var.region}"
+}
+
+resource "random_shuffle" "available_zones" {
+  input        = ["${data.google_compute_zones.available.names}"]
+  result_count = 3
+}
+
+locals {
+  kubernetes_version     = "${var.kubernetes_version != "latest" ? var.kubernetes_version : data.google_container_engine_versions.region.latest_node_version}"
+  node_version           = "${var.node_version != "" ? var.node_version : local.kubernetes_version}"
+  custom_kube_dns_config = "${length(keys(var.stub_domains)) > 0 ? true : false}"
+  network_project_id     = "${var.network_project_id != "" ? var.network_project_id : var.project_id}"
+
+  cluster_type = "${var.regional ? "regional" : "zonal"}"
+
+  cluster_type_output_name = {
+    regional = "${element(concat(google_container_cluster.primary.*.name, list("")), 0)}"
+    zonal    = "${element(concat(google_container_cluster.zonal_primary.*.name, list("")), 0)}"
+  }
+
+  cluster_type_output_location = {
+    regional = "${element(concat(google_container_cluster.primary.*.region, list("")), 0)}"
+    zonal    = "${element(concat(google_container_cluster.zonal_primary.*.zone, list("")), 0)}"
+  }
+
+  cluster_type_output_region = {
+    regional = "${element(concat(google_container_cluster.primary.*.region, list("")), 0)}"
+    zonal    = "${var.region}"
+  }
+
+  cluster_type_output_regional_zones = "${concat(google_container_cluster.primary.*.additional_zones, list(list()))}"
+  cluster_type_output_zonal_zones    = "${concat(slice(var.zones,1,length(var.zones)), list(list()))}"
+
+  cluster_type_output_zones = {
+    regional = "${local.cluster_type_output_regional_zones[0]}"
+    zonal    = "${concat(google_container_cluster.zonal_primary.*.zone, local.cluster_type_output_zonal_zones[0])}"
+  }
+
+  cluster_type_output_endpoint = {
+    regional = "${element(concat(google_container_cluster.primary.*.endpoint, list("")), 0)}"
+    zonal    = "${element(concat(google_container_cluster.zonal_primary.*.endpoint, list("")), 0)}"
+  }
+
+  cluster_type_output_master_auth = {
+    regional = "${concat(google_container_cluster.primary.*.master_auth, list())}"
+    zonal    = "${concat(google_container_cluster.zonal_primary.*.master_auth, list())}"
+  }
+
+  cluster_type_output_master_version = {
+    regional = "${element(concat(google_container_cluster.primary.*.master_version, list("")), 0)}"
+    zonal    = "${element(concat(google_container_cluster.zonal_primary.*.master_version, list("")), 0)}"
+  }
+
+  cluster_type_output_min_master_version = {
+    regional = "${element(concat(google_container_cluster.primary.*.min_master_version, list("")), 0)}"
+    zonal    = "${element(concat(google_container_cluster.zonal_primary.*.min_master_version, list("")), 0)}"
+  }
+
+  cluster_type_output_logging_service = {
+    regional = "${element(concat(google_container_cluster.primary.*.logging_service, list("")), 0)}"
+    zonal    = "${element(concat(google_container_cluster.zonal_primary.*.logging_service, list("")), 0)}"
+  }
+
+  cluster_type_output_monitoring_service = {
+    regional = "${element(concat(google_container_cluster.primary.*.monitoring_service, list("")), 0)}"
+    zonal    = "${element(concat(google_container_cluster.zonal_primary.*.monitoring_service, list("")), 0)}"
+  }
+
+  cluster_type_output_network_policy_enabled = {
+    regional = "${element(concat(google_container_cluster.primary.*.addons_config.0.network_policy_config.0.disabled, list("")), 0)}"
+    zonal    = "${element(concat(google_container_cluster.zonal_primary.*.addons_config.0.network_policy_config.0.disabled, list("")), 0)}"
+  }
+
+  cluster_type_output_http_load_balancing_enabled = {
+    regional = "${element(concat(google_container_cluster.primary.*.addons_config.0.http_load_balancing.0.disabled, list("")), 0)}"
+    zonal    = "${element(concat(google_container_cluster.zonal_primary.*.addons_config.0.http_load_balancing.0.disabled, list("")), 0)}"
+  }
+
+  cluster_type_output_horizontal_pod_autoscaling_enabled = {
+    regional = "${element(concat(google_container_cluster.primary.*.addons_config.0.horizontal_pod_autoscaling.0.disabled, list("")), 0)}"
+    zonal    = "${element(concat(google_container_cluster.zonal_primary.*.addons_config.0.horizontal_pod_autoscaling.0.disabled, list("")), 0)}"
+  }
+
+  cluster_type_output_kubernetes_dashboard_enabled = {
+    regional = "${element(concat(google_container_cluster.primary.*.addons_config.0.kubernetes_dashboard.0.disabled, list("")), 0)}"
+    zonal    = "${element(concat(google_container_cluster.zonal_primary.*.addons_config.0.kubernetes_dashboard.0.disabled, list("")), 0)}"
+  }
+
+  cluster_type_output_node_pools_names = {
+    regional = "${concat(google_container_node_pool.pools.*.name, list(""))}"
+    zonal    = "${concat(google_container_node_pool.zonal_pools.*.name, list(""))}"
+  }
+
+  cluster_type_output_node_pools_versions = {
+    regional = "${concat(google_container_node_pool.pools.*.version, list(""))}"
+    zonal    = "${concat(google_container_node_pool.zonal_pools.*.version, list(""))}"
+  }
+
+  cluster_master_auth_list_layer1 = "${local.cluster_type_output_master_auth[local.cluster_type]}"
+  cluster_master_auth_list_layer2 = "${local.cluster_master_auth_list_layer1[0]}"
+  cluster_master_auth_map         = "${local.cluster_master_auth_list_layer2[0]}"
+
+  # cluster locals
+  cluster_name                = "${local.cluster_type_output_name[local.cluster_type]}"
+  cluster_location            = "${local.cluster_type_output_location[local.cluster_type]}"
+  cluster_region              = "${local.cluster_type_output_region[local.cluster_type]}"
+  cluster_zones               = "${sort(local.cluster_type_output_zones[local.cluster_type])}"
+  cluster_endpoint            = "${local.cluster_type_output_endpoint[local.cluster_type]}"
+  cluster_ca_certificate      = "${lookup(local.cluster_master_auth_map, "cluster_ca_certificate")}"
+  cluster_master_version      = "${local.cluster_type_output_master_version[local.cluster_type]}"
+  cluster_min_master_version  = "${local.cluster_type_output_min_master_version[local.cluster_type]}"
+  cluster_logging_service     = "${local.cluster_type_output_logging_service[local.cluster_type]}"
+  cluster_monitoring_service  = "${local.cluster_type_output_monitoring_service[local.cluster_type]}"
+  cluster_node_pools_names    = "${local.cluster_type_output_node_pools_names[local.cluster_type]}"
+  cluster_node_pools_versions = "${local.cluster_type_output_node_pools_versions[local.cluster_type]}"
+
+  cluster_network_policy_enabled             = "${local.cluster_type_output_network_policy_enabled[local.cluster_type] ? false : true}"
+  cluster_http_load_balancing_enabled        = "${local.cluster_type_output_http_load_balancing_enabled[local.cluster_type] ? false : true}"
+  cluster_horizontal_pod_autoscaling_enabled = "${local.cluster_type_output_horizontal_pod_autoscaling_enabled[local.cluster_type] ? false : true}"
+  cluster_kubernetes_dashboard_enabled       = "${local.cluster_type_output_kubernetes_dashboard_enabled[local.cluster_type] ? false : true}"
+}
+
+/******************************************
+  Get available container engine versions
+ *****************************************/
+data "google_container_engine_versions" "region" {
+  zone    = "${data.google_compute_zones.available.names[0]}"
+  project = "${var.project_id}"
+}

cluster_regional.tf renamed to autogen/cluster_regional.tf

@@ -0,0 +1,107 @@
+/**
+ * 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" {
+  description = "Cluster name"
+  value       = "${local.cluster_name}"
+}
+
+output "type" {
+  description = "Cluster type (regional / zonal)"
+  value       = "${local.cluster_type}"
+}
+
+output "location" {
+  description = "Cluster location (region if regional cluster, zone if zonal cluster)"
+  value       = "${local.cluster_location}"
+}
+
+output "region" {
+  description = "Cluster region"
+  value       = "${local.cluster_region}"
+}
+
+output "zones" {
+  description = "List of zones in which the cluster resides"
+  value       = "${local.cluster_zones}"
+}
+
+output "endpoint" {
+  sensitive   = true
+  description = "Cluster endpoint"
+  value       = "${local.cluster_endpoint}"
+}
+
+output "min_master_version" {
+  description = "Minimum master kubernetes version"
+  value       = "${local.cluster_min_master_version}"
+}
+
+output "logging_service" {
+  description = "Logging service used"
+  value       = "${local.cluster_logging_service}"
+}
+
+output "monitoring_service" {
+  description = "Monitoring service used"
+  value       = "${local.cluster_monitoring_service}"
+}
+
+output "master_authorized_networks_config" {
+  description = "Networks from which access to master is permitted"
+  value       = "${var.master_authorized_networks_config}"
+}
+
+output "master_version" {
+  description = "Current master kubernetes version"
+  value       = "${local.cluster_master_version}"
+}
+
+output "ca_certificate" {
+  sensitive   = true
+  description = "Cluster ca certificate (base64 encoded)"
+  value       = "${local.cluster_ca_certificate}"
+}
+
+output "network_policy_enabled" {
+  description = "Whether network policy enabled"
+  value       = "${local.cluster_network_policy_enabled}"
+}
+
+output "http_load_balancing_enabled" {
+  description = "Whether http load balancing enabled"
+  value       = "${local.cluster_http_load_balancing_enabled}"
+}
+
+output "horizontal_pod_autoscaling_enabled" {
+  description = "Whether horizontal pod autoscaling enabled"
+  value       = "${local.cluster_horizontal_pod_autoscaling_enabled}"
+}
+
+output "kubernetes_dashboard_enabled" {
+  description = "Whether kubernetes dashboard enabled"
+  value       = "${local.cluster_kubernetes_dashboard_enabled}"
+}
+
+output "node_pools_names" {
+  description = "List of node pools names"
+  value       = "${local.cluster_node_pools_names}"
+}
+
+output "node_pools_versions" {
+  description = "List of node pools versions"
+  value       = "${local.cluster_node_pools_versions}"
+}