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. Red Hat OpenShift クラスターで、OAuth アプリケーションを作成する GitHub 組織のメインページに移動します。
2. Settings → Developer Settings → OAuth Apps → Register an application をクリックします。
3. アプリケーション名として Developer Hub と入力します。

4. Homepage URL として次の URL を追加します。

   https://developer-hub-<NAMESPACE_NAME>.<OPENSHIFT_ROUTE_HOST>/

5. Authorization callback URL として次の URL を追加します。

   https://developer-hub-<NAMESPACE_NAME>.<OPENSHIFT_ROUTE_HOST>/api/auth/github/handler/frame

6. Enable Device Flow チェックボックスをオフにします。
7. Register application をクリックして、OAuth アプリケーションを作成します。
8. アプリケーションを作成した後、Generate a new client secret をクリックし、生成されたクライアントシークレットをコピーします。
9. OpenShift で、ConfigMaps をクリックします。

10. 指定された環境変数をキーとして使用して、'github-secrets' という名前のキー/値のシークレットを生成し、GitHub OAuth アプリケーション用に生成した値を入力します。

    1. Red Hat OpenShift で、Secrets タブに移動し、Create をクリックします。
    2. Key/value secret を選択します。
    3. Secret name を github-secrets として入力します。

    4. 環境変数を Key と Value として追加し、Create をクリックします。

       Expand

       表3.1 環境変数

       キー	値
       GITHUB_OAUTH_CLIENT_ID	OAuth アプリケーションからのクライアント ID
       GITHUB_OAUTH_CLIENT_SECRET	OAuth アプリケーションからのクライアントシークレット

       Show more

11. 次のように app-config-rhdh ConfigMap を変更して、GitHub 認証設定を追加します。

    kind: ConfigMap
    apiVersion: v1
    metadata:
      name: app-config-rhdh
    data:
      app-config-rhdh.yaml: |
        app:
          title: Red Hat Developer Hub
        auth:
          # see https://backstage.io/docs/auth/ to learn about auth providers
          environment: development
          providers:
            github:
              development:
                clientId: ${GITHUB_OAUTH_CLIENT_ID}
                clientSecret: ${GITHUB_OAUTH_CLIENT_SECRET}

12. Save をクリックします。
13. Helm タブに移動し、Upgrade を選択します。

14. Helm 設定を編集するには、次のいずれかのビューを使用します。

    • Form view を使用する場合

      1. Root Schema → Backstage Chart Schema → Backstage Parameters → Backstage container environment variables を既存の Secrets を展開します。
      2. Add Backstage container environment variables from existing Secrets リンクをクリックします。
      3. github-secrets を値として入力します。
      4. Upgrade をクリックします。

    • YAML view を使用する場合

      1. 以下の例のように、upstream.backstage.extraEnvVarsSecrets パラメーターの値を github-secrets に設定します。

         # other Red Hat Developer Hub Helm Chart configurations
         upstream:
           backstage:
             # other Red Hat Developer Hub Helm Chart configurations
             extraEnvVarsSecrets:
               - github-secrets
             # other Red Hat Developer Hub Helm Chart configurations

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

手順

1. Red Hat OpenShift クラスターで、OAuth アプリケーションを作成する GitHub 組織のメインページに移動します。
2. Settings → Developer Settings → GitHub Apps → New GitHub App をクリックします。
3. アプリケーション名として Developer Hub と入力します。

4. Homepage URL として次の URL を追加します。

   https://developer-hub-<NAMESPACE_NAME>.<OPENSHIFT_ROUTE_HOST>/

5. Authorization callback URL として次の URL を追加します。

   https://developer-hub-<NAMESPACE_NAME>.<OPENSHIFT_ROUTE_HOST>/api/auth/github/handler/frame

6. Webhook URL → Active の選択を解除します。
7. Where can this GitHub App be installed? セクションで、Only on this account が選択されていることを確認します。
8. Register application をクリックします。
9. アプリケーションを作成した後、Generate a new client secret をクリックし、生成されたクライアントシークレットをコピーします。
10. ページの下部にある Generate a private key をクリックし、生成されたファイルをダウンロードします。
11. OpenShift で、ConfigMaps をクリックします。

12. 指定された環境変数をキーとして使用して、'github-secrets' という名前のキー/値のシークレットを生成し、GitHub OAuth アプリケーション用に生成した値を入力します。

    1. Red Hat OpenShift で、Secrets タブに移動し、Create をクリックします。
    2. Key/value secret を選択します。
    3. Secret name を github-secrets として入力します。
    4. 環境変数を Key と Value として追加し、Create をクリックします。
    Expand

    表3.2 環境変数

    キー	値
    GITHUB_APP_APP_ID	GitHub アプリケーションからのアプリケーション ID
    GITHUB_APP_CLIENT_ID	GitHub アプリケーションからのクライアント ID
    GITHUB_APP_CLIENT_SECRET	GitHub アプリケーションからのクライアントシークレット
    GITHUB_APP_WEBHOOK_URL	"none" と入力します
    GITHUB_APP_WEBHOOK_SECRET	"none" と入力します
    GITHUB_APP_PRIVATE_KEY	ダウンロードした秘密鍵をアップロードします

    Show more

13. 次のように app-config-rhdh ConfigMap を変更して、GitHub 統合を追加します。

    kind: ConfigMap
    apiVersion: v1
    metadata:
      name: app-config-rhdh
    data:
      app-config-rhdh.yaml: |
        app:
          title: Red Hat Developer Hub
        integrations:
          github:
            - host: github.com
              apps:
                - appId: ${GITHUB_APP_APP_ID}
                  clientId: ${GITHUB_APP_CLIENT_ID}
                  clientSecret: ${GITHUB_APP_CLIENT_SECRET}
                  webhookUrl: ${GITHUB_APP_WEBHOOK_URL}
                  webhookSecret: ${GITHUB_APP_WEBHOOK_SECRET}
                  privateKey: |
                    ${GITHUB_APP_PRIVATE_KEY}

14. Toplogy → developer hub → Actions (ドロップダウン) → Restart rollout をクリックします。

手順

1. OpenShift Container Platform Web コンソールの Developer パースペクティブで、Helm タブに移動します。
2. Helm リリースのオーバーフローメニューをクリックし、Upgrade を選択します。

3. Helm 設定を編集するには、次のいずれかのビューを使用します。

   • Form view を使用する場合

     1. Root Schema → global → Dynamic plugins configuration → List of dynamic plugins that should be installed in the backstage application を展開します。
     2. Add List of dynamic plugins that should be installed in the backstage application をクリックします。

     3. Package specification of the dynamic plugin to install.It should be usable by the npm pack command. で、次の値を追加します。

        ./dynamic-plugins/dist/backstage-plugin-catalog-backend-module-github-dynamic

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

   • YAML view を使用する場合

     1. 以下の例のように、global.dynamic.plugins.package パラメーターの値を ./dynamic-plugins/dist/backstage-plugin-catalog-backend-module-github-dynamic に設定します。

        global:
          dynamic:
            # other Red Hat Developer Hub Helm Chart configurations
            plugins:
              - disabled: false
                package: >-
                  ./dynamic-plugins/dist/backstage-plugin-catalog-backend-module-github-dynamic
            # other Red Hat Developer Hub Helm Chart configurations

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

4. ConfigMap に次のコードを追加します。

   kind: ConfigMap
   apiVersion: v1
   metadata:
     name: app-config-rhdh
   data:
     app-config-rhdh.yaml: |
       ...
         catalog:
           providers:
             github:
               providerId:
                 organization: '${GITHUB_ORG}'
                 schedule:
                   frequency:
                     minutes: 30
                   initialDelay:
                     seconds: 15
                   timeout:
                     minutes: 3
       ...

   上記のコードの ${GITHUB_ORG} は、コンポーネントの検出対象とする GitHub 組織に置き換えます。また、プロバイダーが 1 つだけの場合は、次のコードを ConfigMap に追加してください。

   kind: ConfigMap
   apiVersion: v1
   metadata:
     name: app-config-rhdh
   data:
     app-config-rhdh.yaml: |
       ...
       catalog:
         providers:
           github:
             organization: ${GITHUB_ORG}
             schedule:
               frequency: { minutes: 1 }
               timeout: { minutes: 1 }
               initialDelay: { seconds: 100 }
       ...

   プロバイダーがリストとなっている場合は、プロバイダーを特定するには、以前のコードの providerId が必要です。

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

手順

1. OpenShift Container Platform Web コンソールの Developer パースペクティブで、Helm タブに移動します。
2. Helm リリースのオーバーフローメニューをクリックし、Upgrade を選択します。

3. Helm 設定を編集するには、次のいずれかのビューを使用します。

   • Form view を使用する場合

     1. Root Schema → global → Dynamic plugins configuration → List of dynamic plugins that should be installed in the backstage application を展開します。
     2. Add List of dynamic plugins that should be installed in the backstage application をクリックします。

     3. Package specification of the dynamic plugin to install.It should be usable by the npm pack command. で、次の値を追加します。

        ./dynamic-plugins/dist/backstage-plugin-catalog-backend-module-github-org-dynamic

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

   • YAML view を使用する場合

     1. 以下の例のように、global.dynamic.plugins.package パラメーターの値を ./dynamic-plugins/dist/backstage-plugin-catalog-backend-module-github-org-dynamic に設定します。

        global:
          dynamic:
            # other Red Hat Developer Hub Helm Chart configurations
            plugins:
              - disabled: false
                package: >-
                  ./dynamic-plugins/dist/backstage-plugin-catalog-backend-module-github-org-dynamic
            # other Red Hat Developer Hub Helm Chart configurations

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

4. ConfigMap に次のコードを追加します。

   kind: ConfigMap
   apiVersion: v1
   metadata:
     name: app-config-rhdh
   data:
     app-config-rhdh.yaml: |
       ...
       catalog:
         providers:
           githubOrg:
             id: production
             githubUrl: "${GITHUB_URL}"
             orgs: [ "${GITHUB_ORG}" ]
       ...

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

   ${GITHUB_URL}

   GitHub URL に置き換える必要がある変数を示します。

   ${GITHUB_ORG}

   ユーザーの取り込み元となる GitHub 組織に置き換える必要がある変数を示します。

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