第5章 プラグインのトラブルシューティング

手順

1. RHDH Pod ログを調べて、プラグインに特定の環境変数または追加の設定が必要かどうかを確認します。以下はその例です。

   Plugin '<PLUGIN_NAME>' threw an error during startup, waiting for X other plugins to finish before shutting down the process. Plugin '<PLUGIN_NAME>' startup failed; caused by Error: Missing required config value at '<concretePluginRequiredVariable.name>' in 'app-config.local.yaml' type="initialization"

2. 各プラグインに必要な環境変数がリストされた dynamic-plugins.default.yaml ファイルを調べて、必要な設定を確認します。各プラグインの変数の形式は ${PLUGIN_VARIABLE_NAME} です。

3. 必要な環境変数のいずれかが欠けている場合は、secret を使用して環境変数を設定します。以下に例を示します。

   kind: Secret
   apiVersion: v1
   metadata:
     name: rhdh-secrets
     labels:
       backstage.io/kubernetes-id: developer-hub
   data:
     PLUGIN_VARIABLE_NAME: 'dummy-value'
   type: Opaque

4. シークレットをマウントします。

   1. RHDH が Operator を使用してデプロイされている場合は、次のように Backstage CR を更新します。

      spec:
        application:
          extraEnvs:
            secrets:
              - name: rhdh-secrets

   2. RHDH が Helm チャートを使用してデプロイされている場合は、Helm チャート値の upstream.backstage キーに、extraEnvVarsSecrets フィールドの値として、Developer Hub rhdh-secrets シークレットの名前を入力します。以下に例を示します。

      upstream:
        backstage:
          extraEnvVarsSecrets:
            - rhdh-secrets