Skip to content

Commit d3783a6

Browse files
committed
Get README in line with master and implement style changes
1 parent 0299dc3 commit d3783a6

File tree

3 files changed

+42
-54
lines changed

3 files changed

+42
-54
lines changed

README.md

Lines changed: 5 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -167,11 +167,12 @@ Before this module can be used on a project, you must ensure that the following
167167
The [project factory](https://github.com/terraform-google-modules/terraform-google-project-factory) can be used to provision projects with the correct APIs active and the necessary Shared VPC connections.
168168

169169
### Software Dependencies
170-
### Kubectl
170+
#### Kubectl
171171
- [kubectl](https://github.com/kubernetes/kubernetes/releases) 1.9.x
172-
### Terraform plugins
173-
- [Terraform](https://www.terraform.io/downloads.html) 0.10.x
174-
- [terraform-provider-google](https://github.com/terraform-providers/terraform-provider-google) plugin v1.8.0
172+
#### Terraform and Plugins
173+
- [Terraform](https://www.terraform.io/downloads.html) 0.11.x
174+
- [terraform-provider-google](https://github.com/terraform-providers/terraform-provider-google) v1.8.0
175+
175176
### Configure a Service Account
176177
In order to execute this module you must have a Service Account with the
177178
following project roles:
@@ -186,12 +187,6 @@ In order to operate with the Service Account you must activate the following API
186187
- Compute Engine API - compute.googleapis.com
187188
- Kubernetes Engine API - container.googleapis.com
188189

189-
## Install
190-
191-
### Terraform
192-
Be sure you have the correct Terraform version (0.10.x), you can choose the binary here:
193-
- https://releases.hashicorp.com/terraform/
194-
195190
## File structure
196191
The project has the following folders and files:
197192

autogen/README.md

Lines changed: 20 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -166,18 +166,22 @@ Then perform the following commands on the root folder:
166166
Before this module can be used on a project, you must ensure that the following pre-requisites are fulfilled:
167167

168168
1. Terraform and kubectl are [installed](#software-dependencies) on the machine where Terraform is executed.
169-
2. The Service Account you execute the module with has the right [permissions](#iam-roles).
169+
2. The Service Account you execute the module with has the right [permissions](#configure-a-service-account).
170170
3. The Compute Engine and Kubernetes Engine APIs are [active](#enable-apis) on the project you will launch the cluster in.
171171
4. If you are using a Shared VPC, the APIs must also be activated on the Shared VPC host project and your service account needs the proper permissions there.
172172

173173
The [project factory](https://github.com/terraform-google-modules/terraform-google-project-factory) can be used to provision projects with the correct APIs active and the necessary Shared VPC connections.
174174

175175
### Software Dependencies
176-
### Kubectl
176+
#### Kubectl
177177
- [kubectl](https://github.com/kubernetes/kubernetes/releases) 1.9.x
178-
### Terraform plugins
179-
- [Terraform](https://www.terraform.io/downloads.html) 0.10.x
180-
- [terraform-provider-google](https://github.com/terraform-providers/terraform-provider-google) plugin {% if private_cluster %}beta{% else %}v1.8.0{% endif %}
178+
#### Terraform and Plugins
179+
- [Terraform](https://www.terraform.io/downloads.html) 0.11.x
180+
{% if private_cluster %}
181+
- [terraform-provider-google-beta](https://github.com/terraform-providers/terraform-provider-google-beta) v1.20.0
182+
{% else %}
183+
- [terraform-provider-google](https://github.com/terraform-providers/terraform-provider-google) v1.8.0
184+
{% endif %}
181185

182186
### Configure a Service Account
183187
In order to execute this module you must have a Service Account with the
@@ -193,12 +197,6 @@ In order to operate with the Service Account you must activate the following API
193197
- Compute Engine API - compute.googleapis.com
194198
- Kubernetes Engine API - container.googleapis.com
195199

196-
## Install
197-
198-
### Terraform
199-
Be sure you have the correct Terraform version (0.10.x), you can choose the binary here:
200-
- https://releases.hashicorp.com/terraform/
201-
202200
## File structure
203201
The project has the following folders and files:
204202

@@ -237,23 +235,22 @@ Integration tests are run though [test-kitchen](https://github.com/test-kitchen/
237235

238236
Six test-kitchen instances are defined:
239237

240-
- `deploy_service`
241-
- `node_pool`
242-
- `shared_vpc`
243-
- `simple_regional`
244-
- `simple_zonal`
245-
- `stub_domains`
238+
- `deploy-service`
239+
- `node-pool`
240+
- `shared-vpc`
241+
- `simple-regional`
242+
- `simple-zonal`
243+
- `stub-domains`
246244

247245
The test-kitchen instances in `test/fixtures/` wrap identically-named examples in the `examples/` directory.
248246

249247
#### Setup
250248

251249
1. Configure the [test fixtures](#test-configuration)
252250
2. Download a Service Account key with the necessary permissions and put it in the module's root directory with the name `credentials.json`.
253-
3. Build the Docker containers for testing:
251+
3. Build the Docker container for testing:
254252

255253
```
256-
make docker_build_terraform
257254
make docker_build_kitchen_terraform
258255
```
259256
4. Run the testing container in interactive mode:
@@ -262,13 +259,14 @@ The test-kitchen instances in `test/fixtures/` wrap identically-named examples i
262259
make docker_run
263260
```
264261

265-
The module root directory will be loaded into the Docker container at `/cftk/workdir/`.
262+
The module root directory will be loaded into the Docker container at `/cft/workdir/`.
266263
5. Run kitchen-terraform to test the infrastructure:
267264

268265
1. `kitchen create` creates Terraform state and downloads modules, if applicable.
269266
2. `kitchen converge` creates the underlying resources. Run `kitchen converge <INSTANCE_NAME>` to create resources for a specific test case.
270-
3. `kitchen verify` tests the created infrastructure. Run `kitchen verify <INSTANCE_NAME>` to run a specific test case.
271-
4. `kitchen destroy` tears down the underlying resources created by `kitchen converge`. Run `kitchen destroy <INSTANCE_NAME>` to tear down resources for a specific test case.
267+
3. Run `kitchen converge` again. This is necessary due to an oddity in how `networkPolicyConfig` is handled by the upstream API. (See [#72](https://github.com/terraform-google-modules/terraform-google-kubernetes-engine/issues/72) for details).
268+
4. `kitchen verify` tests the created infrastructure. Run `kitchen verify <INSTANCE_NAME>` to run a specific test case.
269+
5. `kitchen destroy` tears down the underlying resources created by `kitchen converge`. Run `kitchen destroy <INSTANCE_NAME>` to tear down resources for a specific test case.
272270

273271
Alternatively, you can simply run `make test_integration_docker` to run all the test steps non-interactively.
274272

modules/private-cluster/README.md

Lines changed: 17 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -163,18 +163,19 @@ Then perform the following commands on the root folder:
163163
Before this module can be used on a project, you must ensure that the following pre-requisites are fulfilled:
164164

165165
1. Terraform and kubectl are [installed](#software-dependencies) on the machine where Terraform is executed.
166-
2. The Service Account you execute the module with has the right [permissions](#iam-roles).
166+
2. The Service Account you execute the module with has the right [permissions](#configure-a-service-account).
167167
3. The Compute Engine and Kubernetes Engine APIs are [active](#enable-apis) on the project you will launch the cluster in.
168168
4. If you are using a Shared VPC, the APIs must also be activated on the Shared VPC host project and your service account needs the proper permissions there.
169169

170170
The [project factory](https://github.com/terraform-google-modules/terraform-google-project-factory) can be used to provision projects with the correct APIs active and the necessary Shared VPC connections.
171171

172172
### Software Dependencies
173-
### Kubectl
173+
#### Kubectl
174174
- [kubectl](https://github.com/kubernetes/kubernetes/releases) 1.9.x
175-
### Terraform plugins
176-
- [Terraform](https://www.terraform.io/downloads.html) 0.10.x
177-
- [terraform-provider-google](https://github.com/terraform-providers/terraform-provider-google) plugin beta
175+
#### Terraform and Plugins
176+
- [Terraform](https://www.terraform.io/downloads.html) 0.11.x
177+
- [terraform-provider-google-beta](https://github.com/terraform-providers/terraform-provider-google-beta) v1.20.0
178+
178179
### Configure a Service Account
179180
In order to execute this module you must have a Service Account with the
180181
following project roles:
@@ -189,12 +190,6 @@ In order to operate with the Service Account you must activate the following API
189190
- Compute Engine API - compute.googleapis.com
190191
- Kubernetes Engine API - container.googleapis.com
191192

192-
## Install
193-
194-
### Terraform
195-
Be sure you have the correct Terraform version (0.10.x), you can choose the binary here:
196-
- https://releases.hashicorp.com/terraform/
197-
198193
## File structure
199194
The project has the following folders and files:
200195

@@ -233,23 +228,22 @@ Integration tests are run though [test-kitchen](https://github.com/test-kitchen/
233228

234229
Six test-kitchen instances are defined:
235230

236-
- `deploy_service`
237-
- `node_pool`
238-
- `shared_vpc`
239-
- `simple_regional`
240-
- `simple_zonal`
241-
- `stub_domains`
231+
- `deploy-service`
232+
- `node-pool`
233+
- `shared-vpc`
234+
- `simple-regional`
235+
- `simple-zonal`
236+
- `stub-domains`
242237

243238
The test-kitchen instances in `test/fixtures/` wrap identically-named examples in the `examples/` directory.
244239

245240
#### Setup
246241

247242
1. Configure the [test fixtures](#test-configuration)
248243
2. Download a Service Account key with the necessary permissions and put it in the module's root directory with the name `credentials.json`.
249-
3. Build the Docker containers for testing:
244+
3. Build the Docker container for testing:
250245

251246
```
252-
make docker_build_terraform
253247
make docker_build_kitchen_terraform
254248
```
255249
4. Run the testing container in interactive mode:
@@ -258,13 +252,14 @@ The test-kitchen instances in `test/fixtures/` wrap identically-named examples i
258252
make docker_run
259253
```
260254

261-
The module root directory will be loaded into the Docker container at `/cftk/workdir/`.
255+
The module root directory will be loaded into the Docker container at `/cft/workdir/`.
262256
5. Run kitchen-terraform to test the infrastructure:
263257

264258
1. `kitchen create` creates Terraform state and downloads modules, if applicable.
265259
2. `kitchen converge` creates the underlying resources. Run `kitchen converge <INSTANCE_NAME>` to create resources for a specific test case.
266-
3. `kitchen verify` tests the created infrastructure. Run `kitchen verify <INSTANCE_NAME>` to run a specific test case.
267-
4. `kitchen destroy` tears down the underlying resources created by `kitchen converge`. Run `kitchen destroy <INSTANCE_NAME>` to tear down resources for a specific test case.
260+
3. Run `kitchen converge` again. This is necessary due to an oddity in how `networkPolicyConfig` is handled by the upstream API. (See [#72](https://github.com/terraform-google-modules/terraform-google-kubernetes-engine/issues/72) for details).
261+
4. `kitchen verify` tests the created infrastructure. Run `kitchen verify <INSTANCE_NAME>` to run a specific test case.
262+
5. `kitchen destroy` tears down the underlying resources created by `kitchen converge`. Run `kitchen destroy <INSTANCE_NAME>` to tear down resources for a specific test case.
268263

269264
Alternatively, you can simply run `make test_integration_docker` to run all the test steps non-interactively.
270265

0 commit comments

Comments
 (0)