Chapter 1. Adding a custom application configuration file to Red Hat OpenShift Container Platform

Procedure

1. From the OpenShift Container Platform web console, select the ConfigMaps tab.
2. Click Create ConfigMap.
3. From Create ConfigMap page, select the YAML view option in Configure via and make changes to the file, if needed.
4. Click Create.
5. Go to the Helm tab to see the list of Helm releases.
6. Click the overflow menu on the Helm release that you want to use and select Upgrade.

7. Use either the Form view or YAML view to edit the Helm configuration.

   • Using Form view

     1. Expand Root Schema Backstage chart schema Backstage parameters Extra app configuration files to inline into command arguments.
     2. Click the Add Extra app configuration files to inline into command arguments link.

     3. Enter the value in the following fields:

        • configMapRef: app-config-rhdh
        • filename: app-config-rhdh.yaml
     4. Click Upgrade.

   • Using YAML view

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

        # ... other Red Hat Developer Hub Helm Chart configurations
        upstream:
          backstage:
            extraAppConfig:
              - configMapRef: app-config-rhdh
                filename: app-config-rhdh.yaml
        # ... other Red Hat Developer Hub Helm Chart configurations

     2. Click Upgrade.

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. From the Developer perspective in the OpenShift Container Platform web console, select the ConfigMaps view.
3. Click Create ConfigMap.

4. Select the YAML view option in Configure via and use the following example as a base template to create a ConfigMap object, such as app-config-rhdh.yaml:

   kind: Backstage
   apiVersion: rhdh.redhat.com/v1alpha1
   metadata:
     name: app-config-rhdh
   data:
     "app-config-rhdh.yaml": |
       app:
         title: Red Hat Developer Hub
         baseUrl: <RHDH_URL> 1
       backend:
         auth:
           keys:
             - secret: "${BACKEND_SECRET}" 2
         baseUrl: <RHDH_URL> 3
         cors:
           origin: <RHDH_URL> 4

   1

   Set the external URL of your Red Hat Developer Hub instance.

   2

   Use an environment variable exposing an OpenShift Container Platform secret to define the mandatory Developer Hub backend authentication key.

   3

   Set the external URL of your Red Hat Developer Hub instance.

   4

   Set the external URL of your Red Hat Developer Hub instance.

5. Click Create.
6. Select the Secrets view.
7. Click Create Key/value Secret.
8. Create a secret named secrets-rhdh.

9. 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")'

10. Click Create.
11. Select the Topology view.

12. 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.

    

13. 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-rhdh
        extraEnvs:
          secrets:
             - name: secrets-rhdh
        extraFiles:
          mountPath: /opt/app-root/src
        replicas: 1
        route:
          enabled: true
      database:
        enableLocalDb: true

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