1 - Helm Release
HelmRelease is an instance of a chart running on a Kubernetes cluster. Users can create a HelmRelease when creating a project or via the HelmInstall menu.
Getting Started with Helm Release
To start HelmRelease, follow these steps.
- From the 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.
| Item | Explanation |
|---|
| Name | Displays the deployment name. Click to view detailed information. |
| Chart | Displays the Helm chart information used for deployment. |
| Cluster/Namespace | Displays the deployed cluster/namespace. |
| Pod status | Displays the current status of the Pod. |
| Deployment result | Displays the deployment execution result. |
| Deployment time | Displays the deployment execution time. |
| Refresh | Refresh the current items. The items that will be updated are the Pod status, deployment result, and deployment time. |
| Delete | Delete the current item. |
Table. Helm release items
- Kubernetes deployment page, click name in the Helm release list. You will be taken to the deployment details page.
Add Helm Release
Helm install
You can add a Helm release through Helm install.
Add related Helm release
To add the related Helm release, 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 Deployment menu in the left menu. You will be taken to the Kubernetes Deployment page.
- Click the Add related Helm release button. The Add related Helm release popup opens.
- Add related Helm release Enter each item in the popup window.
- Click the Save button to complete adding the Helm release.
| Item | Explanation |
|---|
| Helm release already registered in the project | Shows the Helm release already registered in the project.- A Helm release already registered in the project cannot be added.
|
Table. Items displayed when adding related Helm release
Managing Helm Release Secrets
Getting Started with Helm Release Secrets
In HelmRelease secrets, you can manage the ImagePull Secret used for images deployed through the build pipeline in HelmRelease.
To start HelmRelease secret management, follow the steps below.
- On the Deployment Details page, click the Edit Credentials icon to the right of Helm Release.
- Helm Release Secret The popup window opens.
Adding a secret to a Helm release
To add a Helm release secret, follow these steps.
- On the Deployment Details page, click the Edit Authentication Info icon to the right of the Helm Release. The Helm Release Secret popup will open.
- Helm Release Secret popup window, if you need to add a secret to pull a private Chart Image, click the Add button in the Chart Install Secret area. The Add Secret popup will open.
- If you need to add a secret required to pull the App Image used during build/deployment, click the Add button in the ImagePull Secret area. The Add Secret popup will open.
- Add Secret In the popup window, enter the secret information and click the Save button to complete the addition.
| Item | Explanation |
|---|
| Registry URL | From the list of images registered in Image Repository, select the image that ImagePull Secret will use. |
| Secret | Select secret input method- Auto-generate: Automatically create a secret using the credentials of the selected image repository from the Docker URL.
- Use existing secret: Select and use one of the already created secrets.
|
Table. Additional Helm Release Secret Configuration Items
Edit Helm Release Secret
To modify the Helm release secret, follow these steps.
- On the Deployment Details page, click the Edit Authentication Info icon to the right of the Helm Release. The Helm Release Secret popup will open.
- In the HelmRelease secret list, click the secret name you want to edit. Secret Edit popup opens.
- Edit the content and click the Save button to complete the edit.
Delete Helm release secret
To delete a Helm release secret, follow these steps.
- On the Deployment Details page, click the Edit Authentication Info icon to the right of the Helm Release. The Helm Release Secret popup will open.
- Click the secret name you want to delete from the Helm release secret list.
- Click the Delete button to complete the deletion.
Modify K8S credentials
K8S credentials are the authentication information used to verify permission to use a K8S cluster/namespace when performing a deployment in the build pipeline.
To modify the K8S credentials, follow these steps.
- On the Deployment Details page, click the Edit Credentials icon to the right of K8S Cluster/Namespace. The Edit Credentials popup will open.
- Authentication information is fixed to the logged-in user’s account. Click the Save button to edit.
- In the confirmation popup, click the Confirm button.
- K8S authentication information will be changed to the logged-in user.
Check the values.yaml used in the Helm release
To view the contents of values.yaml, follow these steps.
- On the Deployment Details page, click the History tab.
- Click the View icon in the Values column. Revision # - Values.yaml The popup window opens.
- Check the contents of the
values.yaml file.
Comparing values.yaml used in Helm release
To compare the values.yaml contents used in each release, follow the steps below.
- Click the History tab on the Deployment Details page.
- In the list, click the check box of each of the two revisions you want to compare.
- Click the Yaml Diff button. The Yaml Diff popup window opens.
- Yaml Diff (Revision #>#) Check the comparison details in the popup window.
Rollback Helm Release
To roll back a Helm release to a previous revision, follow these steps.
- On the Deployment Details page, click the History tab.
- Click the Rollback button of the revision you want to roll back. The Rollback popup window will open.
- Click the Confirm button to complete the rollback.
Upgrade Helm Release
To upgrade HelmRelease, follow the following procedure.
- On the Deployment Details page, click the History tab.
- In the Values column, click the View icon. The Revision # - Values.yaml popup window opens.
- Modify the contents of Current Values.yaml, and click the Upgrade button. The Upgrade popup window will open.
- Check the upgrade information.
- Click the Run button to complete the upgrade.
View Pod logs
To view the logs of the Pod related to a Helm release, follow these steps.
- On the Deployment Details page, click the Release Object tab.
- Click the view icon in the LOG column of the Pod entry. The Log popup window opens.
| Item | Explanation |
|---|
| container | Select the container from which you want to output logs. |
| Real-time refresh | Refresh the log output in real time. |
| Refresh stopped | Stop real-time refresh. |
| Download | Download the Pod logs to a file. |
Table. Log popup window function description
Delete Helm Release
To delete HelmRelease, follow the steps below.
- On the Deployment Details page, click the Delete button at the lower right of the Helm Release. The Delete Helm Release popup opens.
- Click the Confirm button to complete the deletion.
Reference
Also execute the helm delete command.
- Select: The Helm release is actually deleted from the cluster.
- Unselected: Kubernetes deployment is removed only from the list and remains in the cluster.
2 - Workload
A workload is an application that runs on Kubernetes, and users can add workloads to the DevOps Console for management.
The workload types that can be managed from the DevOps Console are Deployment, StatefulSet, and DaemonSet.
Getting Started
To begin using the workload, follow these steps.
- On the 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.
- On the Kubernetes Deployment page, click the workload name.
| Item | Explanation |
|---|
| Workload type | Displays the workload type.DeploymentStatefulSetDaemonSet
|
| Name | Displays the workload name. Click to view detailed information. |
| Chart | Displays the Helm chart information used for deployment. |
| Cluster/Namespace | Displays the deployed cluster/namespace. |
| Pod status | Displays the current status of the Pod. |
| Deployment result | Displays the deployment execution result. |
| Deployment time | Displays the deployment execution time. |
| Refresh | Refresh the current items. The items that will be updated are the Pod status, deployment result, and deployment time. |
| Delete | Delete the current item. |
Table. Workload screen items
Add workload
To add a workload, follow the steps below.
- On the 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.
- On the Kubernetes deployment page, click the Add workload menu. The Add workload popup opens.
- Add Workload Enter the information in the popup window and click the Save button.
- In the confirmation popup, click the Confirm button to complete adding the workload.
Item | Explanation |
|---|
| Query target | Only workloads deployed with the same Base image as the App template used when the project was first created are displayed. |
| Workload already registered in the project | Shows the workload already registered in the project.- Workloads already registered in the project cannot be added.
|
Table. Additional Workload Input Items
Modify K8S authentication information
K8S credentials are the authentication information used to verify permission to use a K8S cluster/namespace when performing a deployment in the build pipeline.
To modify the K8S credentials, follow these steps.
- On the Deployment Details page, click the Edit Credentials icon to the right of K8S Cluster/Namespace. The Edit Credentials popup will open.
- Authentication information is fixed to the logged-in user’s account. Click the Save button to edit.
- In the confirmation popup, click the Confirm button.
- K8S authentication information will be changed to the logged-in user.
Rollback Workload
To roll back the workload to a previous image, follow these steps.
- On the Main page, click the Project card. 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.
- Kubernetes deployment page, click the workload name to roll back. You will be taken to the Workload details page.
- Click the Details tab on the Workload Details page.
- In the Details tab list, click the Rollback button in the row that contains the image you want to roll back. The Rollback popup window opens.
- Rollback popup window, click the desired button to complete the rollback.
Add recipient to deployment results
To add a distribution result recipient, follow these steps.
- Click the Deployment Result Recipients tab on the Workload Details page.
- Click the Add button on the Distribution Result Recipients tab. The Add Distribution Result Recipients popup window opens.
- Add Distribution Result Recipients In the popup window, select the target and click the Confirm button to complete adding distribution result recipients.
- Search button or click an entry in the list to add the recipient to the lower part of the popup.
- Added recipients can be removed by clicking the X icon on the right.
Delete workload
To delete the workload, follow these steps.
- On the Kubernetes deployment page, click the X icon of the workload you want to delete.
- In the confirmation popup, click the Confirm button to complete the deletion.
Reference
Workloads are not deleted in the actual cluster.
If you want to delete in the actual cluster, delete it using the same method you used to initially deploy the workload.
3 - Blue/Green Deployment
Users can perform blue/green deployments using Ingress or Service.
Adding a blue/green deployment means creating a new K8S Ingress or K8S Service so that the two Helm releases can be swapped.
Only two Helm releases that have the same project, cluster, namespace, release type, chart name, chart version, development classification can be grouped.
Starting Blue/Green Deployment
To start using blue/green deployment, follow these steps.
- On the 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.
Item | Explanation |
|---|
| Name | Displays the blue/green deployment name. Click to view detailed information. |
| Cluster/Namespace | Displays the deployed cluster/namespace. |
| (operation) | Displays information about the currently deployed Helm release. |
| (operational standby) | Shows the Helm release that will be the next version in operation. Using blue/green switching, the standby switches to active. |
| Delete | Delete the current item. |
Table. Kubernetes deployment screen Blue/Green deployment card items
- Click the name of the Blue/Green deployment you want to start from the deployment list on the Kubernetes deployment page. You will be taken to the Deployment details page.
Add blue/green deployment
To add a blue/green deployment, follow these steps.
Reference
To add a blue/green deployment, you need two Helm releases installed with the same chart.
- Click the Project card on the Main page. 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 Add Blue/Green Deployment button at the top right of the Kubernetes deployment page. The Add Blue/Green Deployment popup opens.
- Add Blue/Green deployment After entering the information in the popup window, click the Save button to complete adding the Blue/Green deployment.
Item | Explanation |
|---|
| Category | Select Development, Operations |
| Blue/Green deployment name | Enter the deployment name. |
| Operation | Release and Jenkins Job selection- Release name: Select the name of the currently running Helm release from the list.
- Jenkins Job: Select the Jenkins Job from the list to build/deploy the selected Helm release.
|
| Standby | Release and Jenkins Job selection- Release name: Select the name of the Helm release to be applied to production in the next version from the list.
- Jenkins Job: Select the Jenkins Job from the list to build/deploy the selected Helm release.
|
| K8S cluster/namespace | Displays the K8S cluster/namespace where the Helm release is installed. |
| Type classification | Select whether to use Ingress or Service to perform a blue/green switch. |
| New classification | Choose whether to create a new Ingress or Service, or use an existing one. |
| Name | Enter name- New: Enter the name of an Ingress or Service.
- Existing: Select an already created Ingress or Service from the list.
|
| Service (Operation) | Select the Kubernetes Service related to the currently running Helm release from the list. |
| Service (Operational Standby) | Select the Kubernetes Service related to the Helm release that will be applied to operations in the next version from the list. |
| Rules | Enter the information to be used for Ingress. |
Table. Ingress type input items when adding blue/green deployment
| Item | Explanation |
|---|
| type | Select the type of Kubernetes Service from the listClusterIPNodePortLoadBalancer
|
| Deployment (Production) | Select the Kubernetes Deployment related to the currently running Helm release from the list. |
| Deployment (Operational standby) | Select the Kubernetes Deployment related to the Helm release that will be operated in the next version from the list. |
| Ports | Enter the information to be used by the Service. |
Table. Service type input items when adding Blue/Green deployment
Replace Blue/Green
To replace the blue/green, follow these steps.
- Click the Blue/Green Switch button on the Deployment Details page. The Blue/Green Switch popup opens.
- In the Blue/Green replacement popup, click the Confirm button to complete the Blue/Green replacement.
- The Helm releases for production and staging are being swapped.
- A replacement record will be added.
Check the yaml of Ingress or Service for blue/green deployment
To check the yaml of the Ingress or Service used in blue/green, follow these steps.
- On the Deployment Details page, click the view icon for Ingress YAML or Service YAML. The Ingress YAML or Service YAML popup window opens.
- Ingress YAML or Service YAML popup window, review the contents and click the Confirm button to exit.
Managing Jenkins Jobs for Blue/Green Deployments
Jenkins Job View Log
To view the Jenkins Job log, follow these steps.
- On the Deployment Details page, click the Log button in the Jenkins Job entry for the desired release. The Pipeline Log popup window opens.
- Pipeline Log After confirming the log in the popup window, click the Confirm button.
Running a Jenkins Job
To run a Jenkins job, follow these steps.
- On the Deployment Details page, click the Run button in the Jenkins Job entry for the desired release. The Enter Pipeline Execution Parameters popup will open.
- Pipeline Execution Parameter Input In the popup window, enter or select each item, then click the Confirm button to complete the Jenkins Job execution.
Modify blue/green deployment
To modify a blue/green deployment, follow these steps.
- Deployment Details page, click the Edit button. The Blue/Green Deployment Edit popup window opens.
- Blue/Green Deployment Edit In the popup window, modify the desired items and click the Save button to complete the edit.
Delete blue/green deployment
To delete a blue/green deployment, follow these steps.
- Deployment Details page, click the Delete button. The Blue/Green Deployment Delete popup opens.
- Blue/Green deployment deletion in the popup window, select whether to execute the Ingress/Service deletion command, and click the Confirm button to complete the deletion.
Reference
Execute Ingress/Service deletion command
- Selection: The Ingress or Service used for blue/green deployment is actually deleted from the cluster.
- Unselected: Ingress or Service used for blue/green deployment is not deleted and remains in the cluster.
4 - Canary Deployment
The user can add a canary deployment.
Adding a canary means configuring two Helm releases together so that a canary test can be performed.
Only two Helm releases that have the same Project, Cluster, Release Type, Chart Name, Chart Version, and Development Classification can be grouped.
Getting Started with Canary Deployment
To start using Canary, follow these steps.
- On the 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.
| Item | Explanation |
|---|
| Name | Displays the Canary name. Click to view detailed information. |
| cluster | Displays the deployed cluster. |
| (operation) | Displays the currently running Helm release. |
| (Canary) | Displays the HelmRelease that is in Canary. |
| Exit | Shutting down Canary. |
Table. Kubernetes deployment screen Canary card items
- On the Kubernetes deployment page, click the name of the canary you want to use in the deployment list. You will be taken to the deployment details page.
Add Canary
To add a canary, follow these steps.
Reference
Canary is supported in the following environments. Verify before adding Canary.
Kubernetes v1.17 or laternginx-ingress v0.29.0 or later
information
Adding a canary requires two Helm releases installed with the same chart.
- On the 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 sidebar. You will be taken to the Kubernetes Deploy page.
- Click the Add Canary button at the top right of the Kubernetes Deployment page. The Add Canary popup opens.
- Add Canary In the popup window, after entering the information, click the Save button to complete adding the canary.
| Item | Explanation |
|---|
| Category | Select Development or Operations. |
| Canary name | Enter the canary name. |
| Operation | - Release name: Select the name of the currently deployed Helm release from the list.
- Jenkins Job: Select the Jenkins job for building/deploying the currently deployed Helm release from the list.
|
| Canary | - Release name: Select the name of the Helm release that will be the next version in operation from the list.
- Jenkins Job: Select the Jenkins job that will build/deploy the Helm release for the next operational version from the list.
|
| K8S cluster | Displays the K8S cluster where the Helm release is installed. |
| Ingress annotation | Enter the annotation item you want to apply among the Canary annotations provided by nginx-ingress. |
Table. Canary Additional Input Items
Reference
For detailed guidance on each ingress annotation provided by nginx-ingress, refer to the
following page.
Check Canary’s Ingress YAML
Operational Ingress YAML used in Canary, to view the Canary Ingress YAML, follow these steps.
- On the Deployment Details page, click the View icon for Production Ingress YAML and Canary Ingress YAML. The Ingress YAML popup opens.
- Ingress YAML Check the contents in the popup window and click the Confirm button to exit.
Managing Canary’s Jenkins Job
View Jenkins Job log
To view the Jenkins Job log, follow these steps.
- On the Deployment Details page, click the Log button in the Jenkins Job entry for the desired release. The Pipeline Log popup window will open.
- Pipeline Log After confirming the log in the popup window, click the Confirm button.
Running a Jenkins Job
To run a Jenkins job, follow these steps.
- On the Deployment Details page, click the Run button in the Jenkins Job entry for the desired release. The Enter Pipeline Execution Parameters popup will open.
- Pipeline Execution Parameter Input In the popup window, enter or select each item, then click the Confirm button to complete the Jenkins job execution.
Modify Canary
To modify the canary, follow these steps.
- On the Deployment Details page, click the Edit button. The Canary Edit popup window opens.
- Canary Edit In the popup window, modify the desired items and click the Save button to complete the edit.
Recover Canary
If the ingress annotation data for the production and canary releases fails to operate correctly due to a Helm release change, restore it so it works properly again.
To restore the canary, follow these steps.
- On the Deployment Details page, click the Restore button. The Restore popup window opens.
- In the Recovery popup, click the Confirm button to complete the recovery.
Delete Canary (termination)
To shut down Canary, follow these steps.
- On the Deployment Details page, click the Terminate button. The Canary Termination popup window opens.
- Canary termination In the popup window, select the desired item and click the Confirm button to complete the termination.
item | Explanation |
|---|
| Canary release | Select Canary Release- Rollback Ingress Host: Restores the Ingress host of the Helm release used for the canary to its original value.
- Delete Helm Release: Deletes the Helm release that was used for the canary.
|
| Production Release | Select the production release- Upgrade to the canary image: Upgrade the production Helm release to the image used in the canary. You can modify the
Values.yaml file. - No action: End the canary without any changes to the production Helm release.
|
Table. Canary termination selection items
5 - Istio
Reference
For detailed guidance on Istio, refer to the
following page.
The list of Istio Traffic management Objects supported by the DevOps Console is as follows.
Gateway- Virtual Service
- Destination Rule
Getting Started with Istio
To start using Istio, follow these steps.
- On the Main page, click the Project card. You will be taken to the Project Dashboard page.
- From the left menu, click the Build/Deploy > Kubernetes Deploy menu. You will be taken to the Kubernetes Deploy page.
| Item | Explanation |
|---|
| Name | Displays the Istio name. Click to view detailed information. |
| Cluster/Namespace | Displays the deployed cluster/namespace. |
| Delete | Delete the current item. |
Table. Kubernetes deployment screen Istio card items
- In the deployment list on the Kubernetes Deployment page, click the name of the Istio you want to use. You will be taken to the Istio Details page.
Add Istio
To add Istio, follow the steps below.
- Click the Project card on the Main page. 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 Add Istio button at the top right of the Kubernetes deployment page. Add Istio popup opens.
- Add Istio In the popup window, after entering the information, click the Save button to add Istio.
| Item | Explanation |
|---|
| Category | Select Development or Operations. |
| K8S cluster | Please select a K8S cluster. |
| Namespace | Select a namespace. Only namespaces that can use Istio are displayed in the list. |
Table. Istio Additional Input Items
Reference
Istio has been added, but since no Istio objects have been created, Istio-related functionality cannot be used yet.
Add Istio object using the creation wizard or Add Istio object using object addition to add and use an Istio object.
Istio objects
Adding Istio object
Add Istio object using the creation wizard
- On the Istio details page, click the Istio objects tab.
- Click the Create Wizard button in the Istio objects tab. You will be taken to the Create Wizard page.
Helm Release
This step selects the Helm release to use with Istio.
- Create Wizard page, click the Add button to select all Helm releases to be used in Istio.
- Click the Start button. The Gateway screen appears.
Gateway
The Istio Gateway is the frontmost object that receives traffic from external sources.
- On the Gateway screen of the Creation Wizard page, select whether to create a Gateway.
- If you want to create a Gateway, enter each item.
- If you do not want to create a Gateway, select Pass without creating an Object.
- Click the Next button. The Destination Rule screen appears.
| Item | Explanation |
|---|
| Name Prefix | Specify the prefix name of the Istio Gateway object to be created. |
| Host | Specifies the domain of the Gateway Object accessed from outside. |
Table. Creation Wizard Gateway Input Items
Destination Rule
Destination Rule defines traffic policies in Istio.
- On the Create Wizard page’s Destination Rule screen, select whether to create a Destination Rule.
- If you want to create a Destination Rule, fill in each field.
- If you do not want to create a Destination Rule, select Pass without creating the Object.
- Click the Next button. The Virtual Service screen appears.
| Item | Explanation |
|---|
| Name Prefix | Enter the Prefix name for the Istio Destination Rule Object to be created. |
| LoadBalancer | Select the load balancer mode.ROUND_ROBIN: Round RobinLEAST_CONN: Continue using the last connectionRANDOM: Random
|
| maxConnections | Enter the maximum allowed number of connections. |
Table. Creation Wizard Destination Rule Input Items
Virtual Service
The Virtual Service routes incoming traffic to a service.
- On the Creation Wizard page’s Virtual Service screen, if you want to create a Virtual Service, fill in each field.
- Click the Complete button to finish adding an Istio object using the creation wizard.
| Item | Explanation |
|---|
| Name Prefix | Enter the prefix name for the Istio Virtual Service to create. |
| Prefix-Uri | Enter a prefix URI to enable routing when traffic arrives at that URI. |
| Helm Release Weight | If there are two or more helm releases, enter the connection weight. The sum of each number must be 100. |
Table. Create Wizard Virtual Service Input Items
Add an Istio object using Object addition
- On the Istio details page, click the Istio objects tab.
- Click the Add Object button in the Istio objects tab. The Add Object popup window opens.
- Add Object In the popup window, fill in each field and click the Save button to finish adding the Istio object.
| Item | Explanation |
|---|
| Object | Select the Object to createGatewayVirtual ServiceDestination Rule
|
| input | The input fields differ for each object. Refer to the creation wizard for inputGatewayVirtual ServiceDestination Rule
|
| Generate | Click the Generate button. Based on the information entered earlier, a default Yaml will be generated in the Yaml area. |
| Yaml | Modify the base YAML to complete the final YAML of the object you want to generate. |
| Save | Click the Save button to create an Object. |
Table. Screen items for adding an Istio object using Object addition
Modify Istio object
To modify an Istio object, follow these steps.
- On the Istio details page, click the Istio objects tab.
- In the Istio objects tab, click the Object you want to edit from the Istio object list. The Object popup opens.
- Object In the popup window, edit the Yaml and click the Save button to complete the Istio object modification.
Delete Istio object
To delete an Istio object, follow these steps.
- On the Istio Details page, click the Istio objects tab.
- In the Istio objects tab, click the Object you want to edit from the Istio object list. The Object popup window will open.
- In the Object popup, click the Delete button to complete the deletion of the Istio object.
Helm release
Add Helm Release
To add the Helm release used by Istio, follow these steps.
- On the Istio details page, click the Helm Release tab.
- In the Helm Release tab, click the Add button. The Add Helm Release popup opens.
- Add Helm Release In the popup window, fill out each field and click the Save button to complete adding the Helm release.
Delete Helm Release
To delete the Helm release used by Istio, follow these steps.
- On the Istio Details page, click the Helm Release tab.
- In the Helm release tab, select the checkbox of the Helm release you want to delete and click the Delete button.
- In the confirmation popup, click the Confirm button to complete the Helm release deletion.
Delete Istio
To uninstall Istio, follow these steps.
- On the Istio Details page, click the Delete button at the lower right.
- Click the Confirm button in the confirmation popup to complete the deletion.
6 - ArgoCD
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 Items
Item | Explanation | |
|---|
| 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.
Reference
In the Manifest file and Key information, Deploy Strategy is not a required input.
| Item | Explanation |
|---|
| URL input method | Select URL input method- Select from list: the ArgoCD tools registered as tools appear.
- Enter manually
|
| 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- 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 access rights to among the DevOps Console K8S clusters can be selected.
|
| Namespace | Select the target namespace for deployment- In the K8S cluster, you can only select namespaces that the user has access rights to among the selected clusters.
|
| 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. |
Table. New ArgoCD Application Creation - Settings for creation with Helm chart
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.
Reference
In 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.
Reference
If 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
yaml file 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.
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 Settings
Reference
ArgoCD For detailed information about synchronization, please refer to the
official site.
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.
Reference
It is deleted only from DevOps Console, and the actual ArgoCD application is not deleted.