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 リリースのオーバーフローメニューをクリックし、Upgrade を選択します。

7. Helm 設定を編集するには、Form view または YAML view のいずれかを使用します。

   • Form view を使用する場合

     1. Root Schema → Backstage chart schema → Backstage parameters → Extra app configuration files to inline into command arguments を展開します。
     2. Add Extra app configuration files to inline into command arguments リンクをクリックします。

     3. 以下のフィールドに値を入力します。

        • configMapRef: app-config-rhdh
        • filename: app-config-rhdh.yaml
     4. Upgrade をクリックします。

   • YAML view を使用する場合

     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 オプションを選択し、次の例をベーステンプレートとして使用して、app-config-rhdh.yaml などの ConfigMap オブジェクトを作成します。

   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 シークレットを公開する環境変数を使用して、必須の 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 という名前のシークレットを作成します。

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 インスタンスのオーバーフローメニューをクリックし、Edit Backstage を選択して、Red Hat Developer Hub インスタンスの YAML ビューを読み込みます。

    

13. CR で、spec.application.appConfig.configMaps フィールドの値としてカスタムアプリケーション設定の config map の名前を入力し、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. オプション: 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

   証明書シークレットの名前を指定します。

   2

   CA 証明書の鍵を指定します。

   3

   オプション: TLS 秘密鍵を指定します。

   4

   オプション: TLS 証明書の鍵を指定します。

2. 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

   認証情報シークレットの名前を指定します。

   2

   PostgreSQL インスタンスに接続するための認証情報データを指定します。

   3

   オプション: 必要な Secure Sockets Layer (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 接続を設定した場合は、証明書シークレットの名前を指定します。

   3

   作成した認証情報シークレットの名前を指定します。

   注記

   Backstage CR にリストされている環境変数は、Operator のデフォルト設定を使用します。Operator のデフォルト設定を変更した場合は、それに応じて Backstage CR を再設定する必要があります。

4. RHDH インスタンスをデプロイした namespace に Backstage CR を適用します。

手順

1. オプション: 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

   証明書シークレットの名前を指定します。

   2

   CA 証明書の鍵を指定します。

   3

   オプション: TLS 秘密鍵を指定します。

   4

   オプション: TLS 証明書の鍵を指定します。

2. 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

   認証情報シークレットの名前を指定します。

   2

   PostgreSQL インスタンスに接続するための認証情報データを指定します。

   3

   オプション: 必要な Secure Sockets Layer (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

   認証情報シークレットの名前を指定します。

   3

   認証情報シークレットの名前を指定します。

   4

   オプション: TLS 接続の場合のみ、TLS 証明書の名前を指定します。

   5

   オプション: TLS 接続の場合のみ、CA 証明書の名前を指定します。

   6

   オプション: TLS 接続に秘密鍵が必要な場合にのみ、TLS 秘密鍵の名前を指定します。

   7

   TLS 接続を設定した場合は、証明書シークレットの名前を指定します。

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>

   ここでは、以下のようになります。

   • <pgsql-pod-name> 変数は、backstage-psql-<deployment-name>-<_index> という形式の PostgreSQL Pod の名前を示します。
   • <forward-to-port> 変数は、PostgreSQL データの転送先のポートを示します。

   • <forward-from-port> 変数は、5432 などの PostgreSQL ローカルインスタンスのポートを示します。

     例: ポート転送の設定

     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_scaffolder" "backstage_plugin_search")。

3. データをコピーするための宛先データベースを作成します。

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

   1

   1

   <destination-db-password> 変数は、宛先データベースに接続するためのパスワードを示します。

   注記

   データのコピーが完了したら、ポート転送を停止できます。大規模データベースの処理と圧縮ツールの使用に関する詳細は、PostgreSQL Web サイトの 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>

   <local-psql-pvc-name> 変数は、data-<psql-pod-name> という形式です。

6. 設定の変更を適用します。

検証

1. 次のコマンドを実行して、RHDH インスタンスが移行したデータを使用して実行されており、ローカルの PostgreSQL データベースが含まれていないことを確認します。

   oc get pods -n <your-namespace>

2. 出力で次の詳細を確認します。

   • backstage-developer-hub-xxx Pod が実行中の状態であること。

   • backstage-psql-developer-hub-0 Pod が利用不可であること。

     これらの詳細は、OpenShift Container Platform Web コンソールの Topology ビューを使用して確認することもできます。

手順

1. OpenShift Container Platform Web コンソールの Developer パースペクティブから、Topology ビューを選択します。

2. Red Hat Developer Hub Helm チャートのオーバーフローメニューをクリックし、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 に置き換える必要がある変数を示します (例: foo.com,baz.com)。

   例: Helm チャートを使用してプロキシー変数を設定する

   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. デフォルトの namespace rhdh-operator で backstage-default-config という名前の ConfigMap ファイルを検索して開きます。
     2. deployment.yaml キーを見つけます。

     3. 次の例に示すように、Deployment 仕様で 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. 以下のオプションのいずれかを使用して、テンプレートエディターにアクセスします。

   
   • Red Hat Developer Hub インスタンスの URL https://<rhdh_url>/create/edit 開きます。
   • Red Hat Developer Hub コンソールのナビゲーションメニューで Create…​ をクリックし、オーバーフローメニューボタンをクリックして Template editor を選択します。
2. Edit Template Form をクリックします。
3. オプション: テンプレートのパラメーターの YAML 定義を変更します。これらのパラメーターの詳細は、「YAML ファイルとしてのテンプレートの作成」 を参照してください。
4. Name * に、テンプレート向けに独自の名前を入力します。
5. Owner ドロップダウンメニューから、テンプレートの所有者を選択します。
6. Next をクリックします。

7. Repository Location ビューで、テンプレートを公開するホストされたリポジトリーに関する次の情報を入力します。

   1. ドロップダウンメニューから利用可能な Host を選択します。

      注記

      利用可能なホストは、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. テンプレートが既存のテンプレートのリストに表示されていることを確認します。