Skip to content

Commit 220ae01

Browse files
coryodanielcoryodaniel
committed
regenerating docs
1 parent 6b5876a commit 220ae01

File tree

8 files changed

+206
-136
lines changed

8 files changed

+206
-136
lines changed

‎README.md

Lines changed: 41 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -92,68 +92,70 @@ Then perform the following commands on the root folder:
9292

9393
[^]: (autogen_docs_start)
9494

95-
9695
## Inputs
9796

9897
| Name | Description | Type | Default | Required |
9998
|------|-------------|:----:|:-----:|:-----:|
99+
| basic\_auth\_password | Kubernetes HTTP Basic auth password. Only used if `enable_basic_auth` is true | string | `` | no |
100+
| basic\_auth\_username | Kubernetes HTTP Basic auth username. Only used if `enable_basic_auth` is true | string | `` | no |
100101
| description | The description of the cluster | string | `` | no |
101-
| horizontal_pod_autoscaling | Enable horizontal pod autoscaling addon | string | `true` | no |
102-
| http_load_balancing | Enable httpload balancer addon | string | `true` | no |
103-
| ip_masq_link_local | Whether to masquerade traffic to the link-local prefix (169.254.0.0/16). | string | `false` | no |
104-
| ip_masq_resync_interval | The interval at which the agent attempts to sync its ConfigMap file from the disk. | string | `60s` | no |
105-
| ip_range_pods | The secondary ip range to use for pods | string | - | yes |
106-
| ip_range_services | The secondary ip range to use for pods | string | - | yes |
107-
| kubernetes_dashboard | Enable kubernetes dashboard addon | string | `false` | no |
108-
| 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 |
109-
| 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 |
110-
| maintenance_start_time | Time window specified for daily maintenance operations in RFC3339 format | string | `05:00` | no |
111-
| 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 |
112-
| 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 |
102+
| 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 |
103+
| horizontal\_pod\_autoscaling | Enable horizontal pod autoscaling addon | string | `true` | no |
104+
| http\_load\_balancing | Enable httpload balancer addon | string | `true` | no |
105+
| ip\_masq\_link\_local | Whether to masquerade traffic to the link-local prefix (169.254.0.0/16). | string | `false` | no |
106+
| ip\_masq\_resync\_interval | The interval at which the agent attempts to sync its ConfigMap file from the disk. | string | `60s` | no |
107+
| ip\_range\_pods | The secondary ip range to use for pods | string | - | yes |
108+
| ip\_range\_services | The secondary ip range to use for pods | string | - | yes |
109+
| 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 |
110+
| kubernetes\_dashboard | Enable kubernetes dashboard addon | string | `false` | no |
111+
| 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 |
112+
| 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 |
113+
| maintenance\_start\_time | Time window specified for daily maintenance operations in RFC3339 format | string | `05:00` | no |
114+
| 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 |
115+
| 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 |
113116
| name | The name of the cluster (required) | string | - | yes |
114117
| network | The VPC network to host the cluster in (required) | string | - | yes |
115-
| network_policy | Enable network policy addon | string | `false` | no |
116-
| network_project_id | The project ID of the shared VPC's host (for shared vpc support) | string | `` | no |
117-
| remove_default_node_pool | Boolean value determining removal of default node pool | bool | false | no |
118-
| node_pools | List of maps containing node pools | list | `<list>` | no |
119-
| node_pools_labels | Map of maps containing node labels by node-pool name | map | `<map>` | no |
120-
| node_pools_metadata | Map of maps containing node metadata by node-pool name | map | `<map>` | no |
121-
| node_pools_tags | Map of lists containing node network tags by node-pool name | map | `<map>` | no |
122-
| node_pools_taints | Map of lists containing node taints by node-pool name | map | `<map>` | no |
123-
| 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 |
124-
| non_masquerade_cidrs | List of strings in CIDR notation that specify the IP address ranges that do not use IP masquerading. | list | `<list>` | no |
125-
| project_id | The project ID to host the cluster in (required) | string | - | yes |
118+
| network\_policy | Enable network policy addon | string | `false` | no |
119+
| network\_project\_id | The project ID of the shared VPC's host (for shared vpc support) | string | `` | no |
120+
| node\_pools | List of maps containing node pools | list | `<list>` | no |
121+
| node\_pools\_labels | Map of maps containing node labels by node-pool name | map | `<map>` | no |
122+
| node\_pools\_tags | Map of lists containing node network tags by node-pool name | map | `<map>` | no |
123+
| node\_pools\_taints | Map of lists containing node taints by node-pool name | map | `<map>` | no |
124+
| 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 |
125+
| non\_masquerade\_cidrs | List of strings in CIDR notation that specify the IP address ranges that do not use IP masquerading. | list | `<list>` | no |
126+
| project\_id | The project ID to host the cluster in (required) | string | - | yes |
126127
| region | The region to host the cluster in (required) | string | - | yes |
127128
| regional | Whether is a regional cluster (zonal cluster if set false. WARNING: changing this after cluster creation is destructive!) | string | `true` | no |
128-
| 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 |
129-
| 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 |
129+
| remove\_default\_node\_pool | Remove default node pool while setting up the cluster | string | `false` | no |
130+
| 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 |
131+
| 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 |
130132
| subnetwork | The subnetwork to host the cluster in (required) | string | - | yes |
131133
| zones | The zones to host the cluster in (optional if regional cluster / required if zonal) | list | `<list>` | no |
132134

133135
## Outputs
134136

135137
| Name | Description |
136138
|------|-------------|
137-
| ca_certificate | Cluster ca certificate (base64 encoded) |
139+
| ca\_certificate | Cluster ca certificate (base64 encoded) |
138140
| endpoint | Cluster endpoint |
139-
| horizontal_pod_autoscaling_enabled | Whether horizontal pod autoscaling enabled |
140-
| http_load_balancing_enabled | Whether http load balancing enabled |
141-
| kubernetes_dashboard_enabled | Whether kubernetes dashboard enabled |
141+
| horizontal\_pod\_autoscaling\_enabled | Whether horizontal pod autoscaling enabled |
142+
| http\_load\_balancing\_enabled | Whether http load balancing enabled |
143+
| kubernetes\_dashboard\_enabled | Whether kubernetes dashboard enabled |
142144
| location | Cluster location (region if regional cluster, zone if zonal cluster) |
143-
| logging_service | Logging service used |
144-
| master_authorized_networks_config | Networks from which access to master is permitted |
145-
| master_version | Current master kubernetes version |
146-
| min_master_version | Minimum master kubernetes version |
147-
| monitoring_service | Monitoring service used |
145+
| logging\_service | Logging service used |
146+
| master\_authorized\_networks\_config | Networks from which access to master is permitted |
147+
| master\_version | Current master kubernetes version |
148+
| min\_master\_version | Minimum master kubernetes version |
149+
| monitoring\_service | Monitoring service used |
148150
| name | Cluster name |
149-
| network_policy_enabled | Whether network policy enabled |
150-
| node_pools_names | List of node pools names |
151-
| node_pools_versions | List of node pools versions |
151+
| network\_policy\_enabled | Whether network policy enabled |
152+
| node\_pools\_names | List of node pools names |
153+
| node\_pools\_versions | List of node pools versions |
152154
| region | Cluster region |
153155
| type | Cluster type (regional / zonal) |
154156
| zones | List of zones in which the cluster resides |
155157

156-
[^]: (autogen_docs_end
158+
[^]: (autogen_docs_end)
157159

158160
## Requirements
159161

‎examples/deploy_service/README.md

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -10,37 +10,37 @@ It will:
1010

1111
[^]: (autogen_docs_start)
1212

13-
1413
## Inputs
1514

1615
| Name | Description | Type | Default | Required |
1716
|------|-------------|:----:|:-----:|:-----:|
18-
| compute_engine_service_account | Service account to associate to the nodes in the cluster | string | - | yes |
19-
| credentials_path | The path to the GCP credentials JSON file | string | - | yes |
20-
| ip_range_pods | The secondary ip range to use for pods | string | - | yes |
21-
| ip_range_services | The secondary ip range to use for pods | string | - | yes |
17+
| cluster\_name\_suffix | A suffix to append to the default cluster name | string | `` | no |
18+
| compute\_engine\_service\_account | Service account to associate to the nodes in the cluster | string | - | yes |
19+
| credentials\_path | The path to the GCP credentials JSON file | string | - | yes |
20+
| ip\_range\_pods | The secondary ip range to use for pods | string | - | yes |
21+
| ip\_range\_services | The secondary ip range to use for pods | string | - | yes |
2222
| network | The VPC network to host the cluster in | string | - | yes |
23-
| project_id | The project ID to host the cluster in | string | - | yes |
23+
| project\_id | The project ID to host the cluster in | string | - | yes |
2424
| region | The region to host the cluster in | string | - | yes |
2525
| subnetwork | The subnetwork to host the cluster in | string | - | yes |
2626

2727
## Outputs
2828

2929
| Name | Description |
3030
|------|-------------|
31-
| ca_certificate | |
32-
| client_token | |
33-
| cluster_name | Cluster name |
34-
| credentials_path | |
35-
| ip_range_pods | The secondary IP range used for pods |
36-
| ip_range_services | The secondary IP range used for services |
37-
| kubernetes_endpoint | |
38-
| location | |
39-
| master_kubernetes_version | The master Kubernetes version |
40-
| network | |
41-
| project_id | |
42-
| region | |
43-
| subnetwork | |
31+
| ca\_certificate | - |
32+
| client\_token | - |
33+
| cluster\_name | Cluster name |
34+
| credentials\_path | - |
35+
| ip\_range\_pods | The secondary IP range used for pods |
36+
| ip\_range\_services | The secondary IP range used for services |
37+
| kubernetes\_endpoint | - |
38+
| location | - |
39+
| master\_kubernetes\_version | The master Kubernetes version |
40+
| network | - |
41+
| project\_id | - |
42+
| region | - |
43+
| subnetwork | - |
4444
| zones | List of zones in which the cluster resides |
4545

4646
[^]: (autogen_docs_end)

‎examples/disable_client_cert/README.md

Lines changed: 35 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,44 @@ This example illustrates how to create a simple cluster and disable deprecate se
77

88
[^]: (autogen_docs_start)
99

10+
## Inputs
11+
12+
| Name | Description | Type | Default | Required |
13+
|------|-------------|:----:|:-----:|:-----:|
14+
| cluster\_name\_suffix | A suffix to append to the default cluster name | string | `` | no |
15+
| compute\_engine\_service\_account | Service account to associate to the nodes in the cluster | string | - | yes |
16+
| credentials\_path | The path to the GCP credentials JSON file | string | - | yes |
17+
| ip\_range\_pods | The secondary ip range to use for pods | string | - | yes |
18+
| ip\_range\_services | The secondary ip range to use for pods | string | - | yes |
19+
| network | The VPC network to host the cluster in | string | - | yes |
20+
| network\_project\_id | The GCP project housing the VPC network to host the cluster in | string | - | yes |
21+
| project\_id | The project ID to host the cluster in | string | - | yes |
22+
| region | The region to host the cluster in | string | - | yes |
23+
| subnetwork | The subnetwork to host the cluster in | string | - | yes |
24+
25+
## Outputs
26+
27+
| Name | Description |
28+
|------|-------------|
29+
| ca\_certificate | - |
30+
| client\_token | - |
31+
| cluster\_name | Cluster name |
32+
| credentials\_path | - |
33+
| ip\_range\_pods | The secondary IP range used for pods |
34+
| ip\_range\_services | The secondary IP range used for services |
35+
| kubernetes\_endpoint | - |
36+
| location | - |
37+
| master\_kubernetes\_version | The master Kubernetes version |
38+
| network | - |
39+
| project\_id | - |
40+
| region | - |
41+
| subnetwork | - |
42+
| zones | List of zones in which the cluster resides |
43+
1044
[^]: (autogen_docs_end)
1145

1246
To provision this example, run the following from within this directory:
1347
- `terraform init` to get the plugins
1448
- `terraform plan` to see the infrastructure plan
1549
- `terraform apply` to apply the infrastructure build
16-
- `terraform destroy` to destroy the built infrastructure
50+
- `terraform destroy` to destroy the built infrastructure

‎examples/node_pool/README.md

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -4,37 +4,37 @@ This example illustrates how to create a cluster with multiple custom node-pool
44

55
[^]: (autogen_docs_start)
66

7-
87
## Inputs
98

109
| Name | Description | Type | Default | Required |
1110
|------|-------------|:----:|:-----:|:-----:|
12-
| compute_engine_service_account | Service account to associate to the nodes in the cluster | string | - | yes |
13-
| credentials_path | The path to the GCP credentials JSON file | string | - | yes |
14-
| ip_range_pods | The secondary ip range to use for pods | string | - | yes |
15-
| ip_range_services | The secondary ip range to use for pods | string | - | yes |
11+
| cluster\_name\_suffix | A suffix to append to the default cluster name | string | `` | no |
12+
| compute\_engine\_service\_account | Service account to associate to the nodes in the cluster | string | - | yes |
13+
| credentials\_path | The path to the GCP credentials JSON file | string | - | yes |
14+
| ip\_range\_pods | The secondary ip range to use for pods | string | - | yes |
15+
| ip\_range\_services | The secondary ip range to use for pods | string | - | yes |
1616
| network | The VPC network to host the cluster in | string | - | yes |
17-
| project_id | The project ID to host the cluster in | string | - | yes |
17+
| project\_id | The project ID to host the cluster in | string | - | yes |
1818
| region | The region to host the cluster in | string | - | yes |
1919
| subnetwork | The subnetwork to host the cluster in | string | - | yes |
2020

2121
## Outputs
2222

2323
| Name | Description |
2424
|------|-------------|
25-
| ca_certificate | |
26-
| client_token | |
27-
| cluster_name | Cluster name |
28-
| credentials_path | |
29-
| ip_range_pods | The secondary IP range used for pods |
30-
| ip_range_services | The secondary IP range used for services |
31-
| kubernetes_endpoint | |
32-
| location | |
33-
| master_kubernetes_version | The master Kubernetes version |
34-
| network | |
35-
| project_id | |
36-
| region | |
37-
| subnetwork | |
25+
| ca\_certificate | - |
26+
| client\_token | - |
27+
| cluster\_name | Cluster name |
28+
| credentials\_path | - |
29+
| ip\_range\_pods | The secondary IP range used for pods |
30+
| ip\_range\_services | The secondary IP range used for services |
31+
| kubernetes\_endpoint | - |
32+
| location | - |
33+
| master\_kubernetes\_version | The master Kubernetes version |
34+
| network | - |
35+
| project\_id | - |
36+
| region | - |
37+
| subnetwork | - |
3838
| zones | List of zones in which the cluster resides |
3939

4040
[^]: (autogen_docs_end)

‎examples/shared_vpc/README.md

Lines changed: 35 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,44 @@ This example illustrates how to create a simple cluster where the host network i
44

55
[^]: (autogen_docs_start)
66

7+
## Inputs
8+
9+
| Name | Description | Type | Default | Required |
10+
|------|-------------|:----:|:-----:|:-----:|
11+
| cluster\_name\_suffix | A suffix to append to the default cluster name | string | `` | no |
12+
| compute\_engine\_service\_account | Service account to associate to the nodes in the cluster | string | - | yes |
13+
| credentials\_path | The path to the GCP credentials JSON file | string | - | yes |
14+
| ip\_range\_pods | The secondary ip range to use for pods | string | - | yes |
15+
| ip\_range\_services | The secondary ip range to use for pods | string | - | yes |
16+
| network | The VPC network to host the cluster in | string | - | yes |
17+
| network\_project\_id | The GCP project housing the VPC network to host the cluster in | string | - | yes |
18+
| project\_id | The project ID to host the cluster in | string | - | yes |
19+
| region | The region to host the cluster in | string | - | yes |
20+
| subnetwork | The subnetwork to host the cluster in | string | - | yes |
21+
22+
## Outputs
23+
24+
| Name | Description |
25+
|------|-------------|
26+
| ca\_certificate | - |
27+
| client\_token | - |
28+
| cluster\_name | Cluster name |
29+
| credentials\_path | - |
30+
| ip\_range\_pods | The secondary IP range used for pods |
31+
| ip\_range\_services | The secondary IP range used for services |
32+
| kubernetes\_endpoint | - |
33+
| location | - |
34+
| master\_kubernetes\_version | The master Kubernetes version |
35+
| network | - |
36+
| project\_id | - |
37+
| region | - |
38+
| subnetwork | - |
39+
| zones | List of zones in which the cluster resides |
40+
741
[^]: (autogen_docs_end)
842

943
To provision this example, run the following from within this directory:
1044
- `terraform init` to get the plugins
1145
- `terraform plan` to see the infrastructure plan
1246
- `terraform apply` to apply the infrastructure build
13-
- `terraform destroy` to destroy the built infrastructure
47+
- `terraform destroy` to destroy the built infrastructure

0 commit comments

Comments
 (0)