Skip to content

Commit c195638

Browse files
author
sylvio.pedroza
committed
make generate && make generate_docs
1 parent 433cab0 commit c195638

File tree

14 files changed

+4
-315
lines changed

14 files changed

+4
-315
lines changed

‎README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -125,6 +125,7 @@ Version 1.0.0 of this module introduces a breaking change: adding the `disable-l
125125
In either case, upgrading to module version `v1.0.0` will trigger a recreation of all node pools in the cluster.
126126

127127
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
128+
128129
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
129130

130131
## Requirements

‎examples/deploy_service/README.md

Lines changed: 0 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -9,37 +9,6 @@ It will:
99
- Create an Nginx Service
1010

1111
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
12-
## Inputs
13-
14-
| 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 |
24-
25-
## Outputs
26-
27-
| Name | Description |
28-
|------|-------------|
29-
| ca\_certificate | |
30-
| client\_token | |
31-
| cluster\_name | Cluster name |
32-
| ip\_range\_pods | The secondary IP range used for pods |
33-
| ip\_range\_services | The secondary IP range used for services |
34-
| kubernetes\_endpoint | |
35-
| location | |
36-
| 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 | |
42-
| zones | List of zones in which the cluster resides |
4312

4413
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
4514

‎examples/disable_client_cert/README.md

Lines changed: 0 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -6,39 +6,6 @@ This example illustrates how to create a simple cluster and disable deprecated s
66
* client certificate
77

88
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
9-
## Inputs
10-
11-
| 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-
| credentials\_path | The path to the GCP credentials JSON file | string | n/a | yes |
16-
| ip\_range\_pods | The secondary ip range to use for pods | string | n/a | yes |
17-
| ip\_range\_services | The secondary ip range to use for pods | string | n/a | yes |
18-
| network | The VPC network to host the cluster in | string | n/a | yes |
19-
| network\_project\_id | The GCP project housing the VPC network to host the cluster in | string | n/a | yes |
20-
| project\_id | The project ID to host the cluster in | string | n/a | yes |
21-
| region | The region to host the cluster in | string | n/a | yes |
22-
| subnetwork | The subnetwork to host the cluster in | string | n/a | yes |
23-
24-
## Outputs
25-
26-
| Name | Description |
27-
|------|-------------|
28-
| ca\_certificate | |
29-
| client\_token | |
30-
| cluster\_name | Cluster name |
31-
| ip\_range\_pods | The secondary IP range used for pods |
32-
| ip\_range\_services | The secondary IP range used for services |
33-
| kubernetes\_endpoint | |
34-
| location | |
35-
| 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 | |
41-
| zones | List of zones in which the cluster resides |
429

4310
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
4411

‎examples/node_pool/README.md

Lines changed: 0 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -3,38 +3,6 @@
33
This example illustrates how to create a cluster with multiple custom node-pool configurations with node labels, taints, and network tags.
44

55
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
6-
## Inputs
7-
8-
| 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 pods | 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 |
19-
20-
## Outputs
21-
22-
| Name | Description |
23-
|------|-------------|
24-
| ca\_certificate | |
25-
| client\_token | |
26-
| cluster\_name | Cluster name |
27-
| ip\_range\_pods | The secondary IP range used for pods |
28-
| ip\_range\_services | The secondary IP range used for services |
29-
| kubernetes\_endpoint | |
30-
| location | |
31-
| master\_kubernetes\_version | The master Kubernetes version |
32-
| network | |
33-
| project\_id | |
34-
| region | |
35-
| service\_account | The service account to default running nodes as if not overridden in `node_pools`. |
36-
| subnetwork | |
37-
| zones | List of zones in which the cluster resides |
386

397
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
408

‎examples/shared_vpc/README.md

Lines changed: 0 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -3,38 +3,6 @@
33
This example illustrates how to create a simple cluster where the host network is not necessarily in the same project as the cluster.
44

55
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
6-
## Inputs
7-
8-
| 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 pods | string | n/a | yes |
14-
| network | The VPC network to host the cluster in | string | n/a | yes |
15-
| network\_project\_id | The GCP project housing 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-
20-
## Outputs
21-
22-
| Name | Description |
23-
|------|-------------|
24-
| ca\_certificate | |
25-
| client\_token | |
26-
| cluster\_name | Cluster name |
27-
| ip\_range\_pods | The secondary IP range used for pods |
28-
| ip\_range\_services | The secondary IP range used for services |
29-
| kubernetes\_endpoint | |
30-
| location | |
31-
| master\_kubernetes\_version | The master Kubernetes version |
32-
| network | |
33-
| project\_id | |
34-
| region | |
35-
| service\_account | The service account to default running nodes as if not overridden in `node_pools`. |
36-
| subnetwork | |
37-
| zones | List of zones in which the cluster resides |
386

397
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
408

‎examples/simple_regional/README.md

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

55
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
6-
## Inputs
7-
8-
| 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 pods | 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-
19-
## Outputs
20-
21-
| Name | Description |
22-
|------|-------------|
23-
| ca\_certificate | |
24-
| client\_token | |
25-
| cluster\_name | Cluster name |
26-
| ip\_range\_pods | The secondary IP range used for pods |
27-
| ip\_range\_services | The secondary IP range used for services |
28-
| kubernetes\_endpoint | |
29-
| location | |
30-
| master\_kubernetes\_version | The master Kubernetes version |
31-
| network | |
32-
| project\_id | |
33-
| region | |
34-
| service\_account | The service account to default running nodes as if not overridden in `node_pools`. |
35-
| subnetwork | |
36-
| zones | List of zones in which the cluster resides |
376

387
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
398

‎examples/simple_regional_private/README.md

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

55
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
6-
## Inputs
7-
8-
| 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 pods | 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-
19-
## Outputs
20-
21-
| Name | Description |
22-
|------|-------------|
23-
| ca\_certificate | |
24-
| client\_token | |
25-
| cluster\_name | Cluster name |
26-
| ip\_range\_pods | The secondary IP range used for pods |
27-
| ip\_range\_services | The secondary IP range used for services |
28-
| kubernetes\_endpoint | |
29-
| location | |
30-
| master\_kubernetes\_version | The master Kubernetes version |
31-
| network | |
32-
| project\_id | |
33-
| region | |
34-
| service\_account | The service account to default running nodes as if not overridden in `node_pools`. |
35-
| subnetwork | |
36-
| zones | List of zones in which the cluster resides |
376

387
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
398

‎examples/simple_zonal/README.md

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

55
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
6-
## Inputs
7-
8-
| Name | Description | Type | Default | Required |
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 | string | n/a | yes |
12-
| ip\_range\_services | The secondary ip range to use for pods | string | n/a | yes |
13-
| network | The VPC network to host the cluster in | string | n/a | yes |
14-
| project\_id | The project ID to host the cluster in | string | n/a | yes |
15-
| region | The region to host the cluster in | string | n/a | yes |
16-
| subnetwork | The subnetwork to host the cluster in | string | n/a | yes |
17-
| zones | The zone to host the cluster in (required if is a zonal cluster) | list(string) | n/a | yes |
18-
19-
## Outputs
20-
21-
| Name | Description |
22-
|------|-------------|
23-
| ca\_certificate | |
24-
| client\_token | |
25-
| cluster\_name | Cluster name |
26-
| ip\_range\_pods | The secondary IP range used for pods |
27-
| ip\_range\_services | The secondary IP range used for services |
28-
| kubernetes\_endpoint | |
29-
| location | |
30-
| master\_kubernetes\_version | The master Kubernetes version |
31-
| network | |
32-
| project\_id | |
33-
| region | |
34-
| service\_account | The service account to default running nodes as if not overridden in `node_pools`. |
35-
| subnetwork | |
36-
| zones | List of zones in which the cluster resides |
376

387
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
398

‎examples/simple_zonal_private/README.md

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

55
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
6-
## Inputs
7-
8-
| 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 pods | 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 |
19-
20-
## Outputs
21-
22-
| Name | Description |
23-
|------|-------------|
24-
| ca\_certificate | |
25-
| client\_token | |
26-
| cluster\_name | Cluster name |
27-
| ip\_range\_pods | The secondary IP range used for pods |
28-
| ip\_range\_services | The secondary IP range used for services |
29-
| kubernetes\_endpoint | |
30-
| location | |
31-
| master\_kubernetes\_version | The master Kubernetes version |
32-
| network | |
33-
| project\_id | |
34-
| region | |
35-
| service\_account | The service account to default running nodes as if not overridden in `node_pools`. |
36-
| subnetwork | |
37-
| zones | List of zones in which the cluster resides |
386

397
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
408

‎examples/stub_domains/README.md

Lines changed: 0 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -8,37 +8,6 @@ It will:
88
- Add a new kube-dns configmap with custom stub domains
99

1010
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
11-
## Inputs
12-
13-
| Name | Description | Type | Default | Required |
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 | string | n/a | yes |
17-
| ip\_range\_pods | The secondary ip range to use for pods | string | n/a | yes |
18-
| ip\_range\_services | The secondary ip range to use for pods | string | n/a | yes |
19-
| network | The VPC network to host the cluster in | string | n/a | yes |
20-
| project\_id | The project ID to host the cluster in | string | n/a | yes |
21-
| region | The region to host the cluster in | string | n/a | yes |
22-
| subnetwork | The subnetwork to host the cluster in | string | n/a | yes |
23-
24-
## Outputs
25-
26-
| Name | Description |
27-
|------|-------------|
28-
| ca\_certificate | |
29-
| client\_token | |
30-
| cluster\_name | Cluster name |
31-
| ip\_range\_pods | The secondary IP range used for pods |
32-
| ip\_range\_services | The secondary IP range used for services |
33-
| kubernetes\_endpoint | |
34-
| location | |
35-
| 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 | |
41-
| zones | List of zones in which the cluster resides |
4211

4312
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
4413

‎examples/stub_domains_private/README.md

Lines changed: 0 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -10,37 +10,6 @@ It will:
1010
- Add a new kube-dns configmap with custom stub domains
1111

1212
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
13-
## Inputs
14-
15-
| Name | Description | Type | Default | Required |
16-
|------|-------------|:----:|:-----:|:-----:|
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 | n/a | yes |
19-
| ip\_range\_pods | The secondary ip range to use for pods | string | n/a | yes |
20-
| ip\_range\_services | The secondary ip range to use for pods | string | n/a | yes |
21-
| network | The VPC network to host the cluster in | string | n/a | yes |
22-
| project\_id | The project ID to host the cluster in | string | n/a | yes |
23-
| region | The region to host the cluster in | string | n/a | yes |
24-
| subnetwork | The subnetwork to host the cluster in | string | n/a | yes |
25-
26-
## Outputs
27-
28-
| Name | Description |
29-
|------|-------------|
30-
| ca\_certificate | |
31-
| client\_token | |
32-
| cluster\_name | Cluster name |
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-
| service\_account | The service account to default running nodes as if not overridden in `node_pools`. |
42-
| subnetwork | |
43-
| zones | List of zones in which the cluster resides |
4413

4514
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
4615

0 commit comments

Comments
 (0)