Chapter 1. Supported configurations for Red Hat Developer Hub
Chapter 1. Supported configurations for Red Hat Developer Hub This section describes the configurations that are required to access the Red Hat Developer Hub, including: Custom applications configuration Source control configuration for Developer Hub Catalog 1.1. Adding a custom application configuration file to Red Hat OpenShift Container Platform To access the Red Hat Developer Hub, you must add a custom application configuration file to Red Hat OpenShift Container Platform. In OpenShift Container Platform, you can use the following content as a base template to create a ConfigMap named app-config-rhdh : kind: ConfigMap apiVersion: v1 metadata: name: app-config-rhdh data: app-config-rhdh.yaml: | app: title: Red Hat Developer Hub You can add the custom application configuration file to OpenShift Container Platform in one of the following ways: The Red Hat Developer Hub Operator The Red Hat Developer Hub Helm chart 1.1.1. Adding a custom application configuration file to OpenShift Container Platform using the Helm chart You can use the Red Hat Developer Hub Helm chart to add a custom application configuration file to your OpenShift Container Platform instance. Prerequisites You have created an Red Hat OpenShift Container Platform account. Procedure From the OpenShift Container Platform web console, select the ConfigMaps tab. Click Create ConfigMap . From Create ConfigMap page, select the YAML view option in Configure via and make changes to the file, if needed. Click Create . Go to the Helm tab to see the list of Helm releases. Click the overflow menu on the Helm release that you want to use and select Upgrade . Use either the Form view or YAML view to edit the Helm configuration. Using Form view Expand Root Schema Backstage chart schema Backstage parameters Extra app configuration files to inline into command arguments . Click the Add Extra app configuration files to inline into command arguments link. Enter the value in the following fields: configMapRef : app-config-rhdh filename : app-config-rhdh.yaml Click Upgrade . Using YAML view 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 Click Upgrade . 1.1.2. Adding a custom application configuration file to OpenShift Container Platform using the Operator A custom application configuration file is a ConfigMap object that you can use to change the configuration of your Red Hat Developer Hub instance. If you are deploying your Developer Hub instance on Red Hat OpenShift Container Platform, you can use the Red Hat Developer Hub Operator to add a custom application configuration file to your OpenShift Container Platform instance by creating the ConfigMap object and referencing it in the Developer Hub custom resource (CR). The custom application configuration file contains a sensitive environment variable, named BACKEND_SECRET . This variable contains a mandatory backend authentication key that Developer Hub uses to reference an environment variable defined in an OpenShift Container Platform secret. You must create a secret, named 'secrets-rhdh', and reference it in the Developer Hub CR. Note You are responsible for protecting your Red Hat Developer Hub installation from external and unauthorized access. Manage the backend authentication key like any other secret. Meet strong password requirements, do not expose it in any configuration files, and only inject it into configuration files as an environment variable. Prerequisites You have an active Red Hat OpenShift Container Platform account. Your administrator has installed the Red Hat Developer Hub Operator in OpenShift Container Platform. For more information, see Installing the Red Hat Developer Hub Operator . You have created the Red Hat Developer Hub CR in OpenShift Container Platform. Procedure 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> . From the Developer perspective in the OpenShift Container Platform web console, select the ConfigMaps view. Click Create ConfigMap . 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: ConfigMap apiVersion: v1 metadata: name: app-config-rhdh data: "app-config-rhdh.yaml": | app: title: Red Hat Developer Hub baseUrl: <RHDH_URL> 1 backend: auth: externalAccess: - type: legacy options: subject: legacy-default-config secret: "USD{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. Click Create . Select the Secrets view. Click Create Key/value Secret . Create a secret named secrets-rhdh . 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")' Click Create . Select the Topology view. 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. 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 Click Save . Navigate back to the Topology view and wait for the Red Hat Developer Hub pod to start. Click the Open URL icon to use the Red Hat Developer Hub platform with the configuration changes. Additional resources For more information about roles and responsibilities in Developer Hub, see Role-Based Access Control (RBAC) in Red Hat Developer Hub .
kind: ConfigMap apiVersion: v1 metadata: name: app-config-rhdh data: app-config-rhdh.yaml: | app: title: Red Hat Developer Hub ... 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 kind: ConfigMap apiVersion: v1 metadata: name: app-config-rhdh data: "app-config-rhdh.yaml": | app: title: Red Hat Developer Hub baseUrl: <RHDH_URL> 1 backend: auth: externalAccess: - type: legacy options: subject: legacy-default-config secret: "USD{BACKEND_SECRET}" 2 baseUrl: <RHDH_URL> 3 cors: origin: <RHDH_URL> 4 node -p 'require("crypto").randomBytes(24).toString("base64")' 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