From 0e094a48f82cbee3082ad6d390d10846815fde6d Mon Sep 17 00:00:00 2001 From: Jason Berlinsky Date: Tue, 5 Mar 2019 09:25:48 -0500 Subject: [PATCH 1/4] Remove credentials_path and credentials_path_relative --- examples/deploy_service/README.md | 34 ------------- examples/deploy_service/main.tf | 10 ++-- examples/deploy_service/variables.tf | 4 -- examples/node_pool/README.md | 49 ++++++------------- examples/node_pool/main.tf | 10 ++-- examples/node_pool/variables.tf | 4 -- examples/shared_vpc/README.md | 35 ------------- examples/shared_vpc/main.tf | 10 ++-- examples/shared_vpc/variables.tf | 4 -- examples/simple_regional/README.md | 34 ------------- examples/simple_regional/main.tf | 10 ++-- examples/simple_regional/variables.tf | 4 -- examples/simple_regional_private/README.md | 34 ------------- examples/simple_regional_private/main.tf | 5 +- examples/simple_regional_private/variables.tf | 4 -- examples/simple_zonal/README.md | 34 ------------- examples/simple_zonal/main.tf | 10 ++-- examples/simple_zonal/variables.tf | 4 -- examples/simple_zonal_private/README.md | 35 ------------- examples/simple_zonal_private/main.tf | 5 +- examples/simple_zonal_private/variables.tf | 4 -- examples/stub_domains/README.md | 34 ------------- examples/stub_domains/main.tf | 10 ++-- examples/stub_domains/variables.tf | 4 -- test/fixtures/all_examples/test_outputs.tf | 4 -- test/fixtures/deploy_service/example.tf | 1 - test/fixtures/deploy_service/network.tf | 5 -- test/fixtures/node_pool/example.tf | 1 - test/fixtures/node_pool/network.tf | 5 -- test/fixtures/shared/outputs.tf | 4 -- test/fixtures/shared/terraform.tfvars.sample | 1 - test/fixtures/shared/variables.tf | 4 -- test/fixtures/shared_vpc/example.tf | 1 - test/fixtures/shared_vpc/network.tf | 5 -- test/fixtures/simple_regional/example.tf | 1 - test/fixtures/simple_regional/network.tf | 5 -- .../simple_regional_private/example.tf | 1 - .../simple_regional_private/network.tf | 5 -- test/fixtures/simple_zonal/example.tf | 1 - test/fixtures/simple_zonal/network.tf | 5 -- test/fixtures/simple_zonal_private/example.tf | 1 - test/fixtures/simple_zonal_private/network.tf | 5 -- test/fixtures/stub_domains/example.tf | 1 - test/fixtures/stub_domains/network.tf | 5 -- .../deploy_service/controls/gcloud.rb | 3 -- test/integration/deploy_service/inspec.yml | 3 -- test/integration/node_pool/controls/gcloud.rb | 3 -- test/integration/node_pool/inspec.yml | 3 -- .../integration/shared_vpc/controls/gcloud.rb | 3 -- test/integration/shared_vpc/inspec.yml | 3 -- .../simple_regional/controls/gcloud.rb | 3 -- test/integration/simple_regional/inspec.yml | 3 -- .../controls/gcloud.rb | 3 -- .../simple_regional_private/inspec.yml | 3 -- .../simple_zonal/controls/gcloud.rb | 3 -- test/integration/simple_zonal/inspec.yml | 3 -- .../simple_zonal_private/controls/gcloud.rb | 3 -- .../simple_zonal_private/inspec.yml | 3 -- .../stub_domains/controls/gcloud.rb | 3 -- test/integration/stub_domains/inspec.yml | 3 -- 60 files changed, 43 insertions(+), 457 deletions(-) diff --git a/examples/deploy_service/README.md b/examples/deploy_service/README.md index 9d2429490d..8292d610ad 100644 --- a/examples/deploy_service/README.md +++ b/examples/deploy_service/README.md @@ -10,40 +10,6 @@ It will: [^]: (autogen_docs_start) -## Inputs - -| Name | Description | Type | Default | Required | -|------|-------------|:----:|:-----:|:-----:| -| cluster\_name\_suffix | A suffix to append to the default cluster name | string | `""` | no | -| compute\_engine\_service\_account | Service account to associate to the nodes in the cluster | string | n/a | yes | -| credentials\_path | The path to the GCP credentials JSON file | string | n/a | yes | -| ip\_range\_pods | The secondary ip range to use for pods | string | n/a | yes | -| ip\_range\_services | The secondary ip range to use for pods | string | n/a | yes | -| network | The VPC network to host the cluster in | string | n/a | yes | -| project\_id | The project ID to host the cluster in | string | n/a | yes | -| region | The region to host the cluster in | string | n/a | yes | -| subnetwork | The subnetwork to host the cluster in | string | n/a | yes | - -## Outputs - -| Name | Description | -|------|-------------| -| ca\_certificate | | -| client\_token | | -| cluster\_name | Cluster name | -| credentials\_path | | -| ip\_range\_pods | The secondary IP range used for pods | -| ip\_range\_services | The secondary IP range used for services | -| kubernetes\_endpoint | | -| location | | -| master\_kubernetes\_version | The master Kubernetes version | -| network | | -| project\_id | | -| region | | -| service\_account | The service account to default running nodes as if not overridden in `node_pools`. | -| subnetwork | | -| zones | List of zones in which the cluster resides | - [^]: (autogen_docs_end) To provision this example, run the following from within this directory: diff --git a/examples/deploy_service/main.tf b/examples/deploy_service/main.tf index 6e2a3d2d5c..3b811053bf 100644 --- a/examples/deploy_service/main.tf +++ b/examples/deploy_service/main.tf @@ -19,15 +19,13 @@ locals { } provider "google" { - version = "~> 2.2" - credentials = "${file(var.credentials_path)}" - region = "${var.region}" + version = "~> 2.2" + region = "${var.region}" } provider "google-beta" { - version = "~> 2.2" - credentials = "${file(var.credentials_path)}" - region = "${var.region}" + version = "~> 2.2" + region = "${var.region}" } provider "kubernetes" { diff --git a/examples/deploy_service/variables.tf b/examples/deploy_service/variables.tf index 8501b205b3..a4409795b7 100644 --- a/examples/deploy_service/variables.tf +++ b/examples/deploy_service/variables.tf @@ -18,10 +18,6 @@ variable "project_id" { description = "The project ID to host the cluster in" } -variable "credentials_path" { - description = "The path to the GCP credentials JSON file" -} - variable "cluster_name_suffix" { description = "A suffix to append to the default cluster name" default = "" diff --git a/examples/node_pool/README.md b/examples/node_pool/README.md index d3a3ab7098..fe8caf187b 100644 --- a/examples/node_pool/README.md +++ b/examples/node_pool/README.md @@ -1,43 +1,24 @@ -# Node Pool Cluster +# Project Cleanup Utility -This example illustrates how to create a cluster with multiple custom node-pool configurations with node labels, taints, and network tags. +This is a simple utility that scans a GCP organization for projects matching certain criteria, and enqueues such projects for deletion. Currently supported criteria are the combination of: -[^]: (autogen_docs_start) +- **Age:** Only projects older than the configured age, in hours, will be marked for deletion. +- **Key-Value Pair:** Only projects whose labels contain the provided key-value pair will be marked for deletion. -## Inputs +## Environment Configuration + +The following environment variables may be specified to configure the cleanup utility: | Name | Description | Type | Default | Required | |------|-------------|:----:|:-----:|:-----:| -| cluster\_name\_suffix | A suffix to append to the default cluster name | string | `""` | no | -| compute\_engine\_service\_account | Service account to associate to the nodes in the cluster | string | n/a | yes | -| credentials\_path | The path to the GCP credentials JSON file | string | n/a | yes | -| ip\_range\_pods | The secondary ip range to use for pods | string | n/a | yes | -| ip\_range\_services | The secondary ip range to use for pods | string | n/a | yes | -| network | The VPC network to host the cluster in | string | n/a | yes | -| project\_id | The project ID to host the cluster in | string | n/a | yes | -| region | The region to host the cluster in | string | n/a | yes | -| subnetwork | The subnetwork to host the cluster in | string | n/a | yes | -| zones | The zone to host the cluster in (required if is a zonal cluster) | list | n/a | yes | - -## Outputs - -| Name | Description | -|------|-------------| -| ca\_certificate | | -| client\_token | | -| cluster\_name | Cluster name | -| credentials\_path | | -| ip\_range\_pods | The secondary IP range used for pods | -| ip\_range\_services | The secondary IP range used for services | -| kubernetes\_endpoint | | -| location | | -| master\_kubernetes\_version | The master Kubernetes version | -| network | | -| project\_id | | -| region | | -| service\_account | The service account to default running nodes as if not overridden in `node_pools`. | -| subnetwork | | -| zones | List of zones in which the cluster resides | +| `TARGET_TAG_NAME` | The tag name to match on for identifying projects to delete | string | n/a | yes | +| `TARGET_TAG_VALUE` | The tag value to match on for identifying projects to delete | string | n/a | yes | +| `MAX_PROJECT_AGE_HOURS` | The project age, in hours, at which point deletion should be considered | integer | n/a | yes | +# Node Pool Cluster + +This example illustrates how to create a cluster with multiple custom node-pool configurations with node labels, taints, and network tags. + +[^]: (autogen_docs_start) [^]: (autogen_docs_end) diff --git a/examples/node_pool/main.tf b/examples/node_pool/main.tf index bb5c8c74ed..adf0f1e2af 100644 --- a/examples/node_pool/main.tf +++ b/examples/node_pool/main.tf @@ -19,15 +19,13 @@ locals { } provider "google" { - version = "~> 2.2" - credentials = "${file(var.credentials_path)}" - region = "${var.region}" + version = "~> 2.2" + region = "${var.region}" } provider "google-beta" { - version = "~> 2.2" - credentials = "${file(var.credentials_path)}" - region = "${var.region}" + version = "~> 2.2" + region = "${var.region}" } module "gke" { diff --git a/examples/node_pool/variables.tf b/examples/node_pool/variables.tf index ebb151e38a..847277a5ba 100644 --- a/examples/node_pool/variables.tf +++ b/examples/node_pool/variables.tf @@ -18,10 +18,6 @@ variable "project_id" { description = "The project ID to host the cluster in" } -variable "credentials_path" { - description = "The path to the GCP credentials JSON file" -} - variable "cluster_name_suffix" { description = "A suffix to append to the default cluster name" default = "" diff --git a/examples/shared_vpc/README.md b/examples/shared_vpc/README.md index 86a561331f..1ecd805d6e 100644 --- a/examples/shared_vpc/README.md +++ b/examples/shared_vpc/README.md @@ -4,41 +4,6 @@ This example illustrates how to create a simple cluster where the host network i [^]: (autogen_docs_start) -## Inputs - -| Name | Description | Type | Default | Required | -|------|-------------|:----:|:-----:|:-----:| -| cluster\_name\_suffix | A suffix to append to the default cluster name | string | `""` | no | -| compute\_engine\_service\_account | Service account to associate to the nodes in the cluster | string | n/a | yes | -| credentials\_path | The path to the GCP credentials JSON file | string | n/a | yes | -| ip\_range\_pods | The secondary ip range to use for pods | string | n/a | yes | -| ip\_range\_services | The secondary ip range to use for pods | string | n/a | yes | -| network | The VPC network to host the cluster in | string | n/a | yes | -| network\_project\_id | The GCP project housing the VPC network to host the cluster in | string | n/a | yes | -| project\_id | The project ID to host the cluster in | string | n/a | yes | -| region | The region to host the cluster in | string | n/a | yes | -| subnetwork | The subnetwork to host the cluster in | string | n/a | yes | - -## Outputs - -| Name | Description | -|------|-------------| -| ca\_certificate | | -| client\_token | | -| cluster\_name | Cluster name | -| credentials\_path | | -| ip\_range\_pods | The secondary IP range used for pods | -| ip\_range\_services | The secondary IP range used for services | -| kubernetes\_endpoint | | -| location | | -| master\_kubernetes\_version | The master Kubernetes version | -| network | | -| project\_id | | -| region | | -| service\_account | The service account to default running nodes as if not overridden in `node_pools`. | -| subnetwork | | -| zones | List of zones in which the cluster resides | - [^]: (autogen_docs_end) To provision this example, run the following from within this directory: diff --git a/examples/shared_vpc/main.tf b/examples/shared_vpc/main.tf index d4a4283a6f..ec732c9c08 100644 --- a/examples/shared_vpc/main.tf +++ b/examples/shared_vpc/main.tf @@ -19,15 +19,13 @@ locals { } provider "google" { - version = "~> 2.2" - credentials = "${file(var.credentials_path)}" - region = "${var.region}" + version = "~> 2.2" + region = "${var.region}" } provider "google-beta" { - version = "~> 2.2" - credentials = "${file(var.credentials_path)}" - region = "${var.region}" + version = "~> 2.2" + region = "${var.region}" } module "gke" { diff --git a/examples/shared_vpc/variables.tf b/examples/shared_vpc/variables.tf index 645d2311a1..f8d1189671 100644 --- a/examples/shared_vpc/variables.tf +++ b/examples/shared_vpc/variables.tf @@ -18,10 +18,6 @@ variable "project_id" { description = "The project ID to host the cluster in" } -variable "credentials_path" { - description = "The path to the GCP credentials JSON file" -} - variable "cluster_name_suffix" { description = "A suffix to append to the default cluster name" default = "" diff --git a/examples/simple_regional/README.md b/examples/simple_regional/README.md index f37db67dfc..347e92cf6e 100644 --- a/examples/simple_regional/README.md +++ b/examples/simple_regional/README.md @@ -4,40 +4,6 @@ This example illustrates how to create a simple cluster. [^]: (autogen_docs_start) -## Inputs - -| Name | Description | Type | Default | Required | -|------|-------------|:----:|:-----:|:-----:| -| cluster\_name\_suffix | A suffix to append to the default cluster name | string | `""` | no | -| compute\_engine\_service\_account | Service account to associate to the nodes in the cluster | string | n/a | yes | -| credentials\_path | The path to the GCP credentials JSON file | string | n/a | yes | -| ip\_range\_pods | The secondary ip range to use for pods | string | n/a | yes | -| ip\_range\_services | The secondary ip range to use for pods | string | n/a | yes | -| network | The VPC network to host the cluster in | string | n/a | yes | -| project\_id | The project ID to host the cluster in | string | n/a | yes | -| region | The region to host the cluster in | string | n/a | yes | -| subnetwork | The subnetwork to host the cluster in | string | n/a | yes | - -## Outputs - -| Name | Description | -|------|-------------| -| ca\_certificate | | -| client\_token | | -| cluster\_name | Cluster name | -| credentials\_path | | -| ip\_range\_pods | The secondary IP range used for pods | -| ip\_range\_services | The secondary IP range used for services | -| kubernetes\_endpoint | | -| location | | -| master\_kubernetes\_version | The master Kubernetes version | -| network | | -| project\_id | | -| region | | -| service\_account | The service account to default running nodes as if not overridden in `node_pools`. | -| subnetwork | | -| zones | List of zones in which the cluster resides | - [^]: (autogen_docs_end) To provision this example, run the following from within this directory: diff --git a/examples/simple_regional/main.tf b/examples/simple_regional/main.tf index 328658cff8..81fb0381f7 100644 --- a/examples/simple_regional/main.tf +++ b/examples/simple_regional/main.tf @@ -19,15 +19,13 @@ locals { } provider "google" { - version = "~> 2.2" - credentials = "${file(var.credentials_path)}" - region = "${var.region}" + version = "~> 2.2" + region = "${var.region}" } provider "google-beta" { - version = "~> 2.2" - credentials = "${file(var.credentials_path)}" - region = "${var.region}" + version = "~> 2.2" + region = "${var.region}" } module "gke" { diff --git a/examples/simple_regional/variables.tf b/examples/simple_regional/variables.tf index 8501b205b3..a4409795b7 100644 --- a/examples/simple_regional/variables.tf +++ b/examples/simple_regional/variables.tf @@ -18,10 +18,6 @@ variable "project_id" { description = "The project ID to host the cluster in" } -variable "credentials_path" { - description = "The path to the GCP credentials JSON file" -} - variable "cluster_name_suffix" { description = "A suffix to append to the default cluster name" default = "" diff --git a/examples/simple_regional_private/README.md b/examples/simple_regional_private/README.md index 0b7a1089e1..2bee35a4df 100644 --- a/examples/simple_regional_private/README.md +++ b/examples/simple_regional_private/README.md @@ -4,40 +4,6 @@ This example illustrates how to create a simple private cluster. [^]: (autogen_docs_start) -## Inputs - -| Name | Description | Type | Default | Required | -|------|-------------|:----:|:-----:|:-----:| -| cluster\_name\_suffix | A suffix to append to the default cluster name | string | `""` | no | -| compute\_engine\_service\_account | Service account to associate to the nodes in the cluster | string | n/a | yes | -| credentials\_path | The path to the GCP credentials JSON file | string | n/a | yes | -| ip\_range\_pods | The secondary ip range to use for pods | string | n/a | yes | -| ip\_range\_services | The secondary ip range to use for pods | string | n/a | yes | -| network | The VPC network to host the cluster in | string | n/a | yes | -| project\_id | The project ID to host the cluster in | string | n/a | yes | -| region | The region to host the cluster in | string | n/a | yes | -| subnetwork | The subnetwork to host the cluster in | string | n/a | yes | - -## Outputs - -| Name | Description | -|------|-------------| -| ca\_certificate | | -| client\_token | | -| cluster\_name | Cluster name | -| credentials\_path | | -| ip\_range\_pods | The secondary IP range used for pods | -| ip\_range\_services | The secondary IP range used for services | -| kubernetes\_endpoint | | -| location | | -| master\_kubernetes\_version | The master Kubernetes version | -| network | | -| project\_id | | -| region | | -| service\_account | The service account to default running nodes as if not overridden in `node_pools`. | -| subnetwork | | -| zones | List of zones in which the cluster resides | - [^]: (autogen_docs_end) To provision this example, run the following from within this directory: diff --git a/examples/simple_regional_private/main.tf b/examples/simple_regional_private/main.tf index 1f1776c8a6..0b2ffcf90c 100644 --- a/examples/simple_regional_private/main.tf +++ b/examples/simple_regional_private/main.tf @@ -19,9 +19,8 @@ locals { } provider "google-beta" { - version = "~> 2.2" - credentials = "${file(var.credentials_path)}" - region = "${var.region}" + version = "~> 2.2" + region = "${var.region}" } data "google_compute_subnetwork" "subnetwork" { diff --git a/examples/simple_regional_private/variables.tf b/examples/simple_regional_private/variables.tf index 8501b205b3..a4409795b7 100644 --- a/examples/simple_regional_private/variables.tf +++ b/examples/simple_regional_private/variables.tf @@ -18,10 +18,6 @@ variable "project_id" { description = "The project ID to host the cluster in" } -variable "credentials_path" { - description = "The path to the GCP credentials JSON file" -} - variable "cluster_name_suffix" { description = "A suffix to append to the default cluster name" default = "" diff --git a/examples/simple_zonal/README.md b/examples/simple_zonal/README.md index 0e528744dc..a56d60dfcd 100644 --- a/examples/simple_zonal/README.md +++ b/examples/simple_zonal/README.md @@ -4,40 +4,6 @@ This example illustrates how to create a simple cluster. [^]: (autogen_docs_start) -## Inputs - -| Name | Description | Type | Default | Required | -|------|-------------|:----:|:-----:|:-----:| -| cluster\_name\_suffix | A suffix to append to the default cluster name | string | `""` | no | -| credentials\_path | The path to the GCP credentials JSON file | string | n/a | yes | -| ip\_range\_pods | The secondary ip range to use for pods | string | n/a | yes | -| ip\_range\_services | The secondary ip range to use for pods | string | n/a | yes | -| network | The VPC network to host the cluster in | string | n/a | yes | -| project\_id | The project ID to host the cluster in | string | n/a | yes | -| region | The region to host the cluster in | string | n/a | yes | -| subnetwork | The subnetwork to host the cluster in | string | n/a | yes | -| zones | The zone to host the cluster in (required if is a zonal cluster) | list | n/a | yes | - -## Outputs - -| Name | Description | -|------|-------------| -| ca\_certificate | | -| client\_token | | -| cluster\_name | Cluster name | -| credentials\_path | | -| ip\_range\_pods | The secondary IP range used for pods | -| ip\_range\_services | The secondary IP range used for services | -| kubernetes\_endpoint | | -| location | | -| master\_kubernetes\_version | The master Kubernetes version | -| network | | -| project\_id | | -| region | | -| service\_account | The service account to default running nodes as if not overridden in `node_pools`. | -| subnetwork | | -| zones | List of zones in which the cluster resides | - [^]: (autogen_docs_end) To provision this example, run the following from within this directory: diff --git a/examples/simple_zonal/main.tf b/examples/simple_zonal/main.tf index 71fe57ed28..904dbc9e51 100644 --- a/examples/simple_zonal/main.tf +++ b/examples/simple_zonal/main.tf @@ -19,15 +19,13 @@ locals { } provider "google" { - version = "~> 2.2" - credentials = "${file(var.credentials_path)}" - region = "${var.region}" + version = "~> 2.2" + region = "${var.region}" } provider "google-beta" { - version = "~> 2.2" - credentials = "${file(var.credentials_path)}" - region = "${var.region}" + version = "~> 2.2" + region = "${var.region}" } module "gke" { diff --git a/examples/simple_zonal/variables.tf b/examples/simple_zonal/variables.tf index 10130ab2d1..62547edfcd 100644 --- a/examples/simple_zonal/variables.tf +++ b/examples/simple_zonal/variables.tf @@ -18,10 +18,6 @@ variable "project_id" { description = "The project ID to host the cluster in" } -variable "credentials_path" { - description = "The path to the GCP credentials JSON file" -} - variable "cluster_name_suffix" { description = "A suffix to append to the default cluster name" default = "" diff --git a/examples/simple_zonal_private/README.md b/examples/simple_zonal_private/README.md index cc1643aec8..2bee35a4df 100644 --- a/examples/simple_zonal_private/README.md +++ b/examples/simple_zonal_private/README.md @@ -4,41 +4,6 @@ This example illustrates how to create a simple private cluster. [^]: (autogen_docs_start) -## Inputs - -| Name | Description | Type | Default | Required | -|------|-------------|:----:|:-----:|:-----:| -| cluster\_name\_suffix | A suffix to append to the default cluster name | string | `""` | no | -| compute\_engine\_service\_account | Service account to associate to the nodes in the cluster | string | n/a | yes | -| credentials\_path | The path to the GCP credentials JSON file | string | n/a | yes | -| ip\_range\_pods | The secondary ip range to use for pods | string | n/a | yes | -| ip\_range\_services | The secondary ip range to use for pods | string | n/a | yes | -| network | The VPC network to host the cluster in | string | n/a | yes | -| project\_id | The project ID to host the cluster in | string | n/a | yes | -| region | The region to host the cluster in | string | n/a | yes | -| subnetwork | The subnetwork to host the cluster in | string | n/a | yes | -| zones | The zone to host the cluster in (required if is a zonal cluster) | list | n/a | yes | - -## Outputs - -| Name | Description | -|------|-------------| -| ca\_certificate | | -| client\_token | | -| cluster\_name | Cluster name | -| credentials\_path | | -| ip\_range\_pods | The secondary IP range used for pods | -| ip\_range\_services | The secondary IP range used for services | -| kubernetes\_endpoint | | -| location | | -| master\_kubernetes\_version | The master Kubernetes version | -| network | | -| project\_id | | -| region | | -| service\_account | The service account to default running nodes as if not overridden in `node_pools`. | -| subnetwork | | -| zones | List of zones in which the cluster resides | - [^]: (autogen_docs_end) To provision this example, run the following from within this directory: diff --git a/examples/simple_zonal_private/main.tf b/examples/simple_zonal_private/main.tf index 76f7d6da13..e0ba0cbdb3 100644 --- a/examples/simple_zonal_private/main.tf +++ b/examples/simple_zonal_private/main.tf @@ -19,9 +19,8 @@ locals { } provider "google-beta" { - version = "~> 2.2" - credentials = "${file(var.credentials_path)}" - region = "${var.region}" + version = "~> 2.2" + region = "${var.region}" } data "google_compute_subnetwork" "subnetwork" { diff --git a/examples/simple_zonal_private/variables.tf b/examples/simple_zonal_private/variables.tf index ebb151e38a..847277a5ba 100644 --- a/examples/simple_zonal_private/variables.tf +++ b/examples/simple_zonal_private/variables.tf @@ -18,10 +18,6 @@ variable "project_id" { description = "The project ID to host the cluster in" } -variable "credentials_path" { - description = "The path to the GCP credentials JSON file" -} - variable "cluster_name_suffix" { description = "A suffix to append to the default cluster name" default = "" diff --git a/examples/stub_domains/README.md b/examples/stub_domains/README.md index 5bff5843f1..dc4333491c 100644 --- a/examples/stub_domains/README.md +++ b/examples/stub_domains/README.md @@ -9,40 +9,6 @@ It will: [^]: (autogen_docs_start) -## Inputs - -| Name | Description | Type | Default | Required | -|------|-------------|:----:|:-----:|:-----:| -| cluster\_name\_suffix | A suffix to append to the default cluster name | string | `""` | no | -| compute\_engine\_service\_account | Service account to associate to the nodes in the cluster | string | n/a | yes | -| credentials\_path | The path to the GCP credentials JSON file | string | n/a | yes | -| ip\_range\_pods | The secondary ip range to use for pods | string | n/a | yes | -| ip\_range\_services | The secondary ip range to use for pods | string | n/a | yes | -| network | The VPC network to host the cluster in | string | n/a | yes | -| project\_id | The project ID to host the cluster in | string | n/a | yes | -| region | The region to host the cluster in | string | n/a | yes | -| subnetwork | The subnetwork to host the cluster in | string | n/a | yes | - -## Outputs - -| Name | Description | -|------|-------------| -| ca\_certificate | | -| client\_token | | -| cluster\_name | Cluster name | -| credentials\_path | | -| ip\_range\_pods | The secondary IP range used for pods | -| ip\_range\_services | The secondary IP range used for services | -| kubernetes\_endpoint | | -| location | | -| master\_kubernetes\_version | The master Kubernetes version | -| network | | -| project\_id | | -| region | | -| service\_account | The service account to default running nodes as if not overridden in `node_pools`. | -| subnetwork | | -| zones | List of zones in which the cluster resides | - [^]: (autogen_docs_end) To provision this example, run the following from within this directory: diff --git a/examples/stub_domains/main.tf b/examples/stub_domains/main.tf index 1a5568e663..70ace9d6c9 100644 --- a/examples/stub_domains/main.tf +++ b/examples/stub_domains/main.tf @@ -19,15 +19,13 @@ locals { } provider "google" { - version = "~> 2.2" - credentials = "${file(var.credentials_path)}" - region = "${var.region}" + version = "~> 2.2" + region = "${var.region}" } provider "google-beta" { - version = "~> 2.2" - credentials = "${file(var.credentials_path)}" - region = "${var.region}" + version = "~> 2.2" + region = "${var.region}" } module "gke" { diff --git a/examples/stub_domains/variables.tf b/examples/stub_domains/variables.tf index 8501b205b3..a4409795b7 100644 --- a/examples/stub_domains/variables.tf +++ b/examples/stub_domains/variables.tf @@ -18,10 +18,6 @@ variable "project_id" { description = "The project ID to host the cluster in" } -variable "credentials_path" { - description = "The path to the GCP credentials JSON file" -} - variable "cluster_name_suffix" { description = "A suffix to append to the default cluster name" default = "" diff --git a/test/fixtures/all_examples/test_outputs.tf b/test/fixtures/all_examples/test_outputs.tf index 4d1361b7eb..c1d4352219 100644 --- a/test/fixtures/all_examples/test_outputs.tf +++ b/test/fixtures/all_examples/test_outputs.tf @@ -21,10 +21,6 @@ output "project_id" { value = "${var.project_id}" } -output "credentials_path" { - value = "${var.credentials_path}" -} - output "region" { value = "${module.gke.region}" } diff --git a/test/fixtures/deploy_service/example.tf b/test/fixtures/deploy_service/example.tf index ed22358d66..7cc5178569 100644 --- a/test/fixtures/deploy_service/example.tf +++ b/test/fixtures/deploy_service/example.tf @@ -18,7 +18,6 @@ module "example" { source = "../../../examples/deploy_service" project_id = "${var.project_id}" - credentials_path = "${local.credentials_path}" cluster_name_suffix = "-${random_string.suffix.result}" region = "${var.region}" network = "${google_compute_network.main.name}" diff --git a/test/fixtures/deploy_service/network.tf b/test/fixtures/deploy_service/network.tf index 64dfbf8aeb..2dfbf2d9b2 100644 --- a/test/fixtures/deploy_service/network.tf +++ b/test/fixtures/deploy_service/network.tf @@ -14,10 +14,6 @@ * limitations under the License. */ -locals { - credentials_path = "${path.module}/${var.credentials_path_relative}" -} - resource "random_string" "suffix" { length = 4 special = false @@ -25,7 +21,6 @@ resource "random_string" "suffix" { } provider "google" { - credentials = "${file(local.credentials_path)}" project = "${var.project_id}" } diff --git a/test/fixtures/node_pool/example.tf b/test/fixtures/node_pool/example.tf index 26086812e9..097c9e3bcf 100644 --- a/test/fixtures/node_pool/example.tf +++ b/test/fixtures/node_pool/example.tf @@ -18,7 +18,6 @@ module "example" { source = "../../../examples/node_pool" project_id = "${var.project_id}" - credentials_path = "${local.credentials_path}" cluster_name_suffix = "-${random_string.suffix.result}" region = "${var.region}" zones = ["${slice(var.zones,0,1)}"] diff --git a/test/fixtures/node_pool/network.tf b/test/fixtures/node_pool/network.tf index 64dfbf8aeb..2dfbf2d9b2 100644 --- a/test/fixtures/node_pool/network.tf +++ b/test/fixtures/node_pool/network.tf @@ -14,10 +14,6 @@ * limitations under the License. */ -locals { - credentials_path = "${path.module}/${var.credentials_path_relative}" -} - resource "random_string" "suffix" { length = 4 special = false @@ -25,7 +21,6 @@ resource "random_string" "suffix" { } provider "google" { - credentials = "${file(local.credentials_path)}" project = "${var.project_id}" } diff --git a/test/fixtures/shared/outputs.tf b/test/fixtures/shared/outputs.tf index ee85f31f4e..229dc82689 100644 --- a/test/fixtures/shared/outputs.tf +++ b/test/fixtures/shared/outputs.tf @@ -18,10 +18,6 @@ output "project_id" { value = "${var.project_id}" } -output "credentials_path" { - value = "${local.credentials_path}" -} - output "region" { value = "${module.example.region}" } diff --git a/test/fixtures/shared/terraform.tfvars.sample b/test/fixtures/shared/terraform.tfvars.sample index b1f826ed7e..3110e9b3d5 100644 --- a/test/fixtures/shared/terraform.tfvars.sample +++ b/test/fixtures/shared/terraform.tfvars.sample @@ -1,5 +1,4 @@ project_id="" -credentials_path_relative="../../../credentials.json" region="us-east4" zones=["us-east4-a","us-east4-b","us-east4-c"] compute_engine_service_account="" diff --git a/test/fixtures/shared/variables.tf b/test/fixtures/shared/variables.tf index 8955c2e0be..28b827b0d5 100644 --- a/test/fixtures/shared/variables.tf +++ b/test/fixtures/shared/variables.tf @@ -18,10 +18,6 @@ variable "project_id" { description = "The GCP project to use for integration tests" } -variable "credentials_path_relative" { - description = "The relative path from the fixture directory to the GCP credentials file that will run Terraform tests" -} - variable "region" { description = "The GCP region to create and test resources in" } diff --git a/test/fixtures/shared_vpc/example.tf b/test/fixtures/shared_vpc/example.tf index 58b784a7ae..276e8f9dd7 100644 --- a/test/fixtures/shared_vpc/example.tf +++ b/test/fixtures/shared_vpc/example.tf @@ -18,7 +18,6 @@ module "example" { source = "../../../examples/shared_vpc" project_id = "${var.project_id}" - credentials_path = "${local.credentials_path}" cluster_name_suffix = "-${random_string.suffix.result}" region = "${var.region}" network = "${google_compute_network.main.name}" diff --git a/test/fixtures/shared_vpc/network.tf b/test/fixtures/shared_vpc/network.tf index 64dfbf8aeb..2dfbf2d9b2 100644 --- a/test/fixtures/shared_vpc/network.tf +++ b/test/fixtures/shared_vpc/network.tf @@ -14,10 +14,6 @@ * limitations under the License. */ -locals { - credentials_path = "${path.module}/${var.credentials_path_relative}" -} - resource "random_string" "suffix" { length = 4 special = false @@ -25,7 +21,6 @@ resource "random_string" "suffix" { } provider "google" { - credentials = "${file(local.credentials_path)}" project = "${var.project_id}" } diff --git a/test/fixtures/simple_regional/example.tf b/test/fixtures/simple_regional/example.tf index 3f0855d225..ea14fbc3f8 100644 --- a/test/fixtures/simple_regional/example.tf +++ b/test/fixtures/simple_regional/example.tf @@ -18,7 +18,6 @@ module "example" { source = "../../../examples/simple_regional" project_id = "${var.project_id}" - credentials_path = "${local.credentials_path}" cluster_name_suffix = "-${random_string.suffix.result}" region = "${var.region}" network = "${google_compute_network.main.name}" diff --git a/test/fixtures/simple_regional/network.tf b/test/fixtures/simple_regional/network.tf index 64dfbf8aeb..2dfbf2d9b2 100644 --- a/test/fixtures/simple_regional/network.tf +++ b/test/fixtures/simple_regional/network.tf @@ -14,10 +14,6 @@ * limitations under the License. */ -locals { - credentials_path = "${path.module}/${var.credentials_path_relative}" -} - resource "random_string" "suffix" { length = 4 special = false @@ -25,7 +21,6 @@ resource "random_string" "suffix" { } provider "google" { - credentials = "${file(local.credentials_path)}" project = "${var.project_id}" } diff --git a/test/fixtures/simple_regional_private/example.tf b/test/fixtures/simple_regional_private/example.tf index ddd8058572..beefece56c 100644 --- a/test/fixtures/simple_regional_private/example.tf +++ b/test/fixtures/simple_regional_private/example.tf @@ -18,7 +18,6 @@ module "example" { source = "../../../examples/simple_regional_private" project_id = "${var.project_id}" - credentials_path = "${local.credentials_path}" cluster_name_suffix = "-${random_string.suffix.result}" region = "${var.region}" network = "${google_compute_network.main.name}" diff --git a/test/fixtures/simple_regional_private/network.tf b/test/fixtures/simple_regional_private/network.tf index 6228192e31..0f7492d884 100644 --- a/test/fixtures/simple_regional_private/network.tf +++ b/test/fixtures/simple_regional_private/network.tf @@ -14,10 +14,6 @@ * limitations under the License. */ -locals { - credentials_path = "${path.module}/${var.credentials_path_relative}" -} - resource "random_string" "suffix" { length = 4 special = false @@ -25,7 +21,6 @@ resource "random_string" "suffix" { } provider "google-beta" { - credentials = "${file(local.credentials_path)}" project = "${var.project_id}" } diff --git a/test/fixtures/simple_zonal/example.tf b/test/fixtures/simple_zonal/example.tf index 2874e4b91e..e85f1818ba 100644 --- a/test/fixtures/simple_zonal/example.tf +++ b/test/fixtures/simple_zonal/example.tf @@ -18,7 +18,6 @@ module "example" { source = "../../../examples/simple_zonal" project_id = "${var.project_id}" - credentials_path = "${local.credentials_path}" cluster_name_suffix = "-${random_string.suffix.result}" region = "${var.region}" zones = ["${slice(var.zones,0,1)}"] diff --git a/test/fixtures/simple_zonal/network.tf b/test/fixtures/simple_zonal/network.tf index 64dfbf8aeb..2dfbf2d9b2 100644 --- a/test/fixtures/simple_zonal/network.tf +++ b/test/fixtures/simple_zonal/network.tf @@ -14,10 +14,6 @@ * limitations under the License. */ -locals { - credentials_path = "${path.module}/${var.credentials_path_relative}" -} - resource "random_string" "suffix" { length = 4 special = false @@ -25,7 +21,6 @@ resource "random_string" "suffix" { } provider "google" { - credentials = "${file(local.credentials_path)}" project = "${var.project_id}" } diff --git a/test/fixtures/simple_zonal_private/example.tf b/test/fixtures/simple_zonal_private/example.tf index b45355ccf9..6fd14c4c4c 100644 --- a/test/fixtures/simple_zonal_private/example.tf +++ b/test/fixtures/simple_zonal_private/example.tf @@ -18,7 +18,6 @@ module "example" { source = "../../../examples/simple_zonal_private" project_id = "${var.project_id}" - credentials_path = "${local.credentials_path}" cluster_name_suffix = "-${random_string.suffix.result}" region = "${var.region}" zones = ["${slice(var.zones,0,1)}"] diff --git a/test/fixtures/simple_zonal_private/network.tf b/test/fixtures/simple_zonal_private/network.tf index 6228192e31..0f7492d884 100644 --- a/test/fixtures/simple_zonal_private/network.tf +++ b/test/fixtures/simple_zonal_private/network.tf @@ -14,10 +14,6 @@ * limitations under the License. */ -locals { - credentials_path = "${path.module}/${var.credentials_path_relative}" -} - resource "random_string" "suffix" { length = 4 special = false @@ -25,7 +21,6 @@ resource "random_string" "suffix" { } provider "google-beta" { - credentials = "${file(local.credentials_path)}" project = "${var.project_id}" } diff --git a/test/fixtures/stub_domains/example.tf b/test/fixtures/stub_domains/example.tf index 0170e24577..1072411867 100644 --- a/test/fixtures/stub_domains/example.tf +++ b/test/fixtures/stub_domains/example.tf @@ -18,7 +18,6 @@ module "example" { source = "../../../examples/stub_domains" project_id = "${var.project_id}" - credentials_path = "${local.credentials_path}" cluster_name_suffix = "-${random_string.suffix.result}" region = "${var.region}" network = "${google_compute_network.main.name}" diff --git a/test/fixtures/stub_domains/network.tf b/test/fixtures/stub_domains/network.tf index 64dfbf8aeb..2dfbf2d9b2 100644 --- a/test/fixtures/stub_domains/network.tf +++ b/test/fixtures/stub_domains/network.tf @@ -14,10 +14,6 @@ * limitations under the License. */ -locals { - credentials_path = "${path.module}/${var.credentials_path_relative}" -} - resource "random_string" "suffix" { length = 4 special = false @@ -25,7 +21,6 @@ resource "random_string" "suffix" { } provider "google" { - credentials = "${file(local.credentials_path)}" project = "${var.project_id}" } diff --git a/test/integration/deploy_service/controls/gcloud.rb b/test/integration/deploy_service/controls/gcloud.rb index ccdcd3e461..2f8cfb2a38 100644 --- a/test/integration/deploy_service/controls/gcloud.rb +++ b/test/integration/deploy_service/controls/gcloud.rb @@ -16,9 +16,6 @@ location = attribute('location') cluster_name = attribute('cluster_name') -credentials_path = attribute('credentials_path') -ENV['CLOUDSDK_AUTH_CREDENTIAL_FILE_OVERRIDE'] = credentials_path - control "gcloud" do title "Google Compute Engine GKE configuration" describe command("gcloud --project=#{project_id} container clusters --zone=#{location} describe #{cluster_name} --format=json") do diff --git a/test/integration/deploy_service/inspec.yml b/test/integration/deploy_service/inspec.yml index 947d2a13e8..f01c60e9ac 100644 --- a/test/integration/deploy_service/inspec.yml +++ b/test/integration/deploy_service/inspec.yml @@ -3,9 +3,6 @@ attributes: - name: project_id required: true type: string - - name: credentials_path - required: true - type: string - name: location required: true type: string diff --git a/test/integration/node_pool/controls/gcloud.rb b/test/integration/node_pool/controls/gcloud.rb index a89e3eced0..866f7af400 100644 --- a/test/integration/node_pool/controls/gcloud.rb +++ b/test/integration/node_pool/controls/gcloud.rb @@ -16,9 +16,6 @@ location = attribute('location') cluster_name = attribute('cluster_name') -credentials_path = attribute('credentials_path') -ENV['CLOUDSDK_AUTH_CREDENTIAL_FILE_OVERRIDE'] = credentials_path - control "gcloud" do title "Google Compute Engine GKE configuration" describe command("gcloud --project=#{project_id} container clusters --zone=#{location} describe #{cluster_name} --format=json") do diff --git a/test/integration/node_pool/inspec.yml b/test/integration/node_pool/inspec.yml index a38e10b807..79cc899016 100644 --- a/test/integration/node_pool/inspec.yml +++ b/test/integration/node_pool/inspec.yml @@ -3,9 +3,6 @@ attributes: - name: project_id required: true type: string - - name: credentials_path - required: true - type: string - name: location required: true type: string diff --git a/test/integration/shared_vpc/controls/gcloud.rb b/test/integration/shared_vpc/controls/gcloud.rb index ccdcd3e461..2f8cfb2a38 100644 --- a/test/integration/shared_vpc/controls/gcloud.rb +++ b/test/integration/shared_vpc/controls/gcloud.rb @@ -16,9 +16,6 @@ location = attribute('location') cluster_name = attribute('cluster_name') -credentials_path = attribute('credentials_path') -ENV['CLOUDSDK_AUTH_CREDENTIAL_FILE_OVERRIDE'] = credentials_path - control "gcloud" do title "Google Compute Engine GKE configuration" describe command("gcloud --project=#{project_id} container clusters --zone=#{location} describe #{cluster_name} --format=json") do diff --git a/test/integration/shared_vpc/inspec.yml b/test/integration/shared_vpc/inspec.yml index c4cdfdd1a4..aa4303bc38 100644 --- a/test/integration/shared_vpc/inspec.yml +++ b/test/integration/shared_vpc/inspec.yml @@ -3,9 +3,6 @@ attributes: - name: project_id required: true type: string - - name: credentials_path - required: true - type: string - name: location required: true type: string diff --git a/test/integration/simple_regional/controls/gcloud.rb b/test/integration/simple_regional/controls/gcloud.rb index 83f33be1c3..e3fba671b3 100644 --- a/test/integration/simple_regional/controls/gcloud.rb +++ b/test/integration/simple_regional/controls/gcloud.rb @@ -16,9 +16,6 @@ location = attribute('location') cluster_name = attribute('cluster_name') -credentials_path = attribute('credentials_path') -ENV['CLOUDSDK_AUTH_CREDENTIAL_FILE_OVERRIDE'] = credentials_path - control "gcloud" do title "Google Compute Engine GKE configuration" describe command("gcloud --project=#{project_id} container clusters --zone=#{location} describe #{cluster_name} --format=json") do diff --git a/test/integration/simple_regional/inspec.yml b/test/integration/simple_regional/inspec.yml index 802697b75a..b4b455a341 100644 --- a/test/integration/simple_regional/inspec.yml +++ b/test/integration/simple_regional/inspec.yml @@ -3,9 +3,6 @@ attributes: - name: project_id required: true type: string - - name: credentials_path - required: true - type: string - name: location required: true type: string diff --git a/test/integration/simple_regional_private/controls/gcloud.rb b/test/integration/simple_regional_private/controls/gcloud.rb index 18ee9e0293..f4df827813 100644 --- a/test/integration/simple_regional_private/controls/gcloud.rb +++ b/test/integration/simple_regional_private/controls/gcloud.rb @@ -16,9 +16,6 @@ location = attribute('location') cluster_name = attribute('cluster_name') -credentials_path = attribute('credentials_path') -ENV['CLOUDSDK_AUTH_CREDENTIAL_FILE_OVERRIDE'] = credentials_path - control "gcloud" do title "Google Compute Engine GKE configuration" describe command("gcloud --project=#{project_id} container clusters --zone=#{location} describe #{cluster_name} --format=json") do diff --git a/test/integration/simple_regional_private/inspec.yml b/test/integration/simple_regional_private/inspec.yml index 7ee916787d..ebe54e2374 100644 --- a/test/integration/simple_regional_private/inspec.yml +++ b/test/integration/simple_regional_private/inspec.yml @@ -3,9 +3,6 @@ attributes: - name: project_id required: true type: string - - name: credentials_path - required: true - type: string - name: location required: true type: string diff --git a/test/integration/simple_zonal/controls/gcloud.rb b/test/integration/simple_zonal/controls/gcloud.rb index f65986b0a8..cab5f8e4fd 100644 --- a/test/integration/simple_zonal/controls/gcloud.rb +++ b/test/integration/simple_zonal/controls/gcloud.rb @@ -17,9 +17,6 @@ cluster_name = attribute('cluster_name') service_account = attribute('service_account') -credentials_path = attribute('credentials_path') -ENV['CLOUDSDK_AUTH_CREDENTIAL_FILE_OVERRIDE'] = credentials_path - control "gcloud" do title "Google Compute Engine GKE configuration" describe command("gcloud --project=#{project_id} container clusters --zone=#{location} describe #{cluster_name} --format=json") do diff --git a/test/integration/simple_zonal/inspec.yml b/test/integration/simple_zonal/inspec.yml index 8b66718e9c..fb587182c7 100644 --- a/test/integration/simple_zonal/inspec.yml +++ b/test/integration/simple_zonal/inspec.yml @@ -3,9 +3,6 @@ attributes: - name: project_id required: true type: string - - name: credentials_path - required: true - type: string - name: location required: true type: string diff --git a/test/integration/simple_zonal_private/controls/gcloud.rb b/test/integration/simple_zonal_private/controls/gcloud.rb index a2bc62eba9..2f808e136c 100644 --- a/test/integration/simple_zonal_private/controls/gcloud.rb +++ b/test/integration/simple_zonal_private/controls/gcloud.rb @@ -16,9 +16,6 @@ location = attribute('location') cluster_name = attribute('cluster_name') -credentials_path = attribute('credentials_path') -ENV['CLOUDSDK_AUTH_CREDENTIAL_FILE_OVERRIDE'] = credentials_path - control "gcloud" do title "Google Compute Engine GKE configuration" describe command("gcloud --project=#{project_id} container clusters --zone=#{location} describe #{cluster_name} --format=json") do diff --git a/test/integration/simple_zonal_private/inspec.yml b/test/integration/simple_zonal_private/inspec.yml index 7ee916787d..ebe54e2374 100644 --- a/test/integration/simple_zonal_private/inspec.yml +++ b/test/integration/simple_zonal_private/inspec.yml @@ -3,9 +3,6 @@ attributes: - name: project_id required: true type: string - - name: credentials_path - required: true - type: string - name: location required: true type: string diff --git a/test/integration/stub_domains/controls/gcloud.rb b/test/integration/stub_domains/controls/gcloud.rb index a20fb67a89..03612e151e 100644 --- a/test/integration/stub_domains/controls/gcloud.rb +++ b/test/integration/stub_domains/controls/gcloud.rb @@ -16,9 +16,6 @@ location = attribute('location') cluster_name = attribute('cluster_name') -credentials_path = attribute('credentials_path') -ENV['CLOUDSDK_AUTH_CREDENTIAL_FILE_OVERRIDE'] = credentials_path - control "gcloud" do title "Google Compute Engine GKE configuration" describe command("gcloud --project=#{project_id} container clusters --zone=#{location} describe #{cluster_name} --format=json") do diff --git a/test/integration/stub_domains/inspec.yml b/test/integration/stub_domains/inspec.yml index 0dfb503568..1d9b10bbe0 100644 --- a/test/integration/stub_domains/inspec.yml +++ b/test/integration/stub_domains/inspec.yml @@ -3,9 +3,6 @@ attributes: - name: project_id required: true type: string - - name: credentials_path - required: true - type: string - name: location required: true type: string From 830be838d577bc8c70a4be73c8dd005effd2de36 Mon Sep 17 00:00:00 2001 From: Jason Berlinsky Date: Wed, 27 Mar 2019 10:50:48 -0400 Subject: [PATCH 2/4] Regenerate READMEs --- README.md | 91 ++++++++++---------- examples/deploy_service/README.md | 33 ++++++++ examples/node_pool/README.md | 34 ++++++++ examples/shared_vpc/README.md | 34 ++++++++ examples/simple_regional/README.md | 33 ++++++++ examples/simple_regional_private/README.md | 33 ++++++++ examples/simple_zonal/README.md | 33 ++++++++ examples/simple_zonal_private/README.md | 34 ++++++++ examples/stub_domains/README.md | 33 ++++++++ modules/private-cluster/README.md | 97 +++++++++++----------- 10 files changed, 362 insertions(+), 93 deletions(-) diff --git a/README.md b/README.md index 6fece407ce..607efeb1db 100644 --- a/README.md +++ b/README.md @@ -97,65 +97,66 @@ In either case, upgrading to module version `v1.0.0` will trigger a recreation o [^]: (autogen_docs_start) + ## Inputs | Name | Description | Type | Default | Required | |------|-------------|:----:|:-----:|:-----:| -| description | The description of the cluster | string | `""` | no | -| disable\_legacy\_metadata\_endpoints | Disable the /0.1/ and /v1beta1/ metadata server endpoints on the node. Changing this value will cause all node pools to be recreated. | string | `"true"` | no | -| horizontal\_pod\_autoscaling | Enable horizontal pod autoscaling addon | string | `"true"` | no | -| http\_load\_balancing | Enable httpload balancer addon | string | `"true"` | no | -| ip\_masq\_link\_local | Whether to masquerade traffic to the link-local prefix (169.254.0.0/16). | string | `"false"` | no | -| ip\_masq\_resync\_interval | The interval at which the agent attempts to sync its ConfigMap file from the disk. | string | `"60s"` | no | -| ip\_range\_pods | The _name_ of the secondary subnet ip range to use for pods | string | n/a | yes | -| ip\_range\_services | The _name_ of the secondary subnet range to use for services | string | n/a | yes | -| kubernetes\_dashboard | Enable kubernetes dashboard addon | string | `"false"` | no | -| kubernetes\_version | The Kubernetes version of the masters. If set to 'latest' it will pull latest available version in the selected region. | string | `"latest"` | no | -| logging\_service | The logging service that the cluster should write logs to. Available options include logging.googleapis.com, logging.googleapis.com/kubernetes (beta), and none | string | `"logging.googleapis.com"` | no | -| maintenance\_start\_time | Time window specified for daily maintenance operations in RFC3339 format | string | `"05:00"` | no | -| master\_authorized\_networks\_config | The desired configuration options for master authorized networks. Omit the nested cidr_blocks attribute to disallow external access (except the cluster node IPs, which GKE automatically whitelists)

### example format ### master_authorized_networks_config = [{ cidr_blocks = [{ cidr_block = "10.0.0.0/8" display_name = "example_network" }], }] | list | `` | no | -| monitoring\_service | The monitoring service that the cluster should write metrics to. Automatically send metrics from pods in the cluster to the Google Cloud Monitoring API. VM metrics will be collected by Google Compute Engine regardless of this setting Available options include monitoring.googleapis.com, monitoring.googleapis.com/kubernetes (beta) and none | string | `"monitoring.googleapis.com"` | no | -| name | The name of the cluster (required) | string | n/a | yes | -| network | The VPC network to host the cluster in (required) | string | n/a | yes | -| network\_policy | Enable network policy addon | string | `"false"` | no | -| network\_project\_id | The project ID of the shared VPC's host (for shared vpc support) | string | `""` | no | -| node\_pools | List of maps containing node pools | list | `` | no | -| node\_pools\_labels | Map of maps containing node labels by node-pool name | map | `` | no | -| node\_pools\_metadata | Map of maps containing node metadata by node-pool name | map | `` | no | -| node\_pools\_tags | Map of lists containing node network tags by node-pool name | map | `` | no | -| node\_pools\_taints | Map of lists containing node taints by node-pool name | map | `` | no | -| node\_version | The Kubernetes version of the node pools. Defaults kubernetes_version (master) variable and can be overridden for individual node pools by setting the `version` key on them. Must be empyty or set the same as master at cluster creation. | string | `""` | no | -| non\_masquerade\_cidrs | List of strings in CIDR notation that specify the IP address ranges that do not use IP masquerading. | list | `` | no | -| project\_id | The project ID to host the cluster in (required) | string | n/a | yes | -| region | The region to host the cluster in (required) | string | n/a | yes | -| regional | Whether is a regional cluster (zonal cluster if set false. WARNING: changing this after cluster creation is destructive!) | string | `"true"` | no | -| remove\_default\_node\_pool | Remove default node pool while setting up the cluster | string | `"false"` | no | -| service\_account | The service account to default running nodes as if not overridden in `node_pools`. Defaults to the compute engine default service account. May also specify `create` to automatically create a cluster-specific service account | string | `""` | no | -| stub\_domains | Map of stub domains and their resolvers to forward DNS queries for a certain domain to an external DNS server | map | `` | no | -| subnetwork | The subnetwork to host the cluster in (required) | string | n/a | yes | +| description | The description of the cluster | string | `` | no | +| disable_legacy_metadata_endpoints | Disable the /0.1/ and /v1beta1/ metadata server endpoints on the node. Changing this value will cause all node pools to be recreated. | string | `true` | no | +| horizontal_pod_autoscaling | Enable horizontal pod autoscaling addon | string | `true` | no | +| http_load_balancing | Enable httpload balancer addon | string | `true` | no | +| ip_masq_link_local | Whether to masquerade traffic to the link-local prefix (169.254.0.0/16). | string | `false` | no | +| ip_masq_resync_interval | The interval at which the agent attempts to sync its ConfigMap file from the disk. | string | `60s` | no | +| ip_range_pods | The _name_ of the secondary subnet ip range to use for pods | string | - | yes | +| ip_range_services | The _name_ of the secondary subnet range to use for services | string | - | yes | +| kubernetes_dashboard | Enable kubernetes dashboard addon | string | `false` | no | +| kubernetes_version | The Kubernetes version of the masters. If set to 'latest' it will pull latest available version in the selected region. | string | `latest` | no | +| logging_service | The logging service that the cluster should write logs to. Available options include logging.googleapis.com, logging.googleapis.com/kubernetes (beta), and none | string | `logging.googleapis.com` | no | +| maintenance_start_time | Time window specified for daily maintenance operations in RFC3339 format | string | `05:00` | no | +| master_authorized_networks_config | The desired configuration options for master authorized networks. Omit the nested cidr_blocks attribute to disallow external access (except the cluster node IPs, which GKE automatically whitelists)

### example format ### master_authorized_networks_config = [{ cidr_blocks = [{ cidr_block = "10.0.0.0/8" display_name = "example_network" }], }] | list | `` | no | +| monitoring_service | The monitoring service that the cluster should write metrics to. Automatically send metrics from pods in the cluster to the Google Cloud Monitoring API. VM metrics will be collected by Google Compute Engine regardless of this setting Available options include monitoring.googleapis.com, monitoring.googleapis.com/kubernetes (beta) and none | string | `monitoring.googleapis.com` | no | +| name | The name of the cluster (required) | string | - | yes | +| network | The VPC network to host the cluster in (required) | string | - | yes | +| network_policy | Enable network policy addon | string | `false` | no | +| network_project_id | The project ID of the shared VPC's host (for shared vpc support) | string | `` | no | +| node_pools | List of maps containing node pools | list | `` | no | +| node_pools_labels | Map of maps containing node labels by node-pool name | map | `` | no | +| node_pools_metadata | Map of maps containing node metadata by node-pool name | map | `` | no | +| node_pools_tags | Map of lists containing node network tags by node-pool name | map | `` | no | +| node_pools_taints | Map of lists containing node taints by node-pool name | map | `` | no | +| node_version | The Kubernetes version of the node pools. Defaults kubernetes_version (master) variable and can be overridden for individual node pools by setting the `version` key on them. Must be empyty or set the same as master at cluster creation. | string | `` | no | +| non_masquerade_cidrs | List of strings in CIDR notation that specify the IP address ranges that do not use IP masquerading. | list | `` | no | +| project_id | The project ID to host the cluster in (required) | string | - | yes | +| region | The region to host the cluster in (required) | string | - | yes | +| regional | Whether is a regional cluster (zonal cluster if set false. WARNING: changing this after cluster creation is destructive!) | string | `true` | no | +| remove_default_node_pool | Remove default node pool while setting up the cluster | string | `false` | no | +| service_account | The service account to default running nodes as if not overridden in `node_pools`. Defaults to the compute engine default service account. May also specify `create` to automatically create a cluster-specific service account | string | `` | no | +| stub_domains | Map of stub domains and their resolvers to forward DNS queries for a certain domain to an external DNS server | map | `` | no | +| subnetwork | The subnetwork to host the cluster in (required) | string | - | yes | | zones | The zones to host the cluster in (optional if regional cluster / required if zonal) | list | `` | no | ## Outputs | Name | Description | |------|-------------| -| ca\_certificate | Cluster ca certificate (base64 encoded) | +| ca_certificate | Cluster ca certificate (base64 encoded) | | endpoint | Cluster endpoint | -| horizontal\_pod\_autoscaling\_enabled | Whether horizontal pod autoscaling enabled | -| http\_load\_balancing\_enabled | Whether http load balancing enabled | -| kubernetes\_dashboard\_enabled | Whether kubernetes dashboard enabled | +| horizontal_pod_autoscaling_enabled | Whether horizontal pod autoscaling enabled | +| http_load_balancing_enabled | Whether http load balancing enabled | +| kubernetes_dashboard_enabled | Whether kubernetes dashboard enabled | | location | Cluster location (region if regional cluster, zone if zonal cluster) | -| logging\_service | Logging service used | -| master\_authorized\_networks\_config | Networks from which access to master is permitted | -| master\_version | Current master kubernetes version | -| min\_master\_version | Minimum master kubernetes version | -| monitoring\_service | Monitoring service used | +| logging_service | Logging service used | +| master_authorized_networks_config | Networks from which access to master is permitted | +| master_version | Current master kubernetes version | +| min_master_version | Minimum master kubernetes version | +| monitoring_service | Monitoring service used | | name | Cluster name | -| network\_policy\_enabled | Whether network policy enabled | -| node\_pools\_names | List of node pools names | -| node\_pools\_versions | List of node pools versions | +| network_policy_enabled | Whether network policy enabled | +| node_pools_names | List of node pools names | +| node_pools_versions | List of node pools versions | | region | Cluster region | -| service\_account | The service account to default running nodes as if not overridden in `node_pools`. | +| service_account | The service account to default running nodes as if not overridden in `node_pools`. | | type | Cluster type (regional / zonal) | | zones | List of zones in which the cluster resides | diff --git a/examples/deploy_service/README.md b/examples/deploy_service/README.md index 8292d610ad..14ae3e615d 100644 --- a/examples/deploy_service/README.md +++ b/examples/deploy_service/README.md @@ -10,6 +10,39 @@ It will: [^]: (autogen_docs_start) + +## Inputs + +| Name | Description | Type | Default | Required | +|------|-------------|:----:|:-----:|:-----:| +| cluster_name_suffix | A suffix to append to the default cluster name | string | `` | no | +| compute_engine_service_account | Service account to associate to the nodes in the cluster | string | - | yes | +| ip_range_pods | The secondary ip range to use for pods | string | - | yes | +| ip_range_services | The secondary ip range to use for pods | string | - | yes | +| network | The VPC network to host the cluster in | string | - | yes | +| project_id | The project ID to host the cluster in | string | - | yes | +| region | The region to host the cluster in | string | - | yes | +| subnetwork | The subnetwork to host the cluster in | string | - | yes | + +## Outputs + +| Name | Description | +|------|-------------| +| ca_certificate | | +| client_token | | +| cluster_name | Cluster name | +| ip_range_pods | The secondary IP range used for pods | +| ip_range_services | The secondary IP range used for services | +| kubernetes_endpoint | | +| location | | +| master_kubernetes_version | The master Kubernetes version | +| network | | +| project_id | | +| region | | +| service_account | The service account to default running nodes as if not overridden in `node_pools`. | +| subnetwork | | +| zones | List of zones in which the cluster resides | + [^]: (autogen_docs_end) To provision this example, run the following from within this directory: diff --git a/examples/node_pool/README.md b/examples/node_pool/README.md index fe8caf187b..fccf879da6 100644 --- a/examples/node_pool/README.md +++ b/examples/node_pool/README.md @@ -20,6 +20,40 @@ This example illustrates how to create a cluster with multiple custom node-pool [^]: (autogen_docs_start) + +## Inputs + +| Name | Description | Type | Default | Required | +|------|-------------|:----:|:-----:|:-----:| +| cluster_name_suffix | A suffix to append to the default cluster name | string | `` | no | +| compute_engine_service_account | Service account to associate to the nodes in the cluster | string | - | yes | +| ip_range_pods | The secondary ip range to use for pods | string | - | yes | +| ip_range_services | The secondary ip range to use for pods | string | - | yes | +| network | The VPC network to host the cluster in | string | - | yes | +| project_id | The project ID to host the cluster in | string | - | yes | +| region | The region to host the cluster in | string | - | yes | +| subnetwork | The subnetwork to host the cluster in | string | - | yes | +| zones | The zone to host the cluster in (required if is a zonal cluster) | list | - | yes | + +## Outputs + +| Name | Description | +|------|-------------| +| ca_certificate | | +| client_token | | +| cluster_name | Cluster name | +| ip_range_pods | The secondary IP range used for pods | +| ip_range_services | The secondary IP range used for services | +| kubernetes_endpoint | | +| location | | +| master_kubernetes_version | The master Kubernetes version | +| network | | +| project_id | | +| region | | +| service_account | The service account to default running nodes as if not overridden in `node_pools`. | +| subnetwork | | +| zones | List of zones in which the cluster resides | + [^]: (autogen_docs_end) To provision this example, run the following from within this directory: diff --git a/examples/shared_vpc/README.md b/examples/shared_vpc/README.md index 1ecd805d6e..c1d98fc09f 100644 --- a/examples/shared_vpc/README.md +++ b/examples/shared_vpc/README.md @@ -4,6 +4,40 @@ This example illustrates how to create a simple cluster where the host network i [^]: (autogen_docs_start) + +## Inputs + +| Name | Description | Type | Default | Required | +|------|-------------|:----:|:-----:|:-----:| +| cluster_name_suffix | A suffix to append to the default cluster name | string | `` | no | +| compute_engine_service_account | Service account to associate to the nodes in the cluster | string | - | yes | +| ip_range_pods | The secondary ip range to use for pods | string | - | yes | +| ip_range_services | The secondary ip range to use for pods | string | - | yes | +| network | The VPC network to host the cluster in | string | - | yes | +| network_project_id | The GCP project housing the VPC network to host the cluster in | string | - | yes | +| project_id | The project ID to host the cluster in | string | - | yes | +| region | The region to host the cluster in | string | - | yes | +| subnetwork | The subnetwork to host the cluster in | string | - | yes | + +## Outputs + +| Name | Description | +|------|-------------| +| ca_certificate | | +| client_token | | +| cluster_name | Cluster name | +| ip_range_pods | The secondary IP range used for pods | +| ip_range_services | The secondary IP range used for services | +| kubernetes_endpoint | | +| location | | +| master_kubernetes_version | The master Kubernetes version | +| network | | +| project_id | | +| region | | +| service_account | The service account to default running nodes as if not overridden in `node_pools`. | +| subnetwork | | +| zones | List of zones in which the cluster resides | + [^]: (autogen_docs_end) To provision this example, run the following from within this directory: diff --git a/examples/simple_regional/README.md b/examples/simple_regional/README.md index 347e92cf6e..8db7b945e8 100644 --- a/examples/simple_regional/README.md +++ b/examples/simple_regional/README.md @@ -4,6 +4,39 @@ This example illustrates how to create a simple cluster. [^]: (autogen_docs_start) + +## Inputs + +| Name | Description | Type | Default | Required | +|------|-------------|:----:|:-----:|:-----:| +| cluster_name_suffix | A suffix to append to the default cluster name | string | `` | no | +| compute_engine_service_account | Service account to associate to the nodes in the cluster | string | - | yes | +| ip_range_pods | The secondary ip range to use for pods | string | - | yes | +| ip_range_services | The secondary ip range to use for pods | string | - | yes | +| network | The VPC network to host the cluster in | string | - | yes | +| project_id | The project ID to host the cluster in | string | - | yes | +| region | The region to host the cluster in | string | - | yes | +| subnetwork | The subnetwork to host the cluster in | string | - | yes | + +## Outputs + +| Name | Description | +|------|-------------| +| ca_certificate | | +| client_token | | +| cluster_name | Cluster name | +| ip_range_pods | The secondary IP range used for pods | +| ip_range_services | The secondary IP range used for services | +| kubernetes_endpoint | | +| location | | +| master_kubernetes_version | The master Kubernetes version | +| network | | +| project_id | | +| region | | +| service_account | The service account to default running nodes as if not overridden in `node_pools`. | +| subnetwork | | +| zones | List of zones in which the cluster resides | + [^]: (autogen_docs_end) To provision this example, run the following from within this directory: diff --git a/examples/simple_regional_private/README.md b/examples/simple_regional_private/README.md index 2bee35a4df..6fd1d87162 100644 --- a/examples/simple_regional_private/README.md +++ b/examples/simple_regional_private/README.md @@ -4,6 +4,39 @@ This example illustrates how to create a simple private cluster. [^]: (autogen_docs_start) + +## Inputs + +| Name | Description | Type | Default | Required | +|------|-------------|:----:|:-----:|:-----:| +| cluster_name_suffix | A suffix to append to the default cluster name | string | `` | no | +| compute_engine_service_account | Service account to associate to the nodes in the cluster | string | - | yes | +| ip_range_pods | The secondary ip range to use for pods | string | - | yes | +| ip_range_services | The secondary ip range to use for pods | string | - | yes | +| network | The VPC network to host the cluster in | string | - | yes | +| project_id | The project ID to host the cluster in | string | - | yes | +| region | The region to host the cluster in | string | - | yes | +| subnetwork | The subnetwork to host the cluster in | string | - | yes | + +## Outputs + +| Name | Description | +|------|-------------| +| ca_certificate | | +| client_token | | +| cluster_name | Cluster name | +| ip_range_pods | The secondary IP range used for pods | +| ip_range_services | The secondary IP range used for services | +| kubernetes_endpoint | | +| location | | +| master_kubernetes_version | The master Kubernetes version | +| network | | +| project_id | | +| region | | +| service_account | The service account to default running nodes as if not overridden in `node_pools`. | +| subnetwork | | +| zones | List of zones in which the cluster resides | + [^]: (autogen_docs_end) To provision this example, run the following from within this directory: diff --git a/examples/simple_zonal/README.md b/examples/simple_zonal/README.md index a56d60dfcd..3e7ac4f3b1 100644 --- a/examples/simple_zonal/README.md +++ b/examples/simple_zonal/README.md @@ -4,6 +4,39 @@ This example illustrates how to create a simple cluster. [^]: (autogen_docs_start) + +## Inputs + +| Name | Description | Type | Default | Required | +|------|-------------|:----:|:-----:|:-----:| +| cluster_name_suffix | A suffix to append to the default cluster name | string | `` | no | +| ip_range_pods | The secondary ip range to use for pods | string | - | yes | +| ip_range_services | The secondary ip range to use for pods | string | - | yes | +| network | The VPC network to host the cluster in | string | - | yes | +| project_id | The project ID to host the cluster in | string | - | yes | +| region | The region to host the cluster in | string | - | yes | +| subnetwork | The subnetwork to host the cluster in | string | - | yes | +| zones | The zone to host the cluster in (required if is a zonal cluster) | list | - | yes | + +## Outputs + +| Name | Description | +|------|-------------| +| ca_certificate | | +| client_token | | +| cluster_name | Cluster name | +| ip_range_pods | The secondary IP range used for pods | +| ip_range_services | The secondary IP range used for services | +| kubernetes_endpoint | | +| location | | +| master_kubernetes_version | The master Kubernetes version | +| network | | +| project_id | | +| region | | +| service_account | The service account to default running nodes as if not overridden in `node_pools`. | +| subnetwork | | +| zones | List of zones in which the cluster resides | + [^]: (autogen_docs_end) To provision this example, run the following from within this directory: diff --git a/examples/simple_zonal_private/README.md b/examples/simple_zonal_private/README.md index 2bee35a4df..4d305e0df8 100644 --- a/examples/simple_zonal_private/README.md +++ b/examples/simple_zonal_private/README.md @@ -4,6 +4,40 @@ This example illustrates how to create a simple private cluster. [^]: (autogen_docs_start) + +## Inputs + +| Name | Description | Type | Default | Required | +|------|-------------|:----:|:-----:|:-----:| +| cluster_name_suffix | A suffix to append to the default cluster name | string | `` | no | +| compute_engine_service_account | Service account to associate to the nodes in the cluster | string | - | yes | +| ip_range_pods | The secondary ip range to use for pods | string | - | yes | +| ip_range_services | The secondary ip range to use for pods | string | - | yes | +| network | The VPC network to host the cluster in | string | - | yes | +| project_id | The project ID to host the cluster in | string | - | yes | +| region | The region to host the cluster in | string | - | yes | +| subnetwork | The subnetwork to host the cluster in | string | - | yes | +| zones | The zone to host the cluster in (required if is a zonal cluster) | list | - | yes | + +## Outputs + +| Name | Description | +|------|-------------| +| ca_certificate | | +| client_token | | +| cluster_name | Cluster name | +| ip_range_pods | The secondary IP range used for pods | +| ip_range_services | The secondary IP range used for services | +| kubernetes_endpoint | | +| location | | +| master_kubernetes_version | The master Kubernetes version | +| network | | +| project_id | | +| region | | +| service_account | The service account to default running nodes as if not overridden in `node_pools`. | +| subnetwork | | +| zones | List of zones in which the cluster resides | + [^]: (autogen_docs_end) To provision this example, run the following from within this directory: diff --git a/examples/stub_domains/README.md b/examples/stub_domains/README.md index dc4333491c..9736bc4ba1 100644 --- a/examples/stub_domains/README.md +++ b/examples/stub_domains/README.md @@ -9,6 +9,39 @@ It will: [^]: (autogen_docs_start) + +## Inputs + +| Name | Description | Type | Default | Required | +|------|-------------|:----:|:-----:|:-----:| +| cluster_name_suffix | A suffix to append to the default cluster name | string | `` | no | +| compute_engine_service_account | Service account to associate to the nodes in the cluster | string | - | yes | +| ip_range_pods | The secondary ip range to use for pods | string | - | yes | +| ip_range_services | The secondary ip range to use for pods | string | - | yes | +| network | The VPC network to host the cluster in | string | - | yes | +| project_id | The project ID to host the cluster in | string | - | yes | +| region | The region to host the cluster in | string | - | yes | +| subnetwork | The subnetwork to host the cluster in | string | - | yes | + +## Outputs + +| Name | Description | +|------|-------------| +| ca_certificate | | +| client_token | | +| cluster_name | Cluster name | +| ip_range_pods | The secondary IP range used for pods | +| ip_range_services | The secondary IP range used for services | +| kubernetes_endpoint | | +| location | | +| master_kubernetes_version | The master Kubernetes version | +| network | | +| project_id | | +| region | | +| service_account | The service account to default running nodes as if not overridden in `node_pools`. | +| subnetwork | | +| zones | List of zones in which the cluster resides | + [^]: (autogen_docs_end) To provision this example, run the following from within this directory: diff --git a/modules/private-cluster/README.md b/modules/private-cluster/README.md index e3eeb194cf..27a2c6176c 100644 --- a/modules/private-cluster/README.md +++ b/modules/private-cluster/README.md @@ -100,68 +100,69 @@ In either case, upgrading to module version `v1.0.0` will trigger a recreation o [^]: (autogen_docs_start) + ## Inputs | Name | Description | Type | Default | Required | |------|-------------|:----:|:-----:|:-----:| -| description | The description of the cluster | string | `""` | no | -| disable\_legacy\_metadata\_endpoints | Disable the /0.1/ and /v1beta1/ metadata server endpoints on the node. Changing this value will cause all node pools to be recreated. | string | `"true"` | no | -| enable\_private\_endpoint | (Beta) Whether the master's internal IP address is used as the cluster endpoint | string | `"false"` | no | -| enable\_private\_nodes | (Beta) Whether nodes have internal IP addresses only | string | `"false"` | no | -| horizontal\_pod\_autoscaling | Enable horizontal pod autoscaling addon | string | `"true"` | no | -| http\_load\_balancing | Enable httpload balancer addon | string | `"true"` | no | -| ip\_masq\_link\_local | Whether to masquerade traffic to the link-local prefix (169.254.0.0/16). | string | `"false"` | no | -| ip\_masq\_resync\_interval | The interval at which the agent attempts to sync its ConfigMap file from the disk. | string | `"60s"` | no | -| ip\_range\_pods | The _name_ of the secondary subnet ip range to use for pods | string | n/a | yes | -| ip\_range\_services | The _name_ of the secondary subnet range to use for services | string | n/a | yes | -| kubernetes\_dashboard | Enable kubernetes dashboard addon | string | `"false"` | no | -| kubernetes\_version | The Kubernetes version of the masters. If set to 'latest' it will pull latest available version in the selected region. | string | `"latest"` | no | -| logging\_service | The logging service that the cluster should write logs to. Available options include logging.googleapis.com, logging.googleapis.com/kubernetes (beta), and none | string | `"logging.googleapis.com"` | no | -| maintenance\_start\_time | Time window specified for daily maintenance operations in RFC3339 format | string | `"05:00"` | no | -| master\_authorized\_networks\_config | The desired configuration options for master authorized networks. Omit the nested cidr_blocks attribute to disallow external access (except the cluster node IPs, which GKE automatically whitelists)

### example format ### master_authorized_networks_config = [{ cidr_blocks = [{ cidr_block = "10.0.0.0/8" display_name = "example_network" }], }] | list | `` | no | -| master\_ipv4\_cidr\_block | (Beta) The IP range in CIDR notation to use for the hosted master network | string | `"10.0.0.0/28"` | no | -| monitoring\_service | The monitoring service that the cluster should write metrics to. Automatically send metrics from pods in the cluster to the Google Cloud Monitoring API. VM metrics will be collected by Google Compute Engine regardless of this setting Available options include monitoring.googleapis.com, monitoring.googleapis.com/kubernetes (beta) and none | string | `"monitoring.googleapis.com"` | no | -| name | The name of the cluster (required) | string | n/a | yes | -| network | The VPC network to host the cluster in (required) | string | n/a | yes | -| network\_policy | Enable network policy addon | string | `"false"` | no | -| network\_project\_id | The project ID of the shared VPC's host (for shared vpc support) | string | `""` | no | -| node\_pools | List of maps containing node pools | list | `` | no | -| node\_pools\_labels | Map of maps containing node labels by node-pool name | map | `` | no | -| node\_pools\_metadata | Map of maps containing node metadata by node-pool name | map | `` | no | -| node\_pools\_tags | Map of lists containing node network tags by node-pool name | map | `` | no | -| node\_pools\_taints | Map of lists containing node taints by node-pool name | map | `` | no | -| node\_version | The Kubernetes version of the node pools. Defaults kubernetes_version (master) variable and can be overridden for individual node pools by setting the `version` key on them. Must be empyty or set the same as master at cluster creation. | string | `""` | no | -| non\_masquerade\_cidrs | List of strings in CIDR notation that specify the IP address ranges that do not use IP masquerading. | list | `` | no | -| project\_id | The project ID to host the cluster in (required) | string | n/a | yes | -| region | The region to host the cluster in (required) | string | n/a | yes | -| regional | Whether is a regional cluster (zonal cluster if set false. WARNING: changing this after cluster creation is destructive!) | string | `"true"` | no | -| remove\_default\_node\_pool | Remove default node pool while setting up the cluster | string | `"false"` | no | -| service\_account | The service account to default running nodes as if not overridden in `node_pools`. Defaults to the compute engine default service account. May also specify `create` to automatically create a cluster-specific service account | string | `""` | no | -| stub\_domains | Map of stub domains and their resolvers to forward DNS queries for a certain domain to an external DNS server | map | `` | no | -| subnetwork | The subnetwork to host the cluster in (required) | string | n/a | yes | +| description | The description of the cluster | string | `` | no | +| disable_legacy_metadata_endpoints | Disable the /0.1/ and /v1beta1/ metadata server endpoints on the node. Changing this value will cause all node pools to be recreated. | string | `true` | no | +| enable_private_endpoint | (Beta) Whether the master's internal IP address is used as the cluster endpoint | string | `false` | no | +| enable_private_nodes | (Beta) Whether nodes have internal IP addresses only | string | `false` | no | +| horizontal_pod_autoscaling | Enable horizontal pod autoscaling addon | string | `true` | no | +| http_load_balancing | Enable httpload balancer addon | string | `true` | no | +| ip_masq_link_local | Whether to masquerade traffic to the link-local prefix (169.254.0.0/16). | string | `false` | no | +| ip_masq_resync_interval | The interval at which the agent attempts to sync its ConfigMap file from the disk. | string | `60s` | no | +| ip_range_pods | The _name_ of the secondary subnet ip range to use for pods | string | - | yes | +| ip_range_services | The _name_ of the secondary subnet range to use for services | string | - | yes | +| kubernetes_dashboard | Enable kubernetes dashboard addon | string | `false` | no | +| kubernetes_version | The Kubernetes version of the masters. If set to 'latest' it will pull latest available version in the selected region. | string | `latest` | no | +| logging_service | The logging service that the cluster should write logs to. Available options include logging.googleapis.com, logging.googleapis.com/kubernetes (beta), and none | string | `logging.googleapis.com` | no | +| maintenance_start_time | Time window specified for daily maintenance operations in RFC3339 format | string | `05:00` | no | +| master_authorized_networks_config | The desired configuration options for master authorized networks. Omit the nested cidr_blocks attribute to disallow external access (except the cluster node IPs, which GKE automatically whitelists)

### example format ### master_authorized_networks_config = [{ cidr_blocks = [{ cidr_block = "10.0.0.0/8" display_name = "example_network" }], }] | list | `` | no | +| master_ipv4_cidr_block | (Beta) The IP range in CIDR notation to use for the hosted master network | string | `10.0.0.0/28` | no | +| monitoring_service | The monitoring service that the cluster should write metrics to. Automatically send metrics from pods in the cluster to the Google Cloud Monitoring API. VM metrics will be collected by Google Compute Engine regardless of this setting Available options include monitoring.googleapis.com, monitoring.googleapis.com/kubernetes (beta) and none | string | `monitoring.googleapis.com` | no | +| name | The name of the cluster (required) | string | - | yes | +| network | The VPC network to host the cluster in (required) | string | - | yes | +| network_policy | Enable network policy addon | string | `false` | no | +| network_project_id | The project ID of the shared VPC's host (for shared vpc support) | string | `` | no | +| node_pools | List of maps containing node pools | list | `` | no | +| node_pools_labels | Map of maps containing node labels by node-pool name | map | `` | no | +| node_pools_metadata | Map of maps containing node metadata by node-pool name | map | `` | no | +| node_pools_tags | Map of lists containing node network tags by node-pool name | map | `` | no | +| node_pools_taints | Map of lists containing node taints by node-pool name | map | `` | no | +| node_version | The Kubernetes version of the node pools. Defaults kubernetes_version (master) variable and can be overridden for individual node pools by setting the `version` key on them. Must be empyty or set the same as master at cluster creation. | string | `` | no | +| non_masquerade_cidrs | List of strings in CIDR notation that specify the IP address ranges that do not use IP masquerading. | list | `` | no | +| project_id | The project ID to host the cluster in (required) | string | - | yes | +| region | The region to host the cluster in (required) | string | - | yes | +| regional | Whether is a regional cluster (zonal cluster if set false. WARNING: changing this after cluster creation is destructive!) | string | `true` | no | +| remove_default_node_pool | Remove default node pool while setting up the cluster | string | `false` | no | +| service_account | The service account to default running nodes as if not overridden in `node_pools`. Defaults to the compute engine default service account. May also specify `create` to automatically create a cluster-specific service account | string | `` | no | +| stub_domains | Map of stub domains and their resolvers to forward DNS queries for a certain domain to an external DNS server | map | `` | no | +| subnetwork | The subnetwork to host the cluster in (required) | string | - | yes | | zones | The zones to host the cluster in (optional if regional cluster / required if zonal) | list | `` | no | ## Outputs | Name | Description | |------|-------------| -| ca\_certificate | Cluster ca certificate (base64 encoded) | +| ca_certificate | Cluster ca certificate (base64 encoded) | | endpoint | Cluster endpoint | -| horizontal\_pod\_autoscaling\_enabled | Whether horizontal pod autoscaling enabled | -| http\_load\_balancing\_enabled | Whether http load balancing enabled | -| kubernetes\_dashboard\_enabled | Whether kubernetes dashboard enabled | +| horizontal_pod_autoscaling_enabled | Whether horizontal pod autoscaling enabled | +| http_load_balancing_enabled | Whether http load balancing enabled | +| kubernetes_dashboard_enabled | Whether kubernetes dashboard enabled | | location | Cluster location (region if regional cluster, zone if zonal cluster) | -| logging\_service | Logging service used | -| master\_authorized\_networks\_config | Networks from which access to master is permitted | -| master\_version | Current master kubernetes version | -| min\_master\_version | Minimum master kubernetes version | -| monitoring\_service | Monitoring service used | +| logging_service | Logging service used | +| master_authorized_networks_config | Networks from which access to master is permitted | +| master_version | Current master kubernetes version | +| min_master_version | Minimum master kubernetes version | +| monitoring_service | Monitoring service used | | name | Cluster name | -| network\_policy\_enabled | Whether network policy enabled | -| node\_pools\_names | List of node pools names | -| node\_pools\_versions | List of node pools versions | +| network_policy_enabled | Whether network policy enabled | +| node_pools_names | List of node pools names | +| node_pools_versions | List of node pools versions | | region | Cluster region | -| service\_account | The service account to default running nodes as if not overridden in `node_pools`. | +| service_account | The service account to default running nodes as if not overridden in `node_pools`. | | type | Cluster type (regional / zonal) | | zones | List of zones in which the cluster resides | From a6f39f6fe462ea949af068ee2845e307ce282510 Mon Sep 17 00:00:00 2001 From: Jason Berlinsky Date: Wed, 27 Mar 2019 10:54:15 -0400 Subject: [PATCH 3/4] Remove errant text from rebase gone wrong --- examples/node_pool/README.md | 16 ---------------- 1 file changed, 16 deletions(-) diff --git a/examples/node_pool/README.md b/examples/node_pool/README.md index fccf879da6..83721bf040 100644 --- a/examples/node_pool/README.md +++ b/examples/node_pool/README.md @@ -1,19 +1,3 @@ -# Project Cleanup Utility - -This is a simple utility that scans a GCP organization for projects matching certain criteria, and enqueues such projects for deletion. Currently supported criteria are the combination of: - -- **Age:** Only projects older than the configured age, in hours, will be marked for deletion. -- **Key-Value Pair:** Only projects whose labels contain the provided key-value pair will be marked for deletion. - -## Environment Configuration - -The following environment variables may be specified to configure the cleanup utility: - -| Name | Description | Type | Default | Required | -|------|-------------|:----:|:-----:|:-----:| -| `TARGET_TAG_NAME` | The tag name to match on for identifying projects to delete | string | n/a | yes | -| `TARGET_TAG_VALUE` | The tag value to match on for identifying projects to delete | string | n/a | yes | -| `MAX_PROJECT_AGE_HOURS` | The project age, in hours, at which point deletion should be considered | integer | n/a | yes | # Node Pool Cluster This example illustrates how to create a cluster with multiple custom node-pool configurations with node labels, taints, and network tags. From f6f1dae635d4b0e41f5f8d8391f5dcf173d70635 Mon Sep 17 00:00:00 2001 From: Jason Berlinsky Date: Wed, 27 Mar 2019 13:17:25 -0400 Subject: [PATCH 4/4] Run `make generate_docs` with `terraform-docs` 0.6.0 --- README.md | 91 ++++++++++---------- examples/deploy_service/README.md | 35 ++++---- examples/node_pool/README.md | 37 ++++----- examples/shared_vpc/README.md | 37 ++++----- examples/simple_regional/README.md | 35 ++++---- examples/simple_regional_private/README.md | 35 ++++---- examples/simple_zonal/README.md | 35 ++++---- examples/simple_zonal_private/README.md | 37 ++++----- examples/stub_domains/README.md | 35 ++++---- modules/private-cluster/README.md | 97 +++++++++++----------- 10 files changed, 232 insertions(+), 242 deletions(-) diff --git a/README.md b/README.md index 607efeb1db..6fece407ce 100644 --- a/README.md +++ b/README.md @@ -97,66 +97,65 @@ In either case, upgrading to module version `v1.0.0` will trigger a recreation o [^]: (autogen_docs_start) - ## Inputs | Name | Description | Type | Default | Required | |------|-------------|:----:|:-----:|:-----:| -| description | The description of the cluster | string | `` | no | -| disable_legacy_metadata_endpoints | Disable the /0.1/ and /v1beta1/ metadata server endpoints on the node. Changing this value will cause all node pools to be recreated. | string | `true` | no | -| horizontal_pod_autoscaling | Enable horizontal pod autoscaling addon | string | `true` | no | -| http_load_balancing | Enable httpload balancer addon | string | `true` | no | -| ip_masq_link_local | Whether to masquerade traffic to the link-local prefix (169.254.0.0/16). | string | `false` | no | -| ip_masq_resync_interval | The interval at which the agent attempts to sync its ConfigMap file from the disk. | string | `60s` | no | -| ip_range_pods | The _name_ of the secondary subnet ip range to use for pods | string | - | yes | -| ip_range_services | The _name_ of the secondary subnet range to use for services | string | - | yes | -| kubernetes_dashboard | Enable kubernetes dashboard addon | string | `false` | no | -| kubernetes_version | The Kubernetes version of the masters. If set to 'latest' it will pull latest available version in the selected region. | string | `latest` | no | -| logging_service | The logging service that the cluster should write logs to. Available options include logging.googleapis.com, logging.googleapis.com/kubernetes (beta), and none | string | `logging.googleapis.com` | no | -| maintenance_start_time | Time window specified for daily maintenance operations in RFC3339 format | string | `05:00` | no | -| master_authorized_networks_config | The desired configuration options for master authorized networks. Omit the nested cidr_blocks attribute to disallow external access (except the cluster node IPs, which GKE automatically whitelists)

### example format ### master_authorized_networks_config = [{ cidr_blocks = [{ cidr_block = "10.0.0.0/8" display_name = "example_network" }], }] | list | `` | no | -| monitoring_service | The monitoring service that the cluster should write metrics to. Automatically send metrics from pods in the cluster to the Google Cloud Monitoring API. VM metrics will be collected by Google Compute Engine regardless of this setting Available options include monitoring.googleapis.com, monitoring.googleapis.com/kubernetes (beta) and none | string | `monitoring.googleapis.com` | no | -| name | The name of the cluster (required) | string | - | yes | -| network | The VPC network to host the cluster in (required) | string | - | yes | -| network_policy | Enable network policy addon | string | `false` | no | -| network_project_id | The project ID of the shared VPC's host (for shared vpc support) | string | `` | no | -| node_pools | List of maps containing node pools | list | `` | no | -| node_pools_labels | Map of maps containing node labels by node-pool name | map | `` | no | -| node_pools_metadata | Map of maps containing node metadata by node-pool name | map | `` | no | -| node_pools_tags | Map of lists containing node network tags by node-pool name | map | `` | no | -| node_pools_taints | Map of lists containing node taints by node-pool name | map | `` | no | -| node_version | The Kubernetes version of the node pools. Defaults kubernetes_version (master) variable and can be overridden for individual node pools by setting the `version` key on them. Must be empyty or set the same as master at cluster creation. | string | `` | no | -| non_masquerade_cidrs | List of strings in CIDR notation that specify the IP address ranges that do not use IP masquerading. | list | `` | no | -| project_id | The project ID to host the cluster in (required) | string | - | yes | -| region | The region to host the cluster in (required) | string | - | yes | -| regional | Whether is a regional cluster (zonal cluster if set false. WARNING: changing this after cluster creation is destructive!) | string | `true` | no | -| remove_default_node_pool | Remove default node pool while setting up the cluster | string | `false` | no | -| service_account | The service account to default running nodes as if not overridden in `node_pools`. Defaults to the compute engine default service account. May also specify `create` to automatically create a cluster-specific service account | string | `` | no | -| stub_domains | Map of stub domains and their resolvers to forward DNS queries for a certain domain to an external DNS server | map | `` | no | -| subnetwork | The subnetwork to host the cluster in (required) | string | - | yes | +| description | The description of the cluster | string | `""` | no | +| disable\_legacy\_metadata\_endpoints | Disable the /0.1/ and /v1beta1/ metadata server endpoints on the node. Changing this value will cause all node pools to be recreated. | string | `"true"` | no | +| horizontal\_pod\_autoscaling | Enable horizontal pod autoscaling addon | string | `"true"` | no | +| http\_load\_balancing | Enable httpload balancer addon | string | `"true"` | no | +| ip\_masq\_link\_local | Whether to masquerade traffic to the link-local prefix (169.254.0.0/16). | string | `"false"` | no | +| ip\_masq\_resync\_interval | The interval at which the agent attempts to sync its ConfigMap file from the disk. | string | `"60s"` | no | +| ip\_range\_pods | The _name_ of the secondary subnet ip range to use for pods | string | n/a | yes | +| ip\_range\_services | The _name_ of the secondary subnet range to use for services | string | n/a | yes | +| kubernetes\_dashboard | Enable kubernetes dashboard addon | string | `"false"` | no | +| kubernetes\_version | The Kubernetes version of the masters. If set to 'latest' it will pull latest available version in the selected region. | string | `"latest"` | no | +| logging\_service | The logging service that the cluster should write logs to. Available options include logging.googleapis.com, logging.googleapis.com/kubernetes (beta), and none | string | `"logging.googleapis.com"` | no | +| maintenance\_start\_time | Time window specified for daily maintenance operations in RFC3339 format | string | `"05:00"` | no | +| master\_authorized\_networks\_config | The desired configuration options for master authorized networks. Omit the nested cidr_blocks attribute to disallow external access (except the cluster node IPs, which GKE automatically whitelists)

### example format ### master_authorized_networks_config = [{ cidr_blocks = [{ cidr_block = "10.0.0.0/8" display_name = "example_network" }], }] | list | `` | no | +| monitoring\_service | The monitoring service that the cluster should write metrics to. Automatically send metrics from pods in the cluster to the Google Cloud Monitoring API. VM metrics will be collected by Google Compute Engine regardless of this setting Available options include monitoring.googleapis.com, monitoring.googleapis.com/kubernetes (beta) and none | string | `"monitoring.googleapis.com"` | no | +| name | The name of the cluster (required) | string | n/a | yes | +| network | The VPC network to host the cluster in (required) | string | n/a | yes | +| network\_policy | Enable network policy addon | string | `"false"` | no | +| network\_project\_id | The project ID of the shared VPC's host (for shared vpc support) | string | `""` | no | +| node\_pools | List of maps containing node pools | list | `` | no | +| node\_pools\_labels | Map of maps containing node labels by node-pool name | map | `` | no | +| node\_pools\_metadata | Map of maps containing node metadata by node-pool name | map | `` | no | +| node\_pools\_tags | Map of lists containing node network tags by node-pool name | map | `` | no | +| node\_pools\_taints | Map of lists containing node taints by node-pool name | map | `` | no | +| node\_version | The Kubernetes version of the node pools. Defaults kubernetes_version (master) variable and can be overridden for individual node pools by setting the `version` key on them. Must be empyty or set the same as master at cluster creation. | string | `""` | no | +| non\_masquerade\_cidrs | List of strings in CIDR notation that specify the IP address ranges that do not use IP masquerading. | list | `` | no | +| project\_id | The project ID to host the cluster in (required) | string | n/a | yes | +| region | The region to host the cluster in (required) | string | n/a | yes | +| regional | Whether is a regional cluster (zonal cluster if set false. WARNING: changing this after cluster creation is destructive!) | string | `"true"` | no | +| remove\_default\_node\_pool | Remove default node pool while setting up the cluster | string | `"false"` | no | +| service\_account | The service account to default running nodes as if not overridden in `node_pools`. Defaults to the compute engine default service account. May also specify `create` to automatically create a cluster-specific service account | string | `""` | no | +| stub\_domains | Map of stub domains and their resolvers to forward DNS queries for a certain domain to an external DNS server | map | `` | no | +| subnetwork | The subnetwork to host the cluster in (required) | string | n/a | yes | | zones | The zones to host the cluster in (optional if regional cluster / required if zonal) | list | `` | no | ## Outputs | Name | Description | |------|-------------| -| ca_certificate | Cluster ca certificate (base64 encoded) | +| ca\_certificate | Cluster ca certificate (base64 encoded) | | endpoint | Cluster endpoint | -| horizontal_pod_autoscaling_enabled | Whether horizontal pod autoscaling enabled | -| http_load_balancing_enabled | Whether http load balancing enabled | -| kubernetes_dashboard_enabled | Whether kubernetes dashboard enabled | +| horizontal\_pod\_autoscaling\_enabled | Whether horizontal pod autoscaling enabled | +| http\_load\_balancing\_enabled | Whether http load balancing enabled | +| kubernetes\_dashboard\_enabled | Whether kubernetes dashboard enabled | | location | Cluster location (region if regional cluster, zone if zonal cluster) | -| logging_service | Logging service used | -| master_authorized_networks_config | Networks from which access to master is permitted | -| master_version | Current master kubernetes version | -| min_master_version | Minimum master kubernetes version | -| monitoring_service | Monitoring service used | +| logging\_service | Logging service used | +| master\_authorized\_networks\_config | Networks from which access to master is permitted | +| master\_version | Current master kubernetes version | +| min\_master\_version | Minimum master kubernetes version | +| monitoring\_service | Monitoring service used | | name | Cluster name | -| network_policy_enabled | Whether network policy enabled | -| node_pools_names | List of node pools names | -| node_pools_versions | List of node pools versions | +| network\_policy\_enabled | Whether network policy enabled | +| node\_pools\_names | List of node pools names | +| node\_pools\_versions | List of node pools versions | | region | Cluster region | -| service_account | The service account to default running nodes as if not overridden in `node_pools`. | +| service\_account | The service account to default running nodes as if not overridden in `node_pools`. | | type | Cluster type (regional / zonal) | | zones | List of zones in which the cluster resides | diff --git a/examples/deploy_service/README.md b/examples/deploy_service/README.md index 14ae3e615d..4b43c09e72 100644 --- a/examples/deploy_service/README.md +++ b/examples/deploy_service/README.md @@ -10,36 +10,35 @@ It will: [^]: (autogen_docs_start) - ## Inputs | Name | Description | Type | Default | Required | |------|-------------|:----:|:-----:|:-----:| -| cluster_name_suffix | A suffix to append to the default cluster name | string | `` | no | -| compute_engine_service_account | Service account to associate to the nodes in the cluster | string | - | yes | -| ip_range_pods | The secondary ip range to use for pods | string | - | yes | -| ip_range_services | The secondary ip range to use for pods | string | - | yes | -| network | The VPC network to host the cluster in | string | - | yes | -| project_id | The project ID to host the cluster in | string | - | yes | -| region | The region to host the cluster in | string | - | yes | -| subnetwork | The subnetwork to host the cluster in | string | - | yes | +| cluster\_name\_suffix | A suffix to append to the default cluster name | string | `""` | no | +| compute\_engine\_service\_account | Service account to associate to the nodes in the cluster | string | n/a | yes | +| ip\_range\_pods | The secondary ip range to use for pods | string | n/a | yes | +| ip\_range\_services | The secondary ip range to use for pods | string | n/a | yes | +| network | The VPC network to host the cluster in | string | n/a | yes | +| project\_id | The project ID to host the cluster in | string | n/a | yes | +| region | The region to host the cluster in | string | n/a | yes | +| subnetwork | The subnetwork to host the cluster in | string | n/a | yes | ## Outputs | Name | Description | |------|-------------| -| ca_certificate | | -| client_token | | -| cluster_name | Cluster name | -| ip_range_pods | The secondary IP range used for pods | -| ip_range_services | The secondary IP range used for services | -| kubernetes_endpoint | | +| ca\_certificate | | +| client\_token | | +| cluster\_name | Cluster name | +| ip\_range\_pods | The secondary IP range used for pods | +| ip\_range\_services | The secondary IP range used for services | +| kubernetes\_endpoint | | | location | | -| master_kubernetes_version | The master Kubernetes version | +| master\_kubernetes\_version | The master Kubernetes version | | network | | -| project_id | | +| project\_id | | | region | | -| service_account | The service account to default running nodes as if not overridden in `node_pools`. | +| service\_account | The service account to default running nodes as if not overridden in `node_pools`. | | subnetwork | | | zones | List of zones in which the cluster resides | diff --git a/examples/node_pool/README.md b/examples/node_pool/README.md index 83721bf040..2146e2c53f 100644 --- a/examples/node_pool/README.md +++ b/examples/node_pool/README.md @@ -4,37 +4,36 @@ This example illustrates how to create a cluster with multiple custom node-pool [^]: (autogen_docs_start) - ## Inputs | Name | Description | Type | Default | Required | |------|-------------|:----:|:-----:|:-----:| -| cluster_name_suffix | A suffix to append to the default cluster name | string | `` | no | -| compute_engine_service_account | Service account to associate to the nodes in the cluster | string | - | yes | -| ip_range_pods | The secondary ip range to use for pods | string | - | yes | -| ip_range_services | The secondary ip range to use for pods | string | - | yes | -| network | The VPC network to host the cluster in | string | - | yes | -| project_id | The project ID to host the cluster in | string | - | yes | -| region | The region to host the cluster in | string | - | yes | -| subnetwork | The subnetwork to host the cluster in | string | - | yes | -| zones | The zone to host the cluster in (required if is a zonal cluster) | list | - | yes | +| cluster\_name\_suffix | A suffix to append to the default cluster name | string | `""` | no | +| compute\_engine\_service\_account | Service account to associate to the nodes in the cluster | string | n/a | yes | +| ip\_range\_pods | The secondary ip range to use for pods | string | n/a | yes | +| ip\_range\_services | The secondary ip range to use for pods | string | n/a | yes | +| network | The VPC network to host the cluster in | string | n/a | yes | +| project\_id | The project ID to host the cluster in | string | n/a | yes | +| region | The region to host the cluster in | string | n/a | yes | +| subnetwork | The subnetwork to host the cluster in | string | n/a | yes | +| zones | The zone to host the cluster in (required if is a zonal cluster) | list | n/a | yes | ## Outputs | Name | Description | |------|-------------| -| ca_certificate | | -| client_token | | -| cluster_name | Cluster name | -| ip_range_pods | The secondary IP range used for pods | -| ip_range_services | The secondary IP range used for services | -| kubernetes_endpoint | | +| ca\_certificate | | +| client\_token | | +| cluster\_name | Cluster name | +| ip\_range\_pods | The secondary IP range used for pods | +| ip\_range\_services | The secondary IP range used for services | +| kubernetes\_endpoint | | | location | | -| master_kubernetes_version | The master Kubernetes version | +| master\_kubernetes\_version | The master Kubernetes version | | network | | -| project_id | | +| project\_id | | | region | | -| service_account | The service account to default running nodes as if not overridden in `node_pools`. | +| service\_account | The service account to default running nodes as if not overridden in `node_pools`. | | subnetwork | | | zones | List of zones in which the cluster resides | diff --git a/examples/shared_vpc/README.md b/examples/shared_vpc/README.md index c1d98fc09f..d66cdd5fc4 100644 --- a/examples/shared_vpc/README.md +++ b/examples/shared_vpc/README.md @@ -4,37 +4,36 @@ This example illustrates how to create a simple cluster where the host network i [^]: (autogen_docs_start) - ## Inputs | Name | Description | Type | Default | Required | |------|-------------|:----:|:-----:|:-----:| -| cluster_name_suffix | A suffix to append to the default cluster name | string | `` | no | -| compute_engine_service_account | Service account to associate to the nodes in the cluster | string | - | yes | -| ip_range_pods | The secondary ip range to use for pods | string | - | yes | -| ip_range_services | The secondary ip range to use for pods | string | - | yes | -| network | The VPC network to host the cluster in | string | - | yes | -| network_project_id | The GCP project housing the VPC network to host the cluster in | string | - | yes | -| project_id | The project ID to host the cluster in | string | - | yes | -| region | The region to host the cluster in | string | - | yes | -| subnetwork | The subnetwork to host the cluster in | string | - | yes | +| cluster\_name\_suffix | A suffix to append to the default cluster name | string | `""` | no | +| compute\_engine\_service\_account | Service account to associate to the nodes in the cluster | string | n/a | yes | +| ip\_range\_pods | The secondary ip range to use for pods | string | n/a | yes | +| ip\_range\_services | The secondary ip range to use for pods | string | n/a | yes | +| network | The VPC network to host the cluster in | string | n/a | yes | +| network\_project\_id | The GCP project housing the VPC network to host the cluster in | string | n/a | yes | +| project\_id | The project ID to host the cluster in | string | n/a | yes | +| region | The region to host the cluster in | string | n/a | yes | +| subnetwork | The subnetwork to host the cluster in | string | n/a | yes | ## Outputs | Name | Description | |------|-------------| -| ca_certificate | | -| client_token | | -| cluster_name | Cluster name | -| ip_range_pods | The secondary IP range used for pods | -| ip_range_services | The secondary IP range used for services | -| kubernetes_endpoint | | +| ca\_certificate | | +| client\_token | | +| cluster\_name | Cluster name | +| ip\_range\_pods | The secondary IP range used for pods | +| ip\_range\_services | The secondary IP range used for services | +| kubernetes\_endpoint | | | location | | -| master_kubernetes_version | The master Kubernetes version | +| master\_kubernetes\_version | The master Kubernetes version | | network | | -| project_id | | +| project\_id | | | region | | -| service_account | The service account to default running nodes as if not overridden in `node_pools`. | +| service\_account | The service account to default running nodes as if not overridden in `node_pools`. | | subnetwork | | | zones | List of zones in which the cluster resides | diff --git a/examples/simple_regional/README.md b/examples/simple_regional/README.md index 8db7b945e8..741c40c32b 100644 --- a/examples/simple_regional/README.md +++ b/examples/simple_regional/README.md @@ -4,36 +4,35 @@ This example illustrates how to create a simple cluster. [^]: (autogen_docs_start) - ## Inputs | Name | Description | Type | Default | Required | |------|-------------|:----:|:-----:|:-----:| -| cluster_name_suffix | A suffix to append to the default cluster name | string | `` | no | -| compute_engine_service_account | Service account to associate to the nodes in the cluster | string | - | yes | -| ip_range_pods | The secondary ip range to use for pods | string | - | yes | -| ip_range_services | The secondary ip range to use for pods | string | - | yes | -| network | The VPC network to host the cluster in | string | - | yes | -| project_id | The project ID to host the cluster in | string | - | yes | -| region | The region to host the cluster in | string | - | yes | -| subnetwork | The subnetwork to host the cluster in | string | - | yes | +| cluster\_name\_suffix | A suffix to append to the default cluster name | string | `""` | no | +| compute\_engine\_service\_account | Service account to associate to the nodes in the cluster | string | n/a | yes | +| ip\_range\_pods | The secondary ip range to use for pods | string | n/a | yes | +| ip\_range\_services | The secondary ip range to use for pods | string | n/a | yes | +| network | The VPC network to host the cluster in | string | n/a | yes | +| project\_id | The project ID to host the cluster in | string | n/a | yes | +| region | The region to host the cluster in | string | n/a | yes | +| subnetwork | The subnetwork to host the cluster in | string | n/a | yes | ## Outputs | Name | Description | |------|-------------| -| ca_certificate | | -| client_token | | -| cluster_name | Cluster name | -| ip_range_pods | The secondary IP range used for pods | -| ip_range_services | The secondary IP range used for services | -| kubernetes_endpoint | | +| ca\_certificate | | +| client\_token | | +| cluster\_name | Cluster name | +| ip\_range\_pods | The secondary IP range used for pods | +| ip\_range\_services | The secondary IP range used for services | +| kubernetes\_endpoint | | | location | | -| master_kubernetes_version | The master Kubernetes version | +| master\_kubernetes\_version | The master Kubernetes version | | network | | -| project_id | | +| project\_id | | | region | | -| service_account | The service account to default running nodes as if not overridden in `node_pools`. | +| service\_account | The service account to default running nodes as if not overridden in `node_pools`. | | subnetwork | | | zones | List of zones in which the cluster resides | diff --git a/examples/simple_regional_private/README.md b/examples/simple_regional_private/README.md index 6fd1d87162..9987f9dad0 100644 --- a/examples/simple_regional_private/README.md +++ b/examples/simple_regional_private/README.md @@ -4,36 +4,35 @@ This example illustrates how to create a simple private cluster. [^]: (autogen_docs_start) - ## Inputs | Name | Description | Type | Default | Required | |------|-------------|:----:|:-----:|:-----:| -| cluster_name_suffix | A suffix to append to the default cluster name | string | `` | no | -| compute_engine_service_account | Service account to associate to the nodes in the cluster | string | - | yes | -| ip_range_pods | The secondary ip range to use for pods | string | - | yes | -| ip_range_services | The secondary ip range to use for pods | string | - | yes | -| network | The VPC network to host the cluster in | string | - | yes | -| project_id | The project ID to host the cluster in | string | - | yes | -| region | The region to host the cluster in | string | - | yes | -| subnetwork | The subnetwork to host the cluster in | string | - | yes | +| cluster\_name\_suffix | A suffix to append to the default cluster name | string | `""` | no | +| compute\_engine\_service\_account | Service account to associate to the nodes in the cluster | string | n/a | yes | +| ip\_range\_pods | The secondary ip range to use for pods | string | n/a | yes | +| ip\_range\_services | The secondary ip range to use for pods | string | n/a | yes | +| network | The VPC network to host the cluster in | string | n/a | yes | +| project\_id | The project ID to host the cluster in | string | n/a | yes | +| region | The region to host the cluster in | string | n/a | yes | +| subnetwork | The subnetwork to host the cluster in | string | n/a | yes | ## Outputs | Name | Description | |------|-------------| -| ca_certificate | | -| client_token | | -| cluster_name | Cluster name | -| ip_range_pods | The secondary IP range used for pods | -| ip_range_services | The secondary IP range used for services | -| kubernetes_endpoint | | +| ca\_certificate | | +| client\_token | | +| cluster\_name | Cluster name | +| ip\_range\_pods | The secondary IP range used for pods | +| ip\_range\_services | The secondary IP range used for services | +| kubernetes\_endpoint | | | location | | -| master_kubernetes_version | The master Kubernetes version | +| master\_kubernetes\_version | The master Kubernetes version | | network | | -| project_id | | +| project\_id | | | region | | -| service_account | The service account to default running nodes as if not overridden in `node_pools`. | +| service\_account | The service account to default running nodes as if not overridden in `node_pools`. | | subnetwork | | | zones | List of zones in which the cluster resides | diff --git a/examples/simple_zonal/README.md b/examples/simple_zonal/README.md index 3e7ac4f3b1..229fde7028 100644 --- a/examples/simple_zonal/README.md +++ b/examples/simple_zonal/README.md @@ -4,36 +4,35 @@ This example illustrates how to create a simple cluster. [^]: (autogen_docs_start) - ## Inputs | Name | Description | Type | Default | Required | |------|-------------|:----:|:-----:|:-----:| -| cluster_name_suffix | A suffix to append to the default cluster name | string | `` | no | -| ip_range_pods | The secondary ip range to use for pods | string | - | yes | -| ip_range_services | The secondary ip range to use for pods | string | - | yes | -| network | The VPC network to host the cluster in | string | - | yes | -| project_id | The project ID to host the cluster in | string | - | yes | -| region | The region to host the cluster in | string | - | yes | -| subnetwork | The subnetwork to host the cluster in | string | - | yes | -| zones | The zone to host the cluster in (required if is a zonal cluster) | list | - | yes | +| cluster\_name\_suffix | A suffix to append to the default cluster name | string | `""` | no | +| ip\_range\_pods | The secondary ip range to use for pods | string | n/a | yes | +| ip\_range\_services | The secondary ip range to use for pods | string | n/a | yes | +| network | The VPC network to host the cluster in | string | n/a | yes | +| project\_id | The project ID to host the cluster in | string | n/a | yes | +| region | The region to host the cluster in | string | n/a | yes | +| subnetwork | The subnetwork to host the cluster in | string | n/a | yes | +| zones | The zone to host the cluster in (required if is a zonal cluster) | list | n/a | yes | ## Outputs | Name | Description | |------|-------------| -| ca_certificate | | -| client_token | | -| cluster_name | Cluster name | -| ip_range_pods | The secondary IP range used for pods | -| ip_range_services | The secondary IP range used for services | -| kubernetes_endpoint | | +| ca\_certificate | | +| client\_token | | +| cluster\_name | Cluster name | +| ip\_range\_pods | The secondary IP range used for pods | +| ip\_range\_services | The secondary IP range used for services | +| kubernetes\_endpoint | | | location | | -| master_kubernetes_version | The master Kubernetes version | +| master\_kubernetes\_version | The master Kubernetes version | | network | | -| project_id | | +| project\_id | | | region | | -| service_account | The service account to default running nodes as if not overridden in `node_pools`. | +| service\_account | The service account to default running nodes as if not overridden in `node_pools`. | | subnetwork | | | zones | List of zones in which the cluster resides | diff --git a/examples/simple_zonal_private/README.md b/examples/simple_zonal_private/README.md index 4d305e0df8..0e2c56ff7a 100644 --- a/examples/simple_zonal_private/README.md +++ b/examples/simple_zonal_private/README.md @@ -4,37 +4,36 @@ This example illustrates how to create a simple private cluster. [^]: (autogen_docs_start) - ## Inputs | Name | Description | Type | Default | Required | |------|-------------|:----:|:-----:|:-----:| -| cluster_name_suffix | A suffix to append to the default cluster name | string | `` | no | -| compute_engine_service_account | Service account to associate to the nodes in the cluster | string | - | yes | -| ip_range_pods | The secondary ip range to use for pods | string | - | yes | -| ip_range_services | The secondary ip range to use for pods | string | - | yes | -| network | The VPC network to host the cluster in | string | - | yes | -| project_id | The project ID to host the cluster in | string | - | yes | -| region | The region to host the cluster in | string | - | yes | -| subnetwork | The subnetwork to host the cluster in | string | - | yes | -| zones | The zone to host the cluster in (required if is a zonal cluster) | list | - | yes | +| cluster\_name\_suffix | A suffix to append to the default cluster name | string | `""` | no | +| compute\_engine\_service\_account | Service account to associate to the nodes in the cluster | string | n/a | yes | +| ip\_range\_pods | The secondary ip range to use for pods | string | n/a | yes | +| ip\_range\_services | The secondary ip range to use for pods | string | n/a | yes | +| network | The VPC network to host the cluster in | string | n/a | yes | +| project\_id | The project ID to host the cluster in | string | n/a | yes | +| region | The region to host the cluster in | string | n/a | yes | +| subnetwork | The subnetwork to host the cluster in | string | n/a | yes | +| zones | The zone to host the cluster in (required if is a zonal cluster) | list | n/a | yes | ## Outputs | Name | Description | |------|-------------| -| ca_certificate | | -| client_token | | -| cluster_name | Cluster name | -| ip_range_pods | The secondary IP range used for pods | -| ip_range_services | The secondary IP range used for services | -| kubernetes_endpoint | | +| ca\_certificate | | +| client\_token | | +| cluster\_name | Cluster name | +| ip\_range\_pods | The secondary IP range used for pods | +| ip\_range\_services | The secondary IP range used for services | +| kubernetes\_endpoint | | | location | | -| master_kubernetes_version | The master Kubernetes version | +| master\_kubernetes\_version | The master Kubernetes version | | network | | -| project_id | | +| project\_id | | | region | | -| service_account | The service account to default running nodes as if not overridden in `node_pools`. | +| service\_account | The service account to default running nodes as if not overridden in `node_pools`. | | subnetwork | | | zones | List of zones in which the cluster resides | diff --git a/examples/stub_domains/README.md b/examples/stub_domains/README.md index 9736bc4ba1..4c380ada81 100644 --- a/examples/stub_domains/README.md +++ b/examples/stub_domains/README.md @@ -9,36 +9,35 @@ It will: [^]: (autogen_docs_start) - ## Inputs | Name | Description | Type | Default | Required | |------|-------------|:----:|:-----:|:-----:| -| cluster_name_suffix | A suffix to append to the default cluster name | string | `` | no | -| compute_engine_service_account | Service account to associate to the nodes in the cluster | string | - | yes | -| ip_range_pods | The secondary ip range to use for pods | string | - | yes | -| ip_range_services | The secondary ip range to use for pods | string | - | yes | -| network | The VPC network to host the cluster in | string | - | yes | -| project_id | The project ID to host the cluster in | string | - | yes | -| region | The region to host the cluster in | string | - | yes | -| subnetwork | The subnetwork to host the cluster in | string | - | yes | +| cluster\_name\_suffix | A suffix to append to the default cluster name | string | `""` | no | +| compute\_engine\_service\_account | Service account to associate to the nodes in the cluster | string | n/a | yes | +| ip\_range\_pods | The secondary ip range to use for pods | string | n/a | yes | +| ip\_range\_services | The secondary ip range to use for pods | string | n/a | yes | +| network | The VPC network to host the cluster in | string | n/a | yes | +| project\_id | The project ID to host the cluster in | string | n/a | yes | +| region | The region to host the cluster in | string | n/a | yes | +| subnetwork | The subnetwork to host the cluster in | string | n/a | yes | ## Outputs | Name | Description | |------|-------------| -| ca_certificate | | -| client_token | | -| cluster_name | Cluster name | -| ip_range_pods | The secondary IP range used for pods | -| ip_range_services | The secondary IP range used for services | -| kubernetes_endpoint | | +| ca\_certificate | | +| client\_token | | +| cluster\_name | Cluster name | +| ip\_range\_pods | The secondary IP range used for pods | +| ip\_range\_services | The secondary IP range used for services | +| kubernetes\_endpoint | | | location | | -| master_kubernetes_version | The master Kubernetes version | +| master\_kubernetes\_version | The master Kubernetes version | | network | | -| project_id | | +| project\_id | | | region | | -| service_account | The service account to default running nodes as if not overridden in `node_pools`. | +| service\_account | The service account to default running nodes as if not overridden in `node_pools`. | | subnetwork | | | zones | List of zones in which the cluster resides | diff --git a/modules/private-cluster/README.md b/modules/private-cluster/README.md index 27a2c6176c..e3eeb194cf 100644 --- a/modules/private-cluster/README.md +++ b/modules/private-cluster/README.md @@ -100,69 +100,68 @@ In either case, upgrading to module version `v1.0.0` will trigger a recreation o [^]: (autogen_docs_start) - ## Inputs | Name | Description | Type | Default | Required | |------|-------------|:----:|:-----:|:-----:| -| description | The description of the cluster | string | `` | no | -| disable_legacy_metadata_endpoints | Disable the /0.1/ and /v1beta1/ metadata server endpoints on the node. Changing this value will cause all node pools to be recreated. | string | `true` | no | -| enable_private_endpoint | (Beta) Whether the master's internal IP address is used as the cluster endpoint | string | `false` | no | -| enable_private_nodes | (Beta) Whether nodes have internal IP addresses only | string | `false` | no | -| horizontal_pod_autoscaling | Enable horizontal pod autoscaling addon | string | `true` | no | -| http_load_balancing | Enable httpload balancer addon | string | `true` | no | -| ip_masq_link_local | Whether to masquerade traffic to the link-local prefix (169.254.0.0/16). | string | `false` | no | -| ip_masq_resync_interval | The interval at which the agent attempts to sync its ConfigMap file from the disk. | string | `60s` | no | -| ip_range_pods | The _name_ of the secondary subnet ip range to use for pods | string | - | yes | -| ip_range_services | The _name_ of the secondary subnet range to use for services | string | - | yes | -| kubernetes_dashboard | Enable kubernetes dashboard addon | string | `false` | no | -| kubernetes_version | The Kubernetes version of the masters. If set to 'latest' it will pull latest available version in the selected region. | string | `latest` | no | -| logging_service | The logging service that the cluster should write logs to. Available options include logging.googleapis.com, logging.googleapis.com/kubernetes (beta), and none | string | `logging.googleapis.com` | no | -| maintenance_start_time | Time window specified for daily maintenance operations in RFC3339 format | string | `05:00` | no | -| master_authorized_networks_config | The desired configuration options for master authorized networks. Omit the nested cidr_blocks attribute to disallow external access (except the cluster node IPs, which GKE automatically whitelists)

### example format ### master_authorized_networks_config = [{ cidr_blocks = [{ cidr_block = "10.0.0.0/8" display_name = "example_network" }], }] | list | `` | no | -| master_ipv4_cidr_block | (Beta) The IP range in CIDR notation to use for the hosted master network | string | `10.0.0.0/28` | no | -| monitoring_service | The monitoring service that the cluster should write metrics to. Automatically send metrics from pods in the cluster to the Google Cloud Monitoring API. VM metrics will be collected by Google Compute Engine regardless of this setting Available options include monitoring.googleapis.com, monitoring.googleapis.com/kubernetes (beta) and none | string | `monitoring.googleapis.com` | no | -| name | The name of the cluster (required) | string | - | yes | -| network | The VPC network to host the cluster in (required) | string | - | yes | -| network_policy | Enable network policy addon | string | `false` | no | -| network_project_id | The project ID of the shared VPC's host (for shared vpc support) | string | `` | no | -| node_pools | List of maps containing node pools | list | `` | no | -| node_pools_labels | Map of maps containing node labels by node-pool name | map | `` | no | -| node_pools_metadata | Map of maps containing node metadata by node-pool name | map | `` | no | -| node_pools_tags | Map of lists containing node network tags by node-pool name | map | `` | no | -| node_pools_taints | Map of lists containing node taints by node-pool name | map | `` | no | -| node_version | The Kubernetes version of the node pools. Defaults kubernetes_version (master) variable and can be overridden for individual node pools by setting the `version` key on them. Must be empyty or set the same as master at cluster creation. | string | `` | no | -| non_masquerade_cidrs | List of strings in CIDR notation that specify the IP address ranges that do not use IP masquerading. | list | `` | no | -| project_id | The project ID to host the cluster in (required) | string | - | yes | -| region | The region to host the cluster in (required) | string | - | yes | -| regional | Whether is a regional cluster (zonal cluster if set false. WARNING: changing this after cluster creation is destructive!) | string | `true` | no | -| remove_default_node_pool | Remove default node pool while setting up the cluster | string | `false` | no | -| service_account | The service account to default running nodes as if not overridden in `node_pools`. Defaults to the compute engine default service account. May also specify `create` to automatically create a cluster-specific service account | string | `` | no | -| stub_domains | Map of stub domains and their resolvers to forward DNS queries for a certain domain to an external DNS server | map | `` | no | -| subnetwork | The subnetwork to host the cluster in (required) | string | - | yes | +| description | The description of the cluster | string | `""` | no | +| disable\_legacy\_metadata\_endpoints | Disable the /0.1/ and /v1beta1/ metadata server endpoints on the node. Changing this value will cause all node pools to be recreated. | string | `"true"` | no | +| enable\_private\_endpoint | (Beta) Whether the master's internal IP address is used as the cluster endpoint | string | `"false"` | no | +| enable\_private\_nodes | (Beta) Whether nodes have internal IP addresses only | string | `"false"` | no | +| horizontal\_pod\_autoscaling | Enable horizontal pod autoscaling addon | string | `"true"` | no | +| http\_load\_balancing | Enable httpload balancer addon | string | `"true"` | no | +| ip\_masq\_link\_local | Whether to masquerade traffic to the link-local prefix (169.254.0.0/16). | string | `"false"` | no | +| ip\_masq\_resync\_interval | The interval at which the agent attempts to sync its ConfigMap file from the disk. | string | `"60s"` | no | +| ip\_range\_pods | The _name_ of the secondary subnet ip range to use for pods | string | n/a | yes | +| ip\_range\_services | The _name_ of the secondary subnet range to use for services | string | n/a | yes | +| kubernetes\_dashboard | Enable kubernetes dashboard addon | string | `"false"` | no | +| kubernetes\_version | The Kubernetes version of the masters. If set to 'latest' it will pull latest available version in the selected region. | string | `"latest"` | no | +| logging\_service | The logging service that the cluster should write logs to. Available options include logging.googleapis.com, logging.googleapis.com/kubernetes (beta), and none | string | `"logging.googleapis.com"` | no | +| maintenance\_start\_time | Time window specified for daily maintenance operations in RFC3339 format | string | `"05:00"` | no | +| master\_authorized\_networks\_config | The desired configuration options for master authorized networks. Omit the nested cidr_blocks attribute to disallow external access (except the cluster node IPs, which GKE automatically whitelists)

### example format ### master_authorized_networks_config = [{ cidr_blocks = [{ cidr_block = "10.0.0.0/8" display_name = "example_network" }], }] | list | `` | no | +| master\_ipv4\_cidr\_block | (Beta) The IP range in CIDR notation to use for the hosted master network | string | `"10.0.0.0/28"` | no | +| monitoring\_service | The monitoring service that the cluster should write metrics to. Automatically send metrics from pods in the cluster to the Google Cloud Monitoring API. VM metrics will be collected by Google Compute Engine regardless of this setting Available options include monitoring.googleapis.com, monitoring.googleapis.com/kubernetes (beta) and none | string | `"monitoring.googleapis.com"` | no | +| name | The name of the cluster (required) | string | n/a | yes | +| network | The VPC network to host the cluster in (required) | string | n/a | yes | +| network\_policy | Enable network policy addon | string | `"false"` | no | +| network\_project\_id | The project ID of the shared VPC's host (for shared vpc support) | string | `""` | no | +| node\_pools | List of maps containing node pools | list | `` | no | +| node\_pools\_labels | Map of maps containing node labels by node-pool name | map | `` | no | +| node\_pools\_metadata | Map of maps containing node metadata by node-pool name | map | `` | no | +| node\_pools\_tags | Map of lists containing node network tags by node-pool name | map | `` | no | +| node\_pools\_taints | Map of lists containing node taints by node-pool name | map | `` | no | +| node\_version | The Kubernetes version of the node pools. Defaults kubernetes_version (master) variable and can be overridden for individual node pools by setting the `version` key on them. Must be empyty or set the same as master at cluster creation. | string | `""` | no | +| non\_masquerade\_cidrs | List of strings in CIDR notation that specify the IP address ranges that do not use IP masquerading. | list | `` | no | +| project\_id | The project ID to host the cluster in (required) | string | n/a | yes | +| region | The region to host the cluster in (required) | string | n/a | yes | +| regional | Whether is a regional cluster (zonal cluster if set false. WARNING: changing this after cluster creation is destructive!) | string | `"true"` | no | +| remove\_default\_node\_pool | Remove default node pool while setting up the cluster | string | `"false"` | no | +| service\_account | The service account to default running nodes as if not overridden in `node_pools`. Defaults to the compute engine default service account. May also specify `create` to automatically create a cluster-specific service account | string | `""` | no | +| stub\_domains | Map of stub domains and their resolvers to forward DNS queries for a certain domain to an external DNS server | map | `` | no | +| subnetwork | The subnetwork to host the cluster in (required) | string | n/a | yes | | zones | The zones to host the cluster in (optional if regional cluster / required if zonal) | list | `` | no | ## Outputs | Name | Description | |------|-------------| -| ca_certificate | Cluster ca certificate (base64 encoded) | +| ca\_certificate | Cluster ca certificate (base64 encoded) | | endpoint | Cluster endpoint | -| horizontal_pod_autoscaling_enabled | Whether horizontal pod autoscaling enabled | -| http_load_balancing_enabled | Whether http load balancing enabled | -| kubernetes_dashboard_enabled | Whether kubernetes dashboard enabled | +| horizontal\_pod\_autoscaling\_enabled | Whether horizontal pod autoscaling enabled | +| http\_load\_balancing\_enabled | Whether http load balancing enabled | +| kubernetes\_dashboard\_enabled | Whether kubernetes dashboard enabled | | location | Cluster location (region if regional cluster, zone if zonal cluster) | -| logging_service | Logging service used | -| master_authorized_networks_config | Networks from which access to master is permitted | -| master_version | Current master kubernetes version | -| min_master_version | Minimum master kubernetes version | -| monitoring_service | Monitoring service used | +| logging\_service | Logging service used | +| master\_authorized\_networks\_config | Networks from which access to master is permitted | +| master\_version | Current master kubernetes version | +| min\_master\_version | Minimum master kubernetes version | +| monitoring\_service | Monitoring service used | | name | Cluster name | -| network_policy_enabled | Whether network policy enabled | -| node_pools_names | List of node pools names | -| node_pools_versions | List of node pools versions | +| network\_policy\_enabled | Whether network policy enabled | +| node\_pools\_names | List of node pools names | +| node\_pools\_versions | List of node pools versions | | region | Cluster region | -| service_account | The service account to default running nodes as if not overridden in `node_pools`. | +| service\_account | The service account to default running nodes as if not overridden in `node_pools`. | | type | Cluster type (regional / zonal) | | zones | List of zones in which the cluster resides |