You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+8-15Lines changed: 8 additions & 15 deletions
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,6 @@
1
1
# Terraform Kubernetes Engine Module
2
2
3
3
This module handles opinionated Google Cloud Platform Kubernetes Engine cluster creation and configuration with Node Pools, IP MASQ, Network Policy, etc.
4
-
5
4
The resources/services/activations/deletions that this module will create/trigger are:
6
5
- Create a GKE cluster with the provided addons
7
6
- Create GKE Node Pool(s) with provided configuration and attach to cluster
@@ -115,7 +114,6 @@ Then perform the following commands on the root folder:
115
114
| network | The VPC network to host the cluster in (required) | string | - | yes |
| network_project_id | The project ID of the shared VPC's host (for shared vpc support) | string | `` | no |
118
-
| remove_default_node_pool | Boolean value determining removal of default node pool | bool | false | no |
119
117
| node_pools | List of maps containing node pools | list |`<list>`| no |
120
118
| node_pools_labels | Map of maps containing node labels by node-pool name | map |`<map>`| no |
121
119
| node_pools_metadata | Map of maps containing node metadata by node-pool name | map |`<map>`| no |
@@ -126,6 +124,7 @@ Then perform the following commands on the root folder:
126
124
| project_id | The project ID to host the cluster in (required) | string | - | yes |
127
125
| region | The region to host the cluster in (required) | string | - | yes |
128
126
| regional | Whether is a regional cluster (zonal cluster if set false. WARNING: changing this after cluster creation is destructive!) | string |`true`| no |
127
+
| remove_default_node_pool | Remove default node pool while setting up the cluster | string |`false`| no |
129
128
| 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 |
130
129
| 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 |
131
130
| subnetwork | The subnetwork to host the cluster in (required) | string | - | yes |
@@ -168,11 +167,11 @@ Before this module can be used on a project, you must ensure that the following
168
167
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.
In order to execute this module you must have a Service Account with the
@@ -188,12 +187,6 @@ In order to operate with the Service Account you must activate the following API
188
187
- Compute Engine API - compute.googleapis.com
189
188
- Kubernetes Engine API - container.googleapis.com
190
189
191
-
## Install
192
-
193
-
### Terraform
194
-
Be sure you have the correct Terraform version (0.10.x), you can choose the binary here:
195
-
-https://releases.hashicorp.com/terraform/
196
-
197
190
## File structure
198
191
The project has the following folders and files:
199
192
@@ -209,9 +202,9 @@ The project has the following folders and files:
209
202
210
203
## Templating
211
204
212
-
To more cleanly handle cases where desired functionality would require complex duplication of Terraform resources (i.e. [PR 51](https://github.com/terraform-google-modules/terraform-google-kubernetes-engine/pull/51)), this repository is largely generated from the [`autogen`](./autogen) directory.
205
+
To more cleanly handle cases where desired functionality would require complex duplication of Terraform resources (i.e. [PR 51](https://github.com/terraform-google-modules/terraform-google-kubernetes-engine/pull/51)), this repository is largely generated from the [`autogen`](/autogen) directory.
213
206
214
-
The root module is generated by running `make generate`. Changes to this repository should be made in the [`autogen`](./autogen) directory where appropriate.
207
+
The root module is generated by running `make generate`. Changes to this repository should be made in the [`autogen`](/autogen) directory where appropriate.
215
208
216
209
## Testing
217
210
@@ -270,7 +263,7 @@ Alternatively, you can simply run `make test_integration_docker` to run all the
270
263
#### Test configuration
271
264
272
265
Each test-kitchen instance is configured with a `variables.tfvars` file in the test fixture directory, e.g. `test/fixtures/node_pool/terraform.tfvars`.
273
-
For convenience, since all of the variables are project-specific, these files have been symlinked to `test/fixtures/shared/terraform.tfvars`.
266
+
For convenience, since all of the variables are project-specific, these files have been symlinked to `test/fixtures/shared/terraform.tfvars`.
274
267
Similarly, each test fixture has a `variables.tf` to define these variables, and an `outputs.tf` to facilitate providing necessary information for `inspec` to locate and query against created resources.
275
268
276
269
Each test-kitchen instance creates a GCP Network and Subnetwork fixture to house resources, and may create any other necessary fixture data as needed.
0 commit comments