Procedure

1. Create the RCS ConfigMap.

   1. In the OpenShift Container Platform web console, go to your RHDH instance and select the ConfigMaps tab.
   2. Click Create ConfigMaps.

   3. From the Create ConfigMap page, select the YAML view option in Configure via, and edit the file as shown in the following example:

      kind: ConfigMap
      apiVersion: v1
      metadata:
       name: rcsconfig
       namespace: _<namespace>_ # Enter your namespace (For example, `rhdh`)
      data:
       rcsconfig.yaml: |
        llm_providers:
          # Start: Do not remove this block
          - name: dummy
            type: openai
            url: https://dummy.com
            models:
              - name: dummymodel
            # End: Do not remove this block
        ols_config:
          user_data_collection:
            log_level: "DEBUG"
            feedback_disabled: false
            feedback_storage: "/tmp/feedback"
          reference_content:
            product_docs_index_path: "./vector_db/rhdh_product_docs/1.7"
            product_docs_index_id: rhdh-product-docs-1_7
            embeddings_model_path: "./embeddings_model"
          conversation_cache:
            type: memory
            memory:
              max_entries: 1000
          logging_config:
            app_log_level: info
            lib_log_level: warning
            uvicorn_log_level: info
            suppress_metrics_in_log: false
            suppress_auth_checks_warning_in_log: false
          authentication_config:
            module: "noop"
          default_provider: dummy
          default_model: dummymodel
          query_validation_method: disabled
        dev_config:
          enable_dev_ui: false
          disable_auth: false
          disable_tls: true
          enable_system_prompt_override: true
        user_data_collector_config:
          user_agent: "example-user-agent"
          ingress_url: "https://example.ingress.com/upload"

      Important

      Do not remove the block in the llm_providers section. This requirement is crucial when working with Developer Lightspeed for RHDH because of limitations discovered in Road Core. For instances where you decide to use an alternative LLM provider, you should refer to additional information in the guide. For more information, see link:Changing your LLM provider.

   4. Optional: Configure the number of workers that scale the REST API by specifying the following example to the ols_config.max_workers parameter in the RCS ConfigMap.

      ols_config:
          max_workers: _<number_of_workers>_

   5. Click Create.

2. Create the Developer Lightspeed for RHDH ConfigMap.

   Note

   Create a dedicated Developer Lightspeed for RHDH ConfigMap instead of adding an additional section to your existing RHDH custom application configuration file (for example, lightspeed-app-config.yaml). Creating two files prevents the entire RHDH ConfigMap from being loaded into RCS.

   1. In the OpenShift Container Platform web console, go to your RHDH instance and select the ConfigMaps tab.
   2. Click Create ConfigMap.

   3. From the Create ConfigMap page, select the YAML view option in Configure via, and add the following example:

      kind: ConfigMap
      apiVersion: v1
      metadata:
        name: lightspeed-app-config
        namespace: <__namespace__> # Enter your RHDH instance namespace
      data:
        app-config.yaml: |-
          backend:
            csp:
               upgrade-insecure-requests: false
             img-src:
                - "'self'"
                - "data:"
                - https://img.freepik.com
                - https://cdn.dribbble.com
                - https://avatars.githubusercontent.com # This is to load GitHub avatars in the UI
             script-src:
                 - "'self'"
                 - https://cdn.jsdelivr.net
      
          lightspeed:
            # REQUIRED: Configure LLM servers with OpenAI API compatibility
            servers:
              - id: ${LLM_SERVER_ID}
                url: ${LLM_SERVER_URL}
                token: ${LLM_SERVER_TOKEN}
      
            # OPTIONAL: Enable/disable question validation (default: true)
            # When enabled, restricts questions to RHDH-related topics for better security
            questionValidation: true
      
            # OPTIONAL: Custom users prompts displayed to users
            # If not provided, the plugin uses built-in default prompts
            prompts:
              - title: 'Getting Started with Red Hat Developer Hub'
                message: Can you guide me through the first steps to start using Developer Hub as a developer, like exploring the Software Catalog and adding my service?
      
            # OPTIONAL: Port for lightspeed service (default: 8080)
            # servicePort: ${LIGHTSPEED_SERVICE_PORT}
      
            # OPTIONAL: Override default RHDH system prompt
            # systemPrompt: "You are a helpful assistant focused on Red Hat Developer Hub development."

3. Create Developer Lightspeed for RHDH secret file.

   1. In the OpenShift Container Platform web console, go to Secrets.
   2. Click Create > Key/value secret.

   3. In the Create key/value secret page, select the YAML view option in Configure via, and add the following example:

      kind: Secret
      apiVersion: v1
      metadata:
        name: lightspeed-secrets
        namespace: _<namespace>_ # Enter your rhdh instance namespace
      stringData:
        LLM_SERVER_ID: _<server_id>_ # Enter your server ID (for example, `ollama` or `granite`)
        LLM_SERVER_TOKEN: _<token>_ # Enter your server token value
        LLM_SERVER_URL: _<server_url>_ # Enter your server URL
      type: Opaque

   4. Click Create.

4. To your existing dynamic plugins ConfigMap (for example, dynamic-plugins-rhdh.yaml), add the Developer Lightspeed for RHDH plugin image as shown in the following example:

   includes:
     - dynamic-plugins.default.yaml
    plugins:
     - package: oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/red-hat-developer-hub-backstage-plugin-lightspeed:bs_1.39.1__0.5.7!red-hat-developer-hub-backstage-plugin-lightspeed
       disabled: false
       pluginConfig:
         lightspeed:
           # OPTIONAL: Custom users prompts displayed to users
           # If not provided, the plugin uses built-in default prompts
           prompts:
             - title: 'Getting Started with Red Hat Developer Hub'
               message: Can you guide me through the first steps to start using Developer Hub
                 as a developer, like exploring the Software Catalog and adding my
                 service?
         dynamicPlugins:
           frontend:
             red-hat-developer-hub.backstage-plugin-lightspeed:
               appIcons:
                 - name: LightspeedIcon
                   module: LightspeedPlugin
                   importName: LightspeedIcon
               dynamicRoutes:
                 - path: /lightspeed
                   importName: LightspeedPage
                   module: LightspeedPlugin
                   menuItem:
                     icon: LightspeedIcon
                     text: Lightspeed
     - package: oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/red-hat-developer-hub-backstage-plugin-lightspeed-backend:bs_1.39.1__0.5.7!red-hat-developer-hub-backstage-plugin-lightspeed-backend
       disabled: false
       pluginConfig:
         lightspeed:
           # REQUIRED: Configure LLM servers with OpenAI API compatibility
           servers:
             - id: ${LLM_SERVER_ID}
               url: ${LLM_SERVER_URL}
               token: ${LLM_SERVER_TOKEN}
   
           # OPTIONAL: Port for lightspeed service (default: 8080)
           # servicePort: ${LIGHTSPEED_SERVICE_PORT}

5. Update your deployment configuration based on your installation method:

   1. For an Operator-installed RHDH instance, update your Backstage custom resource (CR).

      1. In the spec.application.appConfig.configMaps section, add the Developer Lightspeed for RHDH custom app configuration as shown in the following example:

               appConfig:
                 configMaps:
                   - name: lightspeed-app-config
                 mountPath: /opt/app-root/src

      2. Update the extraVolumes specification to include the RCS ConfigMap as shown in the following example:

                     volumes:
                       - configMap:
                           name: rcsconfig
                         name: rcsconfig

      3. Update the volumeMounts specification to mount the RCS ConfigMap as shown in the following example:

                 volumeMounts:
                   - mountPath: /app-root/config/rcsconfig.yaml
                     name: rcsconfig
                     subPath: rcsconfig.yaml
                   - mountPath: /app-root/config/app-config-rhdh.yaml
                     name: lightspeed-app-config
                     subPath: app-config.yaml

      4. Add the Developer Lightspeed for RHDH Secret file as shown in the following example:

                 envFrom:
                   - secretRef:
                       name: lightspeed-secrets

      5. In your deployment.patch.spec.template.spec.containers.env section, set the RCS environment variables as shown in the following example:

             - name: PROJECT
               value: rhdh
             - name: RCS_CONFIG_FILE
               value: /app-root/config/rcsconfig.yaml
             - name: RHDH_CONFIG_FILE
               value: /app-root/config/app-config-rhdh.yaml

         Note

         Your RHDH container is typically already present in your CR. You are adding the second container definition road-core-sidecar as the RCS sidecar.

      6. Click Save. The Pods are automatically restarted.

         Example of a Backstage CR with the RCS container

         apiVersion: rhdh.redhat.com/v1alpha3
         kind: Backstage
         metadata:
           name: backstage
           namespace: _<namespace>_ # your RHDH instance namespace
         spec:
           application:
             appConfig:
              configMaps:
         # Adding the Developer Lightspeed custom app config file
                - name: lightspeed-app-config
              mountPath: /opt/app-root/src
             dynamicPluginsConfigMapName: dynamic-plugins-rhdh
             extraEnvs:
         # Adding the Developer Lightspeed secrets file
               secrets:
                 - name: lightspeed-secrets
             replicas: 1
             extraFiles:
               mounthPath: /opt/app-root/src
             replicas: 1
             route:
               enabled: true
           database:
             enableLocalDb: true
           deployment:
             patch:
               spec:
                 template:
                   spec:
                     containers:
                       - env:
                           - name: PROJECT
                             value: rhdh
         # Mounting the RCS sidecar to your RHDH instance
                           - name: RCS_CONFIG_FILE
                             value: /app-root/config/rcsconfig.yaml
         # Your existing RHDH ConfigMap
                           - name: RHDH_CONFIG_FILE
                             value: /app-root/config/app-config-rhdh.yaml
                         envFrom:
                           - secretRef:
                               name: lightspeed-secrets
                         image: 'quay.io/redhat-ai-dev/road-core-service:rcs-06302025-rhdh-1.7'
                         name: road-core-sidecar
                         ports:
                           - containerPort: 8080
                             name: rcs-backend
                             protocol: TCP
                         volumeMounts:
         # Mounting the RCS sidecar to your RHDH instance
                           - mountPath: /app-root/config/rcsconfig.yaml
                             name: rcsconfig
                             subPath: rcsconfig.yaml
         # Mounting the Lightspeed app config file to your RCS container
                           - mountPath: /app-root/config/app-config-rhdh.yaml
                             name: lightspeed-app-config
                             subPath: app-config.yaml
                     volumes:
                       - configMap:
                           name: rcsconfig
                         name: rcsconfig

   2. For a Helm-installed RHDH instance, update your Helm chart.

      1. Add your dynamic plugins configuration in the`global.dynamic` property as shown in the following example:

         global:
         dynamic:
           includes:
           - dynamic-plugins.default.yaml
           plugins:
           - package: oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/red-hat-developer-hub-backstage-plugin-lightspeed:bs_1.39.1__0.5.7!red-hat-developer-hub-backstage-plugin-lightspeed
             disabled: false
             pluginConfig:
               lightspeed:
                 # OPTIONAL: Custom users prompts displayed to users
                 # If not provided, the plugin uses built-in default prompts
                 prompts:
                   - title: 'Getting Started with Red Hat Developer Hub'
                     message: Can you guide me through the first steps to start using Developer Hub
                       as a developer, like exploring the Software Catalog and adding my
                       service?
               dynamicPlugins:
                 frontend:
                   red-hat-developer-hub.backstage-plugin-lightspeed:
                     appIcons:
                       - name: LightspeedIcon
                         module: LightspeedPlugin
                         importName: LightspeedIcon
                     dynamicRoutes:
                       - path: /lightspeed
                         importName: LightspeedPage
                         module: LightspeedPlugin
                         menuItem:
                           icon: LightspeedIcon
                           text: Lightspeed
           - package: oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/red-hat-developer-hub-backstage-plugin-lightspeed-backend:bs_1.39.1__0.5.7!red-hat-developer-hub-backstage-plugin-lightspeed-backend
             disabled: false
             pluginConfig:
               lightspeed:
                 # REQUIRED: Configure LLM servers with OpenAI API compatibility
                 servers:
                   - id: ${LLM_SERVER_ID}
                     url: ${LLM_SERVER_URL}
                     token: ${LLM_SERVER_TOKEN}
                 # OPTIONAL: Port for lightspeed service (default: 8080)
                 # servicePort: ${LIGHTSPEED_SERVICE_PORT}

      2. Add your Developer Lightspeed for RHDH custom app config file as shown in the following example:

          extraAppConfig:
               - configMapRef: lightspeed-app-config
                 filename: app-config.yaml

      3. Update the extraVolumes section to include the RCS ConfigMap as shown in the following example:

         extraVolumes:
               - configMap:
                   name: rcsconfig
                 name: rcsconfig

      4. Update the extraVolumeMounts section to mount the RCS ConfigMap as shown in the following example:

          extraVolumeMounts:
               - mountPath: /app-root/config/rcsconfig.yaml
                 name: rcsconfig

      5. Add the Developer Lightspeed for RHDH Secret file as shown in the following example:

          extraEnvVarsSecrets:
               - lightspeed-secrets

      6. Add the RCS image as shown in the following example:

            extraContainers:
               - env:
                   - name: PROJECT
                     value: rhdh
                   - name: RCS_CONFIG_FILE
                     value: /app-root/config/rcsconfig.yaml
                   - name: RHDH_CONFIG_FILE
                     value: /app-root/config/lightspeed-app-config.yaml
                 envFrom:
                   - secretRef:
                       name: lightspeed-secrets
                 image: 'quay.io/redhat-ai-dev/road-core-service:rcs-06302025-rhdh-1.7'
                 name: road-core-sidecar
                 ports:
                   - containerPort: 8080
                     name: rcs-backend
                     protocol: TCP
                 volumeMounts:
                   - mountPath: /app-root/config/rcsconfig.yaml
                     name: rcsconfig
                     subPath: rcsconfig.yaml
                   - mountPath: /app-root/config/lightspeed-app-config.yaml
                     name: lightspeed-app-config
                     subPath: app-config.yaml

         Note

         Your RHDH container is typically already present in your Helm chart. You are adding the second container definition road-core-sidecar as the RCS sidecar.

      7. Click Save.

      8. Click Helm upgrade.

         Example of a Helm chart with the RCS container

         global:
          ...
         upstream:
          backstage:
            appConfig:
              ...
            args:
              ...
            extraAppConfig:
              - configMapRef: lightspeed-app-config
                filename: app-config.yaml
            extraContainers:
              - env:
                  - name: PROJECT
                    value: rhdh
                  - name: RCS_CONFIG_FILE
                    value: /app-root/config/rcsconfig.yaml
                  - name: RHDH_CONFIG_FILE
                    value: /app-root/config/lightspeed-app-config.yaml
                envFrom:
                  - secretRef:
                      name: lightspeed-secrets
                image: 'quay.io/redhat-ai-dev/road-core-service:rcs-06302025-rhdh-1.7'
                name: road-core-sidecar
                ports:
                  - containerPort: 8080
                    name: rcs-backend
                    protocol: TCP
                volumeMounts:
                  - mountPath: /app-root/config/rcsconfig.yaml
                    name: rcsconfig
                    subPath: rcsconfig.yaml
                  - mountPath: /app-root/config/lightspeed-app-config.yaml
                    name: lightspeed-app-config
                    subPath: lightspeed-app-config.yaml
            extraEnvVars:
              ...
            extraEnvVarsSecrets:
              - lightspeed-secrets
            extraVolumeMounts:
              - mountPath: /app-root/config/rcsconfig.yaml
                name: rcsconfig
            extraVolumes:
              - configMap:
                  name: rcsconfig
                name: rcsconfig
              ...
            image:
              ...
            initContainers:
              ...

6. Define permissions and roles for your users who are not administrators by completing the following steps:

   1. Configure the required RBAC permission by defining an rbac-policies.csv file as shown in the following example:

      p, role:default/_<your_team>_, lightspeed.chat.read, read, allow
      p, role:default/_<your_team>_, lightspeed.chat.create, create, allow
      p, role:default/_<your_team>_, lightspeed.chat.delete, delete, allow
      
      g, user:default/_<your_user>_, role:default/_<your_team>_

   2. Upload your rbac-policies.csv and rbac-conditional-policies.yaml files to an rbac-policies config map in your OpenShift Container Platform project containing RHDH.

   3. Update your Backstage custom resource to mount in the RHDH filesystem your files from the rbac-policies ConfigMap:

      apiVersion: rhdh.redhat.com/v1alpha3
      kind: Backstage
      spec:
        application:
          extraFiles:
            mountPath: /opt/app-root/src
            configMaps:
              - name: rbac-policies

      For detailed information, see Managing authorizations by using external files.

Verification

1. Log in to your RHDH instance.
2. In your Red Hat Developer Hub navigation menu, you are able to see and access the Lightspeed menu item. Clicking this menu takes you to the Developer Lightspeed for RHDH screen.