Red Hat Developer Hub 的管理指南

流程

1. 在 OpenShift Container Platform Web 控制台中，选择 ConfigMaps 选项卡。
2. 点 Create ConfigMap。
3. 在 Create ConfigMap 页面中，选择 Configure via 中的 YAML view 选项，并根据需要更改该文件。
4. 点 Create。
5. 进入 Helm 选项卡查看 Helm 发行版本列表。
6. 点击您要使用的 Helm 发行版本的 overflow 菜单，然后选择 Upgrade。

7. 使用 Form view 或 YAML 视图 来编辑 Helm 配置。

   • 使用 Form view

     1. 展开 Root Schema → Backstage chart schema → Backstage parameters → Extra app 配置文件到内联到命令参数 中。
     2. 点 Add Extra app 配置文件以内联到命令参数 链接。

     3. 在以下字段中输入值：

        • configMapRef: app-config-rhdh
        • filename: app-config-rhdh.yaml
     4. 单击 Upgrade。

   • 使用 YAML 视图

     1. 设置 upstream.backstage.extraAppConfig.configMapRef 和 upstream.backstage.extraAppConfig.filename 参数的值，如下所示：

        # ... 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. 单击 Upgrade。

流程

1. 从 OpenShift Container Platform Web 控制台中的 Developer 视角，选择 Topology 视图，然后点击 Developer Hub pod 上的 Open URL 图标来识别 Developer Hub 外部 URL: < RHDH_URL>。
2. 从 OpenShift Container Platform Web 控制台中的 Developer 视角，选择 ConfigMaps 视图。
3. 点 Create ConfigMap。

4. 在 Configure via 中选择 YAML view 选项，并使用以下示例作为基础模板来创建 ConfigMap 对象，如 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

   设置 Red Hat Developer Hub 实例的外部 URL。

   2

   使用环境变量公开 OpenShift Container Platform secret，以定义强制的 Developer Hub 后端身份验证密钥。

   3

   设置 Red Hat Developer Hub 实例的外部 URL。

   4

   设置 Red Hat Developer Hub 实例的外部 URL。

5. 点 Create。
6. 选择 Secrets 视图。
7. 点 Create Key/value Secret。
8. 创建名为 secrets-rhdh 的 secret。

9. 添加名为 BACKEND_SECRET 的键，并将 base64 编码字符串作为值。为每个 Red Hat Developer Hub 实例使用唯一值。例如，您可以使用以下命令从终端生成密钥：

   node -p 'require("crypto").randomBytes(24).toString("base64")'

10. 点 Create。
11. 选择 Topology 视图。

12. 点您要使用的 Red Hat Developer Hub 实例的 overflow 菜单，然后选择 Edit Backstage 来加载 Red Hat Developer Hub 实例的 YAML 视图。

    

13. 在 CR 中，输入自定义应用程序配置配置映射的名称作为 spec.application.appConfig.configMaps 字段的值，并输入 secret 的名称作为 spec.application.extraEnvs.secrets 字段的值。例如：

    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. 点击 Save。
15. 返回到 Topology 视图，并等待 Red Hat Developer Hub pod 启动。
16. 点 Open URL 图标使用 Red Hat Developer Hub 平台以及配置更改。

流程

1. 可选：创建一个证书 secret 来使用 TLS 连接配置 PostgreSQL 实例：

   cat <<EOF | oc -n <your-namespace> create -f -
   apiVersion: v1
   kind: Secret
   metadata:
    name: <crt-secret> 

   1

   
   type: Opaque
   stringData:
    postgres-ca.pem: |-
     -----BEGIN CERTIFICATE-----
     <ca-certificate-key> 

   2

   
    postgres-key.key: |-
     -----BEGIN CERTIFICATE-----
     <tls-private-key> 

   3

   
    postgres-crt.pem: |-
     -----BEGIN CERTIFICATE-----
     <tls-certificate-key> 

   4

   
     # ...
   EOF

   1

   提供证书 secret 的名称。

   2

   提供 CA 证书密钥。

   3

   可选：提供 TLS 私钥。

   4

   可选：提供 TLS 证书密钥。

2. 创建凭证 secret 以与 PostgreSQL 实例连接：

   cat <<EOF | oc -n <your-namespace> create -f -
   apiVersion: v1
   kind: Secret
   metadata:
    name: <cred-secret> 

   1

   
   type: Opaque
   stringData: 

   2

   
    POSTGRES_PASSWORD: <password>
    POSTGRES_PORT: "<db-port>"
    POSTGRES_USER: <username>
    POSTGRES_HOST: <db-host>
    PGSSLMODE: <ssl-mode> # for TLS connection 

   3

   
    NODE_EXTRA_CA_CERTS: <abs-path-to-pem-file> # for TLS connection, e.g. /opt/app-root/src/postgres-crt.pem 

   4

   
   EOF

   1

   提供凭证 secret 的名称。

   2

   提供用于连接 PostgreSQL 实例的凭证数据。

   3

   可选：根据所需的 安全套接字层(SSL)模式提供值。

   4

   可选： 只有在需要 PostgreSQL 实例的 TLS 连接时才提供值。

3. 创建 Backstage 自定义资源(CR)：

   cat <<EOF | oc -n <your-namespace> create -f -
   apiVersion: rhdh.redhat.com/v1alpha1
   kind: Backstage
   metadata:
     name: <backstage-instance-name>
   spec:
     database:
       enableLocalDb: false 

   1

   
     application:
       extraFiles:
         mountPath: <path> # e g /opt/app-root/src
         secrets:
           - name: <crt-secret> 

   2

   
             key: postgres-crt.pem, postgres-ca.pem, postgres-key.key # key name as in <crt-secret> Secret
       extraEnvs:
         secrets:
           - name: <cred-secret> 

   3

   
           # ...

   1

   将 enableLocalDb 参数的值设置为 false，以禁用创建本地 PostgreSQL 实例。

   2

   如果您配置了 TLS 连接，请提供证书 secret 的名称。

   3

   提供您创建的凭证 secret 的名称。

   注意

   Backstage CR 中列出的环境变量与 Operator 默认配置一起工作。如果更改了 Operator 默认配置，您必须相应地重新配置 Backstage CR。

4. 将 Backstage CR 应用到已部署 RHDH 实例的命名空间。

流程

1. 可选：创建一个证书 secret 来使用 TLS 连接配置 PostgreSQL 实例：

   cat <<EOF | oc -n <your-namespace> create -f -
   apiVersion: v1
   kind: Secret
   metadata:
    name: <crt-secret> 

   1

   
   type: Opaque
   stringData:
    postgres-ca.pem: |-
     -----BEGIN CERTIFICATE-----
     <ca-certificate-key> 

   2

   
    postgres-key.key: |-
     -----BEGIN CERTIFICATE-----
     <tls-private-key> 

   3

   
    postgres-crt.pem: |-
     -----BEGIN CERTIFICATE-----
     <tls-certificate-key> 

   4

   
     # ...
   EOF

   1

   提供证书 secret 的名称。

   2

   提供 CA 证书密钥。

   3

   可选：提供 TLS 私钥。

   4

   可选：提供 TLS 证书密钥。

2. 创建凭证 secret 以与 PostgreSQL 实例连接：

   cat <<EOF | oc -n <your-namespace> create -f -
   apiVersion: v1
   kind: Secret
   metadata:
    name: <cred-secret> 

   1

   
   type: Opaque
   stringData: 

   2

   
    POSTGRES_PASSWORD: <password>
    POSTGRES_PORT: "<db-port>"
    POSTGRES_USER: <username>
    POSTGRES_HOST: <db-host>
    PGSSLMODE: <ssl-mode> # for TLS connection 

   3

   
    NODE_EXTRA_CA_CERTS: <abs-path-to-pem-file> # for TLS connection, e.g. /opt/app-root/src/postgres-crt.pem 

   4

   
   EOF

   1

   提供凭证 secret 的名称。

   2

   提供用于连接 PostgreSQL 实例的凭证数据。

   3

   可选：根据所需的 安全套接字层(SSL)模式提供值。

   4

   可选： 只有在需要 PostgreSQL 实例的 TLS 连接时才提供值。

3. 在名为 values.yaml 的 Helm 配置文件中配置 PostgreSQL 实例：

   # ...
   upstream:
     postgresql:
       enabled: false  # disable PostgreSQL instance creation 

   1

   
       auth:
         existingSecret: <cred-secret> # inject credentials secret to Backstage 

   2

   
     backstage:
       appConfig:
         backend:
           database:
             connection:  # configure Backstage DB connection parameters
               host: ${POSTGRES_HOST}
               port: ${POSTGRES_PORT}
               user: ${POSTGRES_USER}
               password: ${POSTGRES_PASSWORD}
               ssl:
                 rejectUnauthorized: true,
                 ca:
                   $file: /opt/app-root/src/postgres-ca.pem
                 key:
                   $file: /opt/app-root/src/postgres-key.key
                 cert:
                   $file: /opt/app-root/src/postgres-crt.pem
     extraEnvVarsSecrets:
       - <cred-secret> # inject credentials secret to Backstage 

   3

   
     extraEnvVars:
       - name: BACKEND_SECRET
         valueFrom:
           secretKeyRef:
             key: backend-secret
             name: '{{ include "janus-idp.backend-secret-name" $ }}'
     extraVolumeMounts:
       - mountPath: /opt/app-root/src/dynamic-plugins-root
         name: dynamic-plugins-root
       - mountPath: /opt/app-root/src/postgres-crt.pem
         name: postgres-crt # inject TLS certificate to Backstage cont. 

   4

   
         subPath: postgres-crt.pem
       - mountPath: /opt/app-root/src/postgres-ca.pem
         name: postgres-ca # inject CA certificate to Backstage cont. 

   5

   
         subPath: postgres-ca.pem
       - mountPath: /opt/app-root/src/postgres-key.key
         name: postgres-key # inject TLS private key to Backstage cont. 

   6

   
         subPath: postgres-key.key
     extraVolumes:
       - ephemeral:
           volumeClaimTemplate:
             spec:
               accessModes:
                 - ReadWriteOnce
               resources:
                 requests:
                   storage: 1Gi
         name: dynamic-plugins-root
       - configMap:
           defaultMode: 420
           name: dynamic-plugins
           optional: true
         name: dynamic-plugins
       - name: dynamic-plugins-npmrc
         secret:
           defaultMode: 420
           optional: true
           secretName: dynamic-plugins-npmrc
       - name: postgres-crt
         secret:
           secretName: <crt-secret> 

   7

   
           # ...

   1

   将 upstream.postgresql.enabled 参数的值设置为 false，以禁用创建本地 PostgreSQL 实例。

   2

   提供凭证 secret 的名称。

   3

   提供凭证 secret 的名称。

   4

   可选：仅为 TLS 连接提供 TLS 证书的名称。

   5

   可选：仅为 TLS 连接提供 CA 证书的名称。

   6

   可选：仅在 TLS 连接需要私钥时提供 TLS 私钥的名称。

   7

   如果您配置了 TLS 连接，请提供证书 secret 的名称。

4. 在名为 values.yaml 的 Helm 配置文件中应用配置更改：

   helm upgrade -n <your-namespace> <your-deploy-name> openshift-helm-charts/redhat-developer-hub -f values.yaml --version 1.2.6

流程

1. 在终端中运行以下命令，为本地 PostgreSQL 数据库 pod 配置端口转发：

   oc port-forward -n <your-namespace> <pgsql-pod-name> <forward-to-port>:<forward-from-port>

   其中：

   • & lt;pgsql-pod-name& gt; 变量表示 PostgreSQL pod 的名称，格式为 backstage-psql-<deployment-name>-<_index>。
   • & lt;forward-to-port > 变量表示您选择的端口将 PostgreSQL 数据转发到。

   • & lt;forward-from-port > 变量表示本地 PostgreSQL 实例端口，如 5432。

     示例：配置端口转发

     oc port-forward -n developer-hub backstage-psql-developer-hub-0 15432:5432

2. 复制以下 db_copy.sh 脚本，并根据您的配置编辑详情：

   #!/bin/bash
   
   to_host=<db-service-host> 

   1

   
   to_port=5432 

   2

   
   to_user=postgres 

   3

   
   
   from_host=127.0.0.1 

   4

   
   from_port=15432 

   5

   
   from_user=postgres 

   6

   
   
   allDB=("backstage_plugin_app" "backstage_plugin_auth" "backstage_plugin_catalog" "backstage_plugin_permission" "backstage_plugin_scaffolder" "backstage_plugin_search") 

   7

   
   
   for db in ${!allDB[@]};
   do
     db=${allDB[$db]}
     echo Copying database: $db
     PGPASSWORD=$TO_PSW psql -h $to_host -p $to_port -U $to_user -c "create database $db;"
     pg_dump -h $from_host -p $from_port -U $from_user -d $db | PGPASSWORD=$TO_PSW psql -h $to_host -p $to_port -U $to_user -d $db
   done

   1

   目标主机名，例如 < db-instance-name>.rds.amazonaws.com。

   2

   目的地端口，如 5432。

   3

   目标服务器用户名，例如 postgres。

   4

   源主机名，如 127.0.0.1。

   5

   源端口号，如 < forward-to-port> 变量。

   6

   源服务器用户名，如 postgres。

   7

   要使用双引号导入的数据库名称，例如："backstage_plugin_ app" "backstage_plugin_auth" "backstage_plugin_catalog" "backstage_plugin_permission" "backstage_plugin_permission" "backstage_plugin_scaffolder" "backstage_plugin_search"）。

3. 创建用于复制数据的目的地数据库：

   /bin/bash TO_PSW=<destination-db-password> /path/to/db_copy.sh 

   1

   1

   & lt;destination-db-password > 变量表示要连接到目标数据库的密码。

   注意

   当数据复制完成后，您可以停止端口转发。有关处理大型数据库和使用压缩工具的更多信息，请参阅 PostgreSQL 网站上的 Handling Large Databases 部分。

4. 重新配置 Backstage 自定义资源(CR)。如需更多信息，请参阅使用 Operator 配置外部 PostgreSQL 实例。

5. 在重新配置后，检查 Backstage CR 的末尾是否存在以下代码：

   # ...
   spec:
     database:
       enableLocalDb: false
     application:
     # ...
       extraFiles:
         secrets:
           - name: <crt-secret>
             key: postgres-crt.pem # key name as in <crt-secret> Secret
       extraEnvs:
         secrets:
           - name: <cred-secret>
   # ...

   注意

   重新配置 Backstage CR 会删除对应的 StatefulSet 和 Pod 对象，但不删除 PersistenceVolumeClaim 对象。使用以下命令删除本地 PersistenceVolumeClaim 对象：

   oc -n developer-hub delete pvc <local-psql-pvc-name>

   其中，&lt ;local-psql-pvc-name&gt; 变量采用 data-<psql-pod-name> 格式。

6. 应用配置更改。

验证

1. 运行以下命令，验证您的 RHDH 实例是否使用迁移的数据运行，且不包含本地 PostgreSQL 数据库：

   oc get pods -n <your-namespace>

2. 检查以下详情的输出：

   • backstage-developer-hub-xxx pod 处于 running 状态。

   • backstage-psql-developer-hub-0 pod 不可用。

     您还可以使用 OpenShift Container Platform Web 控制台中的 Topology 视图来验证这些详情。

流程

1. 从 OpenShift Container Platform Web 控制台中的 Developer 视角，选择 Topology 视图。

2. 点 Red Hat Developer Hub Helm Chart 的 overflow 菜单，然后选择 Upgrade。

   

3. 在 Upgrade Helm Release 页面中，选择 Configure via 中的 YAML view 选项，然后在 YAML 中配置 metrics 部分，如下例所示：

   upstream:
   # ...
     metrics:
       serviceMonitor:
         enabled: true
         path: /metrics
   # ...

   
4. 单击 Upgrade。

验证

1. 从 OpenShift Container Platform web 控制台中的 Developer 视角，选择 Observe 视图。
2. 点 Metrics 选项卡查看 Red Hat Developer Hub pod 的指标。

1. 将 ServiceMonitor CR 创建为 YAML 文件：

   apiVersion: monitoring.coreos.com/v1
   kind: ServiceMonitor
   metadata:
     name: <custom_resource_name> 

   1

   
     namespace: <project_name> 

   2

   
     labels:
       app.kubernetes.io/instance: <custom_resource_name>
       app.kubernetes.io/name: backstage
   spec:
     namespaceSelector:
       matchNames:
         - <project_name>
     selector:
       matchLabels:
         rhdh.redhat.com/app: backstage-<custom_resource_name>
     endpoints:
     - port: backend
       path: '/metrics'

   1

   将 <custom_resource_name > 替换为 Red Hat Developer Hub CR 的名称。

   2

   将 <project_name > 替换为运行 Red Hat Developer Hub 实例的 OpenShift Container Platform 项目的名称。

2. 运行以下命令来应用 ServiceMonitor CR：

   oc apply -f <filename>

验证

1. 从 OpenShift Container Platform web 控制台中的 Developer 视角，选择 Observe 视图。
2. 点 Metrics 选项卡查看 Red Hat Developer Hub pod 的指标。

流程

1. 在 Helm 配置文件中设置代理信息：

   upstream:
     backstage:
       extraEnvVars:
         - name: HTTP_PROXY
           value: '<http_proxy_url>'
         - name: HTTPS_PROXY
           value: '<https_proxy_url>'
         - name: NO_PROXY
           value: '<no_proxy_settings>'

   其中,

   <http_proxy_url>

   表示必须替换为 HTTP 代理 URL 的变量。

   <https_proxy_url>

   表示必须替换为 HTTPS 代理 URL 的变量。

   <no_proxy_settings>

   表示必须使用逗号分隔的 URL 替换的变量，该 URL 想从代理中排除，例如 foo.com,baz.com。

   示例：使用 Helm Chart 设置代理变量

   upstream:
     backstage:
       extraEnvVars:
         - name: HTTP_PROXY
           value: 'http://10.10.10.105:3128'
         - name: HTTPS_PROXY
           value: 'http://10.10.10.106:3128'
         - name: NO_PROXY
           value: 'localhost,example.org'

2. 保存配置更改。

流程

1. 根据您的角色执行以下步骤：

   • 作为管理员，在 Operator 的默认 ConfigMap 文件中设置代理信息：

     1. 在 default 命名空间 rhdh-operator 中搜索名为 backstage-default-config 的 ConfigMap 文件，并打开它。
     2. 查找 deployment.yaml 密钥。

     3. 在 Deployment spec 中设置 HTTP_PROXY、HTTPS_PROXY 和 NO_PROXY 环境变量的值，如下例所示：

        示例：在 ConfigMap 文件中设置代理变量

        # Other fields omitted
          deployment.yaml: |-
            apiVersion: apps/v1
            kind: Deployment
            spec:
              template:
                spec:
                  # Other fields omitted
                  initContainers:
                    - name: install-dynamic-plugins
                      # command omitted
                      env:
                        - name: NPM_CONFIG_USERCONFIG
                          value: /opt/app-root/src/.npmrc.dynamic-plugins
                        - name: HTTP_PROXY
                          value: 'http://10.10.10.105:3128'
                        - name: HTTPS_PROXY
                          value: 'http://10.10.10.106:3128'
                        - name: NO_PROXY
                          value: 'localhost,example.org'
                      # Other fields omitted
                  containers:
                    - name: backstage-backend
                      # Other fields omitted
                      env:
                        - name: APP_CONFIG_backend_listen_port
                          value: "7007"
                        - name: HTTP_PROXY
                          value: 'http://10.10.10.105:3128'
                        - name: HTTPS_PROXY
                          value: 'http://10.10.10.106:3128'
                        - name: NO_PROXY
                          value: 'localhost,example.org'

   • 作为开发者，在自定义资源(CR)文件中设置代理信息，如下例所示：

     示例：在 CR 文件中设置代理变量

     spec:
       # Other fields omitted
       application:
         extraEnvs:
           envs:
             - name: HTTP_PROXY
               value: 'http://10.10.10.105:3128'
             - name: HTTPS_PROXY
               value: 'http://10.10.10.106:3128'
             - name: NO_PROXY
               value: 'localhost,example.org'

2. 保存配置更改。

验证

1. 进入 Developer Hub web URL 并使用 OIDC 身份验证签名，这会提示您通过配置的 AWS Cognito 用户池进行身份验证。
2. 登录后，访问 Settings 并验证用户详情。

流程

1. 使用以下选项之一访问 Template Editor：

   
   • 为您的 Red Hat Developer Hub 实例打开 URL https://<rhdh_url>/create/edit。
   • 在 Red Hat Developer Hub 控制台的导航菜单中点 Create…​，然后点 overflow 菜单按钮并选择 Template 编辑器。
2. 点 Edit Template Form。
3. 可选：修改模板参数的 YAML 定义。有关这些参数的详情请参考 第 9.2 节 “创建模板作为 YAML 文件”。
4. 在 Name * 字段中，为模板输入一个唯一名称。
5. 从 Owner 下拉菜单中选择模板的所有者。
6. 点击 Next。

7. 在 Repository Location 视图中，输入您要发布模板的托管存储库的以下信息：

   1. 从下拉菜单中选择 可用主机。

      注意

      可用主机通过 allowedHosts 字段在 YAML 参数中定义：

      YAML 示例

      # ...
              ui:options:
                allowedHosts:
                  - github.com
      # ...

   2. 在 Owner * 字段中，输入托管存储库所属的机构、用户或项目。
   3. 在 Repository * 字段中，输入托管存储库的名称。
   4. 点 Review。
8. 检查信息准确性，然后点 Create。

验证

1. 单击导航面板中的 Catalog 选项卡。
2. 在 Kind 下拉菜单中选择 Template。
3. 确认模板显示在现有模板列表中。

验证

1. 单击导航面板中的 Catalog 选项卡。
2. 在 Kind 下拉菜单中选择 Template。
3. 确认模板显示在现有模板列表中。