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

Gerry-Forde · Gerry-Forde · commit d13ccb9ef79d · 2024-11-21T14:34:49.000Z
diff --git a/modules/installation/proc-deploy-rhdh-instance-gke.adoc b/modules/installation/proc-deploy-rhdh-instance-gke.adoc
@@ -1,12 +1,8 @@
-// Module included in the following assemblies:
-//
-// * assemblies/assembly-install-rhdh-gke.adoc
-
 [id="proc-deploy-rhdh-instance-gke.adoc_{context}"]
 = Deploying the {product-short} instance on {gke-short} with the Operator
 You can deploy your {product-short} instance in {gke-short} using the Operator. 
-.Prerequisites
 
+.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].
@@ -20,14 +16,7 @@ You can deploy your {product-short} instance in {gke-short} using the Operator.
 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 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
-
 . Create a ConfigMap named `app-config-rhdh` containing the {product-short} configuration using the following template:
 +
 --
@@ -197,58 +186,4 @@ Wait until the DNS name is responsive, indicating that your {product-short} inst
 .Additional information
 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-short} with LoadBalancer instead of Ingress, see https://github.com/sumiranchugh/rhdh-gke-poc/tree/main 
-
-
-
-////
-. Create an Ingress resource using the following template, ensuring to customize the names as needed:
-+
---
-[source,yaml,subs="attributes+"]
-----
-apiVersion: networking.k8s.io/v1
-kind: Ingress
-metadata:
-  # TODO: this the name of your {product-short} Ingress
-  name: my-rhdh
-  annotations:
-    alb.ingress.kubernetes.io/scheme: internet-facing
-
-    alb.ingress.kubernetes.io/target-type: ip
-
-    # TODO: Using an ALB HTTPS Listener requires a certificate for your own domain. Fill in the ARN of your certificate, e.g.:
-    alb.ingress.kubernetes.io/certificate-arn: arn:aws:acm:us-xxx:xxxx:certificate/xxxxxx
-
-     alb.ingress.kubernetes.io/listen-ports: '[{"HTTP": 80}, {"HTTPS":443}]'
-
-    alb.ingress.kubernetes.io/ssl-redirect: '443'
-
-    # TODO: Set your application domain name.
-    external-dns.alpha.kubernetes.io/hostname: <rhdh_dns_name>
-
-spec:
-  ingressClassName: alb
-  rules:
-    # TODO: Set your application domain name.
-    - host: <rhdh_dns_name>
-      http:
-        paths:
-        - path: /
-          pathType: Prefix
-          backend:
-            service:
-              # TODO: my-rhdh is the name of your Backstage Custom Resource.
-              # Adjust if you changed it!
-              name: backstage-my-rhdh
-              port:
-                name: http-backend
-----
-
-In the previous template, replace ` <rhdh_dns_name>` with your {product-short} domain name and update the value of `alb.ingress.kubernetes.io/certificate-arn` with your certificate ARN.
---
-
-.Verification
-
-Wait until the DNS name is responsive, indicating that your {product-short} instance is ready for use.
-////
+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
@@ -1,6 +1,3 @@
-// Module included in the following assemblies
-// assembly-install-rhdh-gke.adoc
-
 [id='proc-rhdh-deploy-gke-helm_{context}']
 = Installing {product-short} on {gke-short} with the Helm chart
 
@@ -23,14 +20,7 @@ You need to create an `A` record with the value equal to the IP address. This ca
 ====
 * 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 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 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
-
 . Go to your terminal and run the following command to add the Helm chart repository containing the {product-short} chart to your local Helm registry:
 +
 --
diff --git a/modules/installation/proc-rhdh-deploy-gke-operator.adoc b/modules/installation/proc-rhdh-deploy-gke-operator.adoc
@@ -1,24 +1,11 @@
-// Module included in the following assemblies
-// assembly-install-rhdh-gke.adoc
-
-// [id='proc-rhdh-deploy-gke-operator_{context}']
-// = Installing {product-short} on {gke-short} with the Operator
-
-// You can install the {product} Operator with or without the Operator Lifecycle Manager (OLM) framework.
-
-// .Additonal resources
-// * For information about the OLM, see link:https://olm.operatorframework.io/docs/[Operator Lifecycle Manager(OLM)] documentation.
-
+[id="proc-rhdh-deploy-gke-operator.adoc_{context}"]
 = Installing the {product-short} Operator with the OLM framework
 
 You can install the {product-short} Operator on {gke-short} using the https://olm.operatorframework.io[Operator Lifecycle Manager (OLM) framework]. Following that, you can proceed to deploy your {product-short} instance in {gke-short}.
 
 For information about the OLM, see link:https://olm.operatorframework.io/docs/[Operator Lifecycle Manager(OLM)] documentation.
 
 .Prerequisites
-
-// TODO: Compare with GKE OLM install 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 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?]
@@ -29,26 +16,7 @@ For information about the OLM, see link:https://olm.operatorframework.io/docs/[O
 
 * You have logged in to your Google account and created a 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 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 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
-
 . Connect to your GKE cluster using the following command:
 +
 --
@@ -233,173 +201,4 @@ kubectl -n rhdh-operator edit configmap backstage-default-config
 
 .. Save and exit.
 +
-Wait for a few minutes until the changes are automatically applied to the operator pods.
-
-////
-== Installing the {product-short} Operator without the OLM framework
-
-.Prerequisites
-* You have installed the following commands:
-** `git`
-** `make`
-** `sed`
-
-.Procedure
-
-. Clone the Operator repository to your local machine using the following command:
-+
---
-[source,terminal]
-----
-git clone --depth=1 https://github.com/redhat-developer/rhdh-operator.git rhdh-operator && cd rhdh-operator
-----
---
-
-. Run the following command and generate the deployment manifest:
-+
---
-[source,terminal]
-----
-make deployment-manifest
-----
-
-The previous command generates a file named `rhdh-operator-<VERSION>.yaml`, which is updated manually.
---
-
-. Run the following command to apply replacements in the generated deployment manifest:
-+
---
-[source,terminal]
-----
-sed -i "s/backstage-operator/rhdh-operator/g" rhdh-operator-*.yaml
-sed -i "s/backstage-system/rhdh-operator/g" rhdh-operator-*.yaml
-sed -i "s/backstage-controller-manager/rhdh-controller-manager/g" rhdh-operator-*.yaml
-----
---
-
-. Open the generated deployment manifest file in an editor and perform the following steps:
-.. Locate the `db-statefulset.yaml` string and add the `fsGroup` to its `spec.template.spec.securityContext`, as shown in the following example:
-+
---
-[source,yaml]
-----
-   db-statefulset.yaml: |
-    apiVersion: apps/v1
-    kind: StatefulSet
---- TRUNCATED ---
-    spec:
-    --- TRUNCATED ---
-      restartPolicy: Always
-      securityContext:
-        # You can assign any random value as fsGroup
-        fsGroup: 2000
-      serviceAccount: default
-      serviceAccountName: default
---- TRUNCATED ---
-----
---
-
-.. Locate the `deployment.yaml` string and add the `fsGroup` to its specification, as shown in the following example:
-+
---
-[source,yaml]
-----
-  deployment.yaml: |
-    apiVersion: apps/v1
-    kind: Deployment
---- TRUNCATED ---
-    spec:
-      securityContext:
-        # You can assign any random value as fsGroup
-        fsGroup: 3000
-      automountServiceAccountToken: false
---- TRUNCATED ---
-----
---
-
-.. Locate the `service.yaml` string and change the `type` to `NodePort` as follows:
-+
---
-[source,yaml]
-----
-  service.yaml: |
-    apiVersion: v1
-    kind: Service
-    spec:
-      # NodePort is required for the ALB to route to the Service
-      type: NodePort
---- TRUNCATED ---
-----
---
-
-.. Replace the default images with the images that are pulled from the {company-name} Ecosystem:
-+
---
-[source,terminal,subs="attributes+"]
-----
-sed -i "s#gcr.io/kubebuilder/kube-rbac-proxy:.*#registry.redhat.io/openshift4/ose-kube-rbac-proxy:v{ocp-version}#g" rhdh-operator-*.yaml
-
-sed -i "s#(quay.io/janus-idp/operator:.*|quay.io/rhdh-community/operator:.*)#registry.redhat.io/rhdh/rhdh-rhel9-operator:{product-version}#g" rhdh-operator-*.yaml
-
-sed -i "s#quay.io/janus-idp/backstage-showcase:.*#registry.redhat.io/rhdh/rhdh-hub-rhel9:{product-version}#g" rhdh-operator-*.yaml
-
-sed -i "s#quay.io/fedora/postgresql-15:.*#registry.redhat.io/rhel9/postgresql-15:latest#g" rhdh-operator-*.yaml
-----
---
-
-. Add the image pull secret to the manifest in the Deployment resource as follows:
-+
---
-[source,yaml]
-----
---- TRUNCATED ---
-
-apiVersion: apps/v1
-kind: Deployment
-metadata:
-  labels:
-    app.kubernetes.io/component: manager
-    app.kubernetes.io/created-by: rhdh-operator
-    app.kubernetes.io/instance: controller-manager
-    app.kubernetes.io/managed-by: kustomize
-    app.kubernetes.io/name: deployment
-    app.kubernetes.io/part-of: rhdh-operator
-    control-plane: controller-manager
-  name: rhdh-controller-manager
-  namespace: rhdh-operator
-spec:
-  replicas: 1
-  selector:
-    matchLabels:
-      control-plane: controller-manager
-  template:
-    metadata:
-      annotations:
-        kubectl.kubernetes.io/default-container: manager
-      labels:
-        control-plane: controller-manager
-    spec:
-      imagePullSecrets:
-        - name: rhdh-pull-secret
---- TRUNCATED ---
-----
---
-
-. Apply the manifest to deploy the operator using the following command:
-+
---
-[source,terminal]
-----
-kubectl apply -f rhdh-operator-VERSION.yaml
-----
---
-
-. Run the following command to verify that the Operator is running:
-+
---
-[source,terminal]
-----
-kubectl -n rhdh-operator get pods -w
-----
---
-////
+Wait for a few minutes until the changes are automatically applied to the operator pods.
