Argo CD Plugin

This topic describes the tasks available with the Argo CD plugin.

About Argo CD

Argo CD is a GitOps continuous delivery tool for Kubernetes, which continuously monitors all the running applications and compares the live state with the desired state specified in the Git repo. Argo CD automates the deployment of the desired application states in the specified target environments. Application deployments can track updates to branches, tags, or pinned to a specific version of manifests at a Git commit.

A deployed application whose live state deviates from the target state is considered OutOfSync.

Prerequisites

1. Digital.ai Release 22.0.x or later
2. A running Argo CD server

Setup Connection to Argo CD Server

1. Log on to Digital.ai Release as an Administrator.

2. Navigate to CONFIGURATION > Connections.

3. Click the + icon next to ArgoCD: Server.

4. Fill in the required information:

   Field	Description
   Title	A name for the Argo CD server connection.
   URL	The base URL where the Argo CD server can be reached.
   Username	Login username for the Argo CD server.
   Password	Login password for the Argo CD server.
   Auth Token	Authentication token for connecting to the Argo CD server. Use this instead of username/password when token-based authentication is enabled.
   Proxy	Fill in the proxy details if needed.
   Capabilities	Defines routing rules for Release Runners. Add one or more capability labels to direct tasks to appropriate runners.

   

5. Click Test to verify your connection to the Argo CD server.

6. Click Save if the connection is successful.

Available Tasks

The following tasks are available with the Argo CD plugin:

• Add Repository
• Create Project
• Create Application
• Sync Application
• Get Sync Status
• Get Manifest
• Wait For Status
• Get Revision Metadata
• List Projects
• List Repositories
• Rollback Application
• Delete Application

Each task in the Argo CD plugin includes a set of input properties and output properties. Input properties pass in parameters required for execution, while output properties capture the results returned by Argo CD.

tip

The task output properties can be mapped to Release variables for later use.
For more information, see Mapping Task Output Properties to Variables.

Add Repository

Adds a new Git repository configuration in the Argo CD instance.

Input Properties

Field	Description
ArgoCD server	The ArgoCD server connection to use for this operation.
Repo type	Specifies the repository type (git or helm).
Repo URL	URL to the Git or Helm chart repository.
Repository name	Optional unique identifier for this repository in Argo CD.
Project	Argo CD project associated with the repository.
Repo username	Username for repository authentication.
Repo password	Password or token for repository authentication.
Enable LFS	Enables Git Large File Storage support.
Enable OCI	Enables OCI support for Helm OCI repositories.
Insecure	Allows insecure connections.
Insecure Ignore host key	Disables SSH host key verification for SSH connections.
Proxy	HTTP/HTTPS proxy URL used for repository access.
SSH key	SSH private key used for SSH-based repository authentication.
TLS client certificate	TLS client certificate (PEM format).
TLS client key	TLS private key paired with the client certificate.

Output Properties

Field	Description
Repository URL	The repository URL configured in Argo CD.
Response	Key-value response returned by Argo CD.

Create Project

Creates a new project in the Argo CD instance.

Input Properties

Field	Description
ArgoCD server	The ArgoCD server connection to use for this operation.
Project name	Name of the Argo CD project. Must be lowercase.
Source repositories	List of repository URLs allowed for this project.
Destinations	Allowed deployment destinations (cluster URL and namespace).

Output Properties

Field	Description
Project name	Returns the created project name.

Create Application

Creates a new Argo CD application from definitions in a Git repository.

Input Properties

Field	Description
ArgoCD server	The ArgoCD server connection to use for this operation.
App name	Name of the Argo CD application.
Project name	Argo CD project under which the application is created.
Cluster URL	Destination cluster URL for deployment.
Namespace	Target namespace where the application is deployed.
Repo URL	Source repository URL containing manifests/chart.
Path	Repository path of the application manifests/chart.
Helm chart name	Helm chart name (when Helm source is used).
Target revision	Branch, tag, commit, or chart version to deploy.
Sources YAML	YAML array of sources for multi-source applications. Overrides single source configuration when provided.
Value files	List of Helm value files for rendering.
Values	Inline Helm values in YAML/JSON format.
Helm parameters	Key-value overrides for Helm chart parameters.
Upsert	Updates application if it already exists.
Validate	Validates manifests before creation.
Auto sync	Enables automatic sync for the application.
Prune resources	Deletes resources no longer defined in Git.

Output Properties

Field	Description
App name	Returns the created application name.
Response	Key-value response returned by Argo CD.

Sync Application

Synchronizes an Argo CD application to the target Kubernetes cluster.

Input Properties

Field	Description
ArgoCD server	The ArgoCD server connection to use for this operation.
Application name	Name of the Argo CD application.
Prune resources	Deletes resources no longer defined in Git.
Refresh	Refresh mode for the application (normal or hard).
Wait for sync	Waits until sync operation completes.
Retry wait time	Wait time in seconds between retry attempts.
Max retries	Maximum number of retry attempts.

Output Properties

Field	Description
Status	Result of the sync operation.
Revision	Application revision that was synced.

Get Sync Status

Retrieves the sync status of an existing Argo CD application.

Input Properties

Field	Description
ArgoCD server	The ArgoCD server connection to use for this operation.
App name	Name of the Argo CD application.

Output Properties

Field	Description
Sync status	Current sync status of the application.
Revision	Current revision applied by the application.

Get Manifest

Retrieves live and desired manifest data for an application resource.

Input Properties

Field	Description
ArgoCD server	The ArgoCD server connection to use for this operation.
App name	Name of the Argo CD application.
Resource name	Name of the resource whose manifest is requested.

Output Properties

Field	Description
Live manifest	Current manifest from the cluster.
Desired manifest	Desired manifest from Git.

Wait For Status

Waits for an Argo CD application to reach the expected sync and health status.

Input Properties

Field	Description
ArgoCD server	The ArgoCD server connection to use for this operation.
App name	Name of the Argo CD application.
Expected sync status	Sync status the task waits for.
Expected health status	Health status the task waits for.
Retry wait time	Wait time in seconds between retries.
Max retries	Maximum number of retry attempts.

Output Properties

Field	Description
Sync status	Final sync status of the application.
Health status	Final health status of the application.
Revision	Current revision when task completes.

Get Revision Metadata

Retrieves application revision metadata based on revision ID.

Input Properties

Field	Description
ArgoCD server	The ArgoCD server connection to use for this operation.
App name	Name of the Argo CD application.
Revision	Application revision whose metadata is requested.

Output Properties

Field	Description
Metadata	Metadata details for the specified revision.

Note: The Revision field is available as output in SyncApplication and SyncStatus tasks and can be reused in your flow.

List Projects

Retrieves and displays all projects configured in the Argo CD instance.

Input Properties

Field	Description
ArgoCD server	The ArgoCD server connection to use for this operation.

Output Properties

Field	Description
Project list	List of Argo CD projects.

List Repositories

Retrieves and displays all Git repositories configured in the Argo CD instance.

Input Properties

Field	Description
ArgoCD server	The ArgoCD server connection to use for this operation.

Output Properties

Field	Description
Repositories	List of configured repositories.

Rollback Application

Rolls back an Argo CD application to a previous revision.

Input Properties

Field	Description
ArgoCD server	The ArgoCD server connection to use for this operation.
Project name	Name of the Argo CD project.
Application name	Name of the Argo CD application.
Application namespace	Namespace where the application is deployed.
History ID and revision	Revision to roll back to in HistoryID-Revision format.
Prune resources	Deletes resources no longer defined in Git.
Dry run	Simulates rollback without applying changes.
Wait for completion	Waits until rollback completes.
Retry wait time	Wait time in seconds between retries.
Max retries	Maximum number of retry attempts.

Output Properties

Field	Description
Application sync status	Sync status after rollback.
Current revision	Revision after rollback completion.

Delete Application

Deletes an existing Argo CD application and its managed resources.

Input Properties

Field	Description
ArgoCD server	The ArgoCD server connection to use for this operation.
Project name	Name of the Argo CD project.
Application name	Name of the Argo CD application.
Propagation policy	Deletion propagation policy (foreground, background, non-cascading).
Application namespace	Namespace where the application is deployed.
Wait for completion	Waits until delete operation completes.
Retry wait time	Wait time in seconds between retries.
Max retries	Maximum number of retry attempts.

Output Properties

Field	Description
Response	Key-value response returned by Argo CD.