Description
Argo CD is an open-source declarative continuous delivery (CD) tool for Kubernetes. The Argo CD plug-in provides the ability to interact with Argo CD applications within HCL DevOps Deploy.
- Overview
- Documentation
- Version history
Quick Info
Product
DevOps Deploy (HCL Launch)
Type
plugin
Compatibility
HCL Launch 7.1.0 or later
Created by
HCL Software
Website
Published Date
Last Updated
Overview
Process Steps
Usage
Overview
The Argo CD plug-in includes steps which interact with Argo CD applications in HCL DevOps Deploy.
The Argo CD CLI is required to run the steps in this plugin and must be downloaded and installed on a DevOps Deploy agent.
The Argo CD server hosting the Argo CD applications, you want to interact with, must be accessible from the HCL DevOps Deploy agent.
Installation
No special steps are required for installation. See Installing plug-ins in DevOps Deploy.
History
The following table describes the changes made in each plugin version.
| Version | Description |
|---|---|
| Version 1.1164029 | Initial Release. Includes steps to create, get, rollback, set and sync Argo CD applications. |
| Version 2.1166082 | Add applicationset support. |
Process Steps
The following process steps are available in the Argo CD plug-in:
- App Create
- App Get
- App Rollback
- App Set
- App Sync
- Login
- AppSet Create
- AppSet Delete
- AppSet List
- AppSet Get
App Create
Create an Agro CD application.
| Name | Type | Description | Required |
|---|---|---|---|
| Argo CD Application Name | String | The name of the Argo CD application to create. | Yes |
| Additional application create flags | String | A list of flags to set when running the application create step. For example: ‘–config=path’. Specify each flag on a new line. If the flag takes an argument, put the argument on a separate line or use an equal ‘=’ (not whitespace) between the flag and argument. | Yes |
App Get
Get information about an Argo CD application
| Name | Type | Description | Required |
|---|---|---|---|
| Argo CD Application Name | String | The name of the Argo CD application to get information on. | Yes |
| Additional application get flags | String | A list of flags to set when running the application get step. For example: ‘–config=path’. Specify each flag on a new line. If the flag takes an argument, put the argument on a separate line or use an equal ‘=’ (not whitespace) between the flag and argument. | Yes |
App Rollback
Rollback an Argo CD application to a previous deployed version.
| Name | Type | Description | Required |
|---|---|---|---|
| Argo CD Application Name | String | The name of the Argo CD application to rollback. | Yes |
| Argo CD Application History ID | String | The Argo CD application history ID to rollback to. | Yes |
| Additional Application Rollback Flags | String | A list of flags to set when running the application rollback step. For example: ‘–config=path’. Specify each flag on a new line. If the flag takes an argument, put the argument on a separate line or use an equal ‘=’ (not whitespace) between the flag and argument. | Yes |
App Set
Argo CD application parameters.
| Name | Type | Description | Required |
|---|---|---|---|
| Argo CD Application Name | String | The name of the Argo CD application to modify. | Yes |
| Additional application set flags | String | A list of flags to set when running the application set step. For example: ‘–config=path’. Specify each flag on a new line. If the flag takes an argument, put the argument on a separate line or use an equal ‘=’ (not whitespace) between the flag and argument. | Yes |
Login
Login to an Argo CD instance.
| Name | Type | Description | Required |
|---|---|---|---|
| Argo CD Server | String | The name or IP address of the Argo CD server to login to. | Yes |
| User Name | String | The username of an account to authenticate. | Yes |
| Password | String | The password of an account to authenticate. | Yes |
| Additional login flags | String | A list of flags to set when running the login step. For example: ‘–config=path’. Specify each flag on a new line. If the flag takes an argument, put the argument on a separate line or use an equal ‘=’ (not whitespace) between the flag and argument. | Yes |
AppSet Create
Create one or more Argo CD ApplicationSets.
| Name | Type | Description | Required |
|---|---|---|---|
| Argo CD ApplicationSet Configuration Filename or URL | String | Configuration filename or URL used to create the ApplicationSet. | Yes |
| Additional appset create flags | String | A list of flags to set when running the appset create step. For example: ‘–config=path’. Specify each flag on a new line. If the flag takes an argument, put the argument on a separate line or use an equal ‘=’ (not whitespace) between the flag and argument. | Yes |
AppSet Delete
Delete one or more Argo CD ApplicationSets.
| Name | Type | Description | Required |
|---|---|---|---|
| Name(s) of Argo CD ApplicationSet(s) | String | A list of ApplicationSet name(s) to delete. Specify each name on a new line. | Yes |
| Additional appset delete flags | String | A list of flags to set when running the appset delete step. For example: ‘–config=path’. Specify each flag on a new line. If the flag takes an argument, put the argument on a separate line or use an equal ‘=’ (not whitespace) between the flag and argument. | Yes |
AppSet List
List one or more Argo CD ApplicationSets.
| Name | Type | Description | Required |
|---|---|---|---|
| Additional appset list flags | String | A list of flags to set when running the appset list step. For example: ‘–config=path’. Specify each flag on a new line. If the flag takes an argument, put the argument on a separate line or use an equal ‘=’ (not whitespace) between the flag and argument. | Yes |
AppSet Get
Get Argo CD ApplicationSet.
| Name | Type | Description | Required |
|---|---|---|---|
| Argo CD Application Name | String | The name of the Argo CD application to get. | Yes |
| Additional application sync flags | String | A list of flags to set when running the appset get step. For example: ‘–config=path’. Specify each flag on a new line. If the flag takes an argument, put the argument on a separate line or use an equal ‘=’ (not whitespace) between the flag and argument. | Yes |
Usage
Use this plug-in to work with Argo CD applications.
Before you begin
The Argo CD CLI must be installed on the DevOps Deploy agent that will execute the Argo CD plugin steps. See the installation instructions for guidance.
If you want to install the Argo CD CLI on a containerized DevOps Deploy agent running in a Kubernetes/OpenShift cluster, install it in the persisted configuration directory /opt/hcl-deploy/agent/conf. If you install it in any other location, the installed code will be erased upon restarting the pod.
Step Palette
To access this plug-in in the palette, click Cloud > ArgoCD.
Learning activities
launch-argocd-4.1167795.zip
Uploaded: 06-May-2024 14:37
Release Notes
- Update inventory management to handle digest values in imagespecs.
launch-argocd-3.1166635.zip
Uploaded: 08-Mar-2024 18:08
Release Notes
- Add inventory/snapshot support.
launch-argocd-2.1166082.zip
Uploaded: 15-Feb-2024 13:49
Release Notes
Add applicationset support.