1 - Helm Release
Helm Release is an instance of a chart running in a Kubernetes cluster. Users can create a Helm Release when creating a project or through the Helm Install menu.
Getting Started with Helm Release
To get started with Helm Release, follow these steps:
- Main page, click the Project card. Move to the Project Dashboard page.
- In the left menu, click Build/Deploy > Kubernetes Deploy. Move to the Kubernetes Deploy page.
| Item | Description |
|---|
| Name | Displays the deployment name. Click to view detailed information. |
| Chart | Displays information about the Helm chart used for deployment. |
| Cluster/Namespace | Displays the cluster/namespace where the deployment is located. |
| Pod Status | Displays the current status of the Pod. |
| Deployment Result | Displays the result of the deployment execution. |
| Deployment Time | Displays the deployment execution time. |
| Refresh | Refreshes the current item. The items that change are Pod status, deployment result, and deployment time. |
| Delete | Deletes the current item. |
Table. Helm Release Items
- On the Kubernetes Deploy page, click the Name in the Helm Release list. Move to the Deployment Details page.
Adding Helm Release
Helm Install
You can add a Helm Release through Helm Install.
To add a related Helm Release, follow these steps:
- Main page, click the Project card. Move to the Project Dashboard page.
- In the left menu, click Build/Deploy > Kubernetes Deploy. Move to the Kubernetes Deploy page.
- Click the Add Related Helm Release button. The Add Related Helm Release popup window opens.
- In the Add Related Helm Release popup window, enter each item.
- Click the Save button to complete adding the Helm Release.
| Item | Description |
|---|
| Helm Release already registered in the project | Displays the Helm Release already registered in the project.- 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
Helm Release Secrets allows you to manage the ImagePull Secret used for the image deployed through the build pipeline.
To get started with Helm Release Secrets, follow these steps:
- On the Deployment Details page, click the Edit Authentication Information icon to the right of Helm Release.
- The Helm Release Secrets popup window opens.
Adding Helm Release Secrets
To add a Helm Release Secret, follow these steps:
- On the Deployment Details page, click the Edit Authentication Information icon to the right of Helm Release. The Helm Release Secrets popup window opens.
- In the Helm Release Secrets popup window, if you need to add a secret to pull a private chart image, click the Add button in the Chart Install Secret section. The Add Secret popup window opens.
- If you need to add a secret to pull the app image used for build/deploy, click the Add button in the ImagePull Secret section. The Add Secret popup window opens.
- In the Add Secret popup window, enter the secret-related content and click the Save button to complete the addition.
| Item | Description |
|---|
| Registry URL | Select the image to use for ImagePull Secret from the image list in the image repository. |
| Secret | Select the method for entering secret information- Auto-generation: Automatically generates a secret using the authentication information of the selected image repository in the Docker URL.
- Use existing secret: Select one of the existing secrets to use.
|
Table. Helm Release Secret Addition Settings
Modifying Helm Release Secrets
To modify a Helm Release Secret, follow these steps:
- On the Deployment Details page, click the Edit Authentication Information icon to the right of Helm Release. The Helm Release Secrets popup window opens.
- In the Helm Release Secret list, click the name of the secret you want to modify. The Modify Secret popup window opens.
- Modify the content and click the Save button to complete the modification.
Deleting Helm Release Secrets
To delete a Helm Release Secret, follow these steps:
- On the Deployment Details page, click the Edit Authentication Information icon to the right of Helm Release. The Helm Release Secrets popup window opens.
- In the Helm Release Secret list, click the name of the secret you want to delete.
- Click the Delete button to complete the deletion.
K8S authentication information refers to the authentication information used to verify the authority to use the K8S cluster/namespace when performing deployment in the build pipeline.
To modify the K8S authentication information, follow the procedure below.
- Deployment Details page, click the Edit Authentication Information icon to the right of K8S Cluster/Namespace. The Edit Authentication Information popup window will open.
- The authentication information is fixed to the account of the logged-in user. Click the Save button to modify it.
- In the confirmation popup window, click the Confirm button.
- The K8S authentication information will be changed to the logged-in user.
Checking values.yaml used in Helm Release
To check the contents of values.yaml, follow these steps:
- On the Deployment Details page, click the History tab.
- In the Values column, click the View icon. The Revision # - Values.yaml popup window opens.
- Check the contents of the
values.yaml file.
Comparing values.yaml used in Helm Release
To compare the contents of values.yaml used in each release, follow these steps:
- On the Deployment Details page, click the History tab.
- In the list, select the checkboxes of the two revisions you want to compare.
- Click the Yaml Diff button. The Yaml Diff popup window opens.
- In the Yaml Diff (Revision #>#) popup window, check the comparison contents.
Rolling Back 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 for the revision you want to roll back. The Rollback popup window opens.
- Click the Confirm button to complete the rollback.
Upgrading Helm Release
To upgrade a Helm Release, follow these steps:
- 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 the current Values.yaml and click the Upgrade button. The Upgrade popup window opens.
- Check the information being upgraded.
- Click the Execute button to complete the upgrade.
Viewing Pod Logs
To view the logs of Pods related to Helm Release, follow these steps:
- On the Deployment Details page, click the Release Objects tab.
- In the Pod Items section, click the LOG icon in the LOG column. The Log popup window opens.
| Item | Description |
|---|
| Container | Select the container for which you want to output logs. |
| Real-time Refresh | Refreshes the log output in real-time. |
| Stop Refresh | Stops real-time refresh. |
| Download | Downloads the Pod log as a file. |
Table. Log Popup Window Function Description
Deleting Helm Release
To delete a Helm Release, follow these steps:
- On the Deployment Details page, click the Delete button at the bottom right of Helm Release. The Delete Helm Release popup window opens.
- Click the Confirm button to complete the deletion.
Note
Also execute the Helm delete command
- Selected: The Helm Release is actually deleted from the cluster.
- Not selected: Only deleted from the Kubernetes Deploy 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 manageable from DevOps Console are Deployment, StatefulSet, DaemonSet.
Start Workload
To start using the workload, follow the steps below.
- Click the Project card on the Main page. It moves 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.
- Kubernetes Deployment On the page, click the name of the workload.
| Item | Description |
|---|
| 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 item. The items that change are Pod status, deployment result, deployment time. |
| Delete | Deletes the current item. |
Table. Workload screen items
Add workload
To add a workload, follow the procedure below.
- Main page, click the Project card. It moves to the Project Dashboard page.
- In the left menu, click the Build/Deploy > Kubernetes Deployment menu. It moves to the Kubernetes Deployment page.
- On the Kubernetes Deployment page, click the Add Workload menu. The Add Workload popup window opens.
- In the Add Workload popup window, enter the information and click the Save button.
- In the confirmation popup window, click the Confirm button to complete adding the workload.
Item | Description |
|---|
| Target to be retrieved | Only workloads deployed with the same image as the base image of the App template used when creating the project for the first time are displayed. |
| Workload already registered in the project | It shows the workload already registered in the project.- Workloads already registered in the project cannot be added.
|
Table. Input items for adding workload
K8S authentication information refers to the authentication information used to verify the authority to use the K8S cluster/namespace when performing deployment in the build pipeline.
To modify the K8S authentication information, follow the procedure below.
- Deployment Details page, click the Edit Authentication Information icon to the right of K8S Cluster/Namespace. The Edit Authentication Information popup window will open.
- The authentication information is fixed to the account of the logged-in user. Click the Save button to modify it.
- In the confirmation popup window, click the Confirm button.
- The K8S authentication information will be changed to the logged-in user.
Rollback workload
To roll back the workload to a previous image, follow the steps below.
- On the Main page, click the Project card. It navigates to the Project Dashboard page.
- In the left menu, click the Build/Deploy > Kubernetes Deploy menu. You will be taken to the Kubernetes Deploy page.
- Kubernetes deployment page, click the workload name to roll back. You will be taken to the workload details page.
- Click the Details tab of the Workload Details page.
- Detailed Information tab list, click the Rollback button in the row that has the image you want to rollback. Rollback popup window opens.
- Rollback Click the button in the popup window in the desired way to complete the rollback.
Add distribution result recipient
To add a distribution result recipient, follow the steps below.
- Click the Deployment Result Recipients tab on the Workload Details page.
- Click the Add button on the Distribution Result Recipient tab. The Add Distribution Result Recipient popup 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 the list to add the recipient to the bottom of the popup.
- Added recipients can be deleted by clicking the X icon on the right.
Delete workload
To delete the workload, follow the steps below.
- Click the X icon of the workload to delete on the Kubernetes Deployment page.
- 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 method you originally deployed 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 that can replace two Helm releases with each other.
Only two Helm releases with the same Project, Cluster, Namespace, Release Type, Chart Name, Chart Version, and Development Classification can be linked.
Getting Started with Blue/Green Deployment
To start using blue/green deployment, follow these steps:
- Click the Project card on the Main page. You will be moved to the Project Dashboard page.
- Click the Build/Deployment > Kubernetes Deployment menu on the left. You will be moved to the Kubernetes Deployment page.
Item | Description |
|---|
| Name | Displays the name of the blue/green deployment. Click to view detailed information. |
| Cluster/Namespace | Displays the cluster/namespace where the deployment is deployed. |
| (Operation) | Displays information about the currently operating Helm release. |
| (Pre-operation) | Displays the Helm release that will be the next version of the operation. When using blue/green replacement, the pre-operation becomes the operation. |
| Delete | Deletes the current item. |
Table. Kubernetes Deployment Screen Blue/Green Deployment Card Items
- On the Kubernetes Deployment page, click the name of the blue/green deployment you want to start in the deployment list. You will be moved to the Deployment Details page.
Adding Blue/Green Deployment
To add a blue/green deployment, follow these steps:
Note
To add a blue/green deployment, you need two Helm releases installed using the same chart.
- Click the Project card on the Main page. You will be moved to the Project Dashboard page.
- Click the Build/Deployment > Kubernetes Deployment menu on the left. You will be moved to the Kubernetes Deployment page.
- Click the Add Blue/Green Deployment button at the top right of the Kubernetes Deployment page. The Add Blue/Green Deployment popup window will open.
- Enter the information in the Add Blue/Green Deployment popup window and click the Save button to complete the addition of the blue/green deployment.
Item | Description |
|---|
| Classification | Select development or operation |
| Blue/Green Deployment Name | Enter the deployment name. |
| Operation | Select the release and Jenkins job- Release Name: Select the name of the currently operating Helm release from the list.
- Jenkins Job: Select the Jenkins job to build/deploy the selected Helm release from the list
|
| Pre-operation | Select the release and Jenkins job- Release Name: Select the name of the Helm release to be reflected in the next version of the operation from the list.
- Jenkins Job: Select the Jenkins job to build/deploy the selected Helm release from the list
|
| K8S Cluster/Namespace | Displays the K8S cluster/namespace where the Helm release is installed. |
| Type Classification | Choose whether to use Ingress or Service to switch blue/green. |
| New Classification | Choose whether to create a new Ingress or Service or use an existing one. |
| Name | Enter the name- New: Enter the name of the Ingress or Service.
- Existing: Select an existing Ingress or Service from the list
|
| Service (Operation) | Select the Kubernetes Service related to the currently operating Helm release from the list. |
| Service (Pre-operation) | Select the Kubernetes Service related to the Helm release to be reflected in the next version of the operation from the list. |
| Rules | Enter the information to be used in Ingress. |
Table. Input Items for Ingress Type when Adding Blue/Green Deployment
| Item | Description |
|---|
| Type | Select the type of Kubernetes Service from the listClusterIPNodePortLoadBalancer
|
| Deployment (Operation) | Select the Kubernetes Deployment related to the currently operating Helm release from the list. |
| Deployment (Pre-operation) | Select the Kubernetes Deployment related to the Helm release to be reflected in the next version of the operation from the list. |
| Ports | Enter the information to be used in Service. |
Table. Input Items for Service Type when Adding Blue/Green Deployment
Switching Blue/Green
To switch blue/green, follow these steps:
- Click the Blue/Green Switch button on the Deployment Details page. The Blue/Green Switch popup window will open.
- Click the Confirm button in the Blue/Green Switch popup window to complete the blue/green switch.
- The Helm releases for operation and pre-operation are swapped with each other.
- The switch history is added.
Checking YAML of Ingress or Service Used in Blue/Green Deployment
To check the YAML of the Ingress or Service used in blue/green, follow these steps:
- Click the View icon of Ingress YAML or Service YAML on the Deployment Details page. The Ingress YAML or Service YAML popup window will open.
- Check the contents in the Ingress YAML or Service YAML popup window and click the Confirm button to close.
Managing Jenkins Job of Blue/Green Deployment
Viewing Jenkins Job Log
To view the Jenkins job log, follow these steps:
- Click the Log button in the Jenkins job item of the desired release on the Deployment Details page. The Pipeline Log popup window will open.
- Check the log in the Pipeline Log popup window and click the Confirm button.
Running Jenkins Job
To run a Jenkins job, follow these steps:
- Click the Run button in the Jenkins job item of the desired release on the Deployment Details page. The Pipeline Run Parameter Input popup window will open.
- Enter or select each item in the Pipeline Run Parameter Input popup window and click the Confirm button to complete the Jenkins job run.
Modifying Blue/Green Deployment
To modify a blue/green deployment, follow these steps:
- Click the Modify button on the Deployment Details page. The Modify Blue/Green Deployment popup window will open.
- Modify the desired items in the Modify Blue/Green Deployment popup window and click the Save button to complete the modification.
Deleting Blue/Green Deployment
To delete a blue/green deployment, follow these steps:
- Click the Delete button on the Deployment Details page. The Delete Blue/Green Deployment popup window will open.
- Select whether to execute the Ingress/Service Deletion Command and click the Confirm button to complete the deletion.
Note
Ingress/Service Deletion Command
- Selected: The Ingress or Service used in the blue/green deployment is actually deleted from the cluster.
- Not selected: The Ingress or Service used in the blue/green deployment is not deleted and remains in the cluster.
4 - Canary Deployment
Users can add canary deployments.
Canary addition refers to setting up two Helm releases to be bundled for canary testing.
Project, Cluster, Release Type, Chart Name, Chart Version, and Development Classification must all be the same for two Helm releases to be bundled.
Getting Started with Canary Deployment
To start using canary deployment, follow these steps:
- Click the Project card on the Main page to go to the Project Dashboard page.
- Click Build/Deployment > Kubernetes Deployment in the left menu to go to the Kubernetes Deployment page.
| Item | Description |
|---|
| Name | Displays the canary name. Click to view detailed information. |
| Cluster | Displays the deployed cluster. |
| (Operation) | Displays the currently operating Helm release. |
| (Canary) | Displays the canary Helm release. |
| Terminate | Terminates the canary. |
Table. Kubernetes Deployment Screen Canary Card Items
- Click the name of the canary you want to use on the Kubernetes Deployment page’s deployment list to go to the Deployment Details page.
Adding a Canary
To add a canary, follow these steps:
Note
Canary is supported in the following environments. Check before adding a canary.
Kubernetes v1.17 or highernginx-ingress v0.29.0 or higher
Guide
To add a canary, you need two Helm releases installed using the same chart.
- Click the Project card on the Main page to go to the Project Dashboard page.
- Click Build/Deployment > Kubernetes Deployment in the left menu to go to the Kubernetes Deployment page.
- Click the Add Canary button at the top right of the Kubernetes Deployment page. The Add Canary popup window opens.
- Enter information in the Add Canary popup window and click the Save button to complete adding the canary.
| Item | Description |
|---|
| Classification | Select development or operation. |
| Canary Name | Enter the canary name. |
| Operation | - Release Name: Select the name of the currently operating Helm release from the list.
- Jenkins Job: Select the Jenkins job for building and deploying the currently operating Helm release from the list.
|
| Canary | - Release Name: Select the name of the next operating Helm release from the list.
- Jenkins Job: Select the Jenkins job for building and deploying the next operating Helm release 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 from the canary annotation provided by nginx-ingress. |
Table. Add Canary Input Items
Note
For detailed guidance on each item of nginx-ingress ingress annotations, see
the next page.
Checking Ingress YAML of Canary
To check the operating Ingress YAML and canary Ingress YAML used by the canary, follow these steps:
- Click the View icon for Operating Ingress YAML or Canary Ingress YAML on the Deployment Details page. The Ingress YAML popup window opens.
- Check the contents in the Ingress YAML popup window and click the OK button to close it.
Managing Jenkins Job of Canary
Viewing Jenkins Job Log
To view the Jenkins job log, follow these steps:
- Click the Log button for the Jenkins job item of the desired release on the Deployment Details page. The Pipeline Log popup window opens.
- Check the log in the Pipeline Log popup window and click the OK button.
Running Jenkins Job
To run a Jenkins job, follow these steps:
- Click the Run button for the Jenkins job item of the desired release on the Deployment Details page. The Pipeline Run Parameter Input popup window opens.
- Enter or select each item in the Pipeline Run Parameter Input popup window and click the OK button to complete running the Jenkins job.
Modifying Canary
To modify a canary, follow these steps:
- Click the Modify button on the Deployment Details page. The Modify Canary popup window opens.
- Modify the desired items in the Modify Canary popup window and click the Save button to complete the modification.
Recovering Canary
When the ingress annotation information of the operating release and canary release does not work normally due to changes in the Helm release, recover it to work again.
To recover a canary, follow these steps:
- Click the Recover button on the Deployment Details page. The Recover popup window opens.
- Click the OK button in the Recover popup window to complete the recovery.
Terminating (Deleting) Canary
To terminate a canary, follow these steps:
- Click the Terminate button on the Deployment Details page. The Terminate Canary popup window opens.
- Select the desired items in the Terminate Canary popup window and click the OK button to complete the termination.
Item | Description |
|---|
| Canary Release | Select the canary release- Ingress Host Reversion: Reverts the ingress host of the Helm release used for the canary to its original value.
- Helm Release Deletion: Deletes the Helm release used for the canary.
|
| Operation Release | Select the operation release- Canary Image Upgrade: Upgrades the operation Helm release to the image used by the canary. You can modify the
Values.yaml file. - No Action: Terminates the canary without changing the operation Helm release.
|
Table. Canary Termination Selection Items
5 - Istio
Note
For a detailed guide on Istio, please refer to the
next page.
The list of Istio Traffic management Objects supported by DevOps Console is as follows:
GatewayVirtual ServiceDestination Rule
Getting Started with Istio
To start using Istio, follow these steps:
- Main page, click on the Project card. Move to the Project Dashboard page.
- In the left menu, click on Build/Deploy > Kubernetes Deploy. Move to the Kubernetes Deploy page.
| Item | Description |
|---|
| Name | Displays the Istio name. Click to view detailed information. |
| Cluster/Namespace | Displays the deployed cluster/namespace. |
| Delete | Deletes the current item. |
Table. Kubernetes Deploy page Istio card item
- On the Kubernetes Deploy page, click on the name of the Istio you want to use. Move to the Istio Details page.
Adding Istio
To add Istio, follow these steps:
- Main page, click on the Project card. Move to the Project Dashboard page.
- In the left menu, click on Build/Deploy > Kubernetes Deploy. Move to the Kubernetes Deploy page.
- On the Kubernetes Deploy page, click the Add Istio button in the top right corner. The Add Istio popup window opens.
- In the Add Istio popup window, enter the information and click the Save button to add Istio.
| Item | Description |
|---|
| Type | Select development or operation. |
| K8S Cluster | Select a K8S cluster. |
| Namespace | Select a namespace. Only namespaces that can use Istio are displayed in the list. |
Table. Add Istio input items
Note
Although you have added Istio, you have not created an Istio object yet, so you cannot use the Istio-related functions yet.
Perform Create Wizard to add Istio object or Object addition to add Istio object to add an Istio object and use it.
Istio Objects
Adding Istio Objects
Using Create Wizard to Add Istio Objects
- On the Istio Details page, click on the Istio Objects tab.
- On the Istio Objects tab, click the Create Wizard button. Move to the Create Wizard page.
Helm Release
This is the step to select the Helm release to be used in Istio.
- On the 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
Istio Gateway is the front-end object that receives traffic from outside.
- On the Create Wizard page, on the Gateway screen, 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 Skip object creation.
- Click the Next button. The Destination Rule screen appears.
| Item | Description |
|---|
| Name Prefix | Specify the prefix name for the Istio Gateway object to be created. |
| Host | Specify the domain of the Gateway object to be accessed from outside. |
Table. Create Wizard Gateway input items
Destination Rule
Destination Rule defines the traffic policy of Istio.
- On the Create Wizard page, on the Destination Rule screen, select whether to create a Destination Rule.
- If you want to create a Destination Rule, enter each item.
- If you do not want to create a Destination Rule, select Skip object creation.
- Click the Next button. The Virtual Service screen appears.
| Item | Description |
|---|
| Name Prefix | Enter the prefix name for the Istio Destination Rule object to be created. |
| Load Balancer | Select the load balancer method.ROUND_ROBIN: Round RobinLEAST_CONN: Last connection continues to be usedRANDOM: Random
|
| Max Connections | Enter the maximum number of allowed connections. |
Table. Create Wizard Destination Rule input items
Virtual Service
Virtual Service plays a role in routing incoming traffic to a service.
- On the Create Wizard page, on the Virtual Service screen, enter each item if you want to create a Virtual Service.
- Click the Complete button to complete the creation of the Istio object using the Create Wizard.
| Item | Description |
|---|
| Name Prefix | Enter the prefix name for the Istio Virtual Service to be created. |
| Prefix-Uri | Enter the prefix URI to route traffic to the corresponding URI. |
| Helm Release Weight | If there are multiple Helm releases, enter the connection weight. The sum of each number must be 100. |
Table. Create Wizard Virtual Service input items
Using Object Addition to Add Istio Objects
- On the Istio Details page, click on the Istio Objects tab.
- On the Istio Objects tab, click the Object Addition button. The Object Addition popup window opens.
- In the Object Addition popup window, enter each item and click the Save button to complete the addition of the Istio object.
| Item | Description |
|---|
| Object | Select the object to be createdGatewayVirtual ServiceDestination Rule
|
| Input | The input items vary depending on each object. Refer to the Create Wizard for input.GatewayVirtual ServiceDestination Rule
|
| Generate | Click the Generate button. A basic Yaml is created in the Yaml area based on the input above. |
| Yaml | Modify the basic Yaml to complete the final Yaml of the object you want to create. |
| Save | Click the Save button to create the object. |
Table. Object addition to add Istio object screen items
Modifying Istio Objects
To modify an Istio object, follow these steps:
- On the Istio Details page, click on the Istio Objects tab.
- On the Istio Objects tab, click on the object you want to modify in the Istio object list. The Object popup window opens.
- In the Object popup window, modify the Yaml and click the Save button to complete the modification of the Istio object.
Deleting Istio Objects
To delete an Istio object, follow these steps:
- On the Istio Details page, click on the Istio Objects tab.
- On the Istio Objects tab, click on the object you want to modify in the Istio object list. The Object popup window opens.
- In the Object popup window, click the Delete button to complete the deletion of the Istio object.
Helm Release
Adding Helm Release
To add a Helm release used in Istio, follow these steps:
- On the Istio Details page, click on the Helm Release tab.
- On the Helm Release tab, click the Add button. The Add Helm Release popup window opens.
- In the Add Helm Release popup window, enter each item and click the Save button to complete the addition of the Helm release.
Deleting Helm Release
To delete a Helm release used in Istio, follow these steps:
- On the Istio Details page, click on the Helm Release tab.
- On the Helm Release tab, select the checkbox of the Helm release you want to delete and click the Delete button.
- In the confirmation popup window, click the Confirm button to complete the deletion of the Helm release.
Deleting Istio
To delete Istio, follow these steps:
- On the Istio Details page, click the Delete button at the bottom right.
- In the confirmation popup window, click the Confirm button to complete the deletion.
6 - ArgoCD
ArgoCD is a software used for GitOps deployment in a Kubernetes environment. Users can set up ArgoCD deployment when creating a project or through the Kubernetes deployment menu.
Getting Started with ArgoCD
To view the details of an ArgoCD application, follow these steps:
- Click the Project card on the Main page. You will be taken to the Project Dashboard page.
- Click the Build/Deploy > Kubernetes Deploy menu on the left. You will be taken to the Kubernetes Deploy page.
- Click the ArgoCD Application Card you want to start. You will be taken to the Deploy Details page.
Category | Item | Description |
|---|
ArgoCD Application | Name | Displays the ArgoCD project name/ArgoCD URL. |
| Git Information | Displays the Git information used for deployment. |
| Cluster/Namespace | Displays the deployed cluster/namespace. |
| App Status | Displays the current status of the app. |
| Deployment Result | Displays the current sync status. |
| Deployment Time | Displays the deployment execution time. |
| Refresh | Clicking the Refresh icon refreshes the current item. The items that change are App Status and Deployment Result. |
| Delete | Deletes the current item. |
| Deployment Details | Edit ArgoCD App Secret | Clicking the Edit Authentication Information icon on the right side of the application name opens a popup window to manage the image secret used for deployment. |
| Go to ArgoCD App | The Application Details screen of the actual ArgoCD tool opens in a new window. |
Table. ArgoCD Application Card and Deployment Details Items
Adding an ArgoCD Application
Creating a New ArgoCD Application using Helm Chart
To create a new ArgoCD application using a Helm chart and add it, follow these steps:
- Click the Project card on the Main page. You will be taken to the Project Dashboard page.
- Click the Build/Deploy > Kubernetes Deploy menu on the left. You will be taken to the Kubernetes Deploy page.
- Click the Create New ArgoCD App button at the top right. You will be taken to the Create New ArgoCD App page.
- Enter the ArgoCD Information and click the Confirm button. The Authentication Information input field will appear.
- Enter the Authentication Information and click the Connection Test button.
- The Application Basic Information and Deployment Target K8S Cluster input fields will appear.
- Enter the Application Name and click the Duplicate Check button.
- Enter the Project Name.
- Select Helm Chart to Create a New Repository as the Repository Type.
- Select the K8S Cluster and Namespace.
- Select the Helm Chart. The Helm Chart information and Helm Chart Git Repository information will appear.
- Modify the contents of the Values.yaml file located in the K8S Cluster Values of the Helm Chart and click the Validation Check button.
- Enter the Helm Chart Git Repository information and click the Connection Test button.
- Enter the Manifest Keys information.
- Click the Create button to complete the creation.
Note
The Deploy Strategy in the Manifest File and Key Information is not a required input value.
| Item | Description |
|---|
| URL Input Method | Select the URL input method.- Select from the list: The registered ArgoCD tool appears.
- Direct Input
|
| ArgoCD URL | Enter the ArgoCD URL and click the Confirm button. |
| Authentication Information | Enter the authentication information and click the Connection Test button. |
| Application Name | Enter the ArgoCD application name and click the Duplicate Check button. |
| Project Name | Enter the project name of the ArgoCD application. |
| Repository Type | Select the repository type.- Create a new repository using Helm Chart: Create a Git repository using Helm Chart for GitOps.
- Use an existing Git repository
|
| K8S Cluster | Select the target cluster for deployment.- Only clusters with access rights can be selected from the DevOps Console K8S cluster.
|
| Namespace | Select the target namespace for deployment.- Only namespaces with access rights can be selected from the selected cluster.
|
| Helm Chart | Select the Helm chart. |
| Helm Chart Git Repository | Enter the information of the Git repository used for Helm Chart. |
| Manifest Key Information | Enter the information for continuous deployment (Manifest file/Key information). |
Table. Create New ArgoCD Application - Helm Chart Creation Settings
Creating a New ArgoCD Application using an Existing Git Repository
To create a new ArgoCD application using an existing Git repository and add it, follow these steps:
- Click the Project card on the Main page. You will be taken to the Project Dashboard page.
- Click the Build/Deploy > Kubernetes Deploy menu on the left. You will be taken to the Kubernetes Deploy page.
- Click the Create New ArgoCD App button at the top right. You will be taken to the Create New ArgoCD App page.
- Enter the ArgoCD Information and click the Confirm button. The Authentication Information input field will appear.
- Enter the Authentication Information and click the Connection Test button.
- The Application Basic Information and Deployment Target K8S Cluster input fields will appear.
- Enter the Application Name and click the Duplicate Check button.
- Enter the Project Name.
- Select Use an Existing Git Repository as the Repository Type.
- Select the K8S Cluster and Namespace.
- Select the Helm Chart. The Helm Chart and Helm Chart Git Repository information will appear.
- Modify the contents of the Values.yaml file located in the K8S Cluster Values of the Helm Chart and click the Validation Check button.
- Enter the Helm Chart Git Repository information and click the Connection Test button.
- Enter the Manifest Keys information.
- Click the Create button to complete the creation.
Note
The Deploy Strategy in the Manifest File and Key Information is not a required input value.
Item | Description |
|---|
| URL Input Method | Select the URL input method.- Select from the list: The registered ArgoCD tool appears.
- Direct Input
|
| ArgoCD URL | Enter the ArgoCD URL and click the Confirm button. |
| Authentication Information | Enter the authentication information and click the Connection Test button. |
| Application Name | Enter the ArgoCD application name and click the Duplicate Check button. |
| Project Name | Enter the project name of the ArgoCD application. |
| Repository Type | Select the repository type.- Create a new repository using Helm Chart: Create a Git repository using Helm Chart for GitOps.
- Use an existing Git repository
|
| K8S Cluster | Select the target cluster for deployment.- Only clusters with access rights can be selected from the DevOps Console K8S cluster.
|
| Namespace | Select the target namespace for deployment.- Only namespaces with access rights can be selected from the selected cluster.
|
| Git Repository | Enter the information of the Git repository where the Manifest information for creating the ArgoCD application is stored. |
| Manifest Keys Information | Enter the information for continuous deployment (Manifest Root path, Manifest type, Manifest file/Key information). |
Table. Create New ArgoCD Application - Existing Git Repository Creation Settings
Adding an Existing ArgoCD Application
To add an existing ArgoCD application, follow these steps:
- Click the Project card on the Main page. You will be taken to the Project Dashboard page.
- Click the Build/Deploy > Kubernetes Deploy menu on the left. You will be taken to the Kubernetes Deploy page.
- Click the Add ArgoCD App button at the top right. You will be taken to the Add ArgoCD App page.
- Enter the ArgoCD URL and click the Confirm button.
- The input screen for the existing application name and authentication information will appear.
- Enter the Existing Application Name and Authentication Information and click the Connection Test button.
Note
If the Git repository linked to the ArgoCD application is not registered in the DevOps Console, the URL Check popup window will open. Follow steps 7-8.
- The URL Check popup window will open to distinguish the Git repository linked to the ArgoCD application.
- Modify the Base URL and click the Confirm button.
- The information of the Git Repository linked to the application will appear.
- Enter the Git Repository Authentication Information and click the Connection Test button.
- Enter the Manifest Keys information.
- Click the Save button to complete the Add ArgoCD Application.
Item | Description |
|---|
| URL Input Method | Select the URL input method.- Select from the list: The registered ArgoCD tool appears.
- Direct Input
|
| ArgoCD URL | Enter the ArgoCD URL and click the Confirm button. |
| Application Name / Authentication Information | Enter the Existing Application Name and Authentication Information and click the Connection Test button. |
| Git Repository Authentication Information | Enter the authentication information of the Git repository used by the selected existing application. |
| Image Repo Key | Enter the YAML file path and key value where the image repository information is recorded. |
| Image Tag Key | Enter the YAML file path and key value where the image tag information is recorded. |
| Image Secret Key | Enter the YAML file path and key value where the image secret information is recorded. |
| Deploy Strategy Key | Enter the YAML file path and key value where the deployment strategy information is recorded. (Not a required value) |
Table. Add Existing ArgoCD Application Settings
Managing ArgoCD Applications
To view the details of an ArgoCD application, follow these steps:
- Click the Project card on the Main page. You will be taken to the Project Dashboard page.
- Click the Build/Deploy > Kubernetes Deploy menu on the left. You will be taken to the Kubernetes Deploy page.
- Click the ArgoCD Application Card you want to start. You will be taken to the Deploy Details page.
To edit the manifest information, follow these steps:
- Click the Git-related Information tab.
- Click the Edit icon next to Manifest Information. The Edit Manifest Key Information popup window will open.
- Modify the manifest key value and click the Save button.
To edit the ArgoCD authentication information, follow these steps:
- Click the Edit icon next to ArgoCD User ID. The Edit Authentication Information popup window will open.
- Modify the authentication information value and click the Save button to complete the modification.
To edit the authentication information of the linked Git repository, follow these steps:
- Click the Edit icon next to Linked Git ID. The Edit Authentication Information popup window will open.
- Modify the authentication information and click the Save button to complete the modification.
Setting Sync
To change the sync setting, follow these steps:
- Click the Sync icon next to Current Sync. The ArgoCD App Sync popup window will open.
- Enter the modified contents and click the Sync button to complete the Sync Setting.
| Item | Description |
|---|
| Revision | Select the target branch for synchronization. |
| Sync Options | Select the synchronization options. |
| Synchronize Resources | Select the synchronization target. |
Table. Sync Settings
Note
For more information about ArgoCD synchronization, refer to the
official website.
Setting Auto-Sync
To change the Auto-Sync setting of an ArgoCD application, follow these steps:
- Click the Edit icon next to Auto-Sync. The Auto-Sync Options popup window will open.
- Modify the contents and click the Save button to complete the setting.
| Item | Description |
|---|
| Prune Resources | Select whether to delete the synchronization target when the Git setting is deleted. |
| Self Heal | Select whether to automatically change the value in the cluster to the value defined in Git when the value of the synchronization target is changed in the cluster. |
Table. Auto-Sync Settings
Managing Application Secrets
If the ArgoCD application was created using a Helm chart, you can add, modify, or delete application secrets.
To start managing application secrets, follow these steps:
- Click the application secret icon to the right of the application name.
- The Application Secret Settings popup window will open.
Adding an Application Secret
To add an application secret, follow these steps:
- Click the Edit icon next to Application Name. The Application Secret Settings popup window will open.
- If you need to add a secret to pull the Chart Image, click the Add button in the Chart Install Secret section.
- If you need to add a secret to pull the App Image during build/deployment, click the Add button in the ImagePull Secret section.
- Enter the contents and click the Save button to complete the addition.
Item | Description |
|---|
| Registry URL | Select the image to use for ImagePull Secret from the image list registered in the image repository. |
| Secret | Select the method of entering ImagePull Secret information.- Auto-generation: Automatically generates ImagePull Secret using the authentication information of the selected image repository in the Docker URL.
- Use an existing secret: Select one of the existing secrets to use as ImagePull Secret.
|
Table. Application Secret Addition Settings
Editing an Application Secret
To edit an application secret, follow these steps:
- Click the Edit icon next to Application Name. The Application Secret Settings popup window will open.
- Click the Name of the secret you want to modify in the application secret list.
- Enter the contents and click the Save button to complete the modification.
Deleting an Application Secret
… (rest of the text remains the same)
To delete an application secret, follow these steps:
- Click the Edit Authentication Information icon next to the Application Name. The Application Secret Settings popup window will open.
- Click the Name of the secret you want to delete from the application secret list.
- Click the Delete button to complete the deletion.
Comparing Values.yaml Files
If you are using an ArgoCD application with Helm charts, you can compare values.yaml files.
To compare the values.yaml files used for each release, follow these steps:
- Click the History tab.
- Click the two revisions you want to compare.
- Click the App Diff button. The App Diff popup window will open.
Rolling Back an Application
To roll back an application to a previous revision, follow these steps:
- Click the History tab.
- Click the Rollback button in the rollback column of the revision you want to roll back. The Rollback popup window will open.
- Click the Confirm button to complete the rollback.
Deleting an Application
To delete an application, follow these steps:
- Click the Delete button at the bottom right. The Application Deletion popup will open.
- Click the Confirm button to complete the deletion.
Note
Deletion only occurs in the DevOps Console, and the actual ArgoCD application is not deleted.