Procedure

1. Author the Developer Hub general configuration in the app section.

   title

   Enter your Developer Hub instance display name, such as <Red Hat Developer Hub>.

   app-config.yaml excerpt

   app:
     title: Red Hat Developer Hub

   baseURL

   Enter the external URL of your Red Hat Developer Hub instance, such as https://<my_developer_hub_url>.

   app-config.yaml example

   app:
     baseUrl: https://<my_developer_hub_url>

2. Author the Developer Hub backend configuration in the backend section.

   auth

   Enter your authentication configuration. See Authentication.

   baseURL

   Enter the external URL of your Red Hat Developer Hub instance, such as https://<my_developer_hub_url>.

   app-config.yaml example

   backend:
     baseUrl: https://<my_developer_hub_url>
     cors:
       origin: <RHDH_URL>

3. Optionally, to configure authorization, author the permission section. See Authorization.

Procedure

1. Optionally, to enable dynamic plugins, author the dynamic-plugins.yaml file. See Installing and viewing dynamic plugins.
2. Optionally, to configure authorization by using external files, author the policy.csv and rbac-policy.yaml files. See Authorization.

Procedure

1. From the Developer perspective in the OpenShift Container Platform web console, select the Topology view, and click the Open URL icon on the Developer Hub pod to identify your Developer Hub external URL: <RHDH_URL>.

2. Upload your custom configuration files to OpenShift Container Platform config maps, in your <RHDH> project.

   1. From the Developer perspective in the OpenShift Container Platform web console, select the ConfigMaps view.
   2. Click Create ConfigMap.
   3. Click Create.

3. Create your OpenShift Container Platform secrets.

   1. Select the Secrets view.
   2. Click Create Key/value Secret.
   3. Create a secret named secrets-rhdh.

   4. Add a key named BACKEND_SECRET and a base64 encoded string as a value. Use a unique value for each Red Hat Developer Hub instance. For example, you can use the following command to generate a key from your terminal:

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

   5. Click Create.

4. Configure the Developer Hub custom resource

   1. Select the Topology view.

   2. Click the overflow menu for the Red Hat Developer Hub instance that you want to use and select Edit Backstage to load the YAML view of the Red Hat Developer Hub instance.

      

   3. In the CR, enter the name of the custom application configuration config map as the value for the spec.application.appConfig.configMaps field, and enter the name of your secret as the value for the spec.application.extraEnvs.secrets field. For example:

      apiVersion: rhdh.redhat.com/v1alpha1
      kind: Backstage
      metadata:
        name: developer-hub
      spec:
        application:
          appConfig:
            mountPath: /opt/app-root/src
            configMaps:
               - name: app-config
          extraEnvs:
            secrets:
               - name: secrets-rhdh
          extraFiles:
            mountPath: /opt/app-root/src
          replicas: 1
          route:
            enabled: true
        database:
          enableLocalDb: true

   4. Click Save.
   5. Navigate back to the Topology view and wait for the Red Hat Developer Hub pod to start.
   6. Click the Open URL icon to use the Red Hat Developer Hub platform with the configuration changes.

Procedure

1. Upload your custom configuration files to OpenShift Container Platform config maps, in your <RHDH> project.

   1. From the OpenShift Container Platform web console, select the ConfigMaps tab.
   2. Click Create ConfigMap to create the app-config config map.
   3. From Create ConfigMap page, select the YAML view option in Configure via and make changes to the file, if needed.
   4. Click Create.

2. Configure Helm to use your custom configuration files in Developer Hub.

   1. Go to the Helm tab to see the list of Helm releases.
   2. Click the overflow menu on the Helm release that you want to use and select Upgrade.
   3. Use the YAML view to edit the Helm configuration.

   4. Set the value of the upstream.backstage.extraAppConfig.configMapRef and upstream.backstage.extraAppConfig.filename parameters as follows:

      Helm configuration excerpt

      upstream:
        backstage:
          extraAppConfig:
            - configMapRef: app-config
              filename: app-config.yaml

   5. Click Upgrade.