Skip to content

Commit 4333dad

Browse files
apeabodyapeabody
committed
chore: update docs and inital tflint bump
1 parent b4ccabe commit 4333dad

File tree

14 files changed

+119
-129
lines changed

14 files changed

+119
-129
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 := 1.10
21+
DOCKER_TAG_VERSION_DEVELOPER_TOOLS := 1.12
2222
DOCKER_IMAGE_DEVELOPER_TOOLS := cft/developer-tools
2323
REGISTRY_URL := gcr.io/cloud-foundation-cicd
2424
DOCKER_BIN ?= docker

‎build/int.cloudbuild.yaml

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ steps:
2828
args: ['/bin/bash', '-c', 'source /usr/local/bin/task_helper_functions.sh && kitchen_do create']
2929
- id: init disable-client-cert
3030
waitFor:
31-
- prepare
31+
- create all
3232
name: 'gcr.io/cloud-foundation-cicd/$_DOCKER_IMAGE_DEVELOPER_TOOLS:$_DOCKER_TAG_VERSION_DEVELOPER_TOOLS'
3333
args: ['/bin/bash', '-c', 'cft test run TestDisableClientCert --stage init --verbose --test-dir test/integration']
3434
- id: apply disable-client-cert
@@ -103,7 +103,7 @@ steps:
103103
args: ['/bin/bash', '-c', 'cft test run TestSimpleRegional --stage verify --verbose']
104104
- id: destroy simple-regional-local
105105
waitFor:
106-
- apply simple-regional-local
106+
- verify simple-regional-local
107107
name: 'gcr.io/cloud-foundation-cicd/$_DOCKER_IMAGE_DEVELOPER_TOOLS:$_DOCKER_TAG_VERSION_DEVELOPER_TOOLS'
108108
args: ['/bin/bash', '-c', 'cft test run TestSimpleRegional --stage teardown --verbose']
109109
- id: init simple-regional-private-local
@@ -283,7 +283,7 @@ steps:
283283
args: ['/bin/bash', '-c', 'source /usr/local/bin/task_helper_functions.sh && kitchen_do destroy workload-metadata-config-local']
284284
- id: init beta-cluster
285285
waitFor:
286-
- prepare
286+
- create all
287287
name: 'gcr.io/cloud-foundation-cicd/$_DOCKER_IMAGE_DEVELOPER_TOOLS:$_DOCKER_TAG_VERSION_DEVELOPER_TOOLS'
288288
args: ['/bin/bash', '-c', 'cft test run TestBetaCluster --stage init --verbose --test-dir test/integration']
289289
- id: apply beta-cluster
@@ -443,7 +443,7 @@ steps:
443443
args: ['/bin/bash', '-c', 'cft test run TestSimpleAutopilotPrivate --stage verify --verbose']
444444
- id: destroy simple-autopilot-private-local
445445
waitFor:
446-
- apply simple-autopilot-private-local
446+
- verify simple-autopilot-private-local
447447
name: 'gcr.io/cloud-foundation-cicd/$_DOCKER_IMAGE_DEVELOPER_TOOLS:$_DOCKER_TAG_VERSION_DEVELOPER_TOOLS'
448448
args: ['/bin/bash', '-c', 'cft test run TestSimpleAutopilotPrivate --stage teardown --verbose']
449449
- id: init simple-autopilot-public-local
@@ -468,7 +468,7 @@ steps:
468468
args: ['/bin/bash', '-c', 'cft test run TestSimpleAutopilotPublic --stage teardown --verbose']
469469
- id: init private-zonal-with-networking
470470
waitFor:
471-
- prepare
471+
- create all
472472
name: 'gcr.io/cloud-foundation-cicd/$_DOCKER_IMAGE_DEVELOPER_TOOLS:$_DOCKER_TAG_VERSION_DEVELOPER_TOOLS'
473473
args: ['/bin/bash', '-c', 'cft test run TestPrivateZonalWithNetworking --stage init --verbose --test-dir test/integration']
474474
- id: apply private-zonal-with-networking
@@ -488,7 +488,7 @@ steps:
488488
args: ['/bin/bash', '-c', 'cft test run TestPrivateZonalWithNetworking --stage teardown --verbose --test-dir test/integration']
489489
- id: init simple-autopilot-private-non-default-sa
490490
waitFor:
491-
- prepare
491+
- create all
492492
name: 'gcr.io/cloud-foundation-cicd/$_DOCKER_IMAGE_DEVELOPER_TOOLS:$_DOCKER_TAG_VERSION_DEVELOPER_TOOLS'
493493
args: ['/bin/bash', '-c', 'cft test run TestSimpleAutopilotPrivateNonDefaultSA --stage init --verbose']
494494
- id: apply simple-autopilot-private-non-default-sa
@@ -511,6 +511,6 @@ tags:
511511
- 'integration'
512512
substitutions:
513513
_DOCKER_IMAGE_DEVELOPER_TOOLS: 'cft/developer-tools'
514-
_DOCKER_TAG_VERSION_DEVELOPER_TOOLS: '1.10'
514+
_DOCKER_TAG_VERSION_DEVELOPER_TOOLS: '1.12'
515515
options:
516516
machineType: 'N1_HIGHCPU_8'

‎build/lint.cloudbuild.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ tags:
2222
- 'lint'
2323
substitutions:
2424
_DOCKER_IMAGE_DEVELOPER_TOOLS: 'cft/developer-tools'
25-
_DOCKER_TAG_VERSION_DEVELOPER_TOOLS: '1.10'
25+
_DOCKER_TAG_VERSION_DEVELOPER_TOOLS: '1.12'
2626
options:
2727
machineType: 'N1_HIGHCPU_8'
2828
env:

‎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

0 commit comments

Comments
 (0)