为 Red Hat Developer Hub 与 Red Hat Developer Lightspeed 交互

流程

1. 创建 RCS ConfigMap。

   1. 在 OpenShift Container Platform Web 控制台中，进入您的 RHDH 实例并选择 ConfigMaps 选项卡。
   2. 点 Create ConfigMaps。

   3. 在 Create ConfigMap 页面中，在 Configure via 中选择 YAML view 选项，并编辑该文件，如下例所示：

      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"

      重要

      不要删除 llm_providers 部分中的块。由于在 path Core 中发现的限制，这个要求对于 RHDH 使用 Developer Lightspeed 时至关重要。对于决定使用替代 LLM 供应商的实例，您应该参考指南中的其他信息。如需更多信息，请参阅 更改 LLM 供应商。

   4. 可选：通过在 RCS ConfigMap 中指定以下示例来配置 扩展 REST API 的 worker 数量。

      ols_config:
          max_workers: _<number_of_workers>_

   5. 点 Create。

2. 为 RHDH ConfigMap 创建 Developer Lightspeed。

   注意

   为 RHDH ConfigMap 创建专用的 Developer Lightspeed，而不是向现有的 RHDH 自定义应用程序配置文件添加额外的部分（例如 lightspeed-app-config.yaml）。创建两个文件可防止整个 RHDH ConfigMap 加载到 RCS 中。

   1. 在 OpenShift Container Platform Web 控制台中，进入您的 RHDH 实例并选择 ConfigMaps 选项卡。
   2. 点 Create ConfigMap。

   3. 在 Create ConfigMap 页面中，选择 Configure via 中的 YAML view 选项，并添加以下示例：

      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. 为 RHDH secret 文件创建 Developer Lightspeed。

   1. 在 OpenShift Container Platform Web 控制台中进入 Secrets。
   2. 点 Create > Key/value secret。

   3. 在 Create key/value secret 页面中，选择 Configure via 中的 YAML view 选项，并添加以下示例：

      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. 点 Create。

4. 在现有的动态插件 ConfigMap （如 dynamic-plugins-rhdh.yaml）中，为 RHDH 插件镜像添加 Developer Lightspeed，如下例所示：

   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. 根据您的安装方法更新部署配置：

   1. 对于 Operator 安装的 RHDH 实例，请更新 Backstage 自定义资源(CR)。

      1. 在 spec.application.appConfig.configMaps 部分中，为 RHDH 自定义应用程序配置添加 Developer Lightspeed，如下例所示：

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

      2. 更新 extraVolumes 规格，使其包含 RCS ConfigMap，如下例所示：

                     volumes:
                       - configMap:
                           name: rcsconfig
                         name: rcsconfig

      3. 更新 volumeMounts 规格以挂载 RCS ConfigMap，如下例所示：

                 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. 为 RHDH Secret 文件添加 Developer Lightspeed，如下例所示：

                 envFrom:
                   - secretRef:
                       name: lightspeed-secrets

      5. 在 deployment.patch.spec.template.spec.containers.env 部分中，设置 RCS 环境变量，如下例所示：

             - 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

         注意

         您的 RHDH 容器通常已存在于您的 CR 中。您要添加第二个容器定义 road-core-sidecar 作为 RCS sidecar。

      6. 点击 Save。Pod 会自动重启。

         带有 RCS 容器的 Backstage CR 示例

         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. 对于 Helm 安装的 RHDH 实例，请更新您的 Helm Chart。

      1. 在'global.dynamic' 属性中添加动态插件配置，如下例所示：

         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. 为 RHDH 自定义应用程序配置文件添加 Developer Lightspeed，如下例所示：

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

      3. 更新 extraVolumes 部分，使其包含 RCS ConfigMap，如下例所示：

         extraVolumes:
               - configMap:
                   name: rcsconfig
                 name: rcsconfig

      4. 更新 extraVolumeMounts 部分以挂载 RCS ConfigMap，如下例所示：

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

      5. 为 RHDH Secret 文件添加 Developer Lightspeed，如下例所示：

          extraEnvVarsSecrets:
               - lightspeed-secrets

      6. 添加 RCS 镜像，如下例所示：

            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

         注意

         您的 RHDH 容器通常已存在于 Helm Chart 中。您要添加第二个容器定义 road-core-sidecar 作为 RCS sidecar。

      7. 点击 Save。

      8. 点 Helm upgrade。

         带有 RCS 容器的 Helm chart 示例

         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. 根据您的安装方法管理授权：

   1. 对于 Operator 安装的 RHDH 实例，请完成以下步骤为不是管理员的用户定义权限和角色：

      1. 通过定义 rbac-policies.csv 文件来配置所需的 RBAC 权限，如下例所示：

         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. 将 rbac-policies.csv 文件上传到包含 RHDH 的 OpenShift Container Platform 项目中的 rbac-policies 配置映射。

      3. 更新 Backstage 自定义资源，以便从 rbac-policies ConfigMap 中挂载您的文件：

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

         如需更多信息，请参阅使用 外部文件管理授权。

   2. 对于 Helm 安装的 RHDH 实例，请完成以下步骤为不是管理员的用户定义权限和角色：

      1. 通过定义 rbac-policies.csv 文件来配置所需的 RBAC 权限，如下例所示：

         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. 声明策略管理员，以启用选择数量的经过身份验证的用户，以通过 REST API 或 Web UI 配置 RBAC 策略，而不是直接修改 CSV 文件。权限可以在 my-rhdh-app-config 配置映射中引用的单独 CSV 文件中指定，也可以使用 REST API 或 Web UI 创建权限。要将 < your_policy_administrator_name&gt; 等用户声明为策略管理员，请编辑自定义 RHDH ConfigMap，如 app-config.yaml，并将以下代码添加到 app-config.yaml 内容中：

         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>

验证

1. 登录到您的 RHDH 实例。
2. 在 Red Hat Developer Hub 导航菜单中，您可以看到并访问 Lightspeed 菜单项。单击此菜单可进入 RHDH 屏幕的 Developer Lightspeed。