設定

手順

1. カスタムの &lt ;my_product_secrets > .txt ファイルを作成し、設定ファイルのクリアテキストではなく、OpenShift Container Platform シークレットの環境変数としてシークレットをプロビジョニングします。1 行ごとに KEY=value 形式のシークレットが 1 つ含まれています。

   • 認証シークレットを入力 します。

2. カスタムの app-config.yaml ファイルを作成します。これは、メインの Developer Hub 設定ファイルです。

   Developer Hub が適切に機能させるには、app-config.yaml ファイルに baseUrl フィールドが必須です。初期化中にエラーが発生しないようにするには、アプリケーションセクション と backend セクションの両方で baseUrl を指定する必要があります。

   例1.1 app-config.yaml での baseUrl の設定

   app:
     title: Red Hat Developer Hub
     baseUrl: https://<my_developer_hub_url>
   
   backend:
     auth:
       externalAccess:
         - type: legacy
           options:
             subject: legacy-default-config
             secret: "${BACKEND_SECRET}"
     baseUrl: https://<my_developer_hub_url>
     cors:
       origin: https://<my_developer_hub_url>

   Copy to Clipboard Toggle word wrap

   任意で、以下のような設定を入力します。

   • 認証
   • 認可
   • カスタマイズ
   • OpenShift Container Platform インテグレーションの設定。

3. カスタム設定ファイルを OpenShift Container Platform クラスターにプロビジョニングします。

   1. Developer Hub インスタンスを含むことを目的とした <my-rhdh-project> プロジェクトを作成します。

      $ oc create namespace my-rhdh-project

      Copy to Clipboard Toggle word wrap

      または、Web コンソールを使用してプロジェクトを作成 します。

   2. app-config.yaml ファイルを <my-rhdh-project> プロジェクトの my-rhdh-app-config config map にプロビジョニングします。

      $ oc create configmap my-rhdh-app-config --from-file=app-config.yaml --namespace=my-rhdh-project

      Copy to Clipboard Toggle word wrap

      または、Web コンソールを使用して config map を作成 します。

   3. < my_product_secrets > .txt ファイルを < my -rhdh-project> プロジェクトの <my _product_secrets > シークレットにプロビジョニングします。

      $ oc create secret generic <my_product_secrets> --from-file=<my_product_secrets>.txt --namespace=my-rhdh-project

      Copy to Clipboard Toggle word wrap

      または、Web コンソールを使用してシークレットを作成 します。

手順

1. my-rhdh-custom-resource.yaml ファイルで Backstage CR を作成し、カスタム config map とシークレットを使用します。

   例1.2 最小の my-rhdh-custom-resource.yaml カスタムリソースの例

   apiVersion: rhdh.redhat.com/v1alpha3
   kind: Backstage
   metadata:
     name: my-rhdh-custom-resource
   spec:
     application:
       appConfig:
         mountPath: /opt/app-root/src
         configMaps:
            - name: my-rhdh-app-config
       extraEnvs:
         secrets:
            - name: <my_product_secrets>
       extraFiles:
         mountPath: /opt/app-root/src
       replicas: 1
       route:
         enabled: true
     database:
       enableLocalDb: true

   Copy to Clipboard Toggle word wrap

   例1.3 動的プラグインおよび RBAC ポリシー config map、および外部の PostgreSQL データベースシークレットを含む my-rhdh-custom-resource.yaml カスタムリソースの例。

   apiVersion: rhdh.redhat.com/v1alpha3
   kind: Backstage
   metadata:
     name: <my-rhdh-custom-resource>
   spec:
     application:
       appConfig:
         mountPath: /opt/app-root/src
         configMaps:
            - name: my-rhdh-app-config
            - name: rbac-policies
       dynamicPluginsConfigMapName: dynamic-plugins-rhdh
       extraEnvs:
         secrets:
            - name: <my_product_secrets>
            - name: my-rhdh-database-secrets
       extraFiles:
         mountPath: /opt/app-root/src
         secrets:
           - name: my-rhdh-database-certificates-secrets
             key: postgres-crt.pem, postgres-ca.pem, postgres-key.key
       replicas: 1
       route:
         enabled: true
     database:
       enableLocalDb: false

   Copy to Clipboard Toggle word wrap

   必須フィールド:

   必須フィールドはありません。空の Backstage CR を作成し、デフォルト設定で Developer Hub を実行できます。

   オプションのフィールド:

   spec.application.appConfig.configMaps

   config map 名のリストを入力します。

   my-rhdh-app-config config map のファイルをマウントします。

   spec:
     application:
       appConfig:
         mountPath: /opt/app-root/src
         configMaps:
            - name: my-rhdh-app-config

   Copy to Clipboard Toggle word wrap

   例1.4 my-rhdh-app-config および rbac-policies config map にファイルをマウントします。

   spec:
     application:
       appConfig:
         mountPath: /opt/app-root/src
         configMaps:
            - name: my-rhdh-app-config
            - name: rbac-policies

   Copy to Clipboard Toggle word wrap

   spec.application.extraEnvs.envs

   必要に応じて、プロキシー環境変数 など、シークレットではない追加の環境変数を入力します。

   例1.5 HTTP_PROXY、HTTPS_PROXY、および NO_PROXY 環境変数を注入します。

   spec:
     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'

   Copy to Clipboard Toggle word wrap

   spec.application.extraEnvs.secrets

   環境変数のシークレット名リストを入力します。

   例1.6 Red Hat Developer Hub シークレットに環境変数を挿入する

   spec:
     application:
       extraEnvs:
         secrets:
            - name: <my_product_secrets>

   Copy to Clipboard Toggle word wrap

   例1.7 Red Hat Developer Hub および my-rhdh-database-secrets シークレットに環境変数を挿入します。

   spec:
     application:
       extraEnvs:
         secrets:
            - name: <my_product_secrets>
            - name: my-rhdh-database-secrets

   Copy to Clipboard Toggle word wrap

手順

1. Developer Hub でカスタム設定ファイルを使用するように Helm を設定します。

   1. Helm リリースのリストを表示するには、Helm タブに移動します。
   2. 使用する Helm リリースのオーバーフローメニューをクリックし、Upgrade を選択します。
   3. YAML ビュー を使用して Helm 設定を編集します。

   4. 以下のように upstream.backstage.extraAppConfig.configMapRef パラメーターおよび upstream.backstage.extraAppConfig.filename パラメーターの値を設定します。

      Helm 設定の抜粋

      upstream:
        backstage:
          extraAppConfig:
            - configMapRef: my-rhdh-app-config
              filename: app-config.yaml

      Copy to Clipboard Toggle word wrap

   5. Upgrade をクリックします。

手順

1. オプション: TLS 接続を使用して PostgreSQL インスタンスを設定するための証明書シークレットを作成します。

   cat <<EOF | oc -n my-rhdh-project create -f -
   apiVersion: v1
   kind: Secret
   metadata:
    name: my-rhdh-database-certificates-secrets 

   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

   Copy to Clipboard Toggle word wrap

   1

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

   2

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

   3

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

   4

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

2. PostgreSQL インスタンスに接続するための認証情報シークレットを作成します。

   cat <<EOF | oc -n my-rhdh-project create -f -
   apiVersion: v1
   kind: Secret
   metadata:
    name: my-rhdh-database-secrets 

   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

   Copy to Clipboard Toggle word wrap

   1

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

   2

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

   3

   オプション: 必要な Secure Sockets Layer (SSL) モード に応じて値を指定します。

   4

   オプション: PostgreSQL インスタンスに TLS 接続が必要な場合にのみ値を指定します。

3. Backstage カスタムリソース (CR) を作成します。

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

   1

   
     application:
       extraFiles:
         mountPath: <path> # e g /opt/app-root/src
         secrets:
           - name: my-rhdh-database-certificates-secrets 

   2

   
             key: postgres-crt.pem, postgres-ca.pem, postgres-key.key # key name as in my-rhdh-database-certificates-secrets Secret
       extraEnvs:
         secrets:
           - name: my-rhdh-database-secrets 

   3

   
           # ...

   Copy to Clipboard Toggle word wrap

   1

   enableLocalDb パラメーターの値を false に設定して、PostgreSQL のローカルインスタンスの作成を無効にします。

   2

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

   3

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

   注記

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

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

手順

1. オプション: TLS 接続を使用して PostgreSQL インスタンスを設定するための証明書シークレットを作成します。

   cat <<EOF | oc -n <your-namespace> create -f -
   apiVersion: v1
   kind: Secret
   metadata:
    name: my-rhdh-database-certificates-secrets 

   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

   Copy to Clipboard Toggle word wrap

   1

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

   2

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

   3

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

   4

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

2. PostgreSQL インスタンスに接続するための認証情報シークレットを作成します。

   cat <<EOF | oc -n <your-namespace> create -f -
   apiVersion: v1
   kind: Secret
   metadata:
    name: my-rhdh-database-secrets 

   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

   Copy to Clipboard Toggle word wrap

   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: my-rhdh-database-secrets # 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:
       - my-rhdh-database-secrets # 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: '{{ printf "%s-dynamic-plugins-npmrc" .Release.Name }}'
       - name: postgres-crt
         secret:
           secretName: my-rhdh-database-certificates-secrets 

   7

   
           # ...

   Copy to Clipboard Toggle word wrap

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

   Copy to Clipboard Toggle word wrap

手順

1. ターミナルで次のコマンドを実行して、ローカル PostgreSQL データベース Pod のポート転送を設定します。

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

   Copy to Clipboard Toggle word wrap

   詳細は以下のようになります。

   • <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

     Copy to Clipboard Toggle word wrap

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

   Copy to Clipboard Toggle word wrap

   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

   Copy to Clipboard Toggle word wrap

   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: my-rhdh-database-certificates-secrets
             key: postgres-crt.pem # key name as in my-rhdh-database-certificates-secrets Secret
       extraEnvs:
         secrets:
           - name: my-rhdh-database-secrets
   # ...

   Copy to Clipboard Toggle word wrap
   注記

   Backstage CR を再設定すると、対応する StatefulSet および Pod オブジェクトは削除されますが、PersistenceVolumeClaim オブジェクトは削除されません。ローカル PersistenceVolumeClaim オブジェクトを削除するには、次のコマンドを使用します。

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

   Copy to Clipboard Toggle word wrap

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

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

検証

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

   oc get pods -n <your-namespace>

   Copy to Clipboard Toggle word wrap

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

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

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

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

手順

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'

        Copy to Clipboard Toggle word wrap

   • 開発者は、次の例に示すように、Backstage 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'

     Copy to Clipboard Toggle word wrap

2. 設定変更を保存します。

手順

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>'

   Copy to Clipboard Toggle word wrap

   詳細は以下のようになります。

   <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'

   Copy to Clipboard Toggle word wrap

2. 設定変更を保存します。