Skip to content

Commit 751b8b2

Browse files
thefirstofthe300thefirstofthe300
committed
Update the documentation
1 parent d77ffc3 commit 751b8b2

File tree

11 files changed

+61
-73
lines changed

11 files changed

+61
-73
lines changed

‎README.md‎

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,6 @@ Then perform the following commands on the root folder:
8989
- `terraform apply` to apply the infrastructure build
9090
- `terraform destroy` to destroy the built infrastructure
9191

92-
9392
[^]: (autogen_docs_start)
9493

9594
## Inputs
@@ -101,8 +100,8 @@ Then perform the following commands on the root folder:
101100
| http\_load\_balancing | Enable httpload balancer addon | string | `"true"` | no |
102101
| ip\_masq\_link\_local | Whether to masquerade traffic to the link-local prefix (169.254.0.0/16). | string | `"false"` | no |
103102
| ip\_masq\_resync\_interval | The interval at which the agent attempts to sync its ConfigMap file from the disk. | string | `"60s"` | no |
104-
| ip\_range\_pods | The _name_ of the secondary subnet ip range to use for pods | string | - | yes |
105-
| ip\_range\_services | The _name_ of the secondary subnet ip range to use for services | string | - | yes |
103+
| ip\_range\_pods | The _name_ of the secondary subnet ip range to use for pods | string | n/a | yes |
104+
| ip\_range\_services | The _name_ of the secondary subnet range to use for services | string | n/a | yes |
106105
| kubernetes\_dashboard | Enable kubernetes dashboard addon | string | `"false"` | no |
107106
| 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 |
108107
| logging\_service | The logging service that the cluster should write logs to. Available options include logging.googleapis.com, logging.googleapis.com/kubernetes (beta), and none | string | `"logging.googleapis.com"` | no |
@@ -149,6 +148,7 @@ Then perform the following commands on the root folder:
149148
| node\_pools\_names | List of node pools names |
150149
| node\_pools\_versions | List of node pools versions |
151150
| region | Cluster region |
151+
| service\_account | The service account to default running nodes as if not overridden in `node_pools`. |
152152
| type | Cluster type (regional / zonal) |
153153
| zones | List of zones in which the cluster resides |
154154

@@ -170,7 +170,7 @@ The [project factory](https://github.com/terraform-google-modules/terraform-goog
170170
- [kubectl](https://github.com/kubernetes/kubernetes/releases) 1.9.x
171171
#### Terraform and Plugins
172172
- [Terraform](https://www.terraform.io/downloads.html) 0.11.x
173-
- [terraform-provider-google](https://github.com/terraform-providers/terraform-provider-google) v1.8.0
173+
- [terraform-provider-google](https://github.com/terraform-providers/terraform-provider-google) v2.0.0
174174

175175
### Configure a Service Account
176176
In order to execute this module you must have a Service Account with the
@@ -264,6 +264,20 @@ The test-kitchen instances in `test/fixtures/` wrap identically-named examples i
264264

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

267+
If you wish to parallelize running the test suites, it is also possible to offload the work onto Concourse to run each test suite for you using the command `make test_integration_concourse`. The `.concourse` directory will be created and contain all of the logs from the running test suites.
268+
269+
When running tests locally, you will need to use your own test project environment. You can configure your environment by setting all of the following variables:
270+
271+
```
272+
export COMPUTE_ENGINE_SERVICE_ACCOUNT="<EXISTING_SERVICE_ACCOUNT>"
273+
export PROJECT_ID="<PROJECT_TO_USE>"
274+
export REGION="<REGION_TO_USE>"
275+
export ZONES='["<LIST_OF_ZONES_TO_USE>"]'
276+
export SERVICE_ACCOUNT_JSON="$(cat "<PATH_TO_SERVICE_ACCOUNT_JSON>")"
277+
export CLOUDSDK_AUTH_CREDENTIAL_FILE_OVERRIDE="<PATH_TO_SERVICE_ACCOUNT_JSON>"
278+
export GOOGLE_APPLICATION_CREDENTIALS="<PATH_TO_SERVICE_ACCOUNT_JSON>"
279+
```
280+
267281
#### Test configuration
268282

269283
Each test-kitchen instance is configured with a `variables.tfvars` file in the test fixture directory, e.g. `test/fixtures/node_pool/terraform.tfvars`.

‎autogen/README.md‎

Lines changed: 16 additions & 65 deletions
Original file line numberDiff line numberDiff line change
@@ -95,70 +95,7 @@ Then perform the following commands on the root folder:
9595
- `terraform apply` to apply the infrastructure build
9696
- `terraform destroy` to destroy the built infrastructure
9797

98-
9998
[^]: (autogen_docs_start)
100-
101-
102-
## Inputs
103-
104-
| Name | Description | Type | Default | Required |
105-
|------|-------------|:----:|:-----:|:-----:|
106-
| description | The description of the cluster | string | `` | no |
107-
| horizontal_pod_autoscaling | Enable horizontal pod autoscaling addon | string | `true` | no |
108-
| http_load_balancing | Enable httpload balancer addon | string | `true` | no |
109-
| ip_masq_link_local | Whether to masquerade traffic to the link-local prefix (169.254.0.0/16). | string | `false` | no |
110-
| ip_masq_resync_interval | The interval at which the agent attempts to sync its ConfigMap file from the disk. | string | `60s` | no |
111-
| ip_range_pods | The secondary ip range to use for pods | string | - | yes |
112-
| ip_range_services | The secondary ip range to use for pods | string | - | yes |
113-
| kubernetes_dashboard | Enable kubernetes dashboard addon | string | `false` | no |
114-
| 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 |
115-
| logging_service | The logging service that the cluster should write logs to. Available options include logging.googleapis.com, logging.googleapis.com/kubernetes (beta), and none | string | `logging.googleapis.com` | no |
116-
| maintenance_start_time | Time window specified for daily maintenance operations in RFC3339 format | string | `05:00` | no |
117-
| master_authorized_networks_config | The desired configuration options for master authorized networks. Omit the nested cidr_blocks attribute to disallow external access (except the cluster node IPs, which GKE automatically whitelists)<br><br> ### example format ### master_authorized_networks_config = [{ cidr_blocks = [{ cidr_block = "10.0.0.0/8" display_name = "example_network" }], }] | list | `<list>` | no |
118-
| monitoring_service | The monitoring service that the cluster should write metrics to. Automatically send metrics from pods in the cluster to the Google Cloud Monitoring API. VM metrics will be collected by Google Compute Engine regardless of this setting Available options include monitoring.googleapis.com, monitoring.googleapis.com/kubernetes (beta) and none | string | `monitoring.googleapis.com` | no |
119-
| name | The name of the cluster (required) | string | - | yes |
120-
| network | The VPC network to host the cluster in (required) | string | - | yes |
121-
| network_policy | Enable network policy addon | string | `false` | no |
122-
| network_project_id | The project ID of the shared VPC's host (for shared vpc support) | string | `` | no |
123-
| remove_default_node_pool | Boolean value determining removal of default node pool | bool | false | no |
124-
| node_pools | List of maps containing node pools | list | `<list>` | no |
125-
| node_pools_labels | Map of maps containing node labels by node-pool name | map | `<map>` | no |
126-
| node_pools_metadata | Map of maps containing node metadata by node-pool name | map | `<map>` | no |
127-
| node_pools_tags | Map of lists containing node network tags by node-pool name | map | `<map>` | no |
128-
| node_pools_taints | Map of lists containing node taints by node-pool name | map | `<map>` | no |
129-
| node_version | The Kubernetes version of the node pools. Defaults kubernetes_version (master) variable and can be overridden for individual node pools by setting the `version` key on them. Must be empyty or set the same as master at cluster creation. | string | `` | no |
130-
| non_masquerade_cidrs | List of strings in CIDR notation that specify the IP address ranges that do not use IP masquerading. | list | `<list>` | no |
131-
| project_id | The project ID to host the cluster in (required) | string | - | yes |
132-
| region | The region to host the cluster in (required) | string | - | yes |
133-
| regional | Whether is a regional cluster (zonal cluster if set false. WARNING: changing this after cluster creation is destructive!) | string | `true` | no |
134-
| service_account | The service account to default running nodes as if not overridden in `node_pools`. Defaults to the compute engine default service account | string | `` | no |
135-
| stub_domains | Map of stub domains and their resolvers to forward DNS queries for a certain domain to an external DNS server | map | `<map>` | no |
136-
| subnetwork | The subnetwork to host the cluster in (required) | string | - | yes |
137-
| zones | The zones to host the cluster in (optional if regional cluster / required if zonal) | list | `<list>` | no |
138-
139-
## Outputs
140-
141-
| Name | Description |
142-
|------|-------------|
143-
| ca_certificate | Cluster ca certificate (base64 encoded) |
144-
| endpoint | Cluster endpoint |
145-
| horizontal_pod_autoscaling_enabled | Whether horizontal pod autoscaling enabled |
146-
| http_load_balancing_enabled | Whether http load balancing enabled |
147-
| kubernetes_dashboard_enabled | Whether kubernetes dashboard enabled |
148-
| location | Cluster location (region if regional cluster, zone if zonal cluster) |
149-
| logging_service | Logging service used |
150-
| master_authorized_networks_config | Networks from which access to master is permitted |
151-
| master_version | Current master kubernetes version |
152-
| min_master_version | Minimum master kubernetes version |
153-
| monitoring_service | Monitoring service used |
154-
| name | Cluster name |
155-
| network_policy_enabled | Whether network policy enabled |
156-
| node_pools_names | List of node pools names |
157-
| node_pools_versions | List of node pools versions |
158-
| region | Cluster region |
159-
| type | Cluster type (regional / zonal) |
160-
| zones | List of zones in which the cluster resides |
161-
16299
[^]: (autogen_docs_end)
163100

164101
## Requirements
@@ -178,9 +115,9 @@ The [project factory](https://github.com/terraform-google-modules/terraform-goog
178115
#### Terraform and Plugins
179116
- [Terraform](https://www.terraform.io/downloads.html) 0.11.x
180117
{% if private_cluster %}
181-
- [terraform-provider-google-beta](https://github.com/terraform-providers/terraform-provider-google-beta) v1.20.0
118+
- [terraform-provider-google-beta](https://github.com/terraform-providers/terraform-provider-google-beta) v2.0.0
182119
{% else %}
183-
- [terraform-provider-google](https://github.com/terraform-providers/terraform-provider-google) v1.8.0
120+
- [terraform-provider-google](https://github.com/terraform-providers/terraform-provider-google) v2.0.0
184121
{% endif %}
185122

186123
### Configure a Service Account
@@ -275,6 +212,20 @@ The test-kitchen instances in `test/fixtures/` wrap identically-named examples i
275212

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

215+
If you wish to parallelize running the test suites, it is also possible to offload the work onto Concourse to run each test suite for you using the command `make test_integration_concourse`. The `.concourse` directory will be created and contain all of the logs from the running test suites.
216+
217+
When running tests locally, you will need to use your own test project environment. You can configure your environment by setting all of the following variables:
218+
219+
```
220+
export COMPUTE_ENGINE_SERVICE_ACCOUNT="<EXISTING_SERVICE_ACCOUNT>"
221+
export PROJECT_ID="<PROJECT_TO_USE>"
222+
export REGION="<REGION_TO_USE>"
223+
export ZONES='["<LIST_OF_ZONES_TO_USE>"]'
224+
export SERVICE_ACCOUNT_JSON="$(cat "<PATH_TO_SERVICE_ACCOUNT_JSON>")"
225+
export CLOUDSDK_AUTH_CREDENTIAL_FILE_OVERRIDE="<PATH_TO_SERVICE_ACCOUNT_JSON>"
226+
export GOOGLE_APPLICATION_CREDENTIALS="<PATH_TO_SERVICE_ACCOUNT_JSON>"
227+
```
228+
278229
#### Test configuration
279230

280231
Each test-kitchen instance is configured with a `variables.tfvars` file in the test fixture directory, e.g. `test/fixtures/node_pool/terraform.tfvars`.

‎examples/deploy_service/README.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,7 @@ It will:
4040
| network | |
4141
| project\_id | |
4242
| region | |
43+
| service\_account | The service account to default running nodes as if not overridden in `node_pools`. |
4344
| subnetwork | |
4445
| zones | List of zones in which the cluster resides |
4546

‎examples/node_pool/README.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ This example illustrates how to create a cluster with multiple custom node-pool
1717
| project\_id | The project ID to host the cluster in | string | n/a | yes |
1818
| region | The region to host the cluster in | string | n/a | yes |
1919
| subnetwork | The subnetwork to host the cluster in | string | n/a | yes |
20+
| zones | The zone to host the cluster in (required if is a zonal cluster) | list | n/a | yes |
2021

2122
## Outputs
2223

@@ -34,6 +35,7 @@ This example illustrates how to create a cluster with multiple custom node-pool
3435
| network | |
3536
| project\_id | |
3637
| region | |
38+
| service\_account | The service account to default running nodes as if not overridden in `node_pools`. |
3739
| subnetwork | |
3840
| zones | List of zones in which the cluster resides |
3941

‎examples/shared_vpc/README.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@ This example illustrates how to create a simple cluster where the host network i
3535
| network | |
3636
| project\_id | |
3737
| region | |
38+
| service\_account | The service account to default running nodes as if not overridden in `node_pools`. |
3839
| subnetwork | |
3940
| zones | List of zones in which the cluster resides |
4041

‎examples/simple_regional/README.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@ This example illustrates how to create a simple cluster.
3434
| network | |
3535
| project\_id | |
3636
| region | |
37+
| service\_account | The service account to default running nodes as if not overridden in `node_pools`. |
3738
| subnetwork | |
3839
| zones | List of zones in which the cluster resides |
3940

‎examples/simple_regional_private/README.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@ This example illustrates how to create a simple private cluster.
3434
| network | |
3535
| project\_id | |
3636
| region | |
37+
| service\_account | The service account to default running nodes as if not overridden in `node_pools`. |
3738
| subnetwork | |
3839
| zones | List of zones in which the cluster resides |
3940

‎examples/simple_zonal/README.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@ This example illustrates how to create a simple cluster.
3434
| network | |
3535
| project\_id | |
3636
| region | |
37+
| service\_account | The service account to default running nodes as if not overridden in `node_pools`. |
3738
| subnetwork | |
3839
| zones | List of zones in which the cluster resides |
3940

‎examples/simple_zonal_private/README.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@ This example illustrates how to create a simple private cluster.
3535
| network | |
3636
| project\_id | |
3737
| region | |
38+
| service\_account | The service account to default running nodes as if not overridden in `node_pools`. |
3839
| subnetwork | |
3940
| zones | List of zones in which the cluster resides |
4041

‎examples/stub_domains/README.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,7 @@ It will:
3939
| network | |
4040
| project\_id | |
4141
| region | |
42+
| service\_account | The service account to default running nodes as if not overridden in `node_pools`. |
4243
| subnetwork | |
4344
| zones | List of zones in which the cluster resides |
4445

0 commit comments

Comments
 (0)