regenerating docs

README.md

@@ -84,6 +84,69 @@ Then perform the following commands on the root folder:
 
 [^]: (autogen_docs_start)
 
+## Inputs
+
+| Name | Description | Type | Default | Required |
+|------|-------------|:----:|:-----:|:-----:|
+| basic\_auth\_password | Kubernetes HTTP Basic auth password. Only used if `enable_basic_auth` is true | string | `` | no |
+| basic\_auth\_username | Kubernetes HTTP Basic auth username. Only used if `enable_basic_auth` is true | string | `` | no |
+| description | The description of the cluster | string | `` | no |
+| enable\_basic\_auth | Basic authentication allows a user to authenticate to the cluster with a username and password. To maximize the security of your cluster, disable this option. Basic authentication is not recommended because it provides no confidentiality protection for transmitted credentials | 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 secondary ip range to use for pods | string | - | yes |
+| ip\_range\_services | The secondary ip range to use for pods | string | - | yes |
+| issue\_client\_certificate | Issues a client certificate to authenticate to the cluster endpoint. To maximize the security of your cluster, leave this option disabled. Client certificates don't automatically rotate and aren't easily revocable. WARNING: changing this after cluster creation is destructive! | string | `false` | no |
+| 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)<br><br>  ### example format ###   master_authorized_networks_config = [{     cidr_blocks = [{       cidr_block   = "10.0.0.0/8"       display_name = "example_network"     }],   }] | list | `<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 | `<list>` | no |
+| node\_pools\_labels | Map of maps containing node labels by node-pool name | map | `<map>` | no |
+| node\_pools\_tags | Map of lists containing node network tags by node-pool name | map | `<map>` | no |
+| node\_pools\_taints | Map of lists containing node taints by node-pool name | map | `<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 | `<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 | 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 | `<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 | `<list>` | no |
+
+## Outputs
+
+| Name | Description |
+|------|-------------|
+| 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 |
+| 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 |
+| 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 |
+| region | Cluster region |
+| type | Cluster type (regional / zonal) |
+| zones | List of zones in which the cluster resides |
+
 [^]: (autogen_docs_end)
 
 ## Requirements
@@ -243,4 +306,4 @@ are as follows:
 is a compiled language so there is no standard linter.
 * Terraform - terraform has a built-in linter in the 'terraform validate'
 command.
-* Dockerfiles - hadolint. Can be found in homebrew
+* Dockerfiles - hadolint. Can be found in homebrew

examples/deploy_service/README.md

@@ -10,37 +10,37 @@ It will:
 
 [^]: (autogen_docs_start)
 
-
 ## Inputs
 
 | Name | Description | Type | Default | Required |
 |------|-------------|:----:|:-----:|:-----:|
-| compute_engine_service_account | Service account to associate to the nodes in the cluster | string | - | yes |
-| credentials_path | The path to the GCP credentials JSON file | 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 |
+| 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 |
+| credentials\_path | The path to the GCP credentials JSON file | 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 |
+| 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 |
-| 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 |  |
-| subnetwork |  |
+| 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 | - |
+| subnetwork | - |
 | zones | List of zones in which the cluster resides |
 
 [^]: (autogen_docs_end)

examples/disable_client_cert/README.md

@@ -7,10 +7,44 @@ This example illustrates how to create a simple cluster and disable deprecate se
 
 [^]: (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 |
+| credentials\_path | The path to the GCP credentials JSON file | 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 |
+| 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 | - |
+| subnetwork | - |
+| zones | List of zones in which the cluster resides |
+
 [^]: (autogen_docs_end)
 
 To provision this example, run the following from within this directory:
 - `terraform init` to get the plugins
 - `terraform plan` to see the infrastructure plan
 - `terraform apply` to apply the infrastructure build
-- `terraform destroy` to destroy the built infrastructure
+- `terraform destroy` to destroy the built infrastructure

examples/node_pool/README.md

@@ -4,37 +4,37 @@ This example illustrates how to create a cluster with multiple custom node-pool
 
 [^]: (autogen_docs_start)
 
-
 ## Inputs
 
 | Name | Description | Type | Default | Required |
 |------|-------------|:----:|:-----:|:-----:|
-| compute_engine_service_account | Service account to associate to the nodes in the cluster | string | - | yes |
-| credentials_path | The path to the GCP credentials JSON file | 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 |
+| 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 |
+| credentials\_path | The path to the GCP credentials JSON file | 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 |
+| 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 |
-| 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 |  |
-| subnetwork |  |
+| 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 | - |
+| subnetwork | - |
 | zones | List of zones in which the cluster resides |
 
 [^]: (autogen_docs_end)

examples/shared_vpc/README.md

@@ -4,10 +4,44 @@ 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 |
+| credentials\_path | The path to the GCP credentials JSON file | 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 |
+| 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 | - |
+| subnetwork | - |
+| zones | List of zones in which the cluster resides |
+
 [^]: (autogen_docs_end)
 
 To provision this example, run the following from within this directory:
 - `terraform init` to get the plugins
 - `terraform plan` to see the infrastructure plan
 - `terraform apply` to apply the infrastructure build
-- `terraform destroy` to destroy the built infrastructure
+- `terraform destroy` to destroy the built infrastructure

examples/simple_regional/README.md

@@ -4,37 +4,37 @@ This example illustrates how to create a simple cluster.
 
 [^]: (autogen_docs_start)
 
-
 ## Inputs
 
 | Name | Description | Type | Default | Required |
 |------|-------------|:----:|:-----:|:-----:|
-| compute_engine_service_account | Service account to associate to the nodes in the cluster | string | - | yes |
-| credentials_path | The path to the GCP credentials JSON file | 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 |
+| 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 |
+| credentials\_path | The path to the GCP credentials JSON file | 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 |
+| 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 |
-| 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 |  |
-| subnetwork |  |
+| 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 | - |
+| subnetwork | - |
 | zones | List of zones in which the cluster resides |
 
 [^]: (autogen_docs_end)