第1章 カスタム Red Hat Developer Hub 設定のプロビジョニングおよび使用

手順

1. セキュリティー上の理由から、シークレットは設定ファイル内のクリアテキストではなく、OpenShift Container Platform シークレットの環境変数値として保存します。すべてのシークレットを secrets.txt ファイルに収集します。KEY=value 形式で 1 行につき 1 つのシークレットを記述します。

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

2. カスタムの app-config.yaml ファイルを作成します。これは、メインの Developer Hub 設定ファイルです。Developer Hub インストーラーが、アップグレード時にユーザーの編集を元に戻すのを防ぐには、カスタムの app-config.yaml ファイルが必要です。カスタムの app-config.yaml ファイルが空の場合、Developer Hub はデフォルト値を使用します。

   • OpenShift Container Platform で Red Hat Developer Hub Operator を使用してデプロイメントを準備するには、空のファイルで開始できます。

   • Red Hat Developer Hub Helm チャートまたは Kubernetes でデプロイメントを準備するには、app-config.yaml ファイルの関連フィールドに Developer Hub のベース URL を入力し、Developer Hub の適切な機能を確保します。ベース URL は、Developer Hub ユーザーが Developer Hub にアクセスしたときにブラウザーに表示されるものです。関連するフィールドは、app セクションおよび backend セクションの baseUrl、および backend.cors サブセクションの origin です。

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

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

     Copy to Clipboard Toggle word wrap

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

     • Red Hat Developer Hub での認証
     • Red Hat Developer Hub での認可
     • カスタマイズ
     • OpenShift Container Platform インテグレーションの設定

3. プラグインを有効にするには、カスタム dynamic-plugins.yaml ファイルを作成します。デフォルトでは、Developer Hub は最小限のプラグインセットを有効にし、GitHub リポジトリー検出プラグインやロールベースのアクセス制御 (RBAC) プラグインなどの設定やシークレットを必要とするプラグインを無効にします。

   GitHub リポジトリーの検出と RBAC 機能を有効にします。

   dynamic.plugins.yaml

   includes:
     - dynamic-plugins.default.yaml
   plugins:
     - package: ./dynamic-plugins/dist/backstage-plugin-catalog-backend-module-github
       disabled: false
     - package: ./dynamic-plugins/dist/backstage-community-plugin-rbac
       disabled: false

   Copy to Clipboard Toggle word wrap

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

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

      $ oc create namespace my-rhdh-project

      Copy to Clipboard Toggle word wrap

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

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

      Copy to Clipboard Toggle word wrap

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

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

      $ oc create secret generic my-rhdh-secrets --from-file=secrets.txt --namespace=my-rhdh-project

      Copy to Clipboard Toggle word wrap

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