ArgoCD
ArgoCD is a software used for GitOps deployment in a Kubernetes environment. Users can set up ArgoCD deployment when creating a project or through the Kubernetes deployment menu.
Getting Started with ArgoCD
To view the details of an ArgoCD application, follow these steps:
- Click the Project card on the Main page. You will be taken to the Project Dashboard page.
- Click the Build/Deploy > Kubernetes Deploy menu on the left. You will be taken to the Kubernetes Deploy page.
- Click the ArgoCD Application Card you want to start. You will be taken to the Deploy Details page.
Category | Item | Description |
|---|---|---|
| ArgoCD Application | Name | Displays the ArgoCD project name/ArgoCD URL. |
| Git Information | Displays the Git information used for deployment. | |
| Cluster/Namespace | Displays the deployed cluster/namespace. | |
| App Status | Displays the current status of the app. | |
| Deployment Result | Displays the current sync status. | |
| Deployment Time | Displays the deployment execution time. | |
| Refresh | Clicking the Refresh icon refreshes the current item. The items that change are App Status and Deployment Result. | |
| Delete | Deletes the current item. | |
| Deployment Details | Edit ArgoCD App Secret | Clicking the Edit Authentication Information icon on the right side of the application name opens a popup window to manage the image secret used for deployment. |
| Go to ArgoCD App | The Application Details screen of the actual ArgoCD tool opens in a new window. |
Adding an ArgoCD Application
Creating a New ArgoCD Application using Helm Chart
To create a new ArgoCD application using a Helm chart and add it, follow these steps:
- Click the Project card on the Main page. You will be taken to the Project Dashboard page.
- Click the Build/Deploy > Kubernetes Deploy menu on the left. You will be taken to the Kubernetes Deploy page.
- Click the Create New ArgoCD App button at the top right. You will be taken to the Create New ArgoCD App page.
- Enter the ArgoCD Information and click the Confirm button. The Authentication Information input field will appear.
- Enter the Authentication Information and click the Connection Test button.
- The Application Basic Information and Deployment Target K8S Cluster input fields will appear.
- Enter the Application Name and click the Duplicate Check button.
- Enter the Project Name.
- Select Helm Chart to Create a New Repository as the Repository Type.
- Select the K8S Cluster and Namespace.
- Select the Helm Chart. The Helm Chart information and Helm Chart Git Repository information will appear.
- Modify the contents of the Values.yaml file located in the K8S Cluster Values of the Helm Chart and click the Validation Check button.
- Enter the Helm Chart Git Repository information and click the Connection Test button.
- Enter the Manifest Keys information.
- Click the Create button to complete the creation.
| Item | Description |
|---|---|
| URL Input Method | Select the URL input method.
|
| ArgoCD URL | Enter the ArgoCD URL and click the Confirm button. |
| Authentication Information | Enter the authentication information and click the Connection Test button. |
| Application Name | Enter the ArgoCD application name and click the Duplicate Check button. |
| Project Name | Enter the project name of the ArgoCD application. |
| Repository Type | Select the repository type.
|
| K8S Cluster | Select the target cluster for deployment.
|
| Namespace | Select the target namespace for deployment.
|
| Helm Chart | Select the Helm chart. |
| Helm Chart Git Repository | Enter the information of the Git repository used for Helm Chart. |
| Manifest Key Information | Enter the information for continuous deployment (Manifest file/Key information). |
Creating a New ArgoCD Application using an Existing Git Repository
To create a new ArgoCD application using an existing Git repository and add it, follow these steps:
- Click the Project card on the Main page. You will be taken to the Project Dashboard page.
- Click the Build/Deploy > Kubernetes Deploy menu on the left. You will be taken to the Kubernetes Deploy page.
- Click the Create New ArgoCD App button at the top right. You will be taken to the Create New ArgoCD App page.
- Enter the ArgoCD Information and click the Confirm button. The Authentication Information input field will appear.
- Enter the Authentication Information and click the Connection Test button.
- The Application Basic Information and Deployment Target K8S Cluster input fields will appear.
- Enter the Application Name and click the Duplicate Check button.
- Enter the Project Name.
- Select Use an Existing Git Repository as the Repository Type.
- Select the K8S Cluster and Namespace.
- Select the Helm Chart. The Helm Chart and Helm Chart Git Repository information will appear.
- Modify the contents of the Values.yaml file located in the K8S Cluster Values of the Helm Chart and click the Validation Check button.
- Enter the Helm Chart Git Repository information and click the Connection Test button.
- Enter the Manifest Keys information.
- Click the Create button to complete the creation.
Item | Description |
|---|---|
| URL Input Method | Select the URL input method.
|
| ArgoCD URL | Enter the ArgoCD URL and click the Confirm button. |
| Authentication Information | Enter the authentication information and click the Connection Test button. |
| Application Name | Enter the ArgoCD application name and click the Duplicate Check button. |
| Project Name | Enter the project name of the ArgoCD application. |
| Repository Type | Select the repository type.
|
| K8S Cluster | Select the target cluster for deployment.
|
| Namespace | Select the target namespace for deployment.
|
| Git Repository | Enter the information of the Git repository where the Manifest information for creating the ArgoCD application is stored. |
| Manifest Keys Information | Enter the information for continuous deployment (Manifest Root path, Manifest type, Manifest file/Key information). |
Adding an Existing ArgoCD Application
To add an existing ArgoCD application, follow these steps:
- Click the Project card on the Main page. You will be taken to the Project Dashboard page.
- Click the Build/Deploy > Kubernetes Deploy menu on the left. You will be taken to the Kubernetes Deploy page.
- Click the Add ArgoCD App button at the top right. You will be taken to the Add ArgoCD App page.
- Enter the ArgoCD URL and click the Confirm button.
- The input screen for the existing application name and authentication information will appear.
- Enter the Existing Application Name and Authentication Information and click the Connection Test button.NoteIf the Git repository linked to the ArgoCD application is not registered in the DevOps Console, the URL Check popup window will open. Follow steps 7-8.
- The URL Check popup window will open to distinguish the Git repository linked to the ArgoCD application.
- Modify the Base URL and click the Confirm button.
- The information of the Git Repository linked to the application will appear.
- Enter the Git Repository Authentication Information and click the Connection Test button.
- Enter the Manifest Keys information.
- Click the Save button to complete the Add ArgoCD Application.
Item | Description |
|---|---|
| URL Input Method | Select the URL input method.
|
| ArgoCD URL | Enter the ArgoCD URL and click the Confirm button. |
| Application Name / Authentication Information | Enter the Existing Application Name and Authentication Information and click the Connection Test button. |
| Git Repository Authentication Information | Enter the authentication information of the Git repository used by the selected existing application. |
| Image Repo Key | Enter the YAML file path and key value where the image repository information is recorded. |
| Image Tag Key | Enter the YAML file path and key value where the image tag information is recorded. |
| Image Secret Key | Enter the YAML file path and key value where the image secret information is recorded. |
| Deploy Strategy Key | Enter the YAML file path and key value where the deployment strategy information is recorded. (Not a required value) |
Managing ArgoCD Applications
To view the details of an ArgoCD application, follow these steps:
- Click the Project card on the Main page. You will be taken to the Project Dashboard page.
- Click the Build/Deploy > Kubernetes Deploy menu on the left. You will be taken to the Kubernetes Deploy page.
- Click the ArgoCD Application Card you want to start. You will be taken to the Deploy Details page.
Editing Manifest Information
To edit the manifest information, follow these steps:
- Click the Git-related Information tab.
- Click the Edit icon next to Manifest Information. The Edit Manifest Key Information popup window will open.
- Modify the manifest key value and click the Save button.
Editing ArgoCD Authentication Information
To edit the ArgoCD authentication information, follow these steps:
- Click the Edit icon next to ArgoCD User ID. The Edit Authentication Information popup window will open.
- Modify the authentication information value and click the Save button to complete the modification.
Editing Linked Git Repository Authentication Information
To edit the authentication information of the linked Git repository, follow these steps:
- Click the Edit icon next to Linked Git ID. The Edit Authentication Information popup window will open.
- Modify the authentication information and click the Save button to complete the modification.
Setting Sync
To change the sync setting, follow these steps:
- Click the Sync icon next to Current Sync. The ArgoCD App Sync popup window will open.
- Enter the modified contents and click the Sync button to complete the Sync Setting.
| Item | Description |
|---|---|
| Revision | Select the target branch for synchronization. |
| Sync Options | Select the synchronization options. |
| Synchronize Resources | Select the synchronization target. |
Setting Auto-Sync
To change the Auto-Sync setting of an ArgoCD application, follow these steps:
- Click the Edit icon next to Auto-Sync. The Auto-Sync Options popup window will open.
- Modify the contents and click the Save button to complete the setting.
| Item | Description |
|---|---|
| Prune Resources | Select whether to delete the synchronization target when the Git setting is deleted. |
| Self Heal | Select whether to automatically change the value in the cluster to the value defined in Git when the value of the synchronization target is changed in the cluster. |
Managing Application Secrets
If the ArgoCD application was created using a Helm chart, you can add, modify, or delete application secrets.
To start managing application secrets, follow these steps:
- Click the application secret icon to the right of the application name.
- The Application Secret Settings popup window will open.
Adding an Application Secret
To add an application secret, follow these steps:
- Click the Edit icon next to Application Name. The Application Secret Settings popup window will open.
- If you need to add a secret to pull the Chart Image, click the Add button in the Chart Install Secret section.
- If you need to add a secret to pull the App Image during build/deployment, click the Add button in the ImagePull Secret section.
- Enter the contents and click the Save button to complete the addition.
Item | Description |
|---|---|
| Registry URL | Select the image to use for ImagePull Secret from the image list registered in the image repository. |
| Secret | Select the method of entering ImagePull Secret information.
|
Editing an Application Secret
To edit an application secret, follow these steps:
- Click the Edit icon next to Application Name. The Application Secret Settings popup window will open.
- Click the Name of the secret you want to modify in the application secret list.
- Enter the contents and click the Save button to complete the modification.
Deleting an Application Secret
… (rest of the text remains the same) To delete an application secret, follow these steps:
- Click the Edit Authentication Information icon next to the Application Name. The Application Secret Settings popup window will open.
- Click the Name of the secret you want to delete from the application secret list.
- Click the Delete button to complete the deletion.
Comparing Values.yaml Files
If you are using an ArgoCD application with Helm charts, you can compare values.yaml files.
To compare the values.yaml files used for each release, follow these steps:
- Click the History tab.
- Click the two revisions you want to compare.
- Click the App Diff button. The App Diff popup window will open.
Rolling Back an Application
To roll back an application to a previous revision, follow these steps:
- Click the History tab.
- Click the Rollback button in the rollback column of the revision you want to roll back. The Rollback popup window will open.
- Click the Confirm button to complete the rollback.
Deleting an Application
To delete an application, follow these steps:
- Click the Delete button at the bottom right. The Application Deletion popup will open.
- Click the Confirm button to complete the deletion.