Argo CD Plugin

The Argo CD plugin allows users to view the sync status, health status, and deployment history of Argo CD applications within Backstage entities.

The Argo CD plugin supports multiple Argo CD instances, allowing teams to manage different environments or clusters from a single interface.

note

The current version of the plugin supports only one instance, but future work will enable the ability to view multiple instances.

Generating Credentials

To configure the Argo CD plugin in Venue.sh, you must create a user token in Argo CD.

Log into Argo CD.
Navigate to Settings > Accounts.

A full list of Argo CD user accounts appears.
Select the user account you want to connect to Venue.sh.
In the Tokens section, create a Token ID.

Token IDs appear in Venue.sh and help differentiate among multiple Argo CD tokens in a single venue.

tip

You can also define an expiration date for the token, though it's optional.

Click Generate New and confirm the new-token creation when prompted.

The new token appears in the Tokens section.
Copy the new token and proceed to configure the Argo CD plugin in Venue.sh.

In the Venue.sh app, click Plugins in the left-side navigation.
Find Argo CD, then click Enable Plugin.
Complete the following fields:
- Auth Token: This token is generated in Argo CD in the settings of the desired Argo CD user account or via the CLI. See the Generating Credentials section directly above for step-by-step instructions on creating new tokens.
- Instance URL: The base URL for your Argo CD instance.
Click Enable.

There are two ways to connect an Argo CD application a dashboard component.

Prerequisite

Enable the Argo CD plugin in Venue.sh.

Edit an existing dashboard component, toggle on additional Argo CD metadata fields, then add your desired Argo CD application name.
If you're importing a new repo as a component, connect an Argo CD appliction by toggling on the Argo CD metadata fields and adding a specific Argo CD application name.