Skip to content

Commit 6b927e5

Browse files
apeabodyapeabody
authored
fix: regenerate docs (#1733)
1 parent 426f06f commit 6b927e5

File tree

9 files changed

+108
-118
lines changed

9 files changed

+108
-118
lines changed

‎examples/safer_cluster_iap_bastion/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,4 +71,4 @@ To deploy this example:
7171
| router\_name | Name of the router that was created |
7272
| subnet\_name | The name of the VPC subnet being created |
7373

74-
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
74+
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->

‎examples/simple_regional_private_beta/README.md‎

Lines changed: 22 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -2,45 +2,42 @@
22

33
This example illustrates how to create a simple private cluster with beta features.
44

5-
[^]: (autogen_docs_start)
6-
5+
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
76
## Inputs
87

98
| Name | Description | Type | Default | Required |
10-
|------|-------------|:----:|:-----:|:-----:|
11-
| cloudrun | Boolean to enable / disable CloudRun | string | `"true"` | no |
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 | n/a | yes |
14-
| credentials\_path | The path to the GCP credentials JSON file | string | n/a | yes |
15-
| ip\_range\_pods | The secondary ip range to use for pods | string | n/a | yes |
16-
| ip\_range\_services | The secondary ip range to use for pods | string | n/a | yes |
17-
| istio | Boolean to enable / disable Istio | string | `"true"` | no |
18-
| network | The VPC network to host the cluster in | string | n/a | yes |
19-
| project\_id | The project ID to host the cluster in | string | n/a | yes |
20-
| region | The region to host the cluster in | string | n/a | yes |
21-
| subnetwork | The subnetwork to host the cluster in | string | n/a | yes |
9+
|------|-------------|------|---------|:--------:|
10+
| cluster\_name\_suffix | A suffix to append to the default cluster name | `string` | `""` | no |
11+
| compute\_engine\_service\_account | Service account to associate to the nodes in the cluster | `any` | n/a | yes |
12+
| dns\_cache | Boolean to enable / disable NodeLocal DNSCache | `bool` | `false` | no |
13+
| gce\_pd\_csi\_driver | (Beta) Whether this cluster should enable the Google Compute Engine Persistent Disk Container Storage Interface (CSI) Driver. | `bool` | `false` | no |
14+
| ip\_range\_pods | The secondary ip range to use for pods | `any` | n/a | yes |
15+
| ip\_range\_services | The secondary ip range to use for services | `any` | n/a | yes |
16+
| network | The VPC network to host the cluster in | `any` | n/a | yes |
17+
| project\_id | The project ID to host the cluster in | `any` | n/a | yes |
18+
| region | The region to host the cluster in | `any` | n/a | yes |
19+
| subnetwork | The subnetwork to host the cluster in | `any` | n/a | yes |
2220

2321
## Outputs
2422

2523
| Name | Description |
2624
|------|-------------|
27-
| ca\_certificate | |
28-
| client\_token | |
25+
| ca\_certificate | n/a |
26+
| client\_token | n/a |
2927
| cluster\_name | Cluster name |
30-
| credentials\_path | |
3128
| ip\_range\_pods | The secondary IP range used for pods |
3229
| ip\_range\_services | The secondary IP range used for services |
33-
| kubernetes\_endpoint | |
34-
| location | |
30+
| kubernetes\_endpoint | n/a |
31+
| location | n/a |
3532
| master\_kubernetes\_version | The master Kubernetes version |
36-
| network | |
37-
| project\_id | |
38-
| region | |
39-
| service\_account | The service account to default running nodes as if not overridden in `node_pools`. |
40-
| subnetwork | |
33+
| network | n/a |
34+
| project\_id | n/a |
35+
| region | n/a |
36+
| service\_account | The default service account used for running nodes. |
37+
| subnetwork | n/a |
4138
| zones | List of zones in which the cluster resides |
4239

43-
[^]: (autogen_docs_end)
40+
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
4441

4542
To provision this example, run the following from within this directory:
4643
- `terraform init` to get the plugins

‎examples/simple_regional_private_with_cluster_version/README.md‎

Lines changed: 21 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -2,45 +2,41 @@
22

33
This example illustrates how to create a simple private cluster with beta features.
44

5-
[^]: (autogen_docs_start)
6-
5+
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
76
## Inputs
87

98
| Name | Description | Type | Default | Required |
10-
|------|-------------|:----:|:-----:|:-----:|
11-
| cloudrun | Boolean to enable / disable CloudRun | string | `"true"` | no |
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 | n/a | yes |
14-
| credentials\_path | The path to the GCP credentials JSON file | string | n/a | yes |
15-
| ip\_range\_pods | The secondary ip range to use for pods | string | n/a | yes |
16-
| ip\_range\_services | The secondary ip range to use for pods | string | n/a | yes |
17-
| istio | Boolean to enable / disable Istio | string | `"true"` | no |
18-
| network | The VPC network to host the cluster in | string | n/a | yes |
19-
| project\_id | The project ID to host the cluster in | string | n/a | yes |
20-
| region | The region to host the cluster in | string | n/a | yes |
21-
| subnetwork | The subnetwork to host the cluster in | string | n/a | yes |
9+
|------|-------------|------|---------|:--------:|
10+
| cluster\_name\_suffix | A suffix to append to the default cluster name | `string` | `""` | no |
11+
| compute\_engine\_service\_account | Service account to associate to the nodes in the cluster | `any` | n/a | yes |
12+
| ip\_range\_pods | The secondary ip range to use for pods | `any` | n/a | yes |
13+
| ip\_range\_services | The secondary ip range to use for services | `any` | n/a | yes |
14+
| 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 |
15+
| network | The VPC network to host the cluster in | `any` | n/a | yes |
16+
| project\_id | The project ID to host the cluster in | `any` | n/a | yes |
17+
| region | The region to host the cluster in | `any` | n/a | yes |
18+
| subnetwork | The subnetwork to host the cluster in | `any` | n/a | yes |
2219

2320
## Outputs
2421

2522
| Name | Description |
2623
|------|-------------|
27-
| ca\_certificate | |
28-
| client\_token | |
24+
| ca\_certificate | n/a |
25+
| client\_token | n/a |
2926
| cluster\_name | Cluster name |
30-
| credentials\_path | |
3127
| ip\_range\_pods | The secondary IP range used for pods |
3228
| ip\_range\_services | The secondary IP range used for services |
33-
| kubernetes\_endpoint | |
34-
| location | |
29+
| kubernetes\_endpoint | n/a |
30+
| location | n/a |
3531
| master\_kubernetes\_version | The master Kubernetes version |
36-
| network | |
37-
| project\_id | |
38-
| region | |
39-
| service\_account | The service account to default running nodes as if not overridden in `node_pools`. |
40-
| subnetwork | |
32+
| network | n/a |
33+
| project\_id | n/a |
34+
| region | n/a |
35+
| service\_account | The default service account used for running nodes. |
36+
| subnetwork | n/a |
4137
| zones | List of zones in which the cluster resides |
4238

43-
[^]: (autogen_docs_end)
39+
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
4440

4541
To provision this example, run the following from within this directory:
4642
- `terraform init` to get the plugins

‎examples/stub_domains_upstream_nameservers/README.md‎

Lines changed: 20 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -7,41 +7,40 @@ It will:
77
- Remove the default kube-dns configmap
88
- Add a new kube-dns configmap with custom stub domains and upstream nameservers
99

10-
[^]: (autogen_docs_start)
11-
10+
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
1211
## Inputs
1312

1413
| Name | Description | Type | Default | Required |
15-
|------|-------------|:----:|:-----:|:-----:|
16-
| cluster\_name\_suffix | A suffix to append to the default cluster name | string | `""` | no |
17-
| compute\_engine\_service\_account | Service account to associate to the nodes in the cluster | string | n/a | yes |
18-
| ip\_range\_pods | The secondary ip range to use for pods | string | n/a | yes |
19-
| ip\_range\_services | The secondary ip range to use for pods | string | n/a | yes |
20-
| network | The VPC network to host the cluster in | string | n/a | yes |
21-
| project\_id | The project ID to host the cluster in | string | n/a | yes |
22-
| region | The region to host the cluster in | string | n/a | yes |
23-
| subnetwork | The subnetwork to host the cluster in | string | n/a | yes |
14+
|------|-------------|------|---------|:--------:|
15+
| cluster\_name\_suffix | A suffix to append to the default cluster name | `string` | `""` | no |
16+
| compute\_engine\_service\_account | Service account to associate to the nodes in the cluster | `any` | n/a | yes |
17+
| ip\_range\_pods | The secondary ip range to use for pods | `any` | n/a | yes |
18+
| ip\_range\_services | The secondary ip range to use for services | `any` | n/a | yes |
19+
| network | The VPC network to host the cluster in | `any` | n/a | yes |
20+
| project\_id | The project ID to host the cluster in | `any` | n/a | yes |
21+
| region | The region to host the cluster in | `any` | n/a | yes |
22+
| subnetwork | The subnetwork to host the cluster in | `any` | n/a | yes |
2423

2524
## Outputs
2625

2726
| Name | Description |
2827
|------|-------------|
29-
| ca\_certificate | |
30-
| client\_token | |
28+
| ca\_certificate | n/a |
29+
| client\_token | n/a |
3130
| cluster\_name | Cluster name |
3231
| ip\_range\_pods | The secondary IP range used for pods |
3332
| ip\_range\_services | The secondary IP range used for services |
34-
| kubernetes\_endpoint | |
35-
| location | |
33+
| kubernetes\_endpoint | n/a |
34+
| location | n/a |
3635
| master\_kubernetes\_version | The master Kubernetes version |
37-
| network | |
38-
| project\_id | |
39-
| region | |
40-
| service\_account | The service account to default running nodes as if not overridden in `node_pools`. |
41-
| subnetwork | |
36+
| network | n/a |
37+
| project\_id | n/a |
38+
| region | n/a |
39+
| service\_account | The default service account used for running nodes. |
40+
| subnetwork | n/a |
4241
| zones | List of zones in which the cluster resides |
4342

44-
[^]: (autogen_docs_end)
43+
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
4544

4645
To provision this example, run the following from within this directory:
4746
- `terraform init` to get the plugins

‎examples/upstream_nameservers/README.md‎

Lines changed: 20 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -7,41 +7,40 @@ It will:
77
- Remove the default kube-dns configmap
88
- Add a new kube-dns configmap with custom upstream nameservers
99

10-
[^]: (autogen_docs_start)
11-
10+
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
1211
## Inputs
1312

1413
| Name | Description | Type | Default | Required |
15-
|------|-------------|:----:|:-----:|:-----:|
16-
| cluster\_name\_suffix | A suffix to append to the default cluster name | string | `""` | no |
17-
| compute\_engine\_service\_account | Service account to associate to the nodes in the cluster | string | n/a | yes |
18-
| ip\_range\_pods | The secondary ip range to use for pods | string | n/a | yes |
19-
| ip\_range\_services | The secondary ip range to use for pods | string | n/a | yes |
20-
| network | The VPC network to host the cluster in | string | n/a | yes |
21-
| project\_id | The project ID to host the cluster in | string | n/a | yes |
22-
| region | The region to host the cluster in | string | n/a | yes |
23-
| subnetwork | The subnetwork to host the cluster in | string | n/a | yes |
14+
|------|-------------|------|---------|:--------:|
15+
| cluster\_name\_suffix | A suffix to append to the default cluster name | `string` | `""` | no |
16+
| compute\_engine\_service\_account | Service account to associate to the nodes in the cluster | `any` | n/a | yes |
17+
| ip\_range\_pods | The secondary ip range to use for pods | `any` | n/a | yes |
18+
| ip\_range\_services | The secondary ip range to use for services | `any` | n/a | yes |
19+
| network | The VPC network to host the cluster in | `any` | n/a | yes |
20+
| project\_id | The project ID to host the cluster in | `any` | n/a | yes |
21+
| region | The region to host the cluster in | `any` | n/a | yes |
22+
| subnetwork | The subnetwork to host the cluster in | `any` | n/a | yes |
2423

2524
## Outputs
2625

2726
| Name | Description |
2827
|------|-------------|
29-
| ca\_certificate | |
30-
| client\_token | |
28+
| ca\_certificate | n/a |
29+
| client\_token | n/a |
3130
| cluster\_name | Cluster name |
3231
| ip\_range\_pods | The secondary IP range used for pods |
3332
| ip\_range\_services | The secondary IP range used for services |
34-
| kubernetes\_endpoint | |
35-
| location | |
33+
| kubernetes\_endpoint | n/a |
34+
| location | n/a |
3635
| master\_kubernetes\_version | The master Kubernetes version |
37-
| network | |
38-
| project\_id | |
39-
| region | |
40-
| service\_account | The service account to default running nodes as if not overridden in `node_pools`. |
41-
| subnetwork | |
36+
| network | n/a |
37+
| project\_id | n/a |
38+
| region | n/a |
39+
| service\_account | The default service account used for running nodes. |
40+
| subnetwork | n/a |
4241
| zones | List of zones in which the cluster resides |
4342

44-
[^]: (autogen_docs_end)
43+
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
4544

4645
To provision this example, run the following from within this directory:
4746
- `terraform init` to get the plugins

‎examples/workload_metadata_config/README.md‎

Lines changed: 21 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -2,42 +2,41 @@
22

33
This example illustrates how to use a cluster with `workload_metadata_config` defined.
44

5-
[^]: (autogen_docs_start)
6-
5+
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
76
## Inputs
87

98
| 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 | n/a | yes |
13-
| ip\_range\_pods | The secondary ip range to use for pods | string | n/a | yes |
14-
| ip\_range\_services | The secondary ip range to use for pods | string | n/a | yes |
15-
| network | The VPC network to host the cluster in | string | n/a | yes |
16-
| project\_id | The project ID to host the cluster in | string | n/a | yes |
17-
| region | The region to host the cluster in | string | n/a | yes |
18-
| subnetwork | The subnetwork to host the cluster in | string | n/a | yes |
19-
| zones | The zone to host the cluster in (required if is a zonal cluster) | list | n/a | yes |
9+
|------|-------------|------|---------|:--------:|
10+
| cluster\_name\_suffix | A suffix to append to the default cluster name | `string` | `""` | no |
11+
| ip\_range\_pods | The secondary ip range to use for pods | `any` | n/a | yes |
12+
| ip\_range\_services | The secondary ip range to use for services | `any` | n/a | yes |
13+
| network | The VPC network to host the cluster in | `any` | n/a | yes |
14+
| project\_id | The project ID to host the cluster in | `any` | n/a | yes |
15+
| region | The region to host the cluster in | `any` | n/a | yes |
16+
| registry\_project\_ids | Project names for GCR registries | `list(string)` | n/a | yes |
17+
| subnetwork | The subnetwork to host the cluster in | `any` | n/a | yes |
18+
| zones | The zone to host the cluster in (required if is a zonal cluster) | `list(string)` | n/a | yes |
2019

2120
## Outputs
2221

2322
| Name | Description |
2423
|------|-------------|
25-
| ca\_certificate | |
26-
| client\_token | |
24+
| ca\_certificate | n/a |
25+
| client\_token | n/a |
2726
| cluster\_name | Cluster name |
2827
| ip\_range\_pods | The secondary IP range used for pods |
2928
| ip\_range\_services | The secondary IP range used for services |
30-
| kubernetes\_endpoint | |
31-
| location | |
29+
| kubernetes\_endpoint | n/a |
30+
| location | n/a |
3231
| 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 | |
32+
| network | n/a |
33+
| project\_id | n/a |
34+
| region | n/a |
35+
| service\_account | The default service account used for running nodes. |
36+
| subnetwork | n/a |
3837
| zones | List of zones in which the cluster resides |
3938

40-
[^]: (autogen_docs_end)
39+
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
4140

4241
To provision this example, run the following from within this directory:
4342
- `terraform init` to get the plugins

‎modules/acm/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -111,4 +111,4 @@ data "google_client_config" "default" {}
111111
| git\_creds\_public | Public key of SSH keypair to allow the Anthos Config Management Operator to authenticate to your Git repository. |
112112
| wait | An output to use when you want to depend on cmd finishing |
113113

114-
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
114+
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->

‎modules/fleet-membership/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,4 +39,4 @@ To deploy this config:
3939
| cluster\_membership\_id | The ID of the hub membership |
4040
| wait | An output to use when you want to depend on registration finishing |
4141

42-
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
42+
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->

‎modules/hub-legacy/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,4 +56,4 @@ To deploy this config:
5656
|------|-------------|
5757
| wait | An output to use when you want to depend on registration finishing |
5858

59-
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
59+
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->

0 commit comments

Comments
 (0)