第2章 Argo CD プラグインの有効化

手順

1. Backstage インスタンスの app-config.yaml ファイルで、kubernetes 設定に次の customResources コンポーネントを追加して、Argo Rollouts と AnalysisRuns を有効にします。

   kubernetes:
     ...
     customResources:
       - group: 'argoproj.io'
         apiVersion: 'v1alpha1'
         plural: 'Rollouts'
       - group: 'argoproj.io'
         apiVersion: 'v1alpha1'
         plural: 'analysisruns'

2. カスタムリソースに対する ClusterRole 権限を付与します。

   注記
   • Backstage Kubernetes プラグインがすでに設定されている場合は、Rollouts および AnalysisRuns の ClusterRole 権限がすでに付与されている可能性があります。
   • 準備したマニフェスト を使用して、Kubernetes プラグインと ArgoCD プラグインの両方に読み取り専用の ClusterRole アクセスを割り当てます。
   1. ClusterRole 権限が付与されていない場合は、次の YAML マニフェストを使用して ClusterRole を作成します。

   apiVersion: rbac.authorization.k8s.io/v1
   kind: ClusterRole
   metadata:
     name: backstage-read-only
   rules:
     - apiGroups:
         - argoproj.io
       resources:
         - rollouts
         - analysisruns
       verbs:
         - get
         - list

   1. kubectl を使用してマニフェストをクラスターに適用します。

      kubectl apply -f <your-clusterrole-file>.yaml

   2. クラスターにアクセスする ServiceAccount にこの ClusterRole が割り当てられていることを確認します。

3. Backstage の Kubernetes リソースを識別するために、catalog-info.yaml にアノテーションを追加します。

   1. エンティティー ID でリソースを識別する場合:

      annotations:
        ...
        backstage.io/kubernetes-id: <BACKSTAGE_ENTITY_NAME>

   2. (オプション) 名前空間でリソースを識別する場合:

      annotations:
        ...
        backstage.io/kubernetes-namespace: <RESOURCE_NAMESPACE>

   3. エンティティー ID または名前空間によるリソース識別をオーバーライドするカスタムラベルセレクターを使用する場合:

      annotations:
        ...
        backstage.io/kubernetes-label-selector: 'app=my-app,component=front-end'

      注記

      Kubernetes リソースの backstage.io/kubernetes-label-selector で宣言されたラベルを必ず指定してください。このアノテーションは、backstage.io/kubernetes-id や backstage.io/kubernetes-namespace などのエンティティーベースまたは名前空間ベースの識別アノテーションをオーバーライドします。

4. Backstage が適切な Kubernetes リソースを見つけられるように、Kubernetes リソースにラベルを追加します。

   1. Backstage Kubernetes プラグインラベル: このラベルを追加して、リソースを特定の Backstage エンティティーにマップします。

      labels:
        ...
        backstage.io/kubernetes-id: <BACKSTAGE_ENTITY_NAME>

   2. GitOps アプリケーションマッピング: このラベルを追加して、Argo CD ロールアウトを特定の GitOps アプリケーションにマッピングします。

      labels:
        ...
        app.kubernetes.io/instance: <GITOPS_APPLICATION_NAME>

   注記

   ラベルセレクターアノテーション (backstage.io/kubernetes-label-selector) を使用する場合は、指定されたラベルがリソースに存在することを確認します。ラベルセレクターは、kubernetes-id や kubernetes-namespace などの他のアノテーションをオーバーライドします。

検証

1. 更新された設定を GitOps リポジトリーにプッシュして、ロールアウトをトリガーします。
2. Red Hat Developer Hub インターフェイスを開き、設定したエンティティーに移動します。
3. CD タブを選択し、対象の GitOps アプリケーション を選択します。サイドパネルが開きます。

4. サイドパネルの Resources テーブルで、次のリソースが表示されていることを確認します。

   • Rollouts
   • AnalysisRuns (オプション)

5. ロールアウトリソースを展開し、次の詳細を確認します。

   • Revisions の行には、さまざまなロールアウトバージョンのトラフィックの分布が詳細に表示されます。
   • Analysis Runs の行には、ロールアウトの成功を評価する分析タスクのステータスが表示されます。