2.2. Enabling Argo CD Rollouts

Procedure

1. In the app-config.yaml file in your Backstage instance, add the following customResources component under the kubernetes configuration to enable Argo Rollouts and AnalysisRuns:

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

2. Grant ClusterRole permissions for custom resources.

   注意
   • If the Backstage Kubernetes plugin is already configured, the ClusterRole permissions for Rollouts and AnalysisRuns might already be granted.
   • Use the prepared manifest to provide read-only ClusterRole access to both the Kubernetes and ArgoCD plugins.
   1. If the ClusterRole permission is not granted, use the following YAML manifest to create the 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. Apply the manifest to the cluster using kubectl:

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

   2. Ensure the ServiceAccount accessing the cluster has this ClusterRole assigned.

3. Add annotations to catalog-info.yaml to identify Kubernetes resources for Backstage.

   1. For identifying resources by entity ID:

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

   2. (Optional) For identifying resources by namespace:

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

   3. For using custom label selectors, which override resource identification by entity ID or namespace:

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

      注意

      Ensure you specify the labels declared in backstage.io/kubernetes-label-selector on your Kubernetes resources. This annotation overrides entity-based or namespace-based identification annotations, such as backstage.io/kubernetes-id and backstage.io/kubernetes-namespace.

4. Add label to Kubernetes resources to enable Backstage to find the appropriate Kubernetes resources.

   1. Backstage Kubernetes plugin label: Add this label to map resources to specific Backstage entities.

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

   2. GitOps application mapping: Add this label to map Argo CD Rollouts to a specific GitOps application

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

   注意

   If using the label selector annotation (backstage.io/kubernetes-label-selector), ensure the specified labels are present on the resources. The label selector will override other annotations like kubernetes-id or kubernetes-namespace.

Verification

1. Push the updated configuration to your GitOps repository to trigger a rollout.
2. Open Red Hat Developer Hub interface and navigate to the entity you configured.
3. Select the CD tab and then select the GitOps application. The side panel opens.

4. In the Resources table of the side panel, verify that the following resources are displayed:

   • Rollouts
   • AnalysisRuns (optional)

5. Expand a rollout resource and review the following details:

   • The Revisions row displays traffic distribution details for different rollout versions.
   • The Analysis Runs row displays the status of analysis tasks that evaluate rollout success.