1. Create the Lightspeed Core Service (LCS) ConfigMap: The LCS ConfigMap stores the configuration for the Lightspeed Core Service and is mounted to the LCS container.

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

   3. From the Create ConfigMap page, select the YAML view option and edit the file using the following structure. This example demonstrates the configuration for the LCS ConfigMap, typically named lightspeed-stack, which connects to the Llama Stack service locally on port 8321:

      kind: ConfigMap
      apiVersion: v1
      metadata:
        name: lightspeed-stack
      data:
        lightspeed-stack.yaml: |
          name: Lightspeed Core Service (LCS)
          service:
            host: 0.0.0.0
          # Use ${LIGHTSPEED_SERVICE_PORT} if you are not running the Service on port `8080`
          # port: ${LIGHTSPEED_SERVICE_PORT}
            auth_enabled: false
            workers: 1
            color_log: true
            access_log: true
          llama_stack:
            use_as_library_client: false
            url: http://localhost:8321
          user_data_collection:
            feedback_enabled: true
            feedback_storage: "/tmp/data/feedback"
            transcripts_enabled: true
            transcripts_storage: "/tmp/data/transcripts"
          authentication:
            module: "noop"
          conversation_cache:
            type: "sqlite"
            sqlite:
              db_path: "/tmp/data/conversations/lcs_cache.db"

      where:

      RHDH_HOST

      Enter the hostname for RHDH.

   4. Click Create.

2. Create the Developer Lightspeed for RHDH ConfigMap: Create a dedicated Developer Lightspeed for RHDH ConfigMap (lightspeed-app-config) to hold specific plugin configurations.

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

   3. From the Create ConfigMap page, select the YAML view option 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'"
              - "'unsafe-eval'"
              - https://cdn.jsdelivr.net
      
          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 {product-short} 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."

   4. Click Create.

3. Create Llama Stack Secret file (llama-stack-secrets): This file holds sensitive configuration data for your LLM provider and Llama Stack environment variables.

   Note

   You must provide an LLM provider that conforms to the OpenAI API specification. For more information, see Changing your LLM provider.

   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 and add the following example:

      apiVersion: v1
      kind: Secret
      metadata:
        name: llama-stack-secrets
      type: Opaque
      stringData:
        VLLM_URL: ""
        VLLM_API_KEY: ""
        VLLM_MAX_TOKENS: ""
        VLLM_TLS_VERIFY: ""
        VALIDATION_PROVIDER: ""
        VALIDATION_MODEL_NAME: ""

      where:

      VLLM_URL

      Required for remote services: Set this to the API endpoint URL of your preferred LLM provider, if it is compatible with the OpenAI API specification (Examples: OpenAI, Red Hat OpenShift AI, vLLM)

      VLLM_API_KEY

      Required for remote services: Set this to the API key or token required for authentication with your remote LLM provider, if it is compatible with the OpenAI API specification

      VLLM_MAX_TOKENS

      Optional

      VLLM_TLS_VERIFY

      Optional

      VALIDATION_PROVIDER

      Set this as vllm, ollama, openai, depending on the key you have set in this configuration file

      VALIDATION_MODEL_NAME

      Set the name of the model you want to use for validation

   4. Click Create.

4. Update the dynamic plugins ConfigMap: Add the Developer Lightspeed for RHDH plugin image to your existing dynamic plugins ConfigMap (dynamic-plugins-rhdh).

   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.42.5__1.0.3!red-hat-developer-hub-backstage-plugin-lightspeed
     disabled: false
     pluginConfig:
       lightspeed:
         # OPTIONAL: Custom users prompts displayed to users
         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:
           translationResources:
             - importName: lightspeedTranslations
               module: Alpha
               ref: lightspeedTranslationRef
           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.42.5__1.0.3!red-hat-developer-hub-backstage-plugin-lightspeed-backend
     disabled: false

5. Update your deployment configuration: Update the deployment configuration based on how your RHDH instance was installed. You must add two sidecar containers: llama-stack and lightspeed-core.

   • For an Operator-installed RHDH instance (Update Backstage Custom Resource (CR)):

     1. In the spec.application.appConfig.configMaps section of your Backstage CR, add the Developer Lightspeed for RHDH custom app configuration:

            appConfig:
              configMaps:
                - name: lightspeed-app-config

     2. Update the spec.deployment.patch.spec.template.spec.volumes specification to include volumes for LCS configuration (lightspeed-stack), shared storage for feedback (shared-storage), and RAG data (rag-data-volume):

            volumes:
              - configMap:
                  name: lightspeed-stack
                name: lightspeed-stack
              - emptyDir: {}
                name: shared-storage
              - emptyDir: {}
                name: rag-data-volume

     3. Add the initContainers section to initialize RAG data:

            initContainers:
              - name: init-rag-data
                image: 'quay.io/redhat-ai-dev/rag-content:release-1.8-lcs'
                command:
                  - "sh"
                  - "-c"
                  - "echo 'Copying RAG data...'; cp -r /rag/vector_db/rhdh_product_docs /data/ && cp -r /rag/embeddings_model /data/ && echo 'Copy complete.'"
                volumeMounts:
                  - mountPath: /data
                    name: rag-data-volume

     4. Add the Llama Stack and the LCS containers to the spec.deployment.patch.spec.template.spec.containers section:

          spec:
            application:
              - extraEnvs:
                  secrets:
                    - name: lightspeed-secrets
            containers:
              # ... Your existing RHDH container definition ...
              - envFrom:
                  - secretRef:
                      name: llama-stack-secrets
                image: 'quay.io/redhat-ai-dev/llama-stack:0.1.1' # Llama Stack image
                name: llama-stack
                volumeMounts:
                  - mountPath: /app-root/.llama
                    name: shared-storage
                  - mountPath: /app-root/embeddings_model
                    name: rag-data-volume
                    subPath: embeddings_model
                  - mountPath: /app-root/vector_db/rhdh_product_docs
                    name: rag-data-volume
                    subPath: rhdh_product_docs
              - image: 'quay.io/lightspeed-core/lightspeed-stack:dev-20251021-ee9f08f' # Lightspeed Core Service image
                name: lightspeed-core
                volumeMounts:
                  - mountPath: /app-root/lightspeed-stack.yaml
                    name: lightspeed-stack
                    subPath: lightspeed-stack.yaml
                  - mountPath: /tmp/data/feedback
                    name: shared-storage
                  - mountPath: /tmp/data/transcripts
                    name: shared-storage
                  - mountPath: /tmp/data/conversations
                    name: shared-storage

     5. Click Save. The Pods are automatically restarted.

   • For a Helm-installed RHDH instance (Update the Helm chart):

     1. Add your dynamic plugins configuration in the global.dynamic property.

     2. Add your Developer Lightspeed for RHDH custom app config file to extraAppConfig:

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

     3. Add the Llama Stack Secret file to extraEnvVarsSecrets:

            extraEnvVarsSecrets:
              - llama-stack-secrets

     4. Update the extraVolumes section to include the LCS ConfigMap (lightspeed-stack), shared storage, and RAG data volume:

            extraVolumes:
              - configMap:
                  name: lightspeed-stack
                name: lightspeed-stack
              - emptyDir: {}
                name: shared-storage
              - emptyDir: {}
                name: rag-data-volume

     5. Update the initContainers section (if supported by your Helm chart structure) to initialize RAG data.

          initContainers:
              - name: init-rag-data
                image: 'quay.io/redhat-ai-dev/rag-content:release-1.8-lcs'
                command:
                  - "sh"
                  - "-c"
                  - "echo 'Copying RAG data...'; cp -r /rag/vector_db/rhdh_product_docs /data/ && cp -r /rag/embeddings_model /data/ && echo 'Copy complete.'"
                volumeMounts:
                  - mountPath: /data
                    name: rag-data-volume

     6. Add the Llama Stack and LCS container definitions to extraContainers

        Note

        If you have Road-Core Service installed from the previous Red Hat Developer Lightspeed for Red Hat Developer Hub configuration, you must replace the older single container configuration found in source with the two sidecars.

            extraContainers:
              # Llama Stack Container
              - envFrom:
                  - secretRef:
                      name: llama-stack-secrets
                image: 'quay.io/redhat-ai-dev/llama-stack:0.1.1'
                name: llama-stack
                volumeMounts:
                  - mountPath: /app-root/.llama
                    name: shared-storage
                  - mountPath: /app-root/embeddings_model
                    name: rag-data-volume
                    subPath: embeddings_model
                  - mountPath: /app-root/vector_db/rhdh_product_docs
                    name: rag-data-volume
                    subPath: rhdh_product_docs
              # Lightspeed Core Service Container
              - image: 'quay.io/lightspeed-core/lightspeed-stack:dev-20251021-ee9f08f'
                name: lightspeed-core
                volumeMounts:
                  - mountPath: /app-root/lightspeed-stack.yaml
                    name: lightspeed-stack
                    subPath: lightspeed-stack.yaml
                  - mountPath: /tmp/data/feedback
                    name: shared-storage
                  - mountPath: /tmp/data/transcripts
                    name: shared-storage
                  - mountPath: /tmp/data/conversations
                    name: shared-storage

     7. Click Save and then Helm upgrade.

6. Optional: Manage authorization (RBAC): If you have users who are not administrators, you must define permissions and roles for them to use Developer Lightspeed for RHDH. The Lightspeed Backend plugin uses Backstage RBAC for authorization.

   • For an Operator-installed RHDH instance:

     1. Configure the required RBAC permission by defining an rbac-policies.csv file, including lightspeed.chat.read, lightspeed.chat.create, and lightspeed.chat.delete permissions:

        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 file to an rbac-policies ConfigMap in your OpenShift Container Platform project containing RHDH and update your Backstage CR:

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

   • For a Helm-installed RHDH instance:

     1. Configure the required RBAC permission by defining an rbac-policies.csv file:

        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. Optional: Declare policy administrators by editing your custom RHDH ConfigMap (app-config.yaml) and adding the following code to enable selected authenticated users to configure RBAC policies through the REST API or Web UI:

          permission:
            enabled: true
            rbac:
              policies-csv-file: /opt/app-root/src/rbac-policies.csv
              policyFileReload: true
            admin:
              users:
                - name: user:default/<your_policy_administrator_name>

Verification

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