Skip to content

Commit c5a6fbe

Browse files
alexkonkinalexkonkin
committed
updated documentation
1 parent 2f420a3 commit c5a6fbe

File tree

3 files changed

+139
-0
lines changed

3 files changed

+139
-0
lines changed

‎README.md

+67
Original file line numberDiff line numberDiff line change
@@ -109,6 +109,73 @@ Version 1.0.0 of this module introduces a breaking change: adding the `disable-l
109109
In either case, upgrading to module version `v1.0.0` will trigger a recreation of all node pools in the cluster.
110110

111111
[^]: (autogen_docs_start)
112+
113+
## Inputs
114+
115+
| Name | Description | Type | Default | Required |
116+
|------|-------------|:----:|:-----:|:-----:|
117+
| basic\_auth\_password | The password to be used with Basic Authentication. | string | `""` | no |
118+
| basic\_auth\_username | The username to be used with Basic Authentication. An empty value will disable Basic Authentication, which is the recommended configuration. | string | `""` | no |
119+
| description | The description of the cluster | string | `""` | no |
120+
| 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 |
121+
| horizontal\_pod\_autoscaling | Enable horizontal pod autoscaling addon | string | `"true"` | no |
122+
| http\_load\_balancing | Enable httpload balancer addon | string | `"true"` | no |
123+
| ip\_masq\_link\_local | Whether to masquerade traffic to the link-local prefix (169.254.0.0/16). | string | `"false"` | no |
124+
| ip\_masq\_resync\_interval | The interval at which the agent attempts to sync its ConfigMap file from the disk. | string | `"60s"` | no |
125+
| ip\_range\_pods | The _name_ of the secondary subnet ip range to use for pods | string | n/a | yes |
126+
| ip\_range\_services | The _name_ of the secondary subnet range to use for services | string | n/a | yes |
127+
| 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 |
128+
| kubernetes\_dashboard | Enable kubernetes dashboard addon | string | `"false"` | no |
129+
| 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 |
130+
| 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 |
131+
| maintenance\_start\_time | Time window specified for daily maintenance operations in RFC3339 format | string | `"05:00"` | no |
132+
| 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 |
133+
| 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 |
134+
| name | The name of the cluster (required) | string | n/a | yes |
135+
| network | The VPC network to host the cluster in (required) | string | n/a | yes |
136+
| network\_policy | Enable network policy addon | string | `"false"` | no |
137+
| network\_project\_id | The project ID of the shared VPC's host (for shared vpc support) | string | `""` | no |
138+
| node\_pools | List of maps containing node pools | list | `<list>` | no |
139+
| node\_pools\_labels | Map of maps containing node labels by node-pool name | map | `<map>` | no |
140+
| node\_pools\_metadata | Map of maps containing node metadata by node-pool name | map | `<map>` | no |
141+
| node\_pools\_oauth\_scopes | Map of lists containing node oauth scopes by node-pool name | map | `<map>` | no |
142+
| node\_pools\_tags | Map of lists containing node network tags by node-pool name | map | `<map>` | no |
143+
| node\_pools\_taints | Map of lists containing node taints by node-pool name | map | `<map>` | no |
144+
| 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 |
145+
| non\_masquerade\_cidrs | List of strings in CIDR notation that specify the IP address ranges that do not use IP masquerading. | list | `<list>` | no |
146+
| project\_id | The project ID to host the cluster in (required) | string | n/a | yes |
147+
| region | The region to host the cluster in (required) | string | n/a | yes |
148+
| regional | Whether is a regional cluster (zonal cluster if set false. WARNING: changing this after cluster creation is destructive!) | string | `"true"` | no |
149+
| remove\_default\_node\_pool | Remove default node pool while setting up the cluster | string | `"false"` | no |
150+
| service\_account | The service account to run nodes as if not overridden in `node_pools`. The default value will cause a cluster-specific service account to be created. | string | `"create"` | no |
151+
| 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 |
152+
| subnetwork | The subnetwork to host the cluster in (required) | string | n/a | yes |
153+
| zones | The zones to host the cluster in (optional if regional cluster / required if zonal) | list | `<list>` | no |
154+
155+
## Outputs
156+
157+
| Name | Description |
158+
|------|-------------|
159+
| ca\_certificate | Cluster ca certificate (base64 encoded) |
160+
| endpoint | Cluster endpoint |
161+
| horizontal\_pod\_autoscaling\_enabled | Whether horizontal pod autoscaling enabled |
162+
| http\_load\_balancing\_enabled | Whether http load balancing enabled |
163+
| kubernetes\_dashboard\_enabled | Whether kubernetes dashboard enabled |
164+
| location | Cluster location (region if regional cluster, zone if zonal cluster) |
165+
| logging\_service | Logging service used |
166+
| master\_authorized\_networks\_config | Networks from which access to master is permitted |
167+
| master\_version | Current master kubernetes version |
168+
| min\_master\_version | Minimum master kubernetes version |
169+
| monitoring\_service | Monitoring service used |
170+
| name | Cluster name |
171+
| network\_policy\_enabled | Whether network policy enabled |
172+
| node\_pools\_names | List of node pools names |
173+
| node\_pools\_versions | List of node pools versions |
174+
| region | Cluster region |
175+
| service\_account | The service account to default running nodes as if not overridden in `node_pools`. |
176+
| type | Cluster type (regional / zonal) |
177+
| zones | List of zones in which the cluster resides |
178+
112179
[^]: (autogen_docs_end)
113180

114181
## Requirements

‎examples/disable_client_cert/README.md

+1
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@ This example illustrates how to create a simple cluster and disable deprecated s
3737
| network | |
3838
| project\_id | |
3939
| region | |
40+
| service\_account | The service account to default running nodes as if not overridden in `node_pools`. |
4041
| subnetwork | |
4142
| zones | List of zones in which the cluster resides |
4243

‎modules/private-cluster/README.md

+71
Original file line numberDiff line numberDiff line change
@@ -114,6 +114,77 @@ Version 1.0.0 of this module introduces a breaking change: adding the `disable-l
114114
In either case, upgrading to module version `v1.0.0` will trigger a recreation of all node pools in the cluster.
115115

116116
[^]: (autogen_docs_start)
117+
118+
## Inputs
119+
120+
| Name | Description | Type | Default | Required |
121+
|------|-------------|:----:|:-----:|:-----:|
122+
| basic\_auth\_password | The password to be used with Basic Authentication. | string | `""` | no |
123+
| basic\_auth\_username | The username to be used with Basic Authentication. An empty value will disable Basic Authentication, which is the recommended configuration. | string | `""` | no |
124+
| deploy\_using\_private\_endpoint | (Beta) A toggle for Terraform and kubectl to connect to the master's internal IP address during deployment. | string | `"false"` | no |
125+
| description | The description of the cluster | string | `""` | no |
126+
| 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 |
127+
| enable\_private\_endpoint | (Beta) Whether the master's internal IP address is used as the cluster endpoint | string | `"false"` | no |
128+
| enable\_private\_nodes | (Beta) Whether nodes have internal IP addresses only | string | `"false"` | no |
129+
| horizontal\_pod\_autoscaling | Enable horizontal pod autoscaling addon | string | `"true"` | no |
130+
| http\_load\_balancing | Enable httpload balancer addon | string | `"true"` | no |
131+
| ip\_masq\_link\_local | Whether to masquerade traffic to the link-local prefix (169.254.0.0/16). | string | `"false"` | no |
132+
| ip\_masq\_resync\_interval | The interval at which the agent attempts to sync its ConfigMap file from the disk. | string | `"60s"` | no |
133+
| ip\_range\_pods | The _name_ of the secondary subnet ip range to use for pods | string | n/a | yes |
134+
| ip\_range\_services | The _name_ of the secondary subnet range to use for services | string | n/a | yes |
135+
| 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 |
136+
| kubernetes\_dashboard | Enable kubernetes dashboard addon | string | `"false"` | no |
137+
| 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 |
138+
| 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 |
139+
| maintenance\_start\_time | Time window specified for daily maintenance operations in RFC3339 format | string | `"05:00"` | no |
140+
| 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 |
141+
| 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 |
142+
| 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 |
143+
| name | The name of the cluster (required) | string | n/a | yes |
144+
| network | The VPC network to host the cluster in (required) | string | n/a | yes |
145+
| network\_policy | Enable network policy addon | string | `"false"` | no |
146+
| network\_project\_id | The project ID of the shared VPC's host (for shared vpc support) | string | `""` | no |
147+
| node\_pools | List of maps containing node pools | list | `<list>` | no |
148+
| node\_pools\_labels | Map of maps containing node labels by node-pool name | map | `<map>` | no |
149+
| node\_pools\_metadata | Map of maps containing node metadata by node-pool name | map | `<map>` | no |
150+
| node\_pools\_oauth\_scopes | Map of lists containing node oauth scopes by node-pool name | map | `<map>` | no |
151+
| node\_pools\_tags | Map of lists containing node network tags by node-pool name | map | `<map>` | no |
152+
| node\_pools\_taints | Map of lists containing node taints by node-pool name | map | `<map>` | no |
153+
| 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 |
154+
| non\_masquerade\_cidrs | List of strings in CIDR notation that specify the IP address ranges that do not use IP masquerading. | list | `<list>` | no |
155+
| project\_id | The project ID to host the cluster in (required) | string | n/a | yes |
156+
| region | The region to host the cluster in (required) | string | n/a | yes |
157+
| regional | Whether is a regional cluster (zonal cluster if set false. WARNING: changing this after cluster creation is destructive!) | string | `"true"` | no |
158+
| remove\_default\_node\_pool | Remove default node pool while setting up the cluster | string | `"false"` | no |
159+
| service\_account | The service account to run nodes as if not overridden in `node_pools`. The default value will cause a cluster-specific service account to be created. | string | `"create"` | no |
160+
| 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 |
161+
| subnetwork | The subnetwork to host the cluster in (required) | string | n/a | yes |
162+
| zones | The zones to host the cluster in (optional if regional cluster / required if zonal) | list | `<list>` | no |
163+
164+
## Outputs
165+
166+
| Name | Description |
167+
|------|-------------|
168+
| ca\_certificate | Cluster ca certificate (base64 encoded) |
169+
| endpoint | Cluster endpoint |
170+
| horizontal\_pod\_autoscaling\_enabled | Whether horizontal pod autoscaling enabled |
171+
| http\_load\_balancing\_enabled | Whether http load balancing enabled |
172+
| kubernetes\_dashboard\_enabled | Whether kubernetes dashboard enabled |
173+
| location | Cluster location (region if regional cluster, zone if zonal cluster) |
174+
| logging\_service | Logging service used |
175+
| master\_authorized\_networks\_config | Networks from which access to master is permitted |
176+
| master\_version | Current master kubernetes version |
177+
| min\_master\_version | Minimum master kubernetes version |
178+
| monitoring\_service | Monitoring service used |
179+
| name | Cluster name |
180+
| network\_policy\_enabled | Whether network policy enabled |
181+
| node\_pools\_names | List of node pools names |
182+
| node\_pools\_versions | List of node pools versions |
183+
| region | Cluster region |
184+
| service\_account | The service account to default running nodes as if not overridden in `node_pools`. |
185+
| type | Cluster type (regional / zonal) |
186+
| zones | List of zones in which the cluster resides |
187+
117188
[^]: (autogen_docs_end)
118189

119190
## Requirements

0 commit comments

Comments
 (0)