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
+18-4
Original file line number
Diff line number
Diff line change
@@ -2,6 +2,7 @@
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
4
The resources/services/activations/deletions that this module will create/trigger are:
5
+
5
6
- Create a GKE cluster with the provided addons
6
7
- Create GKE Node Pool(s) with provided configuration and attach to cluster
7
8
- Replace the default kube-dns configmap if `stub_domains` are provided
@@ -24,6 +25,7 @@ If you haven't [upgraded to 0.13][terraform-0.13-upgrade] and need a Terraform
24
25
intended for Terraform 0.12.x is [12.3.0].
25
26
26
27
## Usage
28
+
27
29
There are multiple examples included in the [examples](https://github.com/terraform-google-modules/terraform-google-kubernetes-engine/tree/master/examples) folder but simple usage is as follows:
28
30
29
31
```hcl
@@ -378,8 +380,10 @@ The node_pools variable takes the following parameters:
378
380
| consume_reservation_type | The type of reservation consumption. Accepted values are: "UNSPECIFIED": Default value (should not be specified). "NO_RESERVATION": Do not consume from any reserved capacity, "ANY_RESERVATION": Consume any reservation available, "SPECIFIC_RESERVATION": Must consume from a specific reservation. Must specify key value fields for specifying the reservations. || Optional |
379
381
| reservation_affinity_key | The label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "compute.googleapis.com/reservation-name" as the key and specify the name of your reservation as its value. || Optional |
380
382
| reservation_affinity_values | The list of label values of reservation resources. For example: the name of the specific reservation when using a key of "compute.googleapis.com/reservation-name". This should be passed as comma separated string. || Optional |
383
+
| local_ssd_encryption_mode | specifies the method used for encrypting the local SSDs attached to the node. Valid values are: "STANDARD_ENCRYPTION" and "EPHEMERAL_KEY_ENCRYPTION" || Optional |
381
384
382
385
## windows_node_pools variable
386
+
383
387
The windows_node_pools variable takes the same parameters as [node_pools](#node\_pools-variable) but is reserved for provisioning Windows based node pools only. This variable is introduced to satisfy a [specific requirement](https://cloud.google.com/kubernetes-engine/docs/how-to/creating-a-cluster-windows#create_a_cluster_and_node_pools) for the presence of at least one linux based node pool in the cluster before a windows based node pool can be created.
384
388
385
389
@@ -395,18 +399,26 @@ Before this module can be used on a project, you must ensure that the following
395
399
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.
-[Terraform Provider for GCP][terraform-provider-google] v6.27+
411
+
403
412
#### gcloud
413
+
404
414
Some submodules use the [terraform-google-gcloud](https://github.com/terraform-google-modules/terraform-google-gcloud) module. By default, this module assumes you already have gcloud installed in your $PATH.
405
415
See the [module](https://github.com/terraform-google-modules/terraform-google-gcloud#downloading) documentation for more information.
406
416
407
417
### Configure a Service Account
418
+
408
419
In order to execute this module you must have a Service Account with the
409
420
following project roles:
421
+
410
422
- roles/compute.viewer
411
423
- roles/compute.securityAdmin (only required if `add_cluster_firewall_rules` is set to `true`)
412
424
- roles/container.clusterAdmin
@@ -416,15 +428,17 @@ following project roles:
416
428
- roles/resourcemanager.projectIamAdmin (only required if `service_account` is set to `create`)
417
429
418
430
Additionally, if `service_account` is set to `create` and `grant_registry_access` is requested, the service account requires the following role on the `registry_project_ids` projects:
431
+
419
432
- roles/resourcemanager.projectIamAdmin
420
433
421
434
### Enable APIs
435
+
422
436
In order to operate with the Service Account you must activate the following APIs on the project where the Service Account was created:
423
437
424
438
- Compute Engine API - compute.googleapis.com
425
439
- Kubernetes Engine API - container.googleapis.com
Copy file name to clipboardExpand all lines: autogen/main/README.md
+20-5
Original file line number
Diff line number
Diff line change
@@ -3,6 +3,7 @@
3
3
This module handles opinionated Google Cloud Platform Kubernetes Engine cluster creation and configuration with Node Pools, IP MASQ, Network Policy, etc.{% if private_cluster %} This particular submodule creates a [private cluster](https://cloud.google.com/kubernetes-engine/docs/how-to/private-clusters){% endif %}{% if beta_cluster %}Beta features are enabled in this submodule.{% endif %}
4
4
5
5
The resources/services/activations/deletions that this module will create/trigger are:
6
+
6
7
- Create a GKE cluster with the provided addons
7
8
- Create GKE Node Pool(s) with provided configuration and attach to cluster
8
9
- Replace the default kube-dns configmap if `stub_domains` are provided
@@ -13,6 +14,7 @@ Sub modules are provided for creating private clusters, beta private clusters, a
13
14
14
15
{% if private_cluster %}
15
16
## Private Cluster Details
17
+
16
18
For details on configuring private clusters with this module, check the [troubleshooting guide](https://github.com/terraform-google-modules/terraform-google-kubernetes-engine/blob/master/docs/private_clusters.md).
17
19
18
20
{% endif %}
@@ -54,6 +56,7 @@ If you haven't [upgraded to 0.13][terraform-0.13-upgrade] and need a Terraform
54
56
intended for Terraform 0.12.x is [12.3.0].
55
57
56
58
## Usage
59
+
57
60
There are multiple examples included in the [examples](https://github.com/terraform-google-modules/terraform-google-kubernetes-engine/tree/master/examples) folder but simple usage is as follows:
58
61
59
62
```hcl
@@ -267,8 +270,10 @@ The node_pools variable takes the following parameters:
267
270
| consume_reservation_type | The type of reservation consumption. Accepted values are: "UNSPECIFIED": Default value (should not be specified). "NO_RESERVATION": Do not consume from any reserved capacity, "ANY_RESERVATION": Consume any reservation available, "SPECIFIC_RESERVATION": Must consume from a specific reservation. Must specify key value fields for specifying the reservations. || Optional |
268
271
| reservation_affinity_key | The label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "compute.googleapis.com/reservation-name" as the key and specify the name of your reservation as its value. || Optional |
269
272
| reservation_affinity_values | The list of label values of reservation resources. For example: the name of the specific reservation when using a key of "compute.googleapis.com/reservation-name". This should be passed as comma separated string. || Optional |
273
+
| local_ssd_encryption_mode | specifies the method used for encrypting the local SSDs attached to the node. Valid values are: "STANDARD_ENCRYPTION" and "EPHEMERAL_KEY_ENCRYPTION" || Optional |
270
274
271
275
## windows_node_pools variable
276
+
272
277
The windows_node_pools variable takes the same parameters as [node_pools](#node\_pools-variable) but is reserved for provisioning Windows based node pools only. This variable is introduced to satisfy a [specific requirement](https://cloud.google.com/kubernetes-engine/docs/how-to/creating-a-cluster-windows#create_a_cluster_and_node_pools) for the presence of at least one linux based node pool in the cluster before a windows based node pool can be created.
273
278
274
279
{% endif %}
@@ -285,22 +290,30 @@ Before this module can be used on a project, you must ensure that the following
285
290
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.
-[Terraform Provider for GCP Beta][terraform-provider-google-beta] v6.27+
294
303
{% else %}
295
304
-[Terraform Provider for GCP][terraform-provider-google] v6.27+
296
305
{% endif %}
306
+
297
307
#### gcloud
308
+
298
309
Some submodules use the [terraform-google-gcloud](https://github.com/terraform-google-modules/terraform-google-gcloud) module. By default, this module assumes you already have gcloud installed in your $PATH.
299
310
See the [module](https://github.com/terraform-google-modules/terraform-google-gcloud#downloading) documentation for more information.
300
311
301
312
### Configure a Service Account
313
+
302
314
In order to execute this module you must have a Service Account with the
303
315
following project roles:
316
+
304
317
- roles/compute.viewer
305
318
- roles/compute.securityAdmin (only required if `add_cluster_firewall_rules` is set to `true`)
306
319
- roles/container.clusterAdmin
@@ -310,19 +323,21 @@ following project roles:
310
323
- roles/resourcemanager.projectIamAdmin (only required if `service_account` is set to `create`)
311
324
312
325
Additionally, if `service_account` is set to `create` and `grant_registry_access` is requested, the service account requires the following role on the `registry_project_ids` projects:
326
+
313
327
- roles/resourcemanager.projectIamAdmin
314
328
315
329
### Enable APIs
330
+
316
331
In order to operate with the Service Account you must activate the following APIs on the project where the Service Account was created:
317
332
318
333
- Compute Engine API - compute.googleapis.com
319
334
- Kubernetes Engine API - container.googleapis.com
Copy file name to clipboardExpand all lines: modules/beta-autopilot-private-cluster/README.md
+17-4
Original file line number
Diff line number
Diff line change
@@ -2,6 +2,7 @@
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. This particular submodule creates a [private cluster](https://cloud.google.com/kubernetes-engine/docs/how-to/private-clusters)Beta features are enabled in this submodule.
4
4
The resources/services/activations/deletions that this module will create/trigger are:
5
+
5
6
- Create a GKE cluster with the provided addons
6
7
- Create GKE Node Pool(s) with provided configuration and attach to cluster
7
8
- Replace the default kube-dns configmap if `stub_domains` are provided
@@ -11,6 +12,7 @@ The resources/services/activations/deletions that this module will create/trigge
11
12
Sub modules are provided for creating private clusters, beta private clusters, and beta public clusters as well. Beta sub modules allow for the use of various GKE beta features. See the modules directory for the various sub modules.
12
13
13
14
## Private Cluster Details
15
+
14
16
For details on configuring private clusters with this module, check the [troubleshooting guide](https://github.com/terraform-google-modules/terraform-google-kubernetes-engine/blob/master/docs/private_clusters.md).
15
17
16
18
## Compatibility
@@ -27,6 +29,7 @@ If you haven't [upgraded to 0.13][terraform-0.13-upgrade] and need a Terraform
27
29
intended for Terraform 0.12.x is [12.3.0].
28
30
29
31
## Usage
32
+
30
33
There are multiple examples included in the [examples](https://github.com/terraform-google-modules/terraform-google-kubernetes-engine/tree/master/examples) folder but simple usage is as follows:
31
34
32
35
```hcl
@@ -216,18 +219,26 @@ Before this module can be used on a project, you must ensure that the following
216
219
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.
-[Terraform Provider for GCP Beta][terraform-provider-google-beta] v6.27+
231
+
224
232
#### gcloud
233
+
225
234
Some submodules use the [terraform-google-gcloud](https://github.com/terraform-google-modules/terraform-google-gcloud) module. By default, this module assumes you already have gcloud installed in your $PATH.
226
235
See the [module](https://github.com/terraform-google-modules/terraform-google-gcloud#downloading) documentation for more information.
227
236
228
237
### Configure a Service Account
238
+
229
239
In order to execute this module you must have a Service Account with the
230
240
following project roles:
241
+
231
242
- roles/compute.viewer
232
243
- roles/compute.securityAdmin (only required if `add_cluster_firewall_rules` is set to `true`)
233
244
- roles/container.clusterAdmin
@@ -237,15 +248,17 @@ following project roles:
237
248
- roles/resourcemanager.projectIamAdmin (only required if `service_account` is set to `create`)
238
249
239
250
Additionally, if `service_account` is set to `create` and `grant_registry_access` is requested, the service account requires the following role on the `registry_project_ids` projects:
251
+
240
252
- roles/resourcemanager.projectIamAdmin
241
253
242
254
### Enable APIs
255
+
243
256
In order to operate with the Service Account you must activate the following APIs on the project where the Service Account was created:
244
257
245
258
- Compute Engine API - compute.googleapis.com
246
259
- Kubernetes Engine API - container.googleapis.com
0 commit comments