Skip to content

Commit 6fcdf76

Browse files
committed
update docs
1 parent 08d7720 commit 6fcdf76

File tree

6 files changed

+15
-6
lines changed

6 files changed

+15
-6
lines changed

README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,7 @@ Then perform the following commands on the root folder:
9797

9898
| Name | Description | Type | Default | Required |
9999
|------|-------------|:----:|:-----:|:-----:|
100+
| cluster_resource_labels | Map containing cluster labels. Maximum of 64 labels | map | `<map>` | no |
100101
| description | The description of the cluster | string | `` | no |
101102
| horizontal_pod_autoscaling | Enable horizontal pod autoscaling addon | string | `true` | no |
102103
| http_load_balancing | Enable httpload balancer addon | string | `true` | no |
@@ -114,7 +115,6 @@ Then perform the following commands on the root folder:
114115
| network | The VPC network to host the cluster in (required) | string | - | yes |
115116
| network_policy | Enable network policy addon | string | `false` | no |
116117
| network_project_id | The project ID of the shared VPC's host (for shared vpc support) | string | `` | no |
117-
| remove_default_node_pool | Boolean value determining removal of default node pool | bool | false | no |
118118
| node_pools | List of maps containing node pools | list | `<list>` | no |
119119
| node_pools_labels | Map of maps containing node labels by node-pool name | map | `<map>` | no |
120120
| node_pools_metadata | Map of maps containing node metadata by node-pool name | map | `<map>` | no |
@@ -125,7 +125,8 @@ Then perform the following commands on the root folder:
125125
| project_id | The project ID to host the cluster in (required) | string | - | yes |
126126
| region | The region to host the cluster in (required) | string | - | yes |
127127
| regional | Whether is a regional cluster (zonal cluster if set false. WARNING: changing this after cluster creation is destructive!) | string | `true` | no |
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 |
128+
| remove_default_node_pool | Remove default node pool while setting up the cluster | string | `false` | no |
129+
| service_account | The service account to default running nodes as if not overridden in `node_pools`. Defaults to the compute engine default service account. May also specify `create` to automatically create a cluster-specific service account | string | `` | no |
129130
| 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 |
130131
| subnetwork | The subnetwork to host the cluster in (required) | string | - | yes |
131132
| zones | The zones to host the cluster in (optional if regional cluster / required if zonal) | list | `<list>` | no |
@@ -314,4 +315,4 @@ are as follows:
314315
is a compiled language so there is no standard linter.
315316
* Terraform - terraform has a built-in linter in the 'terraform validate'
316317
command.
317-
* Dockerfiles - hadolint. Can be found in homebrew
318+
* Dockerfiles - hadolint. Can be found in homebrew

examples/simple_regional/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ This example illustrates how to create a simple cluster.
1010
| Name | Description | Type | Default | Required |
1111
|------|-------------|:----:|:-----:|:-----:|
1212
| cluster_name_suffix | A suffix to append to the default cluster name | string | `` | no |
13+
| cluster_resource_labels | Map containing cluster labels. Maximum of 64 labels | map | `<map>` | no |
1314
| compute_engine_service_account | Service account to associate to the nodes in the cluster | string | - | yes |
1415
| credentials_path | The path to the GCP credentials JSON file | string | - | yes |
1516
| ip_range_pods | The secondary ip range to use for pods | string | - | yes |

examples/simple_regional_private/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ This example illustrates how to create a simple private cluster.
1010
| Name | Description | Type | Default | Required |
1111
|------|-------------|:----:|:-----:|:-----:|
1212
| cluster_name_suffix | A suffix to append to the default cluster name | string | `` | no |
13+
| cluster_resource_labels | Map containing cluster labels. Maximum of 64 labels | map | `<map>` | no |
1314
| compute_engine_service_account | Service account to associate to the nodes in the cluster | string | - | yes |
1415
| credentials_path | The path to the GCP credentials JSON file | string | - | yes |
1516
| ip_range_pods | The secondary ip range to use for pods | string | - | yes |

examples/simple_zonal/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ This example illustrates how to create a simple cluster.
1010
| Name | Description | Type | Default | Required |
1111
|------|-------------|:----:|:-----:|:-----:|
1212
| cluster_name_suffix | A suffix to append to the default cluster name | string | `` | no |
13+
| cluster_resource_labels | Map containing cluster labels. Maximum of 64 labels | map | `<map>` | no |
1314
| credentials_path | The path to the GCP credentials JSON file | string | - | yes |
1415
| ip_range_pods | The secondary ip range to use for pods | string | - | yes |
1516
| ip_range_services | The secondary ip range to use for pods | string | - | yes |

examples/simple_zonal_private/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ This example illustrates how to create a simple private cluster.
1010
| Name | Description | Type | Default | Required |
1111
|------|-------------|:----:|:-----:|:-----:|
1212
| cluster_name_suffix | A suffix to append to the default cluster name | string | `` | no |
13+
| cluster_resource_labels | Map containing cluster labels. Maximum of 64 labels | map | `<map>` | no |
1314
| compute_engine_service_account | Service account to associate to the nodes in the cluster | string | - | yes |
1415
| credentials_path | The path to the GCP credentials JSON file | string | - | yes |
1516
| ip_range_pods | The secondary ip range to use for pods | string | - | yes |

modules/private-cluster/README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,10 @@ Then perform the following commands on the root folder:
100100

101101
| Name | Description | Type | Default | Required |
102102
|------|-------------|:----:|:-----:|:-----:|
103+
| cluster_resource_labels | Map containing cluster labels. Maximum of 64 labels | map | `<map>` | no |
103104
| description | The description of the cluster | string | `` | no |
105+
| enable_private_endpoint | (Beta) Whether the master's internal IP address is used as the cluster endpoint | string | `false` | no |
106+
| enable_private_nodes | (Beta) Whether nodes have internal IP addresses only | string | `false` | no |
104107
| horizontal_pod_autoscaling | Enable horizontal pod autoscaling addon | string | `true` | no |
105108
| http_load_balancing | Enable httpload balancer addon | string | `true` | no |
106109
| ip_masq_link_local | Whether to masquerade traffic to the link-local prefix (169.254.0.0/16). | string | `false` | no |
@@ -112,12 +115,12 @@ Then perform the following commands on the root folder:
112115
| 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 |
113116
| maintenance_start_time | Time window specified for daily maintenance operations in RFC3339 format | string | `05:00` | no |
114117
| 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+
| master_ipv4_cidr_block | (Beta) The IP range in CIDR notation to use for the hosted master network | string | `10.0.0.0/28` | no |
115119
| 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 |
116120
| name | The name of the cluster (required) | string | - | yes |
117121
| network | The VPC network to host the cluster in (required) | string | - | yes |
118122
| network_policy | Enable network policy addon | string | `false` | no |
119123
| network_project_id | The project ID of the shared VPC's host (for shared vpc support) | string | `` | no |
120-
| remove_default_node_pool | Boolean value determining removal of default node pool | bool | false | no |
121124
| node_pools | List of maps containing node pools | list | `<list>` | no |
122125
| node_pools_labels | Map of maps containing node labels by node-pool name | map | `<map>` | no |
123126
| node_pools_metadata | Map of maps containing node metadata by node-pool name | map | `<map>` | no |
@@ -128,7 +131,8 @@ Then perform the following commands on the root folder:
128131
| project_id | The project ID to host the cluster in (required) | string | - | yes |
129132
| region | The region to host the cluster in (required) | string | - | yes |
130133
| regional | Whether is a regional cluster (zonal cluster if set false. WARNING: changing this after cluster creation is destructive!) | string | `true` | no |
131-
| 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 |
134+
| remove_default_node_pool | Remove default node pool while setting up the cluster | string | `false` | no |
135+
| service_account | The service account to default running nodes as if not overridden in `node_pools`. Defaults to the compute engine default service account. May also specify `create` to automatically create a cluster-specific service account | string | `` | no |
132136
| 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 |
133137
| subnetwork | The subnetwork to host the cluster in (required) | string | - | yes |
134138
| zones | The zones to host the cluster in (optional if regional cluster / required if zonal) | list | `<list>` | no |
@@ -317,4 +321,4 @@ are as follows:
317321
is a compiled language so there is no standard linter.
318322
* Terraform - terraform has a built-in linter in the 'terraform validate'
319323
command.
320-
* Dockerfiles - hadolint. Can be found in homebrew
324+
* Dockerfiles - hadolint. Can be found in homebrew

0 commit comments

Comments
 (0)