backstage-edp/plugins/argo-workflows

argo-workflows

Welcome to the argo-workflows plugin!

This plugin displays your Argo Workflows in Backstage

Getting started

Configuration

Entities must be annotated with Kubernetes annotations. For example:

apiVersion: backstage.io/v1alpha1
kind: Component
metadata:
  name: backstage
  annotations:
    backstage.io/kubernetes-id: backstage
    backstage.io/kubernetes-namespace: default
    backstage.io/kubernetes-label-selector: env=dev,my=label

Authentication

This plugin supports two methods of authentication.

Through Argo API with Service Account Token

This method uses a service account token to retrieve information from Argo API through the configured proxy endpoint.

1. Create a service account and associated permissions. For this plugin to work, you need list, get, and watch verbs. for example create a file called sa.yaml with the following contents:

   apiVersion: v1
   kind: ServiceAccount
   metadata:
   name: backstage-argo-workflows-plugin
   namespace: argo
   
   ---
   # This is a long-lived token intended to be used by the backstage proxy.
   apiVersion: v1
   kind: Secret
   metadata:
   name: backstage-argo-workflows-plugin-token
   annotations:
   kubernetes.io/service-account.name: backstage-argo-workflows-plugin
   namespace: argo
   type: kubernetes.io/service-account-token
   ---
   apiVersion: rbac.authorization.k8s.io/v1
   kind: ClusterRole
   metadata:
   name: backstage-argo-workflows-plugin
   rules:
   - apiGroups: ["argoproj.io"]
     resources: ["workflows"]
     verbs: [ "get", "watch", "list"]
   ---
   apiVersion: rbac.authorization.k8s.io/v1
   kind: ClusterRoleBinding
   metadata:
   name: backstage-argo-workflows-plugin
   roleRef:
   apiGroup: rbac.authorization.k8s.io
   kind: ClusterRole
   name: backstage-argo-workflows-plugin
   subjects:
   - kind: ServiceAccount
     name: backstage-argo-workflows-plugin
     namespace: argo
   

2. Apply them to your cluster

   kubectl apply -f sa.yaml
   

3. Configure Backstage Proxy. In this example we are instructing Backstage to get the token value from environment variable called ARGO_WORKFLOWS_AUTH_TOKEN

   proxy:
     '/argo-workflows/api':
       target: https://argo.a1.mccloman.people.aws.dev
       changeOrigin: true
       secure: true
       headers:
         Authorization:
           $env: ARGO_WORKFLOWS_AUTH_TOKEN
   

4. Grab the token value and make it available as an environment variable for your backstage backend.

   ARGO_TOKEN="Bearer $(kubectl get secret -n argo backstage-argo-workflows-plugin-token -o=jsonpath='{.data.token}' | base64 --decode)"
   

   If this is running in Kubernetes see this documentation.

See this documentation for more information on getting your token.

Using configured Kubernetes API

The plugin can use configured Kubernetes clusters to fetch resources instead of going through the Argo Workflows API The entity must be annotated correctly for it to work.

For example, for a Kubernetes cluster given in your ap-config.yaml

kubernetes:
  serviceLocatorMethod:
    type: 'multiTenant'
  clusterLocatorMethods:
  - type: 'config'
    clusters:
      - url: https://abcd.gr7.us-west-2.eks.amazonaws.com:443
        name: my-cluster-1
        authProvider: 'serviceAccount'
        serviceAccountToken: eyJh
        caData: LS0t

For this configuration, the argo-workflows/cluster-name annotaton value must be my-cluster-1

apiVersion: backstage.io/v1alpha1
kind: Component
metadata:
  name: backstage
  annotations:
    backstage.io/kubernetes-id: backstage
    backstage.io/kubernetes-namespace: default
    backstage.io/kubernetes-label-selector: env=dev,my=label
    argo-workflows/cluster-name: my-cluster-1