RHIDP-1923 - GKE: Document how RHDH can be installed in GKE

Gerry-Forde · Gerry-Forde · commit 103d1f5066d7 · 2024-11-20T11:56:09.000Z
diff --git a/modules/installation/proc-deploy-rhdh-instance-gke.adoc b/modules/installation/proc-deploy-rhdh-instance-gke.adoc
@@ -8,12 +8,21 @@
 .Prerequisites
 
 * A cluster administrator has installed the {product} Operator.
+* You have subscribed to `registry.redhat.io`. For more information, see https://access.redhat.com/RegistryAuthentication[{company-name} Container Registry Authentication].
+* You have installed `kubectl`. For more information, see https://kubernetes.io/docs/tasks/tools/#kubectl[Install kubetl].
+
+* You have configured a domain name for your {product-short} instance.
+* You have reserved a static external Premium IPv4 Global IP address that is not attached to any VM.
+* You have configured the DNS records for your domain name to point to the IP address that have reseved. For more information see https://cloud.google.com/vpc/docs/reserve-static-external-ip-address#reserve_new_static[Reserve a new static external IP address]
++
+[NOTE]
+You need to create an `A` record with the value equal to the IP address. This can take up to one hour to propagate.
+
 //* You have an {eks-short} cluster with {aws-short} Application Load Balancer (ALB) add-on installed. For more information, see https://docs.aws.amazon.com/eks/latest/userguide/alb-ingress.html[Application load balancing on {eks-brand-name}] and https://docs.aws.amazon.com/eks/latest/userguide/aws-load-balancer-controller.html[Installing the AWS Load Balancer Controller add-on].
 //* You have configured a domain name for your {product-short} instance. The domain name can be a hosted zone entry on Route 53 or managed outside of AWS. For more information, see https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-configuring.html[Configuring Amazon Route 53 as your DNS service] documentation.
 //* You have an entry in the {aws-short} Certificate Manager (ACM) for your preferred domain name. Make sure to keep a record of your Certificate ARN.
-* You have subscribed to `registry.redhat.io`. For more information, see https://access.redhat.com/RegistryAuthentication[{company-name} Container Registry Authentication].
 //* You have set the context to the {eks-short} cluster in your current `kubeconfig`. For more information, see https://docs.aws.amazon.com/eks/latest/userguide/create-kubeconfig.html[Creating or updating a kubeconfig file for an Amazon {eks-short} cluster].
-* You have installed `kubectl`. For more information, see https://docs.aws.amazon.com/eks/latest/userguide/install-kubectl.html[Installing or updating kubectl].
+
 
 .Procedure
 
@@ -90,7 +99,7 @@ kubectl patch serviceaccount default \
 apiVersion: rhdh.redhat.com/v1alpha1
 kind: Backstage
 metadata:
- # TODO: this the name of your {product-short} instance
+  # This is the name of your {product-short} instance
   name: my-rhdh
 spec:
   application:
@@ -107,7 +116,7 @@ spec:
 ----
 --
 
-. Set up a Google-managed certificate by creating a `ManagedCertificate` object that you will later attach to the Ingress.
+. Set up a Google-managed certificate by creating a `ManagedCertificate` object which you will attach to the Ingress.
 +
 --
 [source,yaml,subs="attributes+"]
@@ -121,9 +130,9 @@ spec:
     - <rhdh_domain_name>
 ----
 --
-For more information about setting up a Google-managed certificate, see https://cloud.google.com/kubernetes-engine/docs/how-to/managed-certs?hl=en#setting_up_a_google-managed_certificate 
+For more information about setting up a Google-managed certificate, see https://cloud.google.com/kubernetes-engine/docs/how-to/managed-certs?hl=en#setting_up_a_google-managed_certificate[Setting up a Google-managed certificate]. 
 
-. Create a `FrontendConfig` object to set a policy for redirecting to HTTPS. You will later attach this policy to the Ingress. 
+. Create a `FrontendConfig` object to set a policy for redirecting to HTTPS. You will attach this policy to the Ingress. 
 +
 --
 [source,yaml,subs="attributes+"]
@@ -138,7 +147,7 @@ spec:
     enabled: true
 ----
 --
-For more information about setting a policy to redirect to HTTPS, see https://cloud.google.com/kubernetes-engine/docs/how-to/ingress-configuration?hl=en#https_redirect
+For more information about setting a policy to redirect to HTTPS, see https://cloud.google.com/kubernetes-engine/docs/how-to/ingress-configuration?hl=en#https_redirect[HTTP to HTTPS redirects].
 
 . Create an Ingress resource using the following template, customizing the names as needed:
 +
@@ -182,10 +191,14 @@ spec:
 [IMPORTANT]
 Use the HTTPS protocol, not HTTP.
 
+.Verification
+
+Wait until the DNS name is responsive, indicating that your {product-short} instance is ready for use.
+
 .Additional information
-For more information on setting up GKE using Ingress with TLS, see https://github.com/GoogleCloudPlatform/gke-networking-recipes/tree/main/ingress/single-cluster/ingress-https 
+For more information on setting up {gke-short} using Ingress with TLS, see https://github.com/GoogleCloudPlatform/gke-networking-recipes/tree/main/ingress/single-cluster/ingress-https 
 
-For more information on setting up GKE with LoadBalancer instead of Ingress, see https://github.com/sumiranchugh/rhdh-gke-poc/tree/main 
+For more information on setting up {gke-short} with LoadBalancer instead of Ingress, see https://github.com/sumiranchugh/rhdh-gke-poc/tree/main 
 
 
 
diff --git a/modules/installation/proc-rhdh-deploy-gke-helm.adoc b/modules/installation/proc-rhdh-deploy-gke-helm.adoc
@@ -4,16 +4,27 @@
 [id='proc-rhdh-deploy-gke-helm_{context}']
 = Installing {product-short} on {gke-short} with the Helm chart
 
-When you install the {product-short} Helm chart in {gke-name} ({gke-short}), it orchestrates the deployment of a {product-short} instance, which provides a robust developer platform within the {gke-short} ecosystem.
+When you install the {product-short} Helm chart in {gke-brand-name} ({gke-short}), it orchestrates the deployment of a {product-short} instance, which provides a robust developer platform within the {gke-short} ecosystem.
 
 .Prerequisites
+* You have subscribed to `registry.redhat.io`. For more information, see https://access.redhat.com/RegistryAuthentication[{company-name} Container Registry Authentication].
+* You have installed `kubectl`. For more information, see https://kubernetes.io/docs/tasks/tools/#kubectl[Install kubetl].
+* You have installed the Google Cloud CLI. For more information, see https://cloud.google.com/sdk/docs/install[Install the gcloud CLI].
+* You have logged in to your Google account and created a https://https://cloud.google.com/kubernetes-engine/docs/how-to/creating-an-autopilot-cluster[GKE Autopilot] or https://cloud.google.com/kubernetes-engine/docs/how-to/creating-a-zonal-cluster[GKE Standard] cluster.
+* You have installed Helm 3 or the latest version. For more information, see https://docs.aws.amazon.com/eks/latest/userguide/helm.html[Using Helm with Amazon {eks-short}].
+
+* You have configured a domain name for your {product-short} instance.
+* You have reserved a static external Premium IPv4 Global IP address that is not attached to any VM.
+* You have configured the DNS records for your domain name to point to the IP address that have reseved. For more information see https://cloud.google.com/vpc/docs/reserve-static-external-ip-address#reserve_new_static[Reserve a new static external IP address]
++
+[NOTE]
+You need to create an `A` record with the value equal to the IP address. This can take up to one hour to propagate.
+* You have installed Helm 3 or the latest. For more information, see https://helm.sh/docs/intro/install[Installing Helm].
 
 //* You have an {eks-short} cluster with AWS Application Load Balancer (ALB) add-on installed. For more information, see https://docs.aws.amazon.com/eks/latest/userguide/alb-ingress.html[Application load balancing on Amazon {product-short}] and https://docs.aws.amazon.com/eks/latest/userguide/aws-load-balancer-controller.html[Installing the AWS Load Balancer Controller add-on].
 //* You have configured a domain name for your {product-short} instance. The domain name can be a hosted zone entry on Route 53 or managed outside of AWS. For more information, see https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-configuring.html[Configuring Amazon Route 53 as your DNS service] documentation.
 //* You have an entry in the AWS Certificate Manager (ACM) for your preferred domain name. Make sure to keep a record of your Certificate ARN.
-* You have subscribed to `registry.redhat.io`. For more information, see https://access.redhat.com/RegistryAuthentication[{company-name} Container Registry Authentication].
 //* You have set the context to the {eks-short} cluster in your current `kubeconfig`. For more information, see https://docs.aws.amazon.com/eks/latest/userguide/create-kubeconfig.html[Creating or updating a kubeconfig file for an Amazon {eks-short} cluster].
-* You have installed `kubectl`. For more information, see https://docs.aws.amazon.com/eks/latest/userguide/install-kubectl.html[Installing or updating kubectl].
 //* You have installed Helm 3 or the latest. For more information, see https://docs.aws.amazon.com/eks/latest/userguide/helm.html[Using Helm with Amazon {eks-short}].
 
 .Procedure
@@ -38,15 +49,15 @@ kubectl -n <your-namespace> create secret docker-registry rhdh-pull-secret \ <1>
     --docker-password=<password> \ <3>
     --docker-email=<email> <4>
 ----
-<1> Enter your GKE namespace in the command.
+<1> Enter your {gke-short} namespace in the command.
 <2> Enter your username in the command.
 <3> Enter your password in the command.
 <4> Enter your email address in the command.
 
 The created pull secret is used to pull the {product-short} images from the {company-name} Ecosystem.
 --
 
-. Set up a Google-managed certificate by creating a `ManagedCertificate` object that you will later attach to the Ingress.
+. Set up a Google-managed certificate by creating a `ManagedCertificate` object that you will attach to the Ingress.
 +
 --
 [source,yaml,subs="attributes+"]
@@ -60,9 +71,9 @@ spec:
     - <rhdh_domain_name>
 ----
 --
-For more information about setting up a Google-managed certificate, see https://cloud.google.com/kubernetes-engine/docs/how-to/managed-certs?hl=en#setting_up_a_google-managed_certificate 
+For more information about setting up a Google-managed certificate, see https://cloud.google.com/kubernetes-engine/docs/how-to/managed-certs?hl=en#setting_up_a_google-managed_certificate[Setting up a Google-managed certificate].
 
-. Create a `FrontendConfig` object to set a policy for redirecting to HTTPS. You will later attach this policy to the Ingress. 
+. Create a `FrontendConfig` object to set a policy for redirecting to HTTPS. You will attach this policy to the Ingress. 
 +
 --
 [source,yaml,subs="attributes+"]
@@ -77,7 +88,7 @@ spec:
     enabled: true
 ----
 --
-For more information about setting a policy to redirect to HTTPS, see https://cloud.google.com/kubernetes-engine/docs/how-to/ingress-configuration?hl=en#https_redirect
+For more information about setting a policy to redirect to HTTPS, see https://cloud.google.com/kubernetes-engine/docs/how-to/ingress-configuration?hl=en#https_redirect[HTTP to HTTPS redirects].
 
 . Create a file named `values.yaml` using the following template:
 +
@@ -126,34 +137,41 @@ helm -n <your_namespace> install -f values.yaml <your_deploy_name> \
 +
 For the latest Helm Chart version, see https://github.com/openshift-helm-charts/charts/tree/main/charts/redhat/redhat/redhat-developer-hub
 +
-It takes some time to deploy it, check if the deployment completed use this command
+. Confirm that the deployment is complete.
 +
 [source,terminal,subs="attributes+"]
 ----
 kubectl get deploy <you_deploy_name>-developer-hub -n <your_namespace>
 ----
 
-. Verify that the service and ingress were created
+. Verify that the service and ingress were created.
 +
 [source,terminal,subs="attributes+"]
 ----
 kubectl get service -n <your_namespace>
 kubectl get ingress -n <your_namespace>
 ----
-
-. Wait for the `ManagedCertificate` to be provisioned. This can take a couple of hours.
++
+[NOTE]
+Wait for the `ManagedCertificate` to be provisioned. This can take a couple of hours.
 
 . Access RHDH with `https://<rhdh_domain_name>`
 +
 [IMPORTANT]
 Use the HTTPS protocol, not HTTP.
 
-. To upgrade or delete your deployment use (mind the –version)
+. To upgrade your deployment, use the following command:
 +
 [source,terminal,subs="attributes+"]
 ----
-helm -n <your_namespace> upgrade -f values.yaml <your_deploy_name> openshift-helm-charts/redhat-developer-hub --version 1.3.0
+helm -n <your_namespace> upgrade -f values.yaml <your_deploy_name> openshift-helm-charts/redhat-developer-hub --version <UPGRADE_CHART_VERSION>
 
+----
+
+. To delete your deployment, use the following command:
++
+[source,terminal,subs="attributes+"]
+----
 helm -n <your_namespace> delete <your_deploy_name>
 ----
 
diff --git a/modules/installation/proc-rhdh-deploy-gke-operator.adoc b/modules/installation/proc-rhdh-deploy-gke-operator.adoc
@@ -19,22 +19,32 @@ For information about the OLM, see link:https://olm.operatorframework.io/docs/[O
 
 // TODO: Compare with GKE OLM install prerequisites
 
-//* You have set the context to the {eks-short} cluster in your current `kubeconfig`. For more information, see https://docs.aws.amazon.com/eks/latest/userguide/create-kubeconfig.html[Creating or updating a kubeconfig file for an Amazon {eks-short} cluster].
-
-* You have installed the Google `gcloud` CLI and you have logged in to your Google account. For more information, see https://cloud.google.com/sdk/docs/install[Installing or updating kubectl].
-* You have installed `kubectl`. For more information, see https://docs.aws.amazon.com/eks/latest/userguide/install-kubectl.html[Install the gcloud CLI].
 * You have subscribed to `registry.redhat.io`. For more information, see https://access.redhat.com/RegistryAuthentication[{company-name} Container Registry Authentication].
+
 * You have installed the Operator Lifecycle Manager (OLM). For more information about installation and troubleshooting, see https://operatorhub.io/how-to-install-an-operator#How-do-I-get-Operator-Lifecycle-Manager?[How do I get Operator Lifecycle Manager?]
+
+* You have installed `kubectl`. For more information, see https://kubernetes.io/docs/tasks/tools/#kubectl[Install kubetl].
+
+* You have installed the Google Cloud CLI. For more information, see https://cloud.google.com/sdk/docs/install[Install the gcloud CLI].
+
+* You have logged in to your Google account and created a https://https://cloud.google.com/kubernetes-engine/docs/how-to/creating-an-autopilot-cluster[GKE Autopilot] or https://cloud.google.com/kubernetes-engine/docs/how-to/creating-a-zonal-cluster[GKE Standard] cluster.
+
+////
+[TBC] Are these prerequisites required for the operator install procedure or just the deployment procedure?
+
 * You have configured a domain name for your {product-short} instance.
 
-* You have created a https://https://cloud.google.com/kubernetes-engine/docs/how-to/creating-an-autopilot-cluster[GKE Autopilot] or https://cloud.google.com/kubernetes-engine/docs/how-to/creating-a-zonal-cluster[GKE Standard] cluster.
+* You have reserved a static external Premium IPv4 Global IP address that is not attached to any VM.
+
+* You have configured the DNS records for your domain name to point to the IP address that have reseved. For more information see https://cloud.google.com/vpc/docs/reserve-static-external-ip-address#reserve_new_static[Reserve a new static external IP address]
++
+[NOTE]
+You need to create an `A` record with the value equal to the IP address. This can take up to one hour to propagate.
+////
 
-(TBC)
-Reserve a static external IP address. Chose a Premium IPv4  Global IP address for this example. Do not attach it to any VM.
-https://cloud.google.com/vpc/docs/reserve-static-external-ip-address#reserve_new_static 
-Later, the name is referred to as <ADDRESS_NAME>
-Configure DNS records for your domain name to point to the IP address you just reserved – create an A record with the value equal to the IP address (this can take up to an hour to propagate).
-(END TBC)
+////
+* You have set the context to the {eks-short} cluster in your current `kubeconfig`. For more information, see https://docs.aws.amazon.com/eks/latest/userguide/create-kubeconfig.html[Creating or updating a kubeconfig file for an Amazon {eks-short} cluster].
+////
 
 
 .Procedure
@@ -78,7 +88,7 @@ kubectl -n rhdh-operator create secret docker-registry rhdh-pull-secret \
 
 The created pull secret is used to pull the {product-short} images from the {company-name} Ecosystem.
 --
-. TBC 
+. Patch your {product-very-short} deployment with the previously created `rhdh-pull-secret` as follows:
 +
 --
 [source,terminal]
@@ -168,7 +178,7 @@ kubectl -n rhdh-operator patch deployment \
 ====
 --
 
-. Update the default configuration of the operator to ensure that {product-short} resources can start correctly in {eks-short} using the following steps:
+. Update the default configuration of the operator to ensure that {product-short} resources can start correctly in {gke-short} using the following steps:
 .. Edit the `backstage-default-config` ConfigMap in the `rhdh-operator` namespace using the following command:
 +
 --
