Chapter 1. Installing Developer Hub on EKS with the Operator

Procedure

1. Run the following command in your terminal to create the rhdh-operator namespace where the Operator is installed:

   kubectl create namespace rhdh-operator

2. Create a pull secret using the following command:

   kubectl -n rhdh-operator create secret docker-registry rhdh-pull-secret \
       --docker-server=registry.redhat.io \
       --docker-username=<user_name> \ 

   1

   
       --docker-password=<password> \ 

   2

   
       --docker-email=<email> 

   3

   1

   Enter your username in the command.

   2

   Enter your password in the command.

   3

   Enter your email address in the command.

   The created pull secret is used to pull the Developer Hub images from the Red Hat Ecosystem.

3. Create a CatalogSource resource that contains the Operators from the Red Hat Ecosystem:

   cat <<EOF | kubectl -n rhdh-operator apply -f -
   apiVersion: operators.coreos.com/v1alpha1
   kind: CatalogSource
   metadata:
     name: redhat-catalog
   spec:
     sourceType: grpc
     image: registry.redhat.io/redhat/redhat-operator-index:v4.18
     secrets:
     - "rhdh-pull-secret"
     displayName: Red Hat Operators
   EOF

4. Create an OperatorGroup resource as follows:

   cat <<EOF | kubectl apply -n rhdh-operator -f -
   apiVersion: operators.coreos.com/v1
   kind: OperatorGroup
   metadata:
     name: rhdh-operator-group
   EOF

5. Create a Subscription resource using the following code:

   cat <<EOF | kubectl apply -n rhdh-operator -f -
   apiVersion: operators.coreos.com/v1alpha1
   kind: Subscription
   metadata:
     name: rhdh
     namespace: rhdh-operator
   spec:
     channel: fast
     installPlanApproval: Automatic
     name: rhdh
     source: redhat-catalog
     sourceNamespace: rhdh-operator
     startingCSV: rhdh-operator.v1.6.5
   EOF

6. Run the following command to verify that the created Operator is running:

   kubectl -n rhdh-operator get pods -w

   If the operator pod shows ImagePullBackOff status, then you might need permissions to pull the image directly within the Operator deployment’s manifest.

   Tip

   You can include the required secret name in the deployment.spec.template.spec.imagePullSecrets list and verify the deployment name using kubectl get deployment -n rhdh-operator command:

   kubectl -n rhdh-operator patch deployment \
       rhdh.fast --patch '{"spec":{"template":{"spec":{"imagePullSecrets":[{"name":"rhdh-pull-secret"}]}}}}' \
       --type=merge

Procedure

1. Create a my-rhdh-app-config config map containing the app-config.yaml Developer Hub configuration file by using the following template:

   apiVersion: v1
   kind: ConfigMap
   metadata:
     name: my-rhdh-app-config
   data:
     "app-config.yaml": |
       app:
         title: Red Hat Developer Hub
         baseUrl: https://<rhdh_dns_name>
       backend:
         auth:
           externalAccess:
               - type: legacy
                 options:
                   subject: legacy-default-config
                   secret: "${BACKEND_SECRET}"
         baseUrl: https://<rhdh_dns_name>
         cors:
           origin: https://<rhdh_dns_name>

2. Create a Red Hat Developer Hub secret and add a key named BACKEND_SECRET with a Base64-encoded string as value:

   apiVersion: v1
   kind: Secret
   metadata:
     name: <my_product_secrets> 

   1

   
   stringData:
     # TODO: See https://backstage.io/docs/auth/service-to-service-auth/#setup
     BACKEND_SECRET: "xxx"

   1

   <my_product_secrets> is your preferred Developer Hub secret name, where <my_product_secrets> specifies the unique identifier for your secret configuration within Developer Hub.

   Important

   Ensure that you use a unique value of BACKEND_SECRET for each Developer Hub instance.

   You can use the following command to generate a key:

   node-p'require("crypto").randomBytes(24).toString("base64")'

3. To enable pulling the PostgreSQL image from the Red Hat Ecosystem Catalog, add the image pull secret in the default service account within the namespace where the Developer Hub instance is being deployed:

   kubectl patch serviceaccount default \
       -p '{"imagePullSecrets": [{"name": "rhdh-pull-secret"}]}' \
       -n <your_namespace>

4. Create your Backstage custom resource using the following template:

   apiVersion: rhdh.redhat.com/v1alpha3
   kind: Backstage
   metadata:
    # TODO: this the name of your Developer Hub instance
     name: my-rhdh
   spec:
     application:
       imagePullSecrets:
       - "rhdh-pull-secret"
       route:
         enabled: false
       appConfig:
         configMaps:
           - name: my-rhdh-app-config
       extraEnvs:
         secrets:
           - name: <my_product_secrets> 

   1

   1

   <my_product_secrets> is your preferred Developer Hub secret name, where <my_product_secrets> specifies the identifier for your secret configuration within Developer Hub.

5. Create an Ingress resource using the following template, ensuring to customize the names as needed:

   apiVersion: networking.k8s.io/v1
   kind: Ingress
   metadata:
     # TODO: this the name of your Developer Hub 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 Developer Hub domain name and update the value of alb.ingress.kubernetes.io/certificate-arn with your certificate ARN.