Skip to content

Commit 7ec9c08

Browse files
committed
Add more detailed documentation for private cluster connectivity.
1 parent 27786a6 commit 7ec9c08

File tree

5 files changed

+51
-6
lines changed

5 files changed

+51
-6
lines changed

autogen/README.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,18 @@ The resources/services/activations/deletions that this module will create/trigge
1212
Sub modules are provided from 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.
1313

1414
{% if private_cluster %}
15-
**Note**: You must run Terraform from a VM on the same VPC as your cluster, otherwise there will be issues connecting to the GKE master.
15+
## Private Cluster Endpoints
16+
When creating a [private cluster](https://cloud.google.com/kubernetes-engine/docs/how-to/private-clusters), nodes are provisioned with private IPs.
17+
The Kubernetes master endpoint is also [locked down](https://cloud.google.com/kubernetes-engine/docs/how-to/private-clusters#access_to_the_cluster_endpoints), which affects these module features:
18+
- `configure_ip_masq`
19+
- `stub_domains`
1620

17-
{% endif %}
21+
If you are *not* using these features, then the module will function normally for private clusters and no special configuration is needed.
22+
If you are using these features with a private cluster, you will need to either:
23+
1. Run Terraform from a VM on the same VPC as your cluster (allowing it to connect to the private endpoint) and set `deploy_using_private_endpoint` to `true`.
24+
2. Include the external IP of your Terraform deployer in the `master_authorized_networks_config`.
25+
26+
{% endif %}
1827

1928
## Compatibility
2029

modules/beta-private-cluster-update-variant/README.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,16 @@ The resources/services/activations/deletions that this module will create/trigge
1010

1111
Sub modules are provided from 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.
1212

13-
**Note**: You must run Terraform from a VM on the same VPC as your cluster, otherwise there will be issues connecting to the GKE master.
13+
## Private Cluster Endpoints
14+
When creating a [private cluster](https://cloud.google.com/kubernetes-engine/docs/how-to/private-clusters), nodes are provisioned with private IPs.
15+
The Kubernetes master endpoint is also [locked down](https://cloud.google.com/kubernetes-engine/docs/how-to/private-clusters#access_to_the_cluster_endpoints), which affects these module features:
16+
- `configure_ip_masq`
17+
- `stub_domains`
18+
19+
If you are *not* using these features, then the module will function normally for private clusters and no special configuration is needed.
20+
If you are using these features with a private cluster, you will need to either:
21+
1. Run Terraform from a VM on the same VPC as your cluster (allowing it to connect to the private endpoint) and set `deploy_using_private_endpoint` to `true`.
22+
2. Include the external IP of your Terraform deployer in the `master_authorized_networks_config`.
1423

1524

1625
## Compatibility

modules/beta-private-cluster/README.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,16 @@ The resources/services/activations/deletions that this module will create/trigge
1010

1111
Sub modules are provided from 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.
1212

13-
**Note**: You must run Terraform from a VM on the same VPC as your cluster, otherwise there will be issues connecting to the GKE master.
13+
## Private Cluster Endpoints
14+
When creating a [private cluster](https://cloud.google.com/kubernetes-engine/docs/how-to/private-clusters), nodes are provisioned with private IPs.
15+
The Kubernetes master endpoint is also [locked down](https://cloud.google.com/kubernetes-engine/docs/how-to/private-clusters#access_to_the_cluster_endpoints), which affects these module features:
16+
- `configure_ip_masq`
17+
- `stub_domains`
18+
19+
If you are *not* using these features, then the module will function normally for private clusters and no special configuration is needed.
20+
If you are using these features with a private cluster, you will need to either:
21+
1. Run Terraform from a VM on the same VPC as your cluster (allowing it to connect to the private endpoint) and set `deploy_using_private_endpoint` to `true`.
22+
2. Include the external IP of your Terraform deployer in the `master_authorized_networks_config`.
1423

1524

1625
## Compatibility

modules/private-cluster-update-variant/README.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,16 @@ The resources/services/activations/deletions that this module will create/trigge
1010

1111
Sub modules are provided from 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.
1212

13-
**Note**: You must run Terraform from a VM on the same VPC as your cluster, otherwise there will be issues connecting to the GKE master.
13+
## Private Cluster Endpoints
14+
When creating a [private cluster](https://cloud.google.com/kubernetes-engine/docs/how-to/private-clusters), nodes are provisioned with private IPs.
15+
The Kubernetes master endpoint is also [locked down](https://cloud.google.com/kubernetes-engine/docs/how-to/private-clusters#access_to_the_cluster_endpoints), which affects these module features:
16+
- `configure_ip_masq`
17+
- `stub_domains`
18+
19+
If you are *not* using these features, then the module will function normally for private clusters and no special configuration is needed.
20+
If you are using these features with a private cluster, you will need to either:
21+
1. Run Terraform from a VM on the same VPC as your cluster (allowing it to connect to the private endpoint) and set `deploy_using_private_endpoint` to `true`.
22+
2. Include the external IP of your Terraform deployer in the `master_authorized_networks_config`.
1423

1524

1625
## Compatibility

modules/private-cluster/README.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,16 @@ The resources/services/activations/deletions that this module will create/trigge
1010

1111
Sub modules are provided from 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.
1212

13-
**Note**: You must run Terraform from a VM on the same VPC as your cluster, otherwise there will be issues connecting to the GKE master.
13+
## Private Cluster Endpoints
14+
When creating a [private cluster](https://cloud.google.com/kubernetes-engine/docs/how-to/private-clusters), nodes are provisioned with private IPs.
15+
The Kubernetes master endpoint is also [locked down](https://cloud.google.com/kubernetes-engine/docs/how-to/private-clusters#access_to_the_cluster_endpoints), which affects these module features:
16+
- `configure_ip_masq`
17+
- `stub_domains`
18+
19+
If you are *not* using these features, then the module will function normally for private clusters and no special configuration is needed.
20+
If you are using these features with a private cluster, you will need to either:
21+
1. Run Terraform from a VM on the same VPC as your cluster (allowing it to connect to the private endpoint) and set `deploy_using_private_endpoint` to `true`.
22+
2. Include the external IP of your Terraform deployer in the `master_authorized_networks_config`.
1423

1524

1625
## Compatibility

0 commit comments

Comments
 (0)