[DOC-431] Added a note for GKE cluster docs (#23349)

* added a note message * edits based on suggestions * format * copied to older versions --------- Co-authored-by: Dwight Hodge <[email protected]>
yugabyte · Aug 20, 2024 · e4645e5 · e4645e5
1 parent 507432b
commit e4645e5
Show file tree

Hide file tree

Showing 12 changed files with 48 additions and 25 deletions.
diff --git a/docs/content/preview/deploy/kubernetes/single-zone/gke/helm-chart.md b/docs/content/preview/deploy/kubernetes/single-zone/gke/helm-chart.md
@@ -85,12 +85,14 @@ The following steps show how to meet these prerequisites:
 
 ## Create a GKE cluster
 
-Create a Kubernetes cluster by running the following command:
+Create a private Kubernetes cluster by running the following command.
 
 ```sh
-gcloud container clusters create yugabyte --machine-type=n1-standard-8
+gcloud container clusters create cluster_name --enable-private-nodes --machine-type=n1-standard-8
 ```
 
+Note that you must set up Cloud NAT for a private Kubernetes cluster in Google Cloud to ensure that your cluster can access the internet while its nodes do not have public IP addresses. Refer to [Configuring Private Google Access and Cloud NAT in Google Cloud Platform (GCP)](https://kloudkraft.medium.com/configuring-private-google-access-and-cloud-nat-in-google-cloud-platform-gcp-3c4406b590b3).
+
 As stated in [Prerequisites](#prerequisites), the default configuration in the YugabyteDB Helm chart requires Kubernetes nodes to have a total of 12 CPU cores and 45 GB RAM allocated to YugabyteDB. This can be three nodes with 4 CPU cores and 15 GB RAM allocated to YugabyteDB. The smallest Google Cloud machine type that meets this requirement is `n1-standard-8` which has 8 CPU cores and 30GB RAM.
 
 ## Create a YugabyteDB cluster

diff --git a/...content/preview/deploy/kubernetes/single-zone/gke/statefulset-yaml-local-ssd.md b/...content/preview/deploy/kubernetes/single-zone/gke/statefulset-yaml-local-ssd.md
@@ -70,12 +70,14 @@ Each cluster brings up three nodes each of the type `n1-standard-1` for the Kube
   ...
   ```
 
-- Create a Kubernetes cluster on GKE by running the following in order to create a cluster in the desired zone:
+- Create a private Kubernetes cluster on GKE in the desired zone by running the following.
 
   ```sh
-  gcloud container clusters create yugabyte --zone us-west1-b
+  gcloud container clusters create cluster_name --enable-private-nodes --zone us-west1-b
   ```
 
+  Note that you must set up Cloud NAT for a private Kubernetes cluster in Google Cloud to ensure that your cluster can access the internet while its nodes do not have public IP addresses. Refer to [Configuring Private Google Access and Cloud NAT in Google Cloud Platform (GCP)](https://kloudkraft.medium.com/configuring-private-google-access-and-cloud-nat-in-google-cloud-platform-gcp-3c4406b590b3).
+
 - List the available cluster by running the following command:
 
   ```sh

diff --git a/docs/content/preview/deploy/kubernetes/single-zone/gke/statefulset-yaml.md b/docs/content/preview/deploy/kubernetes/single-zone/gke/statefulset-yaml.md
@@ -35,7 +35,6 @@ type: docs
   </li>
 </ul>
 
-
 ## Prerequisites
 
 Before starting deployment, perform the following:
@@ -64,12 +63,14 @@ Before starting deployment, perform the following:
 
 ## Create a GKE cluster
 
-Create a Kubernetes cluster by running the following command.
+Create a private Kubernetes cluster using the following command.
 
 ```sh
-gcloud container clusters create yugabyte
+gcloud container clusters create cluster_name --enable-private-nodes
 ```
 
+Note that you must set up Cloud NAT for a private Kubernetes cluster in Google Cloud to ensure that your cluster can access the internet while its nodes do not have public IP addresses. Refer to [Configuring Private Google Access and Cloud NAT in Google Cloud Platform (GCP)](https://kloudkraft.medium.com/configuring-private-google-access-and-cloud-nat-in-google-cloud-platform-gcp-3c4406b590b3).
+
 ## Create a YugabyteDB cluster
 
 Create a YugabyteDB cluster by running the following command:

diff --git a/docs/content/stable/deploy/kubernetes/single-zone/gke/helm-chart.md b/docs/content/stable/deploy/kubernetes/single-zone/gke/helm-chart.md
@@ -82,12 +82,14 @@ The following steps show how to meet these prerequisites:
 
 ## Create a GKE cluster
 
-Create a Kubernetes cluster by running the following command:
+Create a private Kubernetes cluster by running the following command.
 
 ```sh
-gcloud container clusters create yugabyte --machine-type=n1-standard-8
+gcloud container clusters create cluster_name --enable-private-nodes --machine-type=n1-standard-8
 ```
 
+Note that you must set up Cloud NAT for a private Kubernetes cluster in Google Cloud to ensure that your cluster can access the internet while its nodes do not have public IP addresses. Refer to [Configuring Private Google Access and Cloud NAT in Google Cloud Platform (GCP)](https://kloudkraft.medium.com/configuring-private-google-access-and-cloud-nat-in-google-cloud-platform-gcp-3c4406b590b3).
+
 As stated in [Prerequisites](#prerequisites), the default configuration in the YugabyteDB Helm chart requires Kubernetes nodes to have a total of 12 CPU cores and 45 GB RAM allocated to YugabyteDB. This can be three nodes with 4 CPU cores and 15 GB RAM allocated to YugabyteDB. The smallest Google Cloud machine type that meets this requirement is `n1-standard-8` which has 8 CPU cores and 30GB RAM.
 
 ## Create a YugabyteDB cluster

diff --git a/.../content/stable/deploy/kubernetes/single-zone/gke/statefulset-yaml-local-ssd.md b/.../content/stable/deploy/kubernetes/single-zone/gke/statefulset-yaml-local-ssd.md
@@ -68,12 +68,14 @@ Each cluster brings up three nodes each of the type `n1-standard-1` for the Kube
   ...
   ```
 
-- Create a Kubernetes cluster on GKE by running the following in order to create a cluster in the desired zone:
+- Create a private Kubernetes cluster on GKE in the desired zone by running the following.
 
   ```sh
-  gcloud container clusters create yugabyte --zone us-west1-b
+  gcloud container clusters create cluster_name --enable-private-nodes --zone us-west1-b
   ```
 
+  Note that you must set up Cloud NAT for a private Kubernetes cluster in Google Cloud to ensure that your cluster can access the internet while its nodes do not have public IP addresses. Refer to [Configuring Private Google Access and Cloud NAT in Google Cloud Platform (GCP)](https://kloudkraft.medium.com/configuring-private-google-access-and-cloud-nat-in-google-cloud-platform-gcp-3c4406b590b3).
+
 - List the available cluster by running the following command:
 
   ```sh

diff --git a/docs/content/stable/deploy/kubernetes/single-zone/gke/statefulset-yaml.md b/docs/content/stable/deploy/kubernetes/single-zone/gke/statefulset-yaml.md
@@ -62,12 +62,14 @@ Before starting deployment, perform the following:
 
 ## Create a GKE cluster
 
-Create a Kubernetes cluster by running the following command.
+Create a private Kubernetes cluster using the following command.
 
 ```sh
-gcloud container clusters create yugabyte
+gcloud container clusters create cluster_name --enable-private-nodes
 ```
 
+Note that you must set up Cloud NAT for a private Kubernetes cluster in Google Cloud to ensure that your cluster can access the internet while its nodes do not have public IP addresses. Refer to [Configuring Private Google Access and Cloud NAT in Google Cloud Platform (GCP)](https://kloudkraft.medium.com/configuring-private-google-access-and-cloud-nat-in-google-cloud-platform-gcp-3c4406b590b3).
+
 ## Create a YugabyteDB cluster
 
 Create a YugabyteDB cluster by running the following command:

diff --git a/docs/content/v2.18/deploy/kubernetes/single-zone/gke/helm-chart.md b/docs/content/v2.18/deploy/kubernetes/single-zone/gke/helm-chart.md
@@ -82,12 +82,14 @@ The following steps show how to meet these prerequisites:
 
 ## Create a GKE cluster
 
-Create a Kubernetes cluster by running the following command:
+Create a private Kubernetes cluster using the following command.
 
 ```sh
-gcloud container clusters create yugabyte --machine-type=n1-standard-8
+gcloud container clusters create cluster_name --enable-private-nodes
 ```
 
+Note that you must set up Cloud NAT for a private Kubernetes cluster in Google Cloud to ensure that your cluster can access the internet while its nodes do not have public IP addresses. Refer to [Configuring Private Google Access and Cloud NAT in Google Cloud Platform (GCP)](https://kloudkraft.medium.com/configuring-private-google-access-and-cloud-nat-in-google-cloud-platform-gcp-3c4406b590b3).
+
 As stated in [Prerequisites](#prerequisites), the default configuration in the YugabyteDB Helm chart requires Kubernetes nodes to have a total of 12 CPU cores and 45 GB RAM allocated to YugabyteDB. This can be three nodes with 4 CPU cores and 15 GB RAM allocated to YugabyteDB. The smallest Google Cloud machine type that meets this requirement is `n1-standard-8` which has 8 CPU cores and 30GB RAM.
 
 ## Create a YugabyteDB cluster

diff --git a/docs/content/v2.18/deploy/kubernetes/single-zone/gke/statefulset-yaml-local-ssd.md b/docs/content/v2.18/deploy/kubernetes/single-zone/gke/statefulset-yaml-local-ssd.md
@@ -68,12 +68,14 @@ Each cluster brings up three nodes each of the type `n1-standard-1` for the Kube
   ...
   ```
 
-- Create a Kubernetes cluster on GKE by running the following in order to create a cluster in the desired zone:
+- Create a private Kubernetes cluster using the following command.
 
   ```sh
-  gcloud container clusters create yugabyte --zone us-west1-b
+  gcloud container clusters create cluster_name --enable-private-nodes
   ```
 
+  Note that you must set up Cloud NAT for a private Kubernetes cluster in Google Cloud to ensure that your cluster can access the internet while its nodes do not have public IP addresses. Refer to [Configuring Private Google Access and Cloud NAT in Google Cloud Platform (GCP)](https://kloudkraft.medium.com/configuring-private-google-access-and-cloud-nat-in-google-cloud-platform-gcp-3c4406b590b3).
+
 - List the available cluster by running the following command:
 
   ```sh

diff --git a/docs/content/v2.18/deploy/kubernetes/single-zone/gke/statefulset-yaml.md b/docs/content/v2.18/deploy/kubernetes/single-zone/gke/statefulset-yaml.md
@@ -62,12 +62,14 @@ Before starting deployment, perform the following:
 
 ## Create a GKE cluster
 
-Create a Kubernetes cluster by running the following command.
+Create a private Kubernetes cluster using the following command.
 
 ```sh
-gcloud container clusters create yugabyte
+gcloud container clusters create cluster_name --enable-private-nodes
 ```
 
+Note that you must set up Cloud NAT for a private Kubernetes cluster in Google Cloud to ensure that your cluster can access the internet while its nodes do not have public IP addresses. Refer to [Configuring Private Google Access and Cloud NAT in Google Cloud Platform (GCP)](https://kloudkraft.medium.com/configuring-private-google-access-and-cloud-nat-in-google-cloud-platform-gcp-3c4406b590b3).
+
 ## Create a YugabyteDB cluster
 
 Create a YugabyteDB cluster by running the following command:

diff --git a/docs/content/v2.20/deploy/kubernetes/single-zone/gke/helm-chart.md b/docs/content/v2.20/deploy/kubernetes/single-zone/gke/helm-chart.md
@@ -82,12 +82,14 @@ The following steps show how to meet these prerequisites:
 
 ## Create a GKE cluster
 
-Create a Kubernetes cluster by running the following command:
+Create a private Kubernetes cluster using the following command.
 
 ```sh
-gcloud container clusters create yugabyte --machine-type=n1-standard-8
+gcloud container clusters create cluster_name --enable-private-nodes
 ```
 
+Note that you must set up Cloud NAT for a private Kubernetes cluster in Google Cloud to ensure that your cluster can access the internet while its nodes do not have public IP addresses. Refer to [Configuring Private Google Access and Cloud NAT in Google Cloud Platform (GCP)](https://kloudkraft.medium.com/configuring-private-google-access-and-cloud-nat-in-google-cloud-platform-gcp-3c4406b590b3).
+
 As stated in [Prerequisites](#prerequisites), the default configuration in the YugabyteDB Helm chart requires Kubernetes nodes to have a total of 12 CPU cores and 45 GB RAM allocated to YugabyteDB. This can be three nodes with 4 CPU cores and 15 GB RAM allocated to YugabyteDB. The smallest Google Cloud machine type that meets this requirement is `n1-standard-8` which has 8 CPU cores and 30GB RAM.
 
 ## Create a YugabyteDB cluster

diff --git a/docs/content/v2.20/deploy/kubernetes/single-zone/gke/statefulset-yaml-local-ssd.md b/docs/content/v2.20/deploy/kubernetes/single-zone/gke/statefulset-yaml-local-ssd.md
@@ -68,12 +68,14 @@ Each cluster brings up three nodes each of the type `n1-standard-1` for the Kube
   ...
   ```
 
-- Create a Kubernetes cluster on GKE by running the following in order to create a cluster in the desired zone:
+- Create a private Kubernetes cluster using the following command.
 
   ```sh
-  gcloud container clusters create yugabyte --zone us-west1-b
+  gcloud container clusters create cluster_name --enable-private-nodes
   ```
 
+  Note that you must set up Cloud NAT for a private Kubernetes cluster in Google Cloud to ensure that your cluster can access the internet while its nodes do not have public IP addresses. Refer to [Configuring Private Google Access and Cloud NAT in Google Cloud Platform (GCP)](https://kloudkraft.medium.com/configuring-private-google-access-and-cloud-nat-in-google-cloud-platform-gcp-3c4406b590b3).
+
 - List the available cluster by running the following command:
 
   ```sh

diff --git a/docs/content/v2.20/deploy/kubernetes/single-zone/gke/statefulset-yaml.md b/docs/content/v2.20/deploy/kubernetes/single-zone/gke/statefulset-yaml.md
@@ -62,12 +62,14 @@ Before starting deployment, perform the following:
 
 ## Create a GKE cluster
 
-Create a Kubernetes cluster by running the following command.
+Create a private Kubernetes cluster using the following command.
 
 ```sh
-gcloud container clusters create yugabyte
+gcloud container clusters create cluster_name --enable-private-nodes
 ```
 
+Note that you must set up Cloud NAT for a private Kubernetes cluster in Google Cloud to ensure that your cluster can access the internet while its nodes do not have public IP addresses. Refer to [Configuring Private Google Access and Cloud NAT in Google Cloud Platform (GCP)](https://kloudkraft.medium.com/configuring-private-google-access-and-cloud-nat-in-google-cloud-platform-gcp-3c4406b590b3).
+
 ## Create a YugabyteDB cluster
 
 Create a YugabyteDB cluster by running the following command: