第3章 Red Hat Developer Hub でサポートされる設定
このセクションでは、Red Hat Developer Hub にアクセスするために必要な以下の設定を説明します。
- カスタムアプリケーション設定
- Developer Hub カタログのソース管理設定
3.1. Red Hat OpenShift Container Platform へのカスタムアプリケーション設定ファイルの追加 リンクのコピーリンクがクリップボードにコピーされました!
Red Hat Developer Hub にアクセスするには、Red Hat OpenShift Container Platform にカスタムアプリケーション設定ファイルを追加する必要があります。OpenShift Container Platform では、次のコンテンツをベーステンプレートとして使用して、app-config-rhdh という名前の ConfigMap を作成できます。
kind: ConfigMap
apiVersion: v1
metadata:
name: app-config-rhdh
data:
app-config-rhdh.yaml: |
app:
title: {product}
次のいずれかの方法で、カスタムアプリケーション設定ファイルを OpenShift Container Platform に追加できます。
- Red Hat Developer Hub Operator
- Red Hat Developer Hub Helm チャート。
3.1.1. Helm チャートを使用したカスタムアプリケーション設定ファイルの OpenShift Container Platform への追加 リンクのコピーリンクがクリップボードにコピーされました!
Red Hat Developer Hub Helm チャートを使用して、カスタムアプリケーション設定ファイルを OpenShift Container Platform インスタンスに追加できます。
前提条件
- Red Hat OpenShift Container Platform アカウントを作成している。
手順
- OpenShift Container Platform Web コンソールから、ConfigMaps タブを選択します。
- Create ConfigMap をクリックします。
- Create ConfigMap ページで、Configure via の YAML view オプションを選択し、必要に応じてファイルに変更を加えます。
- Create をクリックします。
- Helm リリースのリストを表示するには、Helm タブに移動します。
- 使用する Helm リリースのオーバーフローメニューをクリックし、Upgrade を選択します。
Helm 設定を編集するには、Form view または YAML view のいずれかを使用します。
Form view を使用する場合
-
Root Schema
Backstage chart schema Backstage parameters Extra app configuration files to inline into command arguments を展開します。 - Add Extra app configuration files to inline into command arguments リンクをクリックします。
以下のフィールドに値を入力します。
-
configMapRef:
app-config-rhdh -
filename:
app-config-rhdh.yaml
-
configMapRef:
- Upgrade をクリックします。
-
Root Schema
YAML view を使用する場合
以下のように
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- Upgrade をクリックします。
3.1.2. Operator を使用したカスタムアプリケーション設定ファイルの OpenShift Container Platform への追加 リンクのコピーリンクがクリップボードにコピーされました!
カスタムアプリケーション設定ファイルは、Red Hat Developer Hub インスタンスの設定を変更するために使用できる ConfigMap オブジェクトです。Developer Hub インスタンスを Red Hat OpenShift Container Platform にデプロイする場合は、ConfigMap オブジェクトを作成して Developer Hub カスタムリソース (CR) で参照することで、Red Hat Developer Hub Operator を使用して OpenShift Container Platform インスタンスにカスタムアプリケーション設定ファイルを追加できます。
カスタムアプリケーション設定ファイルには、BACKEND_SECRET という名前の機密性の高い環境変数が含まれています。この変数には、OpenShift Container Platform シークレットで定義された環境変数を参照するために Developer Hub が使用する必須のバックエンド認証キーが含まれます。'secrets-rhdh' という名前のシークレットを作成し、それを Developer Hub CR で参照する必要があります。
Red Hat Developer Hub インストールは、ユーザー自身で外部および不正アクセスから保護する必要があります。バックエンド認証キーを他のシークレットと同様に管理します。強力なパスワード要件を満たし、パスワードを設定ファイルで公開せず、環境変数としてのみ設定ファイルに挿入します。
前提条件
- アクティブな Red Hat OpenShift Container Platform アカウントがある。
- 管理者により OpenShift Container Platform に Red Hat Developer Hub Operator がインストールされている。詳細は、Red Hat Developer Hub Operator のインストール を参照してください。
- OpenShift Container Platform で Red Hat Developer Hub CR を作成している。
手順
- OpenShift Container Platform Web コンソールの Developer パースペクティブから Topology ビューを選択し、Developer Hub Pod の Open URL アイコンをクリックして、Developer Hub の外部 URL <RHDH_URL> を特定します。
- OpenShift Container Platform Web コンソールの Developer パースペクティブから、ConfigMaps ビューを選択します。
- Create ConfigMap をクリックします。
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 - Create をクリックします。
- Secrets ビューを選択します。
- Create Key/value Secret をクリックします。
-
secrets-rhdhという名前のシークレットを作成します。 BACKEND_SECRETという名前のキーと、base64 でエンコードされた文字列を値として追加します。Red Hat Developer Hub インスタンスごとに一意の値を使用します。たとえば、次のコマンドを使用してターミナルからキーを生成できます。node -p 'require("crypto").randomBytes(24).toString("base64")'- Create をクリックします。
- Topology ビューを選択します。
使用する Red Hat Developer Hub インスタンスのオーバーフローメニューをクリックし、Edit Backstage を選択して、Red Hat Developer Hub インスタンスの YAML ビューを読み込みます。
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- Save をクリックします。
- Topology ビューに戻り、Red Hat Developer Hub Pod が起動するまで待ちます。
- Open URL アイコンをクリックして、Red Hat Developer Hub プラットフォームを使用し、設定変更を行います。
関連情報
- Developer Hub におけるロールと責任の詳細は、Red Hat Developer Hub のロールベースのアクセス制御 (RBAC) を参照してください。