Skip to content

Commit 56af31d

Browse files
bharathkkbbharathkkb
authored
chore: Regenerate docs with new tfdocs (#718)
1 parent 621b797 commit 56af31d

File tree

39 files changed

+1042
-1040
lines changed

39 files changed

+1042
-1040
lines changed

‎Makefile‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
# Make will use bash instead of sh
1919
SHELL := /usr/bin/env bash
2020

21-
DOCKER_TAG_VERSION_DEVELOPER_TOOLS := 0.12.0
21+
DOCKER_TAG_VERSION_DEVELOPER_TOOLS := 0.12.1
2222
DOCKER_IMAGE_DEVELOPER_TOOLS := cft/developer-tools
2323
REGISTRY_URL := gcr.io/cloud-foundation-cicd
2424

‎README.md‎

Lines changed: 61 additions & 61 deletions
Large diffs are not rendered by default.

‎build/int.cloudbuild.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -429,6 +429,6 @@ tags:
429429
- 'integration'
430430
substitutions:
431431
_DOCKER_IMAGE_DEVELOPER_TOOLS: 'cft/developer-tools'
432-
_DOCKER_TAG_VERSION_DEVELOPER_TOOLS: '0.12.0'
432+
_DOCKER_TAG_VERSION_DEVELOPER_TOOLS: '0.12.1'
433433
options:
434434
machineType: 'N1_HIGHCPU_8'

‎build/lint.cloudbuild.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,4 +22,4 @@ tags:
2222
- 'lint'
2323
substitutions:
2424
_DOCKER_IMAGE_DEVELOPER_TOOLS: 'cft/developer-tools'
25-
_DOCKER_TAG_VERSION_DEVELOPER_TOOLS: '0.12.0'
25+
_DOCKER_TAG_VERSION_DEVELOPER_TOOLS: '0.12.1'

‎examples/deploy_service/README.md‎

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -12,33 +12,33 @@ It will:
1212
## Inputs
1313

1414
| 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 services | 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 |
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 | `any` | n/a | yes |
18+
| ip\_range\_pods | The secondary ip range to use for pods | `any` | n/a | yes |
19+
| ip\_range\_services | The secondary ip range to use for services | `any` | n/a | yes |
20+
| network | The VPC network to host the cluster in | `any` | n/a | yes |
21+
| project\_id | The project ID to host the cluster in | `any` | n/a | yes |
22+
| region | The region to host the cluster in | `any` | n/a | yes |
23+
| subnetwork | The subnetwork to host the cluster in | `any` | n/a | yes |
2424

2525
## Outputs
2626

2727
| Name | Description |
2828
|------|-------------|
29-
| ca\_certificate | |
30-
| client\_token | |
29+
| ca\_certificate | n/a |
30+
| client\_token | n/a |
3131
| cluster\_name | Cluster name |
3232
| ip\_range\_pods | The secondary IP range used for pods |
3333
| ip\_range\_services | The secondary IP range used for services |
34-
| kubernetes\_endpoint | |
35-
| location | |
34+
| kubernetes\_endpoint | n/a |
35+
| location | n/a |
3636
| master\_kubernetes\_version | The master Kubernetes version |
37-
| network | |
38-
| project\_id | |
39-
| region | |
37+
| network | n/a |
38+
| project\_id | n/a |
39+
| region | n/a |
4040
| service\_account | The default service account used for running nodes. |
41-
| subnetwork | |
41+
| subnetwork | n/a |
4242
| zones | List of zones in which the cluster resides |
4343

4444
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->

‎examples/disable_client_cert/README.md‎

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -9,34 +9,34 @@ This example illustrates how to create a simple cluster and disable deprecated s
99
## Inputs
1010

1111
| Name | Description | Type | Default | Required |
12-
|------|-------------|:----:|:-----:|:-----:|
13-
| cluster\_name\_suffix | A suffix to append to the default cluster name | string | `""` | no |
14-
| compute\_engine\_service\_account | Service account to associate to the nodes in the cluster | 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 services | string | n/a | yes |
17-
| network | The VPC network to host the cluster in | string | n/a | yes |
18-
| network\_project\_id | The GCP project housing 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 |
12+
|------|-------------|------|---------|:--------:|
13+
| cluster\_name\_suffix | A suffix to append to the default cluster name | `string` | `""` | no |
14+
| compute\_engine\_service\_account | Service account to associate to the nodes in the cluster | `any` | n/a | yes |
15+
| ip\_range\_pods | The secondary ip range to use for pods | `any` | n/a | yes |
16+
| ip\_range\_services | The secondary ip range to use for services | `any` | n/a | yes |
17+
| network | The VPC network to host the cluster in | `any` | n/a | yes |
18+
| network\_project\_id | The GCP project housing the VPC network to host the cluster in | `any` | n/a | yes |
19+
| project\_id | The project ID to host the cluster in | `any` | n/a | yes |
20+
| region | The region to host the cluster in | `any` | n/a | yes |
21+
| subnetwork | The subnetwork to host the cluster in | `any` | n/a | yes |
2222

2323
## Outputs
2424

2525
| Name | Description |
2626
|------|-------------|
27-
| ca\_certificate | |
28-
| client\_token | |
27+
| ca\_certificate | n/a |
28+
| client\_token | n/a |
2929
| cluster\_name | Cluster name |
3030
| ip\_range\_pods | The secondary IP range used for pods |
3131
| ip\_range\_services | The secondary IP range used for services |
32-
| kubernetes\_endpoint | |
33-
| location | |
32+
| kubernetes\_endpoint | n/a |
33+
| location | n/a |
3434
| master\_kubernetes\_version | The master Kubernetes version |
35-
| network | |
36-
| project\_id | |
37-
| region | |
35+
| network | n/a |
36+
| project\_id | n/a |
37+
| region | n/a |
3838
| service\_account | The default service account used for running nodes. |
39-
| subnetwork | |
39+
| subnetwork | n/a |
4040
| zones | List of zones in which the cluster resides |
4141

4242
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->

‎examples/node_pool/README.md‎

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -6,35 +6,35 @@ This example illustrates how to create a cluster with multiple custom node-pool
66
## Inputs
77

88
| Name | Description | Type | Default | Required |
9-
|------|-------------|:----:|:-----:|:-----:|
10-
| cluster\_autoscaling | Cluster autoscaling configuration. See [more details](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters#clusterautoscaling) | object | `<map>` | no |
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 services | 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(string) | n/a | yes |
9+
|------|-------------|------|---------|:--------:|
10+
| cluster\_autoscaling | Cluster autoscaling configuration. See [more details](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters#clusterautoscaling) | <pre>object({<br> enabled = bool<br> autoscaling_profile = string<br> min_cpu_cores = number<br> max_cpu_cores = number<br> min_memory_gb = number<br> max_memory_gb = number<br> })</pre> | <pre>{<br> "autoscaling_profile": "BALANCED",<br> "enabled": false,<br> "max_cpu_cores": 0,<br> "max_memory_gb": 0,<br> "min_cpu_cores": 0,<br> "min_memory_gb": 0<br>}</pre> | no |
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 | `any` | n/a | yes |
13+
| ip\_range\_pods | The secondary ip range to use for pods | `any` | n/a | yes |
14+
| ip\_range\_services | The secondary ip range to use for services | `any` | n/a | yes |
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 |
19+
| zones | The zone to host the cluster in (required if is a zonal cluster) | `list(string)` | n/a | yes |
2020

2121
## Outputs
2222

2323
| Name | Description |
2424
|------|-------------|
25-
| ca\_certificate | |
26-
| client\_token | |
25+
| ca\_certificate | n/a |
26+
| client\_token | n/a |
2727
| cluster\_name | Cluster name |
2828
| ip\_range\_pods | The secondary IP range used for pods |
2929
| ip\_range\_services | The secondary IP range used for services |
30-
| kubernetes\_endpoint | |
31-
| location | |
30+
| kubernetes\_endpoint | n/a |
31+
| location | n/a |
3232
| master\_kubernetes\_version | The master Kubernetes version |
33-
| network | |
34-
| project\_id | |
35-
| region | |
33+
| network | n/a |
34+
| project\_id | n/a |
35+
| region | n/a |
3636
| service\_account | The default service account used for running nodes. |
37-
| subnetwork | |
37+
| subnetwork | n/a |
3838
| zones | List of zones in which the cluster resides |
3939

4040
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->

‎examples/node_pool_update_variant/README.md‎

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -6,34 +6,34 @@ This example illustrates how to create a cluster with multiple custom node-pool
66
## Inputs
77

88
| Name | Description | Type | Default | Required |
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 | string | n/a | yes |
12-
| ip\_range\_pods | The secondary ip range to use for pods | string | n/a | yes |
13-
| ip\_range\_services | The secondary ip range to use for services | string | n/a | yes |
14-
| network | The VPC network to host the cluster in | string | n/a | yes |
15-
| project\_id | The project ID to host the cluster in | string | n/a | yes |
16-
| region | The region to host the cluster in | string | n/a | yes |
17-
| subnetwork | The subnetwork to host the cluster in | string | n/a | yes |
18-
| zones | The zone to host the cluster in (required if is a zonal cluster) | list(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+
| network | The VPC network to host the cluster in | `any` | n/a | yes |
15+
| project\_id | The project ID to host the cluster in | `any` | n/a | yes |
16+
| region | The region to host the cluster in | `any` | 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 |
1919

2020
## Outputs
2121

2222
| Name | Description |
2323
|------|-------------|
24-
| ca\_certificate | |
25-
| client\_token | |
24+
| ca\_certificate | n/a |
25+
| client\_token | n/a |
2626
| cluster\_name | Cluster name |
2727
| ip\_range\_pods | The secondary IP range used for pods |
2828
| ip\_range\_services | The secondary IP range used for services |
29-
| kubernetes\_endpoint | |
30-
| location | |
29+
| kubernetes\_endpoint | n/a |
30+
| location | n/a |
3131
| master\_kubernetes\_version | The master Kubernetes version |
32-
| network | |
33-
| project\_id | |
34-
| region | |
32+
| network | n/a |
33+
| project\_id | n/a |
34+
| region | n/a |
3535
| service\_account | The service account to default running nodes as if not overridden in `node_pools`. |
36-
| subnetwork | |
36+
| subnetwork | n/a |
3737
| zones | List of zones in which the cluster resides |
3838

3939
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->

‎examples/node_pool_update_variant_beta/README.md‎

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -6,35 +6,35 @@ This example illustrates how to create a cluster with multiple custom node-pool
66
## Inputs
77

88
| Name | Description | Type | Default | Required |
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 | string | n/a | yes |
12-
| credentials\_path | The path to the GCP credentials JSON file | 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 services | 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(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+
| credentials\_path | The path to the GCP credentials JSON file | `any` | n/a | yes |
13+
| ip\_range\_pods | The secondary ip range to use for pods | `any` | n/a | yes |
14+
| ip\_range\_services | The secondary ip range to use for services | `any` | n/a | yes |
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 |
19+
| zones | The zone to host the cluster in (required if is a zonal cluster) | `list(string)` | n/a | yes |
2020

2121
## Outputs
2222

2323
| Name | Description |
2424
|------|-------------|
25-
| ca\_certificate | |
26-
| client\_token | |
25+
| ca\_certificate | n/a |
26+
| client\_token | n/a |
2727
| cluster\_name | Cluster name |
2828
| ip\_range\_pods | The secondary IP range used for pods |
2929
| ip\_range\_services | The secondary IP range used for services |
30-
| kubernetes\_endpoint | |
31-
| location | |
30+
| kubernetes\_endpoint | n/a |
31+
| location | n/a |
3232
| master\_kubernetes\_version | The master Kubernetes version |
33-
| network | |
34-
| project\_id | |
35-
| region | |
33+
| network | n/a |
34+
| project\_id | n/a |
35+
| region | n/a |
3636
| service\_account | The service account to default running nodes as if not overridden in `node_pools`. |
37-
| subnetwork | |
37+
| subnetwork | n/a |
3838
| zones | List of zones in which the cluster resides |
3939

4040
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->

‎examples/regional_private_node_pool_oauth_scopes/README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ This example illustrates how to create a private cluster with node pool specific
66
## Inputs
77

88
| Name | Description | Type | Default | Required |
9-
|------|-------------|:----:|:-----:|:-----:|
10-
| project\_id | The project ID to host the cluster in | string | n/a | yes |
9+
|------|-------------|------|---------|:--------:|
10+
| project\_id | The project ID to host the cluster in | `any` | n/a | yes |
1111

1212
## Outputs
1313

0 commit comments

Comments
 (0)