This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

Kubernetes Deployment

Users can view the list of Helm releases used in the project and their deployment status. Depending on the development classification, the releases appear in the development or production list when the project is created or a chart is installed.

Users can differentiate deployments using icons.

  • 헬름차트 Helm chart
  • Istio Istio
  • 워크로드 Workload
  • 카나리 Canary(Canary)
  • 블루/그린 Blue/Green (Blue-Green)
  • ArgoCD ArgoCD

Getting Started with Kubernetes Deployment

To start using Kubernetes deployment, follow these steps.

  1. On the Main page, click the Project card. You will be taken to the Project Dashboard page.
  2. Click the Build/Deploy > Kubernetes Deploy menu in the left menu. You will be taken to the Kubernetes Deploy page.

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.

  1. From the Main page, click the Project card. You will be taken to the Project Dashboard page.
  2. Click the Build/Deploy > Kubernetes Deploy menu in the left menu. You will be taken to the Kubernetes Deploy page.
    ItemExplanation
    NameDisplays the deployment name. Click to view detailed information.
    ChartDisplays the Helm chart information used for deployment.
    Cluster/NamespaceDisplays the deployed cluster/namespace.
    Pod statusDisplays the current status of the Pod.
    Deployment resultDisplays the deployment execution result.
    Deployment timeDisplays the deployment execution time.
    RefreshRefresh the current items. The items that will be updated are the Pod status, deployment result, and deployment time.
    DeleteDelete the current item.
    Table. Helm release items
  3. 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.

  1. Click the Project card on the Main page. You will be taken to the Project Dashboard page.
  2. Click the Build/Deploy > Kubernetes Deployment menu in the left menu. You will be taken to the Kubernetes Deployment page.
  3. Click the Add related Helm release button. The Add related Helm release popup opens.
  4. Add related Helm release Enter each item in the popup window.
  5. Click the Save button to complete adding the Helm release.
    ItemExplanation
    Helm release already registered in the projectShows 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.

  1. On the Deployment Details page, click the Edit Credentials icon to the right of Helm Release.
  2. Helm Release Secret The popup window opens.

Adding a secret to a Helm release

To add a Helm release secret, follow these steps.

  1. 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.
  2. 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.
  3. 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.
  4. Add Secret In the popup window, enter the secret information and click the Save button to complete the addition.
    ItemExplanation
    Registry URLFrom the list of images registered in Image Repository, select the image that ImagePull Secret will use.
    SecretSelect 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.

  1. 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.
  2. In the HelmRelease secret list, click the secret name you want to edit. Secret Edit popup opens.
  3. 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.

  1. 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.
  2. Click the secret name you want to delete from the Helm release secret list.
  3. 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.

  1. On the Deployment Details page, click the Edit Credentials icon to the right of K8S Cluster/Namespace. The Edit Credentials popup will open.
  2. Authentication information is fixed to the logged-in user’s account. Click the Save button to edit.
  3. In the confirmation popup, click the Confirm button.
  4. 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.

  1. On the Deployment Details page, click the History tab.
  2. Click the View icon in the Values column. Revision # - Values.yaml The popup window opens.
  3. 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.

  1. Click the History tab on the Deployment Details page.
  2. In the list, click the check box of each of the two revisions you want to compare.
  3. Click the Yaml Diff button. The Yaml Diff popup window opens.
  4. 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.

  1. On the Deployment Details page, click the History tab.
  2. Click the Rollback button of the revision you want to roll back. The Rollback popup window will open.
  3. Click the Confirm button to complete the rollback.

Upgrade Helm Release

To upgrade HelmRelease, follow the following procedure.

  1. On the Deployment Details page, click the History tab.
  2. In the Values column, click the View icon. The Revision # - Values.yaml popup window opens.
  3. Modify the contents of Current Values.yaml, and click the Upgrade button. The Upgrade popup window will open.
  4. Check the upgrade information.
  5. 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.

  1. On the Deployment Details page, click the Release Object tab.
  2. Click the view icon in the LOG column of the Pod entry. The Log popup window opens.
    ItemExplanation
    containerSelect the container from which you want to output logs.
    Real-time refreshRefresh the log output in real time.
    Refresh stoppedStop real-time refresh.
    DownloadDownload the Pod logs to a file.
    Table. Log popup window function description

Delete Helm Release

To delete HelmRelease, follow the steps below.

  1. On the Deployment Details page, click the Delete button at the lower right of the Helm Release. The Delete Helm Release popup opens.
  2. 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.

  1. On the Main page, click the Project card. You will be taken to the Project Dashboard page.
  2. Click the Build/Deploy > Kubernetes Deploy menu in the left menu. You will be taken to the Kubernetes Deploy page.
  3. On the Kubernetes Deployment page, click the workload name.
    ItemExplanation
    Workload typeDisplays the workload type.
    • Deployment
    • StatefulSet
    • DaemonSet
    NameDisplays the workload name. Click to view detailed information.
    ChartDisplays the Helm chart information used for deployment.
    Cluster/NamespaceDisplays the deployed cluster/namespace.
    Pod statusDisplays the current status of the Pod.
    Deployment resultDisplays the deployment execution result.
    Deployment timeDisplays the deployment execution time.
    RefreshRefresh the current items. The items that will be updated are the Pod status, deployment result, and deployment time.
    DeleteDelete the current item.
    Table. Workload screen items

Add workload

To add a workload, follow the steps below.

  1. On the Main page, click the Project card. You will be taken to the Project Dashboard page.
  2. Click the Build/Deploy > Kubernetes Deploy menu in the left menu. You will be taken to the Kubernetes Deploy page.
  3. On the Kubernetes deployment page, click the Add workload menu. The Add workload popup opens.
  4. Add Workload Enter the information in the popup window and click the Save button.
  5. In the confirmation popup, click the Confirm button to complete adding the workload.
    Item
    Explanation
    Query targetOnly 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 projectShows 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.

  1. On the Deployment Details page, click the Edit Credentials icon to the right of K8S Cluster/Namespace. The Edit Credentials popup will open.
  2. Authentication information is fixed to the logged-in user’s account. Click the Save button to edit.
  3. In the confirmation popup, click the Confirm button.
  4. 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.

  1. On the Main page, click the Project card. You will be taken to the Project Dashboard page.
  2. In the left menu, click the Build/Deploy > Kubernetes Deployment menu. You will be taken to the Kubernetes Deployment page.
  3. Kubernetes deployment page, click the workload name to roll back. You will be taken to the Workload details page.
  4. Click the Details tab on the Workload Details page.
  5. 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.
  6. Rollback popup window, click the desired button to complete the rollback.
    • Recreate
    • Rolling Update

Add recipient to deployment results

To add a distribution result recipient, follow these steps.

  1. Click the Deployment Result Recipients tab on the Workload Details page.
  2. Click the Add button on the Distribution Result Recipients tab. The Add Distribution Result Recipients popup window opens.
  3. 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.

  1. On the Kubernetes deployment page, click the X icon of the workload you want to delete.
  2. 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.

  1. On the Main page, click the Project card. You will be taken to the Project Dashboard page.
  2. Click the Build/Deploy > Kubernetes Deploy menu in the left menu. You will be taken to the Kubernetes Deploy page.
    Item
    Explanation
    NameDisplays the blue/green deployment name. Click to view detailed information.
    Cluster/NamespaceDisplays 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.
    DeleteDelete the current item.
    Table. Kubernetes deployment screen Blue/Green deployment card items
  3. 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.
  1. Click the Project card on the Main page. You will be taken to the Project Dashboard page.
  2. Click the Build/Deploy > Kubernetes Deploy menu in the left menu. You will be taken to the Kubernetes Deploy page.
  3. Click the Add Blue/Green Deployment button at the top right of the Kubernetes deployment page. The Add Blue/Green Deployment popup opens.
  4. 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
    CategorySelect Development, Operations
    Blue/Green deployment nameEnter the deployment name.
    OperationRelease 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.
    StandbyRelease 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/namespaceDisplays the K8S cluster/namespace where the Helm release is installed.
    Type classificationSelect whether to use Ingress or Service to perform a blue/green switch.
    New classificationChoose whether to create a new Ingress or Service, or use an existing one.
    NameEnter 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.
    RulesEnter the information to be used for Ingress.
    Table. Ingress type input items when adding blue/green deployment
    ItemExplanation
    typeSelect the type of Kubernetes Service from the list
    • ClusterIP
    • NodePort
    • LoadBalancer
    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.
    PortsEnter 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.

  1. Click the Blue/Green Switch button on the Deployment Details page. The Blue/Green Switch popup opens.
  2. 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.

  1. On the Deployment Details page, click the view icon for Ingress YAML or Service YAML. The Ingress YAML or Service YAML popup window opens.
  2. 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.

  1. On the Deployment Details page, click the Log button in the Jenkins Job entry for the desired release. The Pipeline Log popup window opens.
  2. 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.

  1. 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.
  2. 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.

  1. Deployment Details page, click the Edit button. The Blue/Green Deployment Edit popup window opens.
  2. 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.

  1. Deployment Details page, click the Delete button. The Blue/Green Deployment Delete popup opens.
  2. 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.

  1. On the Main page, click the Project card. You will be taken to the Project Dashboard page.
  2. Click the Build/Deploy > Kubernetes Deploy menu in the left menu. You will be taken to the Kubernetes Deploy page.
    ItemExplanation
    NameDisplays the Canary name. Click to view detailed information.
    clusterDisplays the deployed cluster.
    (operation)Displays the currently running Helm release.
    (Canary)Displays the HelmRelease that is in Canary.
    ExitShutting down Canary.
    Table. Kubernetes deployment screen Canary card items
  3. 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 later
  • nginx-ingress v0.29.0 or later
information
Adding a canary requires two Helm releases installed with the same chart.
  1. On the Main page, click the Project card. You will be taken to the Project Dashboard page.
  2. Click the Build/Deploy > Kubernetes Deploy menu in the left sidebar. You will be taken to the Kubernetes Deploy page.
  3. Click the Add Canary button at the top right of the Kubernetes Deployment page. The Add Canary popup opens.
  4. Add Canary In the popup window, after entering the information, click the Save button to complete adding the canary.
    ItemExplanation
    CategorySelect Development or Operations.
    Canary nameEnter 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 clusterDisplays the K8S cluster where the Helm release is installed.
    Ingress annotationEnter 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.

  1. On the Deployment Details page, click the View icon for Production Ingress YAML and Canary Ingress YAML. The Ingress YAML popup opens.
  2. 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.

  1. 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.
  2. 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.

  1. 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.
  2. 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.

  1. On the Deployment Details page, click the Edit button. The Canary Edit popup window opens.
  2. 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.

  1. On the Deployment Details page, click the Restore button. The Restore popup window opens.
  2. In the Recovery popup, click the Confirm button to complete the recovery.

Delete Canary (termination)

To shut down Canary, follow these steps.

  1. On the Deployment Details page, click the Terminate button. The Canary Termination popup window opens.
  2. Canary termination In the popup window, select the desired item and click the Confirm button to complete the termination.
    item
    Explanation
    Canary releaseSelect 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 ReleaseSelect 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.

  1. On the Main page, click the Project card. You will be taken to the Project Dashboard page.
  2. From the left menu, click the Build/Deploy > Kubernetes Deploy menu. You will be taken to the Kubernetes Deploy page.
    ItemExplanation
    NameDisplays the Istio name. Click to view detailed information.
    Cluster/NamespaceDisplays the deployed cluster/namespace.
    DeleteDelete the current item.
    Table. Kubernetes deployment screen Istio card items
  3. 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.

  1. Click the Project card on the Main page. You will be taken to the Project Dashboard page.
  2. Click the Build/Deploy > Kubernetes Deploy menu in the left menu. You will be taken to the Kubernetes Deploy page.
  3. Click the Add Istio button at the top right of the Kubernetes deployment page. Add Istio popup opens.
  4. Add Istio In the popup window, after entering the information, click the Save button to add Istio.
    ItemExplanation
    CategorySelect Development or Operations.
    K8S clusterPlease select a K8S cluster.
    NamespaceSelect 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

  1. On the Istio details page, click the Istio objects tab.
  2. 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.

  1. Create Wizard page, click the Add button to select all Helm releases to be used in Istio.
  2. Click the Start button. The Gateway screen appears.

Gateway

The Istio Gateway is the frontmost object that receives traffic from external sources.

  1. 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.
  2. Click the Next button. The Destination Rule screen appears.
    ItemExplanation
    Name PrefixSpecify the prefix name of the Istio Gateway object to be created.
    HostSpecifies the domain of the Gateway Object accessed from outside.
    Table. Creation Wizard Gateway Input Items

Destination Rule

Destination Rule defines traffic policies in Istio.

  1. 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.
  2. Click the Next button. The Virtual Service screen appears.
    ItemExplanation
    Name PrefixEnter the Prefix name for the Istio Destination Rule Object to be created.
    LoadBalancerSelect the load balancer mode.
    • ROUND_ROBIN: Round Robin
    • LEAST_CONN: Continue using the last connection
    • RANDOM: Random
    maxConnectionsEnter the maximum allowed number of connections.
    Table. Creation Wizard Destination Rule Input Items

Virtual Service

The Virtual Service routes incoming traffic to a service.

  1. On the Creation Wizard page’s Virtual Service screen, if you want to create a Virtual Service, fill in each field.
  2. Click the Complete button to finish adding an Istio object using the creation wizard.
    ItemExplanation
    Name PrefixEnter the prefix name for the Istio Virtual Service to create.
    Prefix-UriEnter a prefix URI to enable routing when traffic arrives at that URI.
    Helm Release WeightIf 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

  1. On the Istio details page, click the Istio objects tab.
  2. Click the Add Object button in the Istio objects tab. The Add Object popup window opens.
  3. Add Object In the popup window, fill in each field and click the Save button to finish adding the Istio object.
    ItemExplanation
    ObjectSelect the Object to create
    • Gateway
    • Virtual Service
    • Destination Rule
    inputThe input fields differ for each object. Refer to the creation wizard for input
    • Gateway
    • Virtual Service
    • Destination Rule
    GenerateClick the Generate button. Based on the information entered earlier, a default Yaml will be generated in the Yaml area.
    YamlModify the base YAML to complete the final YAML of the object you want to generate.
    SaveClick 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.

  1. On the Istio details page, click the Istio objects tab.
  2. In the Istio objects tab, click the Object you want to edit from the Istio object list. The Object popup opens.
  3. 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.

  1. On the Istio Details page, click the Istio objects tab.
  2. In the Istio objects tab, click the Object you want to edit from the Istio object list. The Object popup window will open.
  3. 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.

  1. On the Istio details page, click the Helm Release tab.
  2. In the Helm Release tab, click the Add button. The Add Helm Release popup opens.
  3. 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.

  1. On the Istio Details page, click the Helm Release tab.
  2. In the Helm release tab, select the checkbox of the Helm release you want to delete and click the Delete button.
  3. In the confirmation popup, click the Confirm button to complete the Helm release deletion.

Delete Istio

To uninstall Istio, follow these steps.

  1. On the Istio Details page, click the Delete button at the lower right.
  2. 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.

  1. Main page, click the Project card. You will be taken to the Project Dashboard page.
  2. Click the Build/Deploy > Kubernetes Deploy menu in the left menu. You will be taken to the Kubernetes Deploy page.
  3. Click the ArgoCD application card you want to start from the list. You will be taken to the deployment details page.
    Item
    Explanation
    NameDisplays the ArgoCD project name/ArgoCD URL.
    Git informationDisplays the Git information used for deployment.
    Cluster/NamespaceDisplays the deployed cluster/namespace.
    App statusDisplays the current state of the App.
    Deployment resultDisplays the current Sync status.
    Deployment timeDisplays the deployment execution time.
    RefreshClick the Refresh icon to refresh the current item. The items that are updated are App status, deployment result.
    DeleteDelete the current item.
    Table. ArgoCD Application Detailed Items
    Item
    Explanation
    Modify ArgoCD app secretClick 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 appThe 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.

  1. Click the Project card on the Main page. You will be taken to the Project Dashboard page.
  2. In the left menu, click the Build/Deploy > Kubernetes Deployment menu. You will be taken to the Kubernetes Deployment page.
  3. Click the Create New ArgoCD App button at the top right. You will be taken to the Create New ArgoCD App page.
  4. Enter ArgoCD information and click the Confirm button. The authentication information input field appears.
  5. Enter authentication information and click the Connection Test button.
  6. Application Basic Information, Deployment Target K8S Cluster input fields appear.
  7. Enter the Application Name and click the Check Duplicate button.
  8. Enter Project Name.
  9. Select Repository type as Create a new repository as a Helm chart.
  10. Select a K8S cluster and namespace.
  11. Select Helm chart. Information about the Helm chart and the Helm chart Git repository will be displayed.
  12. 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.
  13. After entering the Helm chart Git repository information, click the Connection Test button.
  14. Manifest Keys Enter the information.
  15. Click the Create button to complete creation.
Reference
In the Manifest file and Key information, Deploy Strategy is not a required input.
ItemExplanation
URL input methodSelect URL input method
  • Select from list: the ArgoCD tools registered as tools appear.
  • Enter manually
ArgoCD URLAfter entering the ArgoCD URL, click the Confirm button.
Authentication informationEnter the credentials and click the Connection Test button.
Application nameEnter the ArgoCD application name and click the Check Duplicate button.
Project nameEnter the project name of the ArgoCD application.
Repository typeSelect 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 clusterSelect the target cluster for deployment
  • Only clusters that the user has access rights to among the DevOps Console K8S clusters can be selected.
NamespaceSelect 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 chartPlease select a Helm chart.
Helm chart Git repositoryEnter the information of the Git repository to be used for GitOps.
Manifest Key InformationEnter 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.

  1. Main page, click the Project card. You will be taken to the Project Dashboard page.
  2. Click the Build/Deploy > Kubernetes Deploy menu in the left menu. You will be taken to the Kubernetes Deploy page.
  3. Click the Create New ArgoCD App button at the top right. You will be taken to the Create New ArgoCD App page.
  4. Enter ArgoCD information and click the Confirm button. The Authentication information input field appears.
  5. Enter authentication information and click the Connection Test button.
  6. Application Basic Information, Deployment Target K8S Cluster input fields appear.
  7. Enter the Application Name and click the Check Duplicate button.
  8. Enter the Project Name.
  9. Select Repository type as Use existing Git repository.
  10. Select K8S cluster and namespace.
  11. Select Helm chart. Information about Helm chart and Helm chart Git repository appears.
  12. 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.
  13. Enter the Helm chart Git repository information and click the Connection Test button.
  14. 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.
  15. 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 methodSelect URL input method
    • Select from list: ArgoCD tools registered as tools appear.
    • Enter manually
    ArgoCD URLAfter entering the ArgoCD URL, click the Confirm button.
    authentication informationEnter the authentication information and click the Connection Test button.
    Application nameEnter the ArgoCD application name and click the Check Duplicate button.
    Project nameEnter the project name of the ArgoCD application.
    Repository typeSelect 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 clusterSelect 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.
    namespaceSelect 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 repositoryEnter the Git repository information that stores the Manifest data for creating the ArgoCD application to be used in GitOps.
    Manifest Keys informationEnter 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.

  1. Click the Project card on the Main page. You will be taken to the Project Dashboard page.
  2. In the left menu, click the Build/Deploy > Kubernetes Deployment menu. You will be taken to the Kubernetes Deployment page.
  3. Click the Add ArgoCD App button at the top right. Navigate to the Add ArgoCD App page.
  4. Enter the ArgoCD URL and click the Confirm button.
  5. The input screen for the existing application name and credentials appears.
  6. 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.
  7. A URL Check popup opens to identify the Git repository linked to the ArgoCD application.
  8. After modifying the Base URL, click the Confirm button.
  9. The Git repository information linked to the application is displayed.
  10. Enter the authentication information for the Git repository and click the Connection Test button.
  11. Enter the yaml file and key to modify among the Manifest Keys items.
  12. After entering the information, click the Save button to complete Add ArgoCD Application.
    item
    Explanation
    URL input methodSelect URL input method
    • Select from list: ArgoCD tools registered as tools appear.
    • Enter manually
    ArgoCD URLAfter entering the ArgoCD URL, click the Confirm button.
    Application name / authentication informationEnter the Existing application name and authentication information, then click the Connection Test button.
    Git repository credentialsEnter the credentials for the Git repository used by the selected existing application.
    Image Repo KeyEnter 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 KeyEnter 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 KeyEnter the path to the Yaml file that contains the image secret information and the Key value.
    Deploy Strategy KeyEnter 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.

  1. Main page, click the Project card. You will be taken to the Project Dashboard page.
  2. Click the Build/Deploy > Kubernetes Deployment menu in the left sidebar. You will be taken to the Kubernetes Deployment page.
  3. 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.

  1. Git related information Click the tab.
  2. Click the Edit icon next to Manifest information. The Edit Manifest key information popup opens.
  3. Modify the Manifest key value and click the Save button.

Modify ArgoCD authentication information

To modify the ArgoCD credentials, follow these steps.

  1. Click the Edit icon next to the ArgoCD User ID. The Edit Authentication Info popup will open.
  2. 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.

  1. Click the Edit icon next to Linked Git ID. The Edit authentication information popup opens.
  2. Modify the authentication information and click the Save button to complete the changes.

Configure Sync

To change the Sync settings, follow the steps below.

  1. Click the Sync icon next to Current Sync. The ArgoCD App Sync popup opens.
  2. Enter the content to edit and click the Sync button to complete the Sync settings.
    ItemExplanation
    RevisionSelect the branch to synchronize.
    Sync OptionsSelect the synchronization-related options.
    Synchronize ResourcesSelect the synchronization target.
    Table. Sync Settings
    Reference
    ArgoCD For 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.

  1. Click the Edit icon next to Auto‑Sync. The Auto‑Sync option popup window opens.
  2. Edit and click the Save button to complete the settings.
    Itemdescription
    Prune ResourcesWhen the Git settings are deleted, choose whether to also delete the synchronization target.
    Self HealIn 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.

  1. Click the application secret to the right of the application name.
  2. Application Secret Settings popup window opens.

Add application secret

To add an application secret, follow these steps.

  1. Click the Edit authentication information icon next to the Application name. The Application secret settings popup opens.
  2. If you need to add a secret to use when pulling the Chart Image, click the Add button in the Chart Install Secret section.
  3. 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.
  4. Enter the content and click the Save button to complete the addition.
    Item
    description
    Registry URLFrom the list of images registered in Image Repository, select the image that ImagePull Secret will use.
    SecretSelect 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.

  1. Click the Edit authentication information icon next to the Application name. The Application secret settings popup opens.
  2. Click the secret name you want to edit in the application secret list.
  3. Enter the content and click the Save button to complete the edit.

Delete Application Secret

To delete the application secret, follow the steps below.

  1. Click the Edit Authentication Info icon next to Application Name. The Application Secret Settings popup opens.
  2. Click the secret name you want to delete from the application secret list.
  3. 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.

  1. Click the History tab.
  2. Click the two revisions you want to compare.
  3. 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.

  1. Click the History tab.
  2. Click the Rollback button in the rollback column of the revision you want to roll back. The Rollback popup will open.
  3. Click the Confirm button to complete the rollback.

Delete Application

To uninstall the application, follow these steps.

  1. Click the Delete button at the bottom right. The Application Delete popup will open.
  2. Click the Confirm button to complete the deletion.
Reference
It is deleted only from DevOps Console, and the actual ArgoCD application is not deleted.