1 - Build Pipeline

Reference
For detailed information about the Jenkins pipeline, refer to the official site.

Users can group consecutive tasks into a single pipeline. The pipeline configured here is created as a Jenkins pipeline.

Starting the Build Pipeline

To start using the build pipeline, 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 > Build Pipeline menu. You will be taken to the Build Pipeline page.

Add Build Pipeline

To add a build pipeline, 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 > Build Pipeline menu. You will be taken to the Build Pipeline page.
  3. Build Pipeline page, click the Add Pipeline button at the top right. You will be taken to the Add Pipeline page.
  4. Add Pipeline Enter or configure each field on the page.
  5. Click the Next button.
    ItemExplanation
    CategorySelect Development or Operations
    Jenkins URLSelect Jenkins from the list to add a build pipeline.
    Build AgentSelect the agent (build environment) on which the build pipeline will run.
    Click the Info icon to view the list of tools provided by the agent.
    Build environment OSDisplays the OS information of the environment where the build agent runs.
    Folder typeSelect the folder type.
    • Existing folder: Add a pipeline under an already created folder in Jenkins.
    • New folder: Create a new folder in Jenkins and add a pipeline under it.
    folderSelect a folder from the list or enter the name of a new folder to create.
    Pipeline namePlease enter the pipeline name.
    Parameter settingSet the parameters to be used in the pipeline.
    Environment variable configurationSet the environment variables to be used in the pipeline.
    Stage SettingsConfigure the stage to be used in the pipeline.
    Configure email recipients for build resultsSet the recipients who will receive the result email after the pipeline completes (success/failure).
    Table. Additional Build Pipeline Settings

Setting Parameters

Follow these steps to set the parameters used when running the pipeline.

  1. Click the Parameter card.
  2. Click the Add button to add a parameter.
  3. Click the Apply button to complete the parameter settings.

Setting Environment Variables

Follow these steps to set environment variables for use in the pipeline.

  1. Click the Environment Variable area. The Environment Variable Registration page opens on the right.
  2. A list of pre-registered environment variables appears, and select the checkboxes for the environment variables you want to use.
  3. Check the selected environment variable and click the Apply button to complete the environment variable configuration.

Setting up the stage

To set up the stages to be used in the pipeline, follow these steps.

  1. Click the New Stage card. The Stage area appears on the right.
  2. In the Stage area, select the tool and Stage type.
  3. Enter the required information according to the stage type and click the Apply button to complete the stage configuration.
Reference
Click the Add icon to add a stage.
For detailed information about stage configuration, see Stage.

Configure email recipients for build results

To set the recipients who will receive the build results by email, follow these steps.

  1. Click the Mail Recipient area. The Add Mail Recipient page opens on the right.
  2. In the Search area, search for the recipient and add them.
  3. Click the Apply button to complete the mail recipient settings.

Check the final pipeline script

  1. Check the build pipeline script that will actually be generated. If needed, edit the script directly.
  2. Click the Complete button to finish adding the pipeline.

Pipeline addition result

  1. The added result appears on the Build Pipeline page.
Note
The added pipeline does not run automatically. If execution is required, run the pipeline manually.

Managing Build Pipelines

Build pipeline list

ItemExplanation
statusDisplays the build pipeline status.
  • Green: Completed successfully
  • Blue (blinking): Running
  • Red: Failed
  • Gray: Others
URLGo to the Build Pipeline page of Jenkins.
Recent build execution history URLNavigate to the Build Execution History page of Jenkins.
logpipeline log The popup window opens.
RunRun the build pipeline.
View moreDisplays additional menu.
  • Edit pipeline
  • Duplicate pipeline
  • Delete pipeline
  • Build history
View pipeline stageWhen you click the Expand icon, the stage view expands.
Table. Build pipeline list view feature

Build Pipeline Credentials

When performing build pipeline actions (run, stop, edit, delete, etc.), user credentials are required, so you may request them from the user as needed.

When integrating IDP with Jenkins

If you are not registered as a Jenkins user, when the User Registration Guide popup appears, click the Go to Jenkins link to sign up or perform your first Jenkins login.

For Jenkins without IDP integration

Jenkins credentials are not stored; when the Add Account popup appears, select Use Existing User or Create New User in Account Type to add credentials.

Run Build Pipeline

To run the build pipeline, follow these steps.

  1. On the Build pipeline page, click the Run button of the build pipeline you want to execute.
  2. If there are parameters, the Pipeline Execution Parameter Input popup window opens.
  3. After entering the required fields, click the Confirm button.
Caution

If the Number of executors setting for the Built-In Node in Jenkins system configuration is set to 1 or higher, a security issue may arise, preventing the pipeline from running.

  • In this case, you need to contact the Jenkins administrator to change the settings.
    • In the Jenkins administration menu, you can enable it by changing the Number of executors item of the Built-In Node to 0.
  • Note Jenkins officially recommends avoiding running builds on the Controller Node.

View build pipeline execution logs

Follow these steps to view the build pipeline execution logs.

  1. On the Build Pipeline page, click the Log button of the build pipeline you want to run.
  2. pipeline log A popup window opens, allowing you to view the execution log.
Reference
If a build pipeline is running, the Pipeline Log popup window refreshes periodically to display the latest logs.

Build pipeline build history view

To view the complete build history of the build pipeline, follow these steps.

  1. On the Build pipeline page, click the More icon of the build pipeline you want to view.
  2. Click the Build History menu. The Build History page opens.
    ItemExplanation
    Config DiffConfig Diff The popup window opens.
    logPipeline Log The popup window opens.
    Additional menuNavigate to the Build Details page.
    View pipeline stageClick the Expand icon to expand the stage view.
    Table. Build Pipeline List View Feature

Compare configuration information

You can compare the configuration information with previous build history using the Config Diff button.

Log View

Through the Log button, you can view the logs of the build history.

Build Details

You can view detailed build information via the More icon.

Modify Build Pipeline

To modify the build pipeline, follow these steps.

  1. On the Build pipeline page, click the More icon of the build pipeline you want to edit.
  2. Click the Edit Pipeline button. You will be taken to the Edit Pipeline page.

Edit the script directly

To edit the pipeline script directly, follow these steps.

  1. In the script editor window of the Pipeline Edit page, directly enter a script that conforms to the syntax supported by Jenkins.
  2. After completing the input, click the Save button to finish editing the pipeline.

Modify using the Script Generator feature

Reference
In the Script Generator feature, only one stage can be set. If you want to edit multiple stages, perform it multiple times.

Follow these steps to modify the pipeline script using the Script Generator feature.

  1. On the Pipeline Edit page, change Script Generator to ON.
  2. Select the build agent and script type.
  3. After completing Stage Setup, click the Create Script button to generate the script.
  4. Refer to the generated script to modify the pipeline, and click the Save button to complete the pipeline modification.
    ItemExplanation
    Script GeneratorTurn the Script Generator feature ON/OFF.
    Script Basic InformationSelect the basic information for script generation.
    Existing scriptThis is an existing script.
    New scriptThis is a new script generated by the Script Generator.
    Script modificationRefer to the newly created script and directly edit the existing script on the left.
    Update Jenkins CredentialIf the newly created script contains new credentials, click the Jenkins Credential Update button. This updates (saves) the credentials in Jenkins.
    K8S Secret updateDeploy to K8S stage: when changing the K8S Secret, click the K8S Secret Update button. Update (save) it for use during Secret creation and deployment.
    Table. Script Generator feature

Clone Build Pipeline

To duplicate the build pipeline, follow these steps.

  1. Click the More icon of the build pipeline you want to clone.
  2. Click the Clone Pipeline menu. The Clone Pipeline popup window opens.
  3. After completing the information entry, click the Save button to finish replicating the pipeline.
    ItemExplanation
    Pipeline replication informationEnter the information for the pipeline to be cloned.
    Pipeline modificationModify the pipeline to be cloned.
    Table. Build Pipeline Replication Feature

Delete Build Pipeline

To delete a build pipeline, follow these steps.

  1. On the Build pipeline page, click the More icon of the build pipeline you want to delete.
  2. Click the Delete Pipeline menu. The Delete Pipeline popup window opens.
  3. Delete Pipeline In the popup window, click the Confirm button to complete the pipeline deletion.
Note

Also delete the pipeline in Jenkins

  • Selection: The pipeline is actually deleted from Jenkins.
  • Unselected: Build pipeline is deleted only from the list and remains in Jenkins.

1.1 - Stage

The user can view the description of stage types and each stage-specific item.

You can configure stages in Add Build Pipeline or Edit Build Pipeline.

Common Items

Stage Settings page is organized as follows.

ItemExplanation
ToolsIf you want to specify and use a particular tool other than the default tools set in the stage, select
  • JDK
  • Maven
  • Git
  • Ant
  • Go
  • Gradle
  • NodeJS
Stage typesSelect the required stage from the list and enter the necessary information.
Stage nameEnter the stage name.
Table. Stage Input Item Configuration

Checkout

This stage executes the checkout command on the Git repository registered in the code repository.

Select Checkout as the stage type.

ItemExplanation
URLSelect the code repository to perform checkout.
Branch nameEnter the branch name to checkout.
Table. Checkout stage input items

Build

This is the stage that executes the command to build the application.

Select Build as the stage type.

ItemExplanation
languageSelect the programming language used by the application.
Build toolSelect the build tool used for building the application.
Provides default Shell commands based on the selected build tool.
Shell commandEnter the command to use for building the application.
All commands available in the Shell can be used.
Table. Build Stage Input Items

Docker Build

This stage performs the Docker image build.

Select Docker Build as the stage type.

item
Explanationexample
Registry URL (docker push)Select the image repository where the Docker build result image will be pushed.
IDThe ID value of the account to be used for the image repository
image tag patternThe Docker image tag is automatically generated according to the selected pattern.
  • {YYYYMMDD}: year, month, and day
  • {HHMMSS}: hour, minute, and second
  • {BUILD_NUM}: the number of the current build pipeline execution
  • {YYYYMMDD}.{HHMMSS}: 20200414.150938
  • {YYYYMMDD}.{BUILD_NUM}: 20220414.13
Add base image repositoryAdd Base Image Repository A popup window opens.
Registry URL (docker pull)Select the image repository for docker pull when the repository providing the Base Image used in the Dockerfile (FROM clause, docker pull) differs from the repository of the Registry URL (docker push).
Image build toolDisplays the image build tool.
Pre-build commandIf there are any commands that need to be run before building a Docker image, write them in shell command format.cp target/*.jar docker/
Image Build folderIf you need to run the Docker image build from a specific folder, select the checkbox and enter the folder path.docker
DockerfileEnter the Dockerfile filename.Dockerfile
Image build optionsEnter it if you need to use additional options with the image build tool.--no-cache
Build commandDisplays the image build command that will actually be executed.
Post-build commandIf there are commands that need to be executed after building a Docker image, write them in Shell command format.rm -rf docker/*.jar
Table. Docker Build Stage Input Items

example script

The build pipeline script generated as a result of the example is as follows.

Example Script
Figure. Docker Build Example Script
ItemExplanation
Pre-build command
Image Build folder
Image build options
Post-build command
Table. Docker Build example script description

Deploy to K8S

This is the stage that performs a Kubernetes deployment.

Select Deploy to K8S as the stage type.

Item
Explanation
typeSelect deployment type
  • Helm release (Helm chart type)
  • Workload
  • ArgoCD
K8S clusterSelect a K8S cluster
  • Helm release (Helm chart type) When selected, a list of Helm releases deployed via the DevOps Console is displayed.
namespacePlease select a namespace.
Helm releaseSelect HelmRelease.
Deployment methodSelect deployment method
  • Recreate
  • Rolling Update
Registry URLSelect the image repository where the image to be deployed to Kubernetes has been docker pushed.
SecretSelect the secret information input method
  • Auto-generate: Automatically create the secret corresponding to the selected image repository from the Registry URL in the DevOps Console and use it.
  • Use existing secret: Use a pre-created secret through K8S secret management.
Table. Deploy to K8S stage input items

Deploy to VM

This is the stage that performs VM deployment.

Select Deploy to VM as the stage type.

ItemExplanation
Deployment configurationSelect deployment configuration method
  • Set deployment target (SSH command/Agent): Deploy using SSH commands or an Agent.
  • Write script manually: The user enters all commands directly to deploy.
deployment groupSelect a deployment group
Release InformationThe contents stored in the deployment group are automatically configured.
Manual deploymentSelect the default value for manual deployment
  • Select the default setting for manual deployment parameters when running the pipeline.
Table. Deploy to VM stage input items

Trigger Build

This is a stage that runs the pipeline remotely.

Select Trigger Build as the stage type.

ItemExplanation
Target pipelineChoose the target pipeline to run remotely.
The selectable items vary depending on whether the pipeline is for development or production.
Parameter informationIt is displayed depending on whether the target pipeline’s parameters are set.
The parameter information entered at pipeline execution time is used.
Table. Trigger Build Stage Input Items

Check Remote Execution Information

Remote execution information (parent/child pipelines) through the Trigger Build stage can be viewed on the Build Details screen.

Other stages

ItemExplanation
ArchiveArchive the application build results. The archived file can be downloaded from Jenkins.
Code QualityThis is the stage for executing the Code Quality step.
CustomThe user directly writes the pipeline script in the desired format.
Table. Other Stage Settings

1.2 - Multibranch Pipeline

Reference
For detailed information about Jenkins multibranch pipelines, refer to the official site.

Users can integrate multiple branches of a code repository through a multibranch pipeline and manage them as a single job.

Starting a Multibranch Pipeline

To start using a multibranch pipeline, 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 > Build Pipeline menu. You will be taken to the Build Pipeline page.

Add a multibranch pipeline

To add a multibranch pipeline, follow these steps.

  1. Click the Project card on the Main page. You will be taken to the Project Dashboard page.
  2. From the left menu, click the Build/Deploy > Build Pipeline menu. You will be taken to the Build Pipeline page.
  3. On the Build Pipeline page, click the Add Multi-branch Pipeline button at the top right. The Add Multi-branch Pipeline popup will open.
  4. Add Multi-branch Pipeline In the popup window, enter each field and click the Save button.
    ItemExplanation
    CategorySelect development or operation
    Jenkins URLSelect the Jenkins to add a multibranch pipeline from the list.
    Folder typeSelect folder type
    • Existing folder: Add a pipeline under a folder that already exists in Jenkins.
    • New folder: Create a new folder in Jenkins and add a pipeline under it.
    Folder nameSelect a folder from the list or enter the name of a new folder to create.
    pipeline namePlease enter the pipeline name.
    Git RepositorySelect the code repository to perform builds per branch.
    Only code repositories registered in the DevOps Console project can be selected.
    Branch filteringYou can filter the branch names to build among the branches registered in the code repository.
    When using filtering, enter the filter condition as a Java regular expression.
    Jenkinsfile pathEnter the path within the code repository of the Jenkinsfile where the pipeline build is defined.
    Table. Multi-branch pipeline additional information input items

Managing Multi-Branch Pipelines

Multi-branch pipeline list

ItemExplanation
Multi-branch icon and labelIcons and labels representing a multibranch pipeline are displayed.
URLNavigate to the Jenkins Multibranch Pipeline page.
Scan logMulti-branch pipeline scan log The popup window opens.
ScanScanning the multibranch pipeline.
View moreDisplays additional menu.
  • Edit pipeline
  • Delete pipeline
  • Build history
Table. Multi-branch pipeline list screen items

Scanning a multibranch pipeline

To scan a multibranch pipeline, follow these steps.

  1. On the Build Pipeline page, click the Scan button of the multibranch pipeline card you want to scan.
  2. Click the Confirm button in the confirmation popup.

View multi-branch pipeline scan logs

To view the scan logs of a multibranch pipeline, follow these steps.

  1. Build Pipeline page, click the Scan Log button of the multibranch pipeline card for which you want to view the scan log. The Multibranch Pipeline Scan Log popup window opens.
  2. Multi-branch pipeline scan log After reviewing the contents in the popup window, click the Confirm button to exit.

View multi-branch pipeline build history

To view the build history for each branch in a multibranch pipeline, follow these steps.

  1. On the Build Pipeline page, click the More icon of the multibranch pipeline card for which you want to view the build history.
  2. Click the Build History menu. You will be taken to the Branch-specific Build History screen of Jenkins. (This feature is not provided in DevOps Console)

Modify multi-branch pipeline

To modify a multibranch pipeline, follow these steps.

  1. On the Build Pipeline page, click the More icon of the multibranch pipeline card you want to edit.
  2. Click the Edit Pipeline menu. You will be taken to the Settings screen of Jenkins. (Feature not provided in DevOps Console)

Delete Multi-branch Pipeline

To delete a multibranch pipeline, follow these steps.

  1. On the Build Pipeline page, click the More icon of the multibranch pipeline card you want to delete.
  2. Click the Delete Pipeline menu. The Delete Pipeline popup window opens.
  3. In the Delete Pipeline popup, select whether to Delete the pipeline in Jenkins as well, and click the Confirm button.
Reference

Delete the pipeline in Jenkins as well.

  • Selection: The pipeline is actually deleted in Jenkins.
  • Unselected: Build pipeline is deleted only from the list and remains in Jenkins.

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

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

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

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

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

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

3 - VM Deployment

Users can register and manage VM deployment through DevOps Console.
Before registering a VM deployment, an available VM server group(VM server group) must exist, and the registered VM deployment can be used in the build pipeline (Deploy to VM).
Users can differentiate deployment methods using icons.

  • (SSH 방식) VM 배포 (SSH method) VM deployment
  • (Agent 방식) VM 배포 (Agent mode) VM deployment
Note
Differences by deployment method: Table. SSH method vs Agent method

Start VM deployment

To start VM deployment, follow these steps.

  1. Click the Project card on the Main page. You will be taken to the Project Dashboard page.
  2. From the left menu, click the Build/Deploy > VM Deploy menu. You will be taken to the VM Deploy page.
    ItemExplanation
    Deployment group nameDisplays the name of the deployment group.
    VM deployment result(Success)/(Total): Displays the number of VM servers targeted for deployment and the number of VM servers successfully deployed.
    • Green: All successful
    • Blue: In progress
    • Red: Partial failure
    • Gray: Ready, Stopped
    Deployment timeDisplays the deployment time.
    DeleteDelete the VM deployment.
    Table. VM deployment display items

Add VM deployment

To add a VM deployment, follow these steps.

  1. Click the Project card on the Main page. You will be taken to the Project Dashboard page.
  2. From the left menu, click the Build/Deploy > VM Deploy menu. You will be taken to the VM Deploy page.
  3. VM Deployment page, click the Add VM Deployment button in the top right. The Add VM Deployment popup opens.
  4. Add VM deployment After entering the information in the popup window, click the Save button.
    ItemExplanation
    deployment groupPlease enter the deployment group name.
    Execution methodSelect the execution mode.
    • File transfer and command execution: Choose this when you typically deploy files to a VM.
    • Execute command only: Choose this when you run only commands without transferring files to the VM (e.g., Docker commands).
    Deployment methodSelect deployment method
    Deployment orderIf there are multiple target servers, choose whether to deploy in parallel or sequentially.
    Deployment target VMSet the deployment target server.
    • Click the Settings button to open the Configure Deployment Target VM popup.
    Command before file deploymentWrite the commands that need to be executed before file distribution.
    File to send
    • Source: Enter the file path after the build pipeline execution directory (Jenkins workspace).
    • Target: Enter the path where the file will be deployed on the VM server.
    • Add button can be used to add files.
    Command after file distributionWrite the commands to be executed after file deployment.
    Automatic restore settingSelect whether to enable automatic rollback
    • If the deployment fails, it will be rolled back to the most recent successful deployment.
    • Deployment method is enabled when it is Agent.
    Artifact repositorySelect whether to use the artifact repository for rollback.
    • deployment method is activated when it is Agent.
    Repository nameOnly exposed when using an artifact repository.
    • A list of already registered artifact repository is displayed
    Table. Additional Input Items for VM Deployment
Note

Deployment Target VM Settings The popup window displays the server groups you have access to.

For more details, refer to the VM Server Group.

VM Deployment Details

To view the detailed information of the VM deployment, 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 > VM Deploy menu. You will be taken to the VM Deploy page.
  3. On the VM deployment page, in the VM deployment list, click the VM deployment you want to view in detail. You will be taken to the VM deployment details page.
  4. In the History tab, click the server list. The Deployment Details popup opens.
  5. Deployment Details You can view the detailed history in the popup window.
  6. When you click the Log button of the execution pipeline, the Pipeline Log popup window opens.
  7. Pipeline Log You can view detailed logs in the popup window.
  8. In the history list for each deployment server, click the Log button of the server whose logs you want to view, and the VM Agent Log popup window will open.
  9. VM Agent log You can view detailed logs in the popup window.
    ItemExplanation
    Stop / Start DeploymentStop, Start Deployment button becomes active.
    rollbackYou can roll back to a previous version.
    History tabDeployment history is displayed.
    Pipeline Information tabThe build pipeline information associated with this VM deployment is displayed.
    logYou can view the logs of the build pipeline.
    Table. VM deployment detail screen items
    ItemExplanation
    Execution pipeline logYou can view the logs of the build pipeline.
    History logs per deployment serverYou can view the deployment agent’s logs.
    • Only displayed for AGENT type
    Table. Deployment Detail Screen Items

Delete VM deployment

Delete from list

To delete a VM deployment, follow these steps.

  1. Click the Project card on the Main page. You will be taken to the Project Dashboard page.
  2. From the left menu, click the Build/Deploy > VM Deploy menu. You will be taken to the VM Deploy page.
  3. On the VM deployment page, click the X icon of the VM deployment you want to delete from the list.
  4. In the confirmation popup, click the Confirm button to complete the deletion of the VM deployment.

Delete on the detail page

To delete a VM deployment, follow these steps.

  1. Main page, click the Project card. You will be taken to the Project Dashboard page.
  2. From the left menu, click the Build/Deploy > VM Deploy menu. You will be taken to the VM Deploy page.
  3. On the VM deployment page, click the VM deployment you want to delete from the VM deployment list. You will be taken to the VM deployment details page.
  4. On the VM Deployment Details page, click the Delete button.
  5. Click the Confirm button in the confirmation popup to complete the VM deployment deletion.

Using environment variables in VM deployment commands

You can use environment variables in the pre‑deployment command, post‑deployment command, source path of the file to be transferred, and target path of the file to be transferred.

You can use the $ placeholder or ${} placeholder within commands to access environment variables in the build pipeline.

Color mode
echo ${BUILD_NUMBER}
echo $JOB_NAME
echo ${BUILD_NUMBER}
echo $JOB_NAME
Example of using environment variables

If you want to refer to the environment variables of the VM server where the command runs, add a \.

Color mode
echo \${PATH}
echo \$LANG
echo \${PATH}
echo \$LANG
Reference example of environment variables for a VM server

Stop VM deployment

On the Deployment Details page, you can stop a VM deployment that is in progress. Clicking the Stop button in the recent deployment status area of the Deployment Details page will stop the VM deployment.

The states in which deployment can be halted are listed in the table below, and the Stop button is displayed only when in those states.

method
status value
Explanation
SSHrequestThe build pipeline is running.
AGENTrequestThe build pipeline is running.
AGENTBuild completeWhen the build pipeline is completed
  • When running the build pipeline, you must set the manual_deploy parameter value to use and execute it. If not used, it will immediately change to the ready state.
  • The Start Deployment button becomes active, and clicking it changes the state to ready.
  • In Release Management, you can change to the ready state using the VM deployment task.
AGENTReadyAfter the build pipeline completes, the AGENT is ready to perform deployment.
AGENTIn progressAGENT is currently executing a deployment.
Table. State where deployment can be paused

Understanding VM deployment status values

Deployment Details page lets you check the current status of the VM deployment.

status value
Explanation
Not executedNever run since its initial creation
requestThe build pipeline is running.
SuccessBuild/deployment succeeded
FailureFailed state during build or deployment
Table. Description of SSH deployment status values
status value
Explanation
Not executedNever executed after initial creation
requestThe build pipeline is running.
Build completeWhen the build pipeline is completed
  • When running the build pipeline, you must set the manual_deploy parameter value to use and execute it. If not used, it will immediately change to the ready state.
  • Start Deployment button becomes active, and clicking it changes to the ready state.
  • In Release Management, you can change to the ready state using the VM deployment task.
ReadyAfter the build pipeline completes, the AGENT is ready to perform deployment.
In progressAGENT is currently executing a deployment.
SuccessBuild/deployment succeeded
FailureFailed state during build or deployment
StopBuild or deployment is in a paused state
  • Pause button can be clicked to pause when it is enabled.
Table. AGENT deployment status value description

4 - Helm Install

Users can use the Helm Install menu to view and install project charts, project group charts, tenant charts, and system charts.

Getting Started with Helm Install

To begin using Helm Install, follow the steps below.

  1. Click the Project card on the Main page. You will be taken to the Project Dashboard page.
  2. From the left menu, click the Build/Deploy > Helm Install menu. The Helm Install page opens.
    ItemExplanation
    K8S clusterSelect the K8S cluster to be the target of the Helm install.
    The Helm chart list below shows only the Helm charts that can be installed on the selected K8S cluster.
    Chart nameDisplays the chart name.
    Chart repositoryDisplays information about the chart repository where the Helm chart files are stored.
    Table. Helm install screen items

Helm Chart Details

To view the Helm chart details, follow these steps.

  1. On the Main page, click the Project card.
  2. From the left menu, click the Build/Deploy > HelmInstall menu. The HelmInstall page opens.
  3. On the Helm Install page, select the K8S cluster you want to install. A list of Helm charts belonging to that cluster will be displayed.
  4. From the Helm chart list, click the Helm chart card you want to view in detail. The Helm chart details page opens.

Helm Chart Details

ItemExplanation
VersionIf there are multiple versions, you can select the desired version.
DownloadYou can download the Helm chart file to the user’s PC.
helm installYou can install Helm.
Table. Helm Chart Detail Screen Items

Summary tab

Displays the README.md file included in the Helm chart. You can view the information provided by the chart author.

Values.yaml tab

Displays the values.yaml file included in the Helm chart. You can view the values that can be modified in the chart before running helm install.

Details tab

Item
Explanation
Helm chart repository informationDisplays the repository where the Helm chart is stored.
Api VersionDisplays the API version of the Helm chart.
  • v1
  • v2
Support CI/CDWhen creating a build pipeline, the Deploy to K8S stage indicates whether the Helm chart type can be selected as a Helm release.
Allow new installation?
  • Y: New installation (helm install) is possible.
  • N: Currently, new installation (helm install) is not possible with the helm chart, and only the use of existing installed helm releases is allowed.
Image in the chartDisplays the image information used in the Helm chart.
Table. Detailed Information Tab View Items

Install Helm

To install Helm, follow these steps.

  1. On the Helm Install page, select the K8S cluster you want to install in the K8S cluster field. A list of Helm charts belonging to that cluster will be displayed.
  2. On the Helm Install page, click the Helm chart card you want to view in detail. The Helm Chart Details page opens.
  3. On the Helm Chart Details page, click the Helm Install button. The Helm Install page opens.
  4. On the Helm Install page, fill in each field on the screen and click the Next button. The Helm Chart Install popup opens.
  5. Helm chart installation Check the contents in the popup window and click the Run button to complete the Helm installation.
  6. When the installation is complete, the Kubernetes deployment page opens automatically.
    Item
    Explanation
    Release nameEnter the name to be used in Helm.
    It must be unique and cannot be duplicated within the namespace.
    CategoryDevelopment, Operations
    VersionSelect the version of the chart you want to install with Helm.
    K8S clusterDisplays the target K8S cluster for helm install.
    Changes are not allowed; if you wish to change, select the K8S cluster in Start Helm Install.
    NamespaceSelect the target namespace for the helm install from the list.
    Reference informationReference information provided by the selected K8S cluster.
    You can click each tab to view detailed information.
    included in the chart
    default Values.yaml
    You can edit the values.yaml file to run helm install with the desired values.
    If needed, refer to the reference information and modify values.yaml with those values.
    Table. Common Helm chart installation screen items
    Item
    Explanation
    Release nameEnter the name to be used in Helm.
    It must be unique and cannot be duplicated within the namespace.
    CategoryDevelopment, Operations
    VersionSelect the version of the chart you want to install with Helm.
    K8S clusterDisplays the target K8S cluster for helm install.
    Changes are not possible, and if you wish to change, select a K8S cluster in Start Helm Install.
    namespaceSelect the target namespace for helm install from the list.
    Reference informationThis is reference information provided by the selected K8S cluster. You can click each tab to view detailed information.
    Default Values.yaml included in the chart
    You can edit the values.yaml file and run helm install with the desired values.
    If needed, refer to the reference information and modify values.yaml with those values.
    Writing type
    • Form: Enter the items displayed on the screen. Form-type items are displayed only for Helm charts that support form input. For creating Helm charts that support form input, refer to Creating Helm Charts that Support Form Input.
    • Values.yaml: Modify the values in the same YAML editor screen as a typical Helm chart.
    Form and Values.yaml inputs can be switched, but switching will reset any previously entered content.
    Form inputThis is the screen displayed when you select Form in the creation type; review each item and enter values. After completing the input, click the Validation Check button to validate the entered values.
    Table. Helm chart installation screen items that support Form input

5 - Ingress/Service Management

Users can add and manage Ingress/Service using the DevOps Console.

Getting Started with Ingress/Service Management

To start managing Ingress/Service, 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 > Ingress/Service Management menu in the left menu. You will be taken to the Ingress/Service Management page.

Ingress management

  1. On the Ingress/Service Management page, click the Ingress tab.
  2. Select K8S cluster and namespace in the Ingress tab. The list of Ingresses belonging to the selected namespace will be displayed.

Ingress

Reference
Not all Ingresses created in the namespace are displayed; only the Ingresses created from the DevOps Console are shown.
ItemExplanation
K8S clusterSelect a K8S cluster from the list.
NamespaceSelect a namespace from the list. Ingresses created in the selected namespace will be displayed.
Ingress listDisplays the list of Ingresses.
SearchYou can search for Ingress.
AddYou can add an Ingress.
Table. Ingress management screen items

Add Ingress

To add an Ingress, follow these steps.

  1. Click the Add button on the Ingress tab. The Add Ingress popup window opens.
  2. Add Ingress After entering the information in the popup window, click the Confirm button.
  3. Click the Confirm button in the confirmation popup to complete adding the Ingress.
    ItemExplanation
    Ingress namePlease enter the Ingress name.
    K8S clusterSpecifies the K8S cluster where the Ingress will be created.
    NamespaceSpecifies the namespace where the Ingress will be created.
    ServiceSelect the Service that Ingress will use as a target from the list of Services.
    RulesEnter the Host, Path, and Service Port to configure in the Ingress.
    Click Add to input multiple entries.
    Table. Additional Ingress Input Items

Ingress Details

To view the detailed information of an Ingress, follow the steps below.

  1. Click the Ingress you want to view in the Ingress tab. Navigate to the Ingress Details page.
  2. On the Ingress Details page, view the detailed information of the Ingress.
  3. When you click the View icon, the Ingress YAML popup window opens.
  4. Ingress YAML In the popup window, you can view the Ingress YAML content.

Edit Ingress

Caution
The Ingress used in blue/green deployments and canary cannot be modified.

To modify the Ingress, follow these steps.

  1. In the Ingress tab, click the Ingress you want to edit. You will be taken to the Ingress Details page.
  2. On the Ingress Details page, click the Edit button. The Ingress Edit popup opens.
  3. Ingress Edit In the popup window, edit the Ingress information and click the Confirm button.
  4. In the confirmation popup, click the Confirm button to complete the Ingress modification.

Delete Ingress

Caution
Ingress used in blue/green deployments and canary cannot be deleted.

To delete an Ingress, follow these steps.

  1. In the Ingress tab, click the Ingress you want to delete. You will be taken to the Ingress Details page.
  2. On the Ingress Details page, click the Delete button.
  3. In the confirmation popup, click the Confirm button to complete the Ingress deletion.

Service Management

  1. On the Ingress/Service Management page, click the Service tab.
  2. In the Service tab, select the K8S cluster and namespace. The list of Services belonging to the selected namespace will be displayed.

Service

Reference
Not all Services created in the namespace are displayed; only the Services created from the DevOps Console are shown.
ItemExplanation
K8S clusterSelect a K8S cluster from the list.
namespaceSelect a namespace from the list. Services created in the selected namespace will be displayed.
Service ListDisplays the list of services.
searchYou can search for Service.
AddYou can add a Service.
External Endpoint information iconIf there is related additional information, display it.
Table. Service Management Screen Items

Add Service

To add a Service, follow these steps.

  1. Click the Add button in the Service tab. The Service Add popup opens.
  2. Add Service After entering the information in the popup window, click the Confirm button.
  3. In the confirmation popup, click the Confirm button to complete adding the Service.
    ItemExplanation
    Service namePlease enter the service name.
    K8S clusterDisplays the K8S cluster where the Service will be created.
    namespaceSpecifies the namespace where the Service will be created.
    typeSelect the Service type
    • ClusterIP
    • NodePort
    • LoadBalancer
    DeploymentSelect the Deployment that will be the Service’s target from the list.
    PortsEnter the Port Name, Port, Target, and Protocol that the Service will use.
    Click the Add button to input multiple entries.
    Table. Service addition input fields

Service Details

To view the Service details, follow these steps.

  1. On the Service tab, click the Service you want to view in detail. You will be taken to the Service Details page.
  2. Service Details page shows detailed information.
  3. Click the View icon to open the Service YAML popup window.
  4. Service YAML You can view the Service YAML content in the popup window.

Edit Service

Caution
The Service used in blue/green deployments cannot be modified.

To modify the Service, follow these steps.

  1. In the Service tab, click the Service you want to edit. Go to the Service Details page.
  2. On the Service Details page, click the Edit button. The Service Edit popup window opens.
  3. Service Edit In the popup window, edit the Service information and click the Confirm button.
  4. In the confirmation popup, click the Confirm button to complete the Service edit.

Delete Service

Caution
The Service used in blue/green deployments cannot be deleted.

To delete a Service, follow the steps below.

  1. On the Service tab screen, click the Service you want to edit. You will be taken to the Service Details page.
  2. On the Service Details page, click the Delete button.
  3. Click the Confirm button in the confirmation popup to complete the Service deletion.

6 - Kubernetes Secret Management

Users can view secrets created in a namespace. In addition, they can create and delete secrets.

Getting Started with Kubernetes Secret

To start managing Kubernetes Secrets, follow the steps below.

  1. 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 Secret Management menu. You will be taken to the Kubernetes Secret Management page.
    ItemExplanation
    K8S clusterSelect a K8S cluster from the list.
    namespaceSelect a namespace from the list. Secrets created in the selected namespace will be displayed.
    Secret ListDisplays the list of secrets.
    searchYou can search for secrets.
    Detailed filterYou can perform detailed searches by using the detailed filter.
    AddYou can add a secret.
    Table. Kubernetes Secret Management Screen Items

Add secret

Note
In Kubernetes Secret management, the only secret you can add is the Docker config secret, and other secrets cannot be added on the current screen.
Docker Config Secret is a secret used to store Docker registry credentials for an image.

Follow these steps to add a Kubernetes Secret.

  1. Select K8S Cluster on the Kubernetes Secret Management page.
  2. Select namespace.
  3. Click the Add button. The Add Secret popup opens.
  4. Add Secret Enter the information in the popup window and click the Connection Test button.
  5. If Connection Test succeeds, click the Save button.
  6. In the confirmation popup, click the Confirm button to complete the addition.
    ItemExplanation
    K8S clusterDisplays the K8S cluster where the secret will be created.
    NamespaceSpecifies the namespace where the secret will be created.
    Image repository URLSelect the image repository to use in Secret.
    Secret nameEnter the secret name.
    Select authentication information
    • Use new credentials: Enter new credentials.
    • Use saved credentials: Choose one of the previously used credentials.
    Table. Input fields for adding a secret

View Secret Details

To view the secret details, follow these steps.

  1. Kubernetes Secret Management On the page, click the secret whose details you want to view. Secret Details popup window opens.
  2. Secret Details View the secret’s detailed information in the popup window.

Delete secret

To delete the secret, follow these steps.

  1. Kubernetes Secret Management On the page, select the checkbox of the secret you want to delete.
  2. Click the Delete button.
  3. In the confirmation popup, click the Confirm button to complete the deletion.

7 - Environment Variable Management

Users can add frequently used parameters and credentials as environment variables for use when creating a build pipeline.

Getting Started with Environment Variable Management

Follow these steps to manage environment variables used in the build pipeline.

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

Adding environment variables

Add parameter environment variable

Parameter environment variables act as Linux Environment variables and are used in the NAME=VALUE format.

To add a parameter environment variable, follow these steps.

  1. On the Environment Variable Management page, click the Add button. The Add Environment Variable popup window opens.
  2. Add environment variable In the popup window, select the type as parameter.
  3. After entering the information, click the Save button.
  4. In the confirmation popup, click the Confirm button to complete the addition.
    ItemExplanation
    NamePlease enter the parameter name.
    valuePlease enter the parameter value.
    ExplanationEnter a description for the user to refer to.
    Table. Parameter environment variable addition input items

Add authentication credentials environment variable

The authentication environment variable stores credentials for use. You can pre-register and share credentials so they can be easily used in stages that require authentication (preventing duplicate entry).

To add authentication environment variables, follow these steps.

  1. On the Environment Variable Management page, click the Add button. The Add Environment Variable popup window opens.
  2. Add Environment Variable In the popup window, select the type as “Authentication Information”.
  3. After entering the information, click the Save button.
  4. In the confirmation popup, click the Confirm button to complete the addition.
    ItemExplanation
    NameEnter the name of the credential.
    CategorySelect a category value
    • Development: Credentials can be used only in build pipelines of type Development.
    • Production: Credentials can be used only in build pipelines of type Production.
    Authentication typePlease select an authentication type.
    IDPlease enter your ID.
    Password/Private KeyEnter the password or private key according to the authentication type.
    ExplanationEnter a description for the user to refer to.
    Table. Parameter Environment Variable Additional Input Fields

Modify environment variables

To modify environment variables, follow these steps.

  1. On the Environment Variable Management page, click the environment variable you want to edit. The Edit Environment Variable popup will open.
  2. Edit Environment Variables In the popup window, modify the desired items and click the Save button.
  3. In the confirmation popup, click the Confirm button to complete the addition.

Delete environment variable

To delete an environment variable, follow these steps.

Delete from list

  1. On the Environment Variable Management screen, select the checkbox of the environment variable you want to delete.
  2. Click the Delete button on the Environment Variable Management screen.
  3. In the confirmation popup, click the Confirm button to complete the deletion.

Delete in the environment variable edit popup

  1. Environment Variable Management screen, click the environment variable you want to delete. Environment Variable Edit popup window opens.
  2. Edit Environment Variable in the popup window, click the Delete button.
  3. Click the Confirm button in the confirmation popup to complete the deletion.