Skip to content

Commit 5e259cb

Browse files
JberlinskyJberlinsky
committed
Regenerate READMEs
1 parent ad75fbf commit 5e259cb

File tree

10 files changed

+362
-93
lines changed

10 files changed

+362
-93
lines changed

‎README.md‎

Lines changed: 46 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -97,65 +97,66 @@ In either case, upgrading to module version `v1.0.0` will trigger a recreation o
9797

9898
[^]: (autogen_docs_start)
9999

100+
100101
## Inputs
101102

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

138139
## Outputs
139140

140141
| Name | Description |
141142
|------|-------------|
142-
| ca\_certificate | Cluster ca certificate (base64 encoded) |
143+
| ca_certificate | Cluster ca certificate (base64 encoded) |
143144
| endpoint | Cluster endpoint |
144-
| horizontal\_pod\_autoscaling\_enabled | Whether horizontal pod autoscaling enabled |
145-
| http\_load\_balancing\_enabled | Whether http load balancing enabled |
146-
| kubernetes\_dashboard\_enabled | Whether kubernetes dashboard enabled |
145+
| horizontal_pod_autoscaling_enabled | Whether horizontal pod autoscaling enabled |
146+
| http_load_balancing_enabled | Whether http load balancing enabled |
147+
| kubernetes_dashboard_enabled | Whether kubernetes dashboard enabled |
147148
| location | Cluster location (region if regional cluster, zone if zonal cluster) |
148-
| logging\_service | Logging service used |
149-
| master\_authorized\_networks\_config | Networks from which access to master is permitted |
150-
| master\_version | Current master kubernetes version |
151-
| min\_master\_version | Minimum master kubernetes version |
152-
| monitoring\_service | Monitoring service used |
149+
| logging_service | Logging service used |
150+
| master_authorized_networks_config | Networks from which access to master is permitted |
151+
| master_version | Current master kubernetes version |
152+
| min_master_version | Minimum master kubernetes version |
153+
| monitoring_service | Monitoring service used |
153154
| name | Cluster name |
154-
| network\_policy\_enabled | Whether network policy enabled |
155-
| node\_pools\_names | List of node pools names |
156-
| node\_pools\_versions | List of node pools versions |
155+
| network_policy_enabled | Whether network policy enabled |
156+
| node_pools_names | List of node pools names |
157+
| node_pools_versions | List of node pools versions |
157158
| region | Cluster region |
158-
| service\_account | The service account to default running nodes as if not overridden in `node_pools`. |
159+
| service_account | The service account to default running nodes as if not overridden in `node_pools`. |
159160
| type | Cluster type (regional / zonal) |
160161
| zones | List of zones in which the cluster resides |
161162

‎examples/deploy_service/README.md‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,39 @@ It will:
1010

1111
[^]: (autogen_docs_start)
1212

13+
14+
## Inputs
15+
16+
| Name | Description | Type | Default | Required |
17+
|------|-------------|:----:|:-----:|:-----:|
18+
| cluster_name_suffix | A suffix to append to the default cluster name | string | `` | no |
19+
| compute_engine_service_account | Service account to associate to the nodes in the cluster | 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 |
22+
| network | The VPC network to host the cluster in | string | - | yes |
23+
| project_id | The project ID to host the cluster in | string | - | yes |
24+
| region | The region to host the cluster in | string | - | yes |
25+
| subnetwork | The subnetwork to host the cluster in | string | - | yes |
26+
27+
## Outputs
28+
29+
| Name | Description |
30+
|------|-------------|
31+
| ca_certificate | |
32+
| client_token | |
33+
| cluster_name | Cluster name |
34+
| ip_range_pods | The secondary IP range used for pods |
35+
| ip_range_services | The secondary IP range used for services |
36+
| kubernetes_endpoint | |
37+
| location | |
38+
| master_kubernetes_version | The master Kubernetes version |
39+
| network | |
40+
| project_id | |
41+
| region | |
42+
| service_account | The service account to default running nodes as if not overridden in `node_pools`. |
43+
| subnetwork | |
44+
| zones | List of zones in which the cluster resides |
45+
1346
[^]: (autogen_docs_end)
1447

1548
To provision this example, run the following from within this directory:

‎examples/node_pool/README.md‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,40 @@ This example illustrates how to create a cluster with multiple custom node-pool
2020

2121
[^]: (autogen_docs_start)
2222

23+
24+
## Inputs
25+
26+
| Name | Description | Type | Default | Required |
27+
|------|-------------|:----:|:-----:|:-----:|
28+
| cluster_name_suffix | A suffix to append to the default cluster name | string | `` | no |
29+
| compute_engine_service_account | Service account to associate to the nodes in the cluster | string | - | yes |
30+
| ip_range_pods | The secondary ip range to use for pods | string | - | yes |
31+
| ip_range_services | The secondary ip range to use for pods | string | - | yes |
32+
| network | The VPC network to host the cluster in | string | - | yes |
33+
| project_id | The project ID to host the cluster in | string | - | yes |
34+
| region | The region to host the cluster in | string | - | yes |
35+
| subnetwork | The subnetwork to host the cluster in | string | - | yes |
36+
| zones | The zone to host the cluster in (required if is a zonal cluster) | list | - | yes |
37+
38+
## Outputs
39+
40+
| Name | Description |
41+
|------|-------------|
42+
| ca_certificate | |
43+
| client_token | |
44+
| cluster_name | Cluster name |
45+
| ip_range_pods | The secondary IP range used for pods |
46+
| ip_range_services | The secondary IP range used for services |
47+
| kubernetes_endpoint | |
48+
| location | |
49+
| master_kubernetes_version | The master Kubernetes version |
50+
| network | |
51+
| project_id | |
52+
| region | |
53+
| service_account | The service account to default running nodes as if not overridden in `node_pools`. |
54+
| subnetwork | |
55+
| zones | List of zones in which the cluster resides |
56+
2357
[^]: (autogen_docs_end)
2458

2559
To provision this example, run the following from within this directory:

‎examples/shared_vpc/README.md‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,40 @@ This example illustrates how to create a simple cluster where the host network i
44

55
[^]: (autogen_docs_start)
66

7+
8+
## Inputs
9+
10+
| Name | Description | Type | Default | Required |
11+
|------|-------------|:----:|:-----:|:-----:|
12+
| cluster_name_suffix | A suffix to append to the default cluster name | string | `` | no |
13+
| compute_engine_service_account | Service account to associate to the nodes in the cluster | 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+
| 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+
| service_account | The service account to default running nodes as if not overridden in `node_pools`. |
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:

‎examples/simple_regional/README.md‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,39 @@ This example illustrates how to create a simple cluster.
44

55
[^]: (autogen_docs_start)
66

7+
8+
## Inputs
9+
10+
| Name | Description | Type | Default | Required |
11+
|------|-------------|:----:|:-----:|:-----:|
12+
| cluster_name_suffix | A suffix to append to the default cluster name | string | `` | no |
13+
| compute_engine_service_account | Service account to associate to the nodes in the cluster | 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+
| project_id | The project ID to host the cluster in | string | - | yes |
18+
| region | The region to host the cluster in | string | - | yes |
19+
| subnetwork | The subnetwork to host the cluster in | string | - | yes |
20+
21+
## Outputs
22+
23+
| Name | Description |
24+
|------|-------------|
25+
| ca_certificate | |
26+
| client_token | |
27+
| cluster_name | Cluster name |
28+
| ip_range_pods | The secondary IP range used for pods |
29+
| ip_range_services | The secondary IP range used for services |
30+
| kubernetes_endpoint | |
31+
| location | |
32+
| master_kubernetes_version | The master Kubernetes version |
33+
| network | |
34+
| project_id | |
35+
| region | |
36+
| service_account | The service account to default running nodes as if not overridden in `node_pools`. |
37+
| subnetwork | |
38+
| zones | List of zones in which the cluster resides |
39+
740
[^]: (autogen_docs_end)
841

942
To provision this example, run the following from within this directory:

‎examples/simple_regional_private/README.md‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,39 @@ This example illustrates how to create a simple private cluster.
44

55
[^]: (autogen_docs_start)
66

7+
8+
## Inputs
9+
10+
| Name | Description | Type | Default | Required |
11+
|------|-------------|:----:|:-----:|:-----:|
12+
| cluster_name_suffix | A suffix to append to the default cluster name | string | `` | no |
13+
| compute_engine_service_account | Service account to associate to the nodes in the cluster | 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+
| project_id | The project ID to host the cluster in | string | - | yes |
18+
| region | The region to host the cluster in | string | - | yes |
19+
| subnetwork | The subnetwork to host the cluster in | string | - | yes |
20+
21+
## Outputs
22+
23+
| Name | Description |
24+
|------|-------------|
25+
| ca_certificate | |
26+
| client_token | |
27+
| cluster_name | Cluster name |
28+
| ip_range_pods | The secondary IP range used for pods |
29+
| ip_range_services | The secondary IP range used for services |
30+
| kubernetes_endpoint | |
31+
| location | |
32+
| master_kubernetes_version | The master Kubernetes version |
33+
| network | |
34+
| project_id | |
35+
| region | |
36+
| service_account | The service account to default running nodes as if not overridden in `node_pools`. |
37+
| subnetwork | |
38+
| zones | List of zones in which the cluster resides |
39+
740
[^]: (autogen_docs_end)
841

942
To provision this example, run the following from within this directory:

0 commit comments

Comments
 (0)