ArgoCD plugin for Backstage

Option 1: Adding proxy configuration for each ArgoCD instance

1. To create multiple components that fetch data from different ArgoCD instances, add a proxy configuration for each instance as shown in the following example:

   proxy:
     ...
   
     '/argocd/api':
       target: https://<someAddress>/api/v1/
       changeOrigin: true
       secure: false
       headers:
         Cookie:
           $env: ARGOCD_AUTH_TOKEN
   
     '/argocd/api2':
       target: https://<otherAddress>/api/v1/
       changeOrigin: true
       secure: false
       headers:
         Cookie:
           $env: ARGOCD_AUTH_TOKEN2

   Copy to Clipboard Toggle word wrap

2. Add the required authentication tokens to environment variables, such as ARGOCD_AUTH_TOKEN2.

   After adding the authentication tokens, add the URL to the desired proxy path in the following component definition annotations:

   argocd/proxy-url: '/argocd/api2'

   The argocd/proxy-url annotation defaults to '/argocd/api'. Therefore, argocd/proxy-url is not required if there is a single proxy configuration.

Option 2: Using the ArgoCD backend plugin

1. To create multiple components that fetch data from different ArgoCD instances, set the ArgoCD instance URL dynamically by adding the following configuration to app-config.yaml file:

   argocd:
     username: ${ARGOCD_USERNAME}
     password: ${ARGOCD_PASSWORD}
     waitCycles: 25
     appLocatorMethods:
       - type: 'config'
         instances:
           - name: argoInstance1
             url: https://argoInstance1.com
             token: ${ARGOCD_AUTH_TOKEN} # optional
           - name: argoInstance2
             url: https://argoInstance2.com
             # dedicated username/password for this instance
             username: ${ARGOCD_USERNAME_INSTANCE_2} # optional
             password: ${ARGOCD_PASSWORD_INSTANCE_2} # optional

   Copy to Clipboard Toggle word wrap

   A loop is created between deleting ArgoCD project and application to check the deletion of application occurring before the deletion of the project. If waitCycles is set to 25, then the loop can last for 75 seconds before erroring out.

   With the previous configuration, the ArgoCD plugin fetches the ArgoCD instances an application is deployed to and use the ArgoCD backend plugin (backstage-plugin-argo-cd-backend) to reach out to each ArgoCD instance based on the following mapping:

   • Add the required authentication tokens to environment variables, such as ARGOCD_USERNAME and ARGOCD_PASSWORD inside the argocd object. These authentication tokens are used as credentials for all ArgoCD instances by default.

     argocd:
       username: ${ARGOCD_USERNAME}
       password: ${ARGOCD_PASSWORD}
       appLocatorMethods:
         - type: 'config'
           instances:
             - name: argoInstance1
               url: https://argoInstance1.com
             - name: argoInstance2
               url: https://argoInstance2.com

     Copy to Clipboard Toggle word wrap

   • Define a username and password for each ArgoCD instance. This mapping has higher priority than the previous option.

     argocd:
       username: ${ARGOCD_USERNAME}
       password: ${ARGOCD_PASSWORD}
       appLocatorMethods:
         - type: 'config'
           instances:
             - name: argoInstance1
               url: https://argoInstance1.com
             - name: argoInstance2
               url: https://argoInstance2.com
               # dedicated username/password for this instance
               username: ${ARGOCD_USERNAME_INSTANCE_2}
               password: ${ARGOCD_PASSWORD_INSTANCE_2}

     Copy to Clipboard Toggle word wrap

   • Define a token for each instance. This mapping has higher priority than both options mentioned previously.

     argocd:
       username: ${ARGOCD_USERNAME}
       password: ${ARGOCD_PASSWORD}
       appLocatorMethods:
         - type: 'config'
           instances:
             - name: argoInstance1
               url: https://argoInstance1.com
               token: ${ARGOCD_AUTH_TOKEN} # Token to use to instance 1

     Copy to Clipboard Toggle word wrap