ArgoCD is software used for GitOps deployments in a Kubernetes environment. Users can configure deployments via ArgoCD 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.
- Main page, click the Project card. You will be taken to the Project Dashboard page.
- Click the Build/Deploy > Kubernetes Deploy menu in the left menu. You will be taken to the Kubernetes Deploy page.
- Click the ArgoCD application card you want to start from the list. You will be taken to the deployment details page.Item
Explanation 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 state of the App. Deployment result Displays the current Sync status. Deployment time Displays the deployment execution time. Refresh Click the Refresh icon to refresh the current item. The items that are updated are App status, deployment result. Delete Delete the current item. Table. ArgoCD Application Detailed ItemsItemExplanation Modify ArgoCD app secret Click the Edit credentials icon to the right of the application name to open a popup that manages the image secret used for deployment. Go to the ArgoCD app The actual ArgoCD tool’s Application Details screen opens in a new window. Table. ArgoCD Deployment Details
Adding an ArgoCD Application
Create and add a new ArgoCD application - generate with Helm chart
To create and add a new ArgoCD application using a Helm chart, follow the steps below.
- Click the Project card on the Main page. You will be taken to the Project Dashboard page.
- In the left menu, click the Build/Deploy > Kubernetes Deployment menu. You will be taken to the Kubernetes Deployment page.
- Click the Create New ArgoCD App button at the top right. You will be taken to the Create New ArgoCD App page.
- Enter ArgoCD information and click the Confirm button. The authentication information input field appears.
- Enter authentication information and click the Connection Test button.
- Application Basic Information, Deployment Target K8S Cluster input fields appear.
- Enter the Application Name and click the Check Duplicate button.
- Enter Project Name.
- Select Repository type as Create a new repository as a Helm chart.
- Select a K8S cluster and namespace.
- Select Helm chart. Information about the Helm chart and the Helm chart Git repository will be displayed.
- After modifying the contents of the default Values.yaml included in the chart located in the K8S cluster Values of the Helm chart, click the Validation Check button.
- After entering the Helm chart Git repository information, click the Connection Test button.
- Manifest Keys Enter the information.
- Click the Create button to complete creation.
Deploy Strategy is not a required input.| Item | Explanation |
|---|---|
| URL input method | Select URL input method
|
| ArgoCD URL | After entering the ArgoCD URL, click the Confirm button. |
| Authentication information | Enter the credentials and click the Connection Test button. |
| Application name | Enter the ArgoCD application name and click the Check Duplicate button. |
| Project name | Enter the project name of the ArgoCD application. |
| Repository type | Select repository type
|
| K8S cluster | Select the target cluster for deployment
|
| Namespace | Select the target namespace for deployment
|
| Helm chart | Please select a Helm chart. |
| Helm chart Git repository | Enter the information of the Git repository to be used for GitOps. |
| Manifest Key Information | Enter the Manifest file/key information to be used for continuous deployment. |
Create and add a new ArgoCD application – create from an existing Git repository
To create and add a new ArgoCD application using an existing Git repository, follow the steps below.
- Main page, click the Project card. You will be taken to the Project Dashboard page.
- Click the Build/Deploy > Kubernetes Deploy menu in the left menu. 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 ArgoCD information and click the Confirm button. The Authentication information input field appears.
- Enter authentication information and click the Connection Test button.
- Application Basic Information, Deployment Target K8S Cluster input fields appear.
- Enter the Application Name and click the Check Duplicate button.
- Enter the Project Name.
- Select Repository type as Use existing Git repository.
- Select K8S cluster and namespace.
- Select Helm chart. Information about Helm chart and Helm chart Git repository appears.
- After modifying the contents of the default Values.yaml included in the chart located in the K8S cluster Values of the Helm chart, click the Validation Check button.
- Enter the Helm chart Git repository information and click the Connection Test button.
- Enter the Manifest Root path, Manifest type, (values.yaml path if the Manifest type is Helm), and the Manifest file and key information (Image repository, Image tag, Image Secret, Deploy Strategy) for Manifest Keys.
- Click the Create button to complete creation.ReferenceIn the Manifest file and key information, the Deploy Strategy is not a required input.Item
Explanation URL input method Select URL input method - Select from list: ArgoCD tools registered as tools appear.
- Enter manually
ArgoCD URL After entering the ArgoCD URL, 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 Check Duplicate button. Project name Enter the project name of the ArgoCD application. Repository type Select repository type - Create a new repository with Helm chart: Use a Helm chart to create a Git repository for
GitOps. - Use existing Git repository
K8S cluster Select the target cluster for deployment - Only clusters that the user has permission to access can be selected from the clusters in the DevOps Console K8S cluster.
namespace Select the target namespace for deployment - In the K8S cluster, only namespaces that the user has access rights to can be selected from the chosen cluster.
Git repository Enter the Git repository information that stores the Manifest data for creating the ArgoCD application to be used in GitOps.Manifest Keys information Enter the information required for continuous deployment (Manifest Root path, Manifest type ( Helm,Customize,Directory), Manifest file/key information).Table. New ArgoCD application creation - Settings for creating with existing Git repository
Add 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.
- In the left menu, click the Build/Deploy > Kubernetes Deployment menu. You will be taken to the Kubernetes Deployment page.
- Click the Add ArgoCD App button at the top right. Navigate to the Add ArgoCD App page.
- Enter the ArgoCD URL and click the Confirm button.
- The input screen for the existing application name and credentials appears.
- Enter the Existing Application Name and Authentication Information, then click the Connection Test button.ReferenceIf the Git repository linked to the ArgoCD application is not registered in the DevOps Console, the URL Check popup window opens. Follow steps 7–8.
- A URL Check popup opens to identify the Git repository linked to the ArgoCD application.
- After modifying the Base URL, click the Confirm button.
- The Git repository information linked to the application is displayed.
- Enter the authentication information for the Git repository and click the Connection Test button.
- Enter the
yamlfile and key to modify among the Manifest Keys items. - After entering the information, click the Save button to complete Add ArgoCD Application.item
Explanation URL input method Select URL input method - Select from list: ArgoCD tools registered as tools appear.
- Enter manually
ArgoCD URL After entering the ArgoCD URL, click the Confirm button. Application name / authentication information Enter the Existing application name and authentication information, then click the Connection Test button. Git repository credentials Enter the credentials for the Git repository used by the selected existing application. Image Repo Key Enter the path to the Yaml file that records the image repository information and the Key value. If the key values for repository and tag are the same, enter the same value. Image Tag Key Enter the path to the Yaml file containing the image tag information and the Key value. If the repository and tag have the same key, enter the same value. Image Secret Key Enter the path to the Yaml file that contains the image secret information and the Key value. Deploy Strategy Key Enter the path to the Yaml file containing the deployment strategy information and the Key value. (It is not required.) Table. Adding Existing ArgoCD Application Configuration Items
Managing ArgoCD Applications
To view the details of an ArgoCD application, follow these steps.
- Main page, click the Project card. You will be taken to the Project Dashboard page.
- Click the Build/Deploy > Kubernetes Deployment menu in the left sidebar. You will be taken to the Kubernetes Deployment page.
- Click the ArgoCD application card you want to start from the list. You will be taken to the deployment details page.
Modify Manifest information
Follow these steps to modify the Manifest information.
- Git related information Click the tab.
- Click the Edit icon next to Manifest information. The Edit Manifest key information popup opens.
- Modify the Manifest key value and click the Save button.
Modify ArgoCD authentication information
To modify the ArgoCD credentials, follow these steps.
- Click the Edit icon next to the ArgoCD User ID. The Edit Authentication Info popup will open.
- Modify the authentication information value and click the Save button to complete the edit.
Modify linked Git repository credentials
To modify 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 opens.
- Modify the authentication information and click the Save button to complete the changes.
Configure Sync
To change the Sync settings, follow the steps below.
- Click the Sync icon next to Current Sync. The ArgoCD App Sync popup opens.
- Enter the content to edit and click the Sync button to complete the Sync settings.
Item Explanation Revision Select the branch to synchronize. Sync Options Select the synchronization-related options. Synchronize Resources Select the synchronization target. Table. Sync SettingsReferenceArgoCDFor detailed information about synchronization, please refer to the official site.
Configure Auto-Sync
To change the Auto-Sync settings of an ArgoCD application, follow these steps.
- Click the Edit icon next to Auto‑Sync. The Auto‑Sync option popup window opens.
- Edit and click the Save button to complete the settings.
Item description Prune Resources When the Git settings are deleted, choose whether to also delete the synchronization target. Self Heal In the cluster, when the value of synchronization target changes, select whether to automatically change it to the value defined in Git. Table. Auto-Sync Settings
Managing Application Secrets
If it is an ArgoCD application created with a Helm chart, you can add, modify, or delete the application’s secrets.
To start application secret management, follow these steps.
- Click the application secret to the right of the application name.
- Application Secret Settings popup window opens.
Add application secret
To add an application secret, follow these steps.
- Click the Edit authentication information icon next to the Application name. The Application secret settings popup opens.
- If you need to add a secret to use when pulling the Chart Image, click the Add button in the Chart Install Secret section.
- When you need to add a secret for pulling the App Image used during build/deployment, click the Add button in the ImagePull Secret section.
- Enter the content and click the Save button to complete the addition.Item
description Registry URL From the list of images registered in Image Repository, select the image that ImagePull Secret will use. Secret Select the method for entering ImagePull Secret information - Auto-generate: Use the credentials of the image repository selected from the Docker URL to automatically create an ImagePull Secret.
- Use existing secret: Choose one of the already created secrets to use as the ImagePull Secret.
Table. Application Secret Additional Configuration Items
Edit Application Secret
To modify the application secret, follow these steps.
- Click the Edit authentication information icon next to the Application name. The Application secret settings popup opens.
- Click the secret name you want to edit in the application secret list.
- Enter the content and click the Save button to complete the edit.
Delete Application Secret
To delete the application secret, follow the steps below.
- Click the Edit Authentication Info icon next to Application Name. The Application Secret Settings popup opens.
- Click the secret name you want to delete from the application secret list.
- Click the Delete button to complete the deletion.
Comparing Values.yaml file
For an ArgoCD application using a Helm chart, you can compare the values.yaml file.
To compare the values.yaml files used in 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 opens.
Rolling Back an Application
To roll back the 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 will open.
- Click the Confirm button to complete the rollback.
Delete Application
To uninstall the application, follow these steps.
- Click the Delete button at the bottom right. The Application Delete popup will open.
- Click the Confirm button to complete the deletion.