Chapter 1. Installing Red Hat Developer Hub on OpenShift Container Platform with the Operator

Procedure

1. In the navigation menu of the OpenShift Container Platform console, click Operators > OperatorHub.
2. In the Filter by keyword box, enter Developer Hub and click the Red Hat Developer Hub Operator card.
3. On the Red Hat Developer Hub Operator page, read the information about the Operator and click Install to open the Install Operator page.

4. After the Operator is successfully installed, provision your custom configuration:

   Before you create a Developer Hub instance, you must create the required config map and Secret resources in your project. These include the baseUrl and service-to-service authentication secrets.

   For detailed steps, see Provisioning your custom Red Hat Developer Hub configuration.

5. From the Update channel drop-down menu, select the update channel that you want to use, for example, fast or fast-1.6.

   Important

   The `fast channel includes all of the updates available for a particular version. Any update might introduce unexpected changes in your Red Hat Developer Hub deployment. Check the release notes for details about any potentially breaking changes.

   The fast-1.6 channel only provides z-stream updates, for example, updating from version 1.6.1 to 1.6.2. If you want to update the Red Hat Developer Hub y-version in the future, for example, updating from 1.6 to 1.7, you must switch to the fast-1.7 channel manually.

6. From the Version drop-down menu, select the version of the Red Hat Developer Hub Operator that you want to install. The default version is the latest version available in the selected channel.

7. Select the Operator Installation mode.

   Note

   The All namespaces on the cluster (default) option is selected by default. The Specific namespace on the cluster option is not currently supported.

8. In the Installed Namespace field, do one of the following actions:

   • Select Operator recommended Namespace to create and use the rhdh-operator namespace. This option is selected by default.

   • Select Select a Namespace to use an alternative namespace.

     • From the Select Project drop-down menu, do one of the following actions:

       • Select an existing project.

       • Select Create Project to create a new project for the Operator.

         • On the Create Project dialog, enter text into the required fields and click Create.

           Important

           For enhanced security, better control over the Operator lifecycle, and preventing potential privilege escalation, install the Red Hat Developer Hub Operator in a dedicated default rhdh-operator namespace. You can restrict other users' access to the Operator resources through role bindings or cluster role bindings.

           You can also install the Operator in another namespace by creating the necessary resources, such as an Operator group. For more information, see Installing global Operators in custom namespaces.

           However, if the Red Hat Developer Hub Operator shares a namespace with other Operators, then it shares the same update policy as well, preventing the customization of the update policy. For example, if one Operator is set to manual updates, the Red Hat Developer Hub Operator update policy is also set to manual. For more information, see Colocation of Operators in a namespace.

9. Select the Update approval method for the Operator.

   • If you select the Automatic option, the Operator is updated without requiring manual confirmation.
   • If you select the Manual option, a notification opens when a new update is released in the update channel. The update must be manually approved by an administrator before installation can begin.

10. Click Install.

    Note

    If you selected a Manual approval strategy, the upgrade status of the subscription remains Upgrading until you review and approve the install plan. After you click Approve on the Install Plan page, the subscription upgrade status changes to Up to date.

    If you selected an Automatic approval strategy, the upgrade status should resolve to Up to date without intervention.

Procedure

1. In the OpenShift Container Platform web console, select your <{my_product_namespace}> project, then click Add.
2. From the Developer Catalog panel, click Operator Backed.
3. In the Filter by keyword box, enter Developer Hub and click the Red Hat Developer Hub card.

4. Provision your custom configuration using the following template:

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

   Copy to Clipboard Toggle word wrap

   Use a config map named app-config-rhdh to provide your app-config.yaml file, and a Secret for service-to-service authentication (such as BACKEND_SECRET).

   To create and apply these configuration resources, follow the steps in Provisioning your custom Red Hat Developer Hub configuration for the full procedure.

   Note

   The app-config-rhdh config map must include your customized app-config.yaml file. This config map is mounted into the Developer Hub container at runtime.

5. Create a secret named my-rhdh-secrets and add a key named BACKEND_SECRET with a Base64-encoded string as value, as shown in the following example:

   apiVersion: v1
   kind: Secret
   metadata:
     name: my-rhdh-secrets
   stringData:
     # TODO: Add the necessary auth secrets for service-to-service auth setup
     BACKEND_SECRET: "xxx" # Replace with your Base64-encoded secret

   Copy to Clipboard Toggle word wrap
   Note

   Ensure that your secret includes BACKEND_SECRET, used for service-to-service authentication. For structure and provisioning steps, see Provisioning your custom Red Hat Developer Hub configuration.

6. Click Create.
7. Add your Backstage custom resource content.
8. On the Create Backstage page, click Create.

1. Confirm that the pods are ready by clicking the pod in the Topology view and confirming the Status in the Details panel. The pod status is Active when the pod is ready.

2. From the Topology view, click the Open URL icon on the Developer Hub pod.