1 - Build Pipeline

Note
For more information about Jenkins pipeline, please refer to the official website.

Users can combine a series of tasks into a pipeline. The pipeline configured here is created as a Jenkins pipeline.

Getting Started with Build Pipeline

To start using the build pipeline, follow these steps.

  1. Main page, click the Project card. Move to the Project Dashboard page.
  2. Click the Build/Deploy > Build Pipeline menu on the left. Move to the Build Pipeline page.

Adding a Build Pipeline

To add a build pipeline, follow the procedure below.

  1. Main page, click the Project card. Move to the Project Dashboard page.
  2. Click the Build/Deployment > Build Pipeline menu in the left menu. Move to the Build Pipeline page.
  3. On the Build Pipeline page, click the Add Pipeline button at the top right. Move to the Add Pipeline page.
  4. Enter/set each item on the Add Pipeline page.
  5. Click the Next button.
ItemDescription
ClassificationSelect development or operation classification
Jenkins URLSelect Jenkins to add a build pipeline from the list.
Build AgentSelect the agent (build environment) where 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 existing 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 the new folder to be created.
Pipeline NameEnter the pipeline name.
Parameter SettingSet the parameters to be used in the pipeline.
Environment Variable SettingSet the environment variables to be used in the pipeline.
Stage SettingSet the stages to be used in the pipeline.
Build Result Email Recipient SettingSet the recipient to receive the result email after the pipeline is completed (success/failure).
Table. Build Pipeline Addition Setting Items

Setting Parameters

To set parameters to use when running a pipeline, follow these steps:

  1. Parameters card should be clicked.
  2. Add button should be clicked to add parameters.
  3. Apply button should be clicked to complete parameter settings.

Setting Environment Variables

To set environment variables to be used in the pipeline, follow the procedure below.

  1. Environment Variables section, click. The Environment Variable Registration page opens on the right.
  2. A list of pre-registered Environment Variables appears, and select the checkbox of the environment variable to be used.
  3. Check the Selected Environment Variables and click the Apply button to complete the environment variable setting.

Setting Stages

To set up 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 necessary information according to the stage type and click the Apply button to complete the stage setup.
Note
You can add stages by clicking the Add icon.
For more information about stage settings, see Stage.

Setting Build Result Email Recipients

To set up the recipient to receive the build result by email, follow the procedure below.

  1. Email Recipient area, click. The Add Email Recipient page opens on the right.
  2. In the Search area, search for and add the recipient.
  3. Click the Apply button to complete the email recipient setting.

Checking the Final Pipeline Script

  1. Check the actual build pipeline script to be created. Modify the script directly if necessary.
  2. Click the Complete button to complete adding the pipeline.

Pipeline Addition Result

  1. The added result appears on the Build Pipeline page.
Note
The added pipeline will not be executed automatically. If execution is required, run the pipeline directly.

Managing Build Pipelines

Build Pipeline List

ItemDescription
StatusDisplays the status of the build pipeline.
  • Green: Normal execution completed
  • Blue (flashing): Running
  • Red: Failed
  • Gray: Others
URLMoves to the Jenkins Build Pipeline page.
Recent Build Execution History URLMoves to the Jenkins Build Execution History page.
LogOpens the Pipeline Log popup window.
RunRuns the build pipeline.
MoreDisplays additional menus.
  • Edit Pipeline
  • Clone Pipeline
  • Delete Pipeline
  • Build history
Pipeline Stage ViewClick the Expand icon to expand the stage view.
Table. Build Pipeline List View Function

Build Pipeline Authentication

When performing build pipeline actions (execution, stop, modification, deletion, etc.), user authentication information may be required, so it may be requested from the user in some cases.

IDP-Linked Jenkins

If you are not registered as a Jenkins user, a User Registration Guide popup window opens, click the Go to Jenkins link to proceed with User Registration or Jenkins Initial Login.

IDP-Unlinked Jenkins

If Jenkins authentication information is not stored, a Add Account popup window opens, select Existing User Use or New User Creation in Account Type to add authentication information.

Running a Build Pipeline

To run a build pipeline, follow these steps.

  1. On the Build Pipeline page, click the Run button of the build pipeline you want to run.
  2. If there are parameters (parameters), the Pipeline Run Parameter Input popup window opens.
  3. Enter the necessary items and click the OK button.
Caution

If the Number of executors item in the Built-In Node of Jenkins system settings is set to 1 or more, pipeline execution may not be possible due to security issues.

  • In this case, you need to contact the Jenkins administrator to change the settings.
    • You can use it by changing the Number of executors item of the Built-In Node in the Jenkins management menu to 0.
  • Note Jenkins officially recommends avoiding build execution on the Controller Node.

Viewing Build Pipeline Execution Logs

To view the build pipeline execution log, follow these steps.

  1. On the Build Pipeline page, click the Log button of the build pipeline you want to run.
  2. The Pipeline Log popup window opens, and you can check the execution log.
Note
If the build pipeline is running, the Pipeline Log popup window is refreshed periodically to display the latest log.

Viewing Build Pipeline Build History

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

  1. On the Build Pipeline page, click the More icon of the build pipeline you want to check.
  2. Click the Build History menu. The Build History page opens.
ItemDescription
Config DiffOpens the Config Diff popup window.
LogOpens the Pipeline Log popup window.
More MenuMoves to the Build Details page.
Pipeline Stage ViewClick the Expand icon to expand the stage view.
Table. Build Pipeline List View Function

Comparing Settings

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

Viewing Logs

You can check the log of the build history using the Log button.

Viewing Build Details

You can check the build details by clicking the More icon.

Modifying a Build Pipeline

To modify a build pipeline, follow these steps.

  1. On the Build Pipeline page, click the More icon of the build pipeline you want to modify.
  2. Click the Pipeline Modification button. Move to the Pipeline Modification page.

Modifying the Script Directly

To modify the pipeline script directly, follow these steps.

  1. In the script editor window on the Pipeline Modification page, enter the script directly in the syntax supported by Jenkins.
  2. After entering, click the Save button to complete the pipeline modification.

Modifying Using the Script Generator Function

Note
The Script Generator function can only set one stage at a time. If you want to modify multiple stages, perform multiple times.

To modify the pipeline script using the Script Generator function, follow these steps.

  1. On the Pipeline Modification page, change the Script Generator to ON.
  2. Select the Build Agent and Script Type.
  3. Proceed with the Stage Setting and click the Script Generation 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.
ItemDescription
Script GeneratorTurn the Script Generator function ON/OFF.
Script Basic InformationSelect the basic information for script generation.
Existing ScriptExisting script.
New ScriptNew script generated through the Script Generator.
Script ModificationModify the existing script on the left by referring to the new script generated.
Jenkins Credential UpdateIf there is new authentication information in the newly generated script, click the Jenkins Credential Update button. Update (save) the authentication information to Jenkins.
K8S Secret UpdateIn the case of the Deploy to K8S stage, if the K8S Secret is changed, click the K8S Secret Update button. Update (save) the Secret to be used when creating and deploying.
Table. Script Generator Function

Cloning a Build Pipeline

To clone a build pipeline, follow these steps.

  1. Click the More icon of the build pipeline you want to clone.
  2. Click the Clone Pipeline menu. Opens the Clone Pipeline popup window.
  3. Enter the information and click the Save button to complete the pipeline clone.
ItemDescription
Pipeline Clone InformationEnter the information of the pipeline to be cloned.
Pipeline ModificationModify the pipeline to be cloned.
Table. Build Pipeline Clone Function

Deleting a 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 Pipeline Deletion menu. The Pipeline Deletion popup window opens.
  3. In the Pipeline Deletion popup window, click the OK button to complete the pipeline deletion.
Note

Jenkins pipeline is also deleted together

  • Selected: The pipeline is actually deleted from Jenkins.
  • Not selected: Only deleted from the Build Pipeline list and remains in Jenkins.

1.1 - Stage

The user can check the description of stage types and each stage item.

You can set up a stage in Add Build Pipeline or Modify Build Pipeline.

Common Items

The Stage Setting page is composed as follows.

ItemDescription
ToolsUsed to select and use specific tools other than the default tools set in the stage
  • JDK
  • Maven
  • Git
  • Ant
  • Go
  • Gradle
  • NodeJS
Stage TypeSelect the required stage from the list and enter the necessary information.
Stage NameEnter the stage name.
Table. Stage Input Item Composition

Checkout

This stage performs the checkout command in the Git repository registered in the code repository.

Select Checkout as the stage type.

ItemDescription
URLSelect the code repository to perform the checkout command.
Branch NameEnter the branch name to checkout.
Table. Checkout Stage Input Items

Build

This stage executes the command to build the application.

Select Build as the stage type.

ItemDescription
LanguageSelect the programming language used by the application.
Build ToolSelect the build tool used to build the application.
A basic shell command is provided depending 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 builds a Docker image.

Select Docker Build as the stage type.

Item
DescriptionExample
Registry URL (docker push)Select the image repository where the completed Docker build result image will be pushed.
IDID value of the account to be used in the image repository
Image Tag PatternThe Docker image tag will be automatically generated based on the selected pattern.
  • {YYYYMMDD}: year, month, day
  • {HHMMSS}: hour, minute, second
  • {BUILD_NUM}: current build pipeline execution number
  • {YYYYMMDD}.{HHMMSS}: 20200414.150938
  • {YYYYMMDD}.{BUILD_NUM}: 20220414.13
Add Base Image RepositoryThe Add Base Image Repository popup window will open.
Registry URL (docker pull)If the image repository providing the base image (Dockerfile’s FROM clause, docker pull) used in the Dockerfile and the image repository of the Registry URL (docker push) are different, select the image repository for docker pull.
Image Build ToolDisplays the image build tool.
Pre-build CommandIf there are commands that must be executed before building the Docker image, write them in Shell command format.cp target/*.jar docker/
Image Build FolderIf the Docker image build needs to be executed in a specific folder, select the checkbox and enter the folder path.docker
DockerfileEnter the Dockerfile file name.Dockerfile
Image Build OptionsIf additional options are required for the image build tool, enter them.--no-cache
Build CommandDisplays the actual image build command to be executed.
Post-build CommandIf there are commands that must be executed after building the Docker image, write them in Shell command format.rm -rf docker/*.jar
Table. Docker Build Stage Input Items

Example Script

The resulting build pipeline script from the example is as follows.

Example Script
Figure. Docker Build Example Script
ItemDescription
Pre-build command
Image build folder
Image build option
Post-build command
Table. Docker Build Example Script Description

Deploy to K8S

This stage deploys to Kubernetes.

Select Deploy to K8S as the stage type.

Item
Description
TypeSelect deployment type
  • Helm Release (Helm Chart Type)
  • Workload
  • ArgoCD
K8S ClusterSelect K8S cluster
  • Helm Release (Helm Chart Type) selection will display a list of Helm releases deployed through DevOps Console.
NamespaceSelect namespace.
Helm ReleaseSelect Helm release.
Deployment MethodSelect deployment method
  • Recreate
  • Rolling Update
Registry URLSelect the image repository where the image to be deployed to Kubernetes is docker pushed.
SecretSelect secret information input method
  • Auto Generation: Automatically generate and use the secret corresponding to the selected image repository in DevOps Console.
  • Use Existing Secret: Use a pre-created secret through K8S secret management.
Table. Deploy to K8S Stage Input Items

Deploy to VM

This stage deploys to a VM.

Select Deploy to VM as the stage type.

ItemDescription
Deployment ConfigurationSelect the deployment configuration method
  • Deployment target setting (using SSH command/Agent): Deploy using SSH command or Agent.
  • Direct script writing: Users directly input all commands for deployment.
Deployment GroupSelect the deployment group
Deployment InformationContents saved in the deployment group are automatically set.
Manual DeploymentSelect the default value for manual deployment
  • Please select the default setting value for manual deployment-related parameters when running the pipeline.
Table. Deploy to VM Stage Input Items

Trigger Build

This stage remotely executes a pipeline.

Select Trigger Build as the stage type.

ItemDescription
Target PipelineSelect the target pipeline to execute remotely.
The available items vary depending on the development/operation distinction of the pipeline.
Parameter InformationExposed depending on the parameter setting of the target pipeline.
The parameter information entered at the time of pipeline execution is used.
Table. Trigger Build Stage Input Items

Remote Execution Information Check

Remote execution information (upper/lower pipeline) through the Trigger Build stage can be checked on the Build Details View screen.

Other Stages

ItemDescription
ArchiveArchives the application build result. The archived file can be downloaded from Jenkins.
Code QualityStage for executing the Code Quality step.
CustomThe user writes the pipeline script directly in the desired format.
Table. Other Stage Setting Items

1.2 - Multibranch Pipeline

Note
For more detailed information on Jenkins multibranch pipeline, please refer to the official website.

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

Getting Started with Multibranch Pipeline

To start using the multibranch pipeline, follow these steps:

  1. Main page, click the Project card. Move to the Project Dashboard page.
  2. Click the Build/Deployment > Build Pipeline menu on the left. Move to the Build Pipeline page.

Adding a Multibranch Pipeline

To add a multibranch pipeline, follow these steps:

  1. Main page, click the Project card. Move to the Project Dashboard page.
  2. Click the Build/Deployment > Build Pipeline menu on the left. Move to the Build Pipeline page.
  3. On the Build Pipeline page, click the Add Multibranch Pipeline button at the top right. The Add Multibranch Pipeline popup window opens.
  4. In the Add Multibranch Pipeline popup window, enter each item and click the Save button.
ItemDescription
TypeSelect the development and operation distinction
Jenkins URLSelect Jenkins to add a multibranch pipeline from the list.
Folder TypeSelect the folder type
  • Existing folder: Add a pipeline under an existing folder 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 the new folder to be created.
Pipeline NameEnter the pipeline name.
Git RepositorySelect the code repository to perform branch-based builds.
Only code repositories registered in the DevOps Console project can be selected.
Branch FilteringFilter the branch names to be built from the registered branches in the code repository.
If filtering is used, enter the filtering conditions in Java regular expression format.
Jenkinsfile PathEnter the path to the Jenkinsfile that defines the pipeline build in the code repository.
Table. Multibranch Pipeline Addition Information Input Items

Managing Multibranch Pipelines

Multibranch Pipeline List

ItemDescription
Multibranch Icon and LabelThe icon and label representing the multibranch pipeline are displayed.
URLMove to the Multibranch Pipeline page in Jenkins.
Scan LogThe Multibranch Pipeline Scan Log popup window opens.
ScanScan the multibranch pipeline.
MoreDisplay additional menus.
  • Pipeline modification
  • Pipeline deletion
  • Build history
Table. Multibranch 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 on the multibranch pipeline card you want to scan.
  2. In the confirmation popup window, click the Confirm button.

Viewing Multibranch Pipeline Scan Logs

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

  1. On the Build Pipeline page, click the Scan Log button on the multibranch pipeline card you want to view the scan log for. The Multibranch Pipeline Scan Log popup window opens.
  2. In the Multibranch Pipeline Scan Log popup window, check the contents and click the Confirm button to close.

Viewing Multibranch Pipeline Build History

To view the branch-based build history of a multibranch pipeline, follow these steps:

  1. On the Build Pipeline page, click the More icon on the multibranch pipeline card you want to view the build history for.
  2. Click the Build History menu. Move to the Branch-based Build History screen in Jenkins (Not provided by DevOps Console).

Modifying a Multibranch Pipeline

To modify a multibranch pipeline, follow these steps:

  1. On the Build Pipeline page, click the More icon on the multibranch pipeline card you want to modify.
  2. Click the Pipeline Modification menu. Move to the Settings screen in Jenkins (Not provided by DevOps Console).

Deleting a Multibranch Pipeline

To delete a multibranch pipeline, follow these steps:

  1. On the Build Pipeline page, click the More icon on the multibranch pipeline card you want to delete.
  2. Click the Pipeline Deletion menu. The Pipeline Deletion popup window opens.
  3. In the Pipeline Deletion popup window, select whether to delete the pipeline in Jenkins together and click the Confirm button.
Note

Delete pipeline in Jenkins together

  • Selected: The pipeline is actually deleted in Jenkins.
  • Not selected: The pipeline is deleted only from the Build Pipeline list and remains in Jenkins.

2 - Kubernetes Deployment

The user can check the list of Helm releases used in the project and the deployment status. It appears in the development/operation list when creating a project or installing a chart, depending on the development classification.

The user can check the deployment by distinguishing it with an icon.

  • Helm Chart Helm Chart
  • Istio Istio
  • Workload Workload
  • Canary Canary
  • Blue-Green Blue-Green
  • ArgoCD ArgoCD

Getting Started with Kubernetes Deployment

To start using Kubernetes deployment, follow the procedure below.

  1. Main page, click the Project card. Move to the Project Dashboard page.
  2. In the left menu, click the Build/Deploy > Kubernetes Deployment menu. Move to the Kubernetes Deployment page.

2.1 - Helm Release

Helm Release is an instance of a chart running in a Kubernetes cluster. Users can create a Helm Release when creating a project or through the Helm Install menu.

Getting Started with Helm Release

To get started with Helm Release, follow these steps:

  1. Main page, click the Project card. Move to the Project Dashboard page.
  2. In the left menu, click Build/Deploy > Kubernetes Deploy. Move to the Kubernetes Deploy page.
    ItemDescription
    NameDisplays the deployment name. Click to view detailed information.
    ChartDisplays information about the Helm chart used for deployment.
    Cluster/NamespaceDisplays the cluster/namespace where the deployment is located.
    Pod StatusDisplays the current status of the Pod.
    Deployment ResultDisplays the result of the deployment execution.
    Deployment TimeDisplays the deployment execution time.
    RefreshRefreshes the current item. The items that change are Pod status, deployment result, and deployment time.
    DeleteDeletes the current item.
    Table. Helm Release Items
  3. On the Kubernetes Deploy page, click the Name in the Helm Release list. Move to the Deployment Details page.

Adding Helm Release

Helm Install

You can add a Helm Release through Helm Install.

To add a related Helm Release, follow these steps:

  1. Main page, click the Project card. Move to the Project Dashboard page.
  2. In the left menu, click Build/Deploy > Kubernetes Deploy. Move to the Kubernetes Deploy page.
  3. Click the Add Related Helm Release button. The Add Related Helm Release popup window opens.
  4. In the Add Related Helm Release popup window, enter each item.
  5. Click the Save button to complete adding the Helm Release.
ItemDescription
Helm Release already registered in the projectDisplays the Helm Release already registered in the project.
  • Helm Release already registered in the project cannot be added.
Table. Items displayed when adding related Helm Release

Managing Helm Release Secrets

Getting Started with Helm Release Secrets

Helm Release Secrets allows you to manage the ImagePull Secret used for the image deployed through the build pipeline.

To get started with Helm Release Secrets, follow these steps:

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

Adding Helm Release Secrets

To add a Helm Release Secret, follow these steps:

  1. On the Deployment Details page, click the Edit Authentication Information icon to the right of Helm Release. The Helm Release Secrets popup window opens.
  2. In the Helm Release Secrets popup window, if you need to add a secret to pull a private chart image, click the Add button in the Chart Install Secret section. The Add Secret popup window opens.
  3. If you need to add a secret to pull the app image used for build/deploy, click the Add button in the ImagePull Secret section. The Add Secret popup window opens.
  4. In the Add Secret popup window, enter the secret-related content and click the Save button to complete the addition.
ItemDescription
Registry URLSelect the image to use for ImagePull Secret from the image list in the image repository.
SecretSelect the method for entering secret information
  • Auto-generation: Automatically generates a secret using the authentication information of the selected image repository in the Docker URL.
  • Use existing secret: Select one of the existing secrets to use.
Table. Helm Release Secret Addition Settings

Modifying Helm Release Secrets

To modify a Helm Release Secret, follow these steps:

  1. On the Deployment Details page, click the Edit Authentication Information icon to the right of Helm Release. The Helm Release Secrets popup window opens.
  2. In the Helm Release Secret list, click the name of the secret you want to modify. The Modify Secret popup window opens.
  3. Modify the content and click the Save button to complete the modification.

Deleting Helm Release Secrets

To delete a Helm Release Secret, follow these steps:

  1. On the Deployment Details page, click the Edit Authentication Information icon to the right of Helm Release. The Helm Release Secrets popup window opens.
  2. In the Helm Release Secret list, click the name of the secret you want to delete.
  3. Click the Delete button to complete the deletion.

Modifying K8S Authentication Information

K8S authentication information refers to the authentication information used to verify the authority to use the K8S cluster/namespace when performing deployment in the build pipeline.

To modify the K8S authentication information, follow the procedure below.

  1. Deployment Details page, click the Edit Authentication Information icon to the right of K8S Cluster/Namespace. The Edit Authentication Information popup window will open.
  2. The authentication information is fixed to the account of the logged-in user. Click the Save button to modify it.
  3. In the confirmation popup window, click the Confirm button.
  4. The K8S authentication information will be changed to the logged-in user.

Checking values.yaml used in Helm Release

To check the contents of values.yaml, follow these steps:

  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. Check the contents of the values.yaml file.

Comparing values.yaml used in Helm Release

To compare the contents of values.yaml used in each release, follow these steps:

  1. On the Deployment Details page, click the History tab.
  2. In the list, select the checkboxes of the two revisions you want to compare.
  3. Click the Yaml Diff button. The Yaml Diff popup window opens.
  4. In the Yaml Diff (Revision #>#) popup window, check the comparison contents.

Rolling Back Helm Release

To roll back a Helm Release to a previous revision, follow these steps:

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

Upgrading Helm Release

To upgrade a Helm Release, follow these steps:

  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 the current Values.yaml and click the Upgrade button. The Upgrade popup window opens.
  4. Check the information being upgraded.
  5. Click the Execute button to complete the upgrade.

Viewing Pod Logs

To view the logs of Pods related to Helm Release, follow these steps:

  1. On the Deployment Details page, click the Release Objects tab.
  2. In the Pod Items section, click the LOG icon in the LOG column. The Log popup window opens.
ItemDescription
ContainerSelect the container for which you want to output logs.
Real-time RefreshRefreshes the log output in real-time.
Stop RefreshStops real-time refresh.
DownloadDownloads the Pod log as a file.
Table. Log Popup Window Function Description

Deleting Helm Release

To delete a Helm Release, follow these steps:

  1. On the Deployment Details page, click the Delete button at the bottom right of Helm Release. The Delete Helm Release popup window opens.
  2. Click the Confirm button to complete the deletion.
Note

Also execute the Helm delete command

  • Selected: The Helm Release is actually deleted from the cluster.
  • Not selected: Only deleted from the Kubernetes Deploy list and remains in the cluster.

2.2 - Workload

A workload is an application that runs on Kubernetes, and users can add workloads to the DevOps Console for management.

The workload types manageable from DevOps Console are Deployment, StatefulSet, DaemonSet.

Start Workload

To start using the workload, follow the steps below.

  1. Click the Project card on the Main page. It moves 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. Kubernetes Deployment On the page, click the name of the workload.
    ItemDescription
    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 item. The items that change are Pod status, deployment result, deployment time.
    DeleteDeletes the current item.
    Table. Workload screen items

Add workload

To add a workload, follow the procedure below.

  1. Main page, click the Project card. It moves to the Project Dashboard page.
  2. In the left menu, click the Build/Deploy > Kubernetes Deployment menu. It moves to the Kubernetes Deployment page.
  3. On the Kubernetes Deployment page, click the Add Workload menu. The Add Workload popup window opens.
  4. In the Add Workload popup window, enter the information and click the Save button.
  5. In the confirmation popup window, click the Confirm button to complete adding the workload.
Item
Description
Target to be retrievedOnly workloads deployed with the same image as the base image of the App template used when creating the project for the first time are displayed.
Workload already registered in the projectIt shows the workload already registered in the project.
  • Workloads already registered in the project cannot be added.
Table. Input items for adding workload

K8S Modify authentication information

K8S authentication information refers to the authentication information used to verify the authority to use the K8S cluster/namespace when performing deployment in the build pipeline.

To modify the K8S authentication information, follow the procedure below.

  1. Deployment Details page, click the Edit Authentication Information icon to the right of K8S Cluster/Namespace. The Edit Authentication Information popup window will open.
  2. The authentication information is fixed to the account of the logged-in user. Click the Save button to modify it.
  3. In the confirmation popup window, click the Confirm button.
  4. The K8S authentication information will be changed to the logged-in user.

Rollback workload

To roll back the workload to a previous image, follow the steps below.

  1. On the Main page, click the Project card. It navigates to the Project Dashboard page.
  2. In the left menu, click the Build/Deploy > Kubernetes Deploy menu. You will be taken to the Kubernetes Deploy 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 of the Workload Details page.
  5. Detailed Information tab list, click the Rollback button in the row that has the image you want to rollback. Rollback popup window opens.
  6. Rollback Click the button in the popup window in the desired way to complete the rollback.
    • Recreate
    • Rolling Update

Add distribution result recipient

To add a distribution result recipient, follow the steps below.

  1. Click the Deployment Result Recipients tab on the Workload Details page.
  2. Click the Add button on the Distribution Result Recipient tab. The Add Distribution Result Recipient popup 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 the list to add the recipient to the bottom of the popup.
    • Added recipients can be deleted by clicking the X icon on the right.

Delete workload

To delete the workload, follow the steps below.

  1. Click the X icon of the workload to delete on the Kubernetes Deployment page.
  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 method you originally deployed 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 that can replace two Helm releases with each other.

Only two Helm releases with the same Project, Cluster, Namespace, Release Type, Chart Name, Chart Version, and Development Classification can be linked.

Getting Started with Blue/Green Deployment

To start using blue/green deployment, follow these steps:

  1. Click the Project card on the Main page. You will be moved to the Project Dashboard page.
  2. Click the Build/Deployment > Kubernetes Deployment menu on the left. You will be moved to the Kubernetes Deployment page.
    Item
    Description
    NameDisplays the name of the blue/green deployment. Click to view detailed information.
    Cluster/NamespaceDisplays the cluster/namespace where the deployment is deployed.
    (Operation)Displays information about the currently operating Helm release.
    (Pre-operation)Displays the Helm release that will be the next version of the operation. When using blue/green replacement, the pre-operation becomes the operation.
    DeleteDeletes the current item.
    Table. Kubernetes Deployment Screen Blue/Green Deployment Card Items
  3. On the Kubernetes Deployment page, click the name of the blue/green deployment you want to start in the deployment list. You will be moved to the Deployment Details page.

Adding Blue/Green Deployment

To add a blue/green deployment, follow these steps:

Note
To add a blue/green deployment, you need two Helm releases installed using the same chart.
  1. Click the Project card on the Main page. You will be moved to the Project Dashboard page.
  2. Click the Build/Deployment > Kubernetes Deployment menu on the left. You will be moved to the Kubernetes Deployment page.
  3. Click the Add Blue/Green Deployment button at the top right of the Kubernetes Deployment page. The Add Blue/Green Deployment popup window will open.
  4. Enter the information in the Add Blue/Green Deployment popup window and click the Save button to complete the addition of the blue/green deployment.
Item
Description
ClassificationSelect development or operation
Blue/Green Deployment NameEnter the deployment name.
OperationSelect the release and Jenkins job
  • Release Name: Select the name of the currently operating Helm release from the list.
  • Jenkins Job: Select the Jenkins job to build/deploy the selected Helm release from the list
Pre-operationSelect the release and Jenkins job
  • Release Name: Select the name of the Helm release to be reflected in the next version of the operation from the list.
  • Jenkins Job: Select the Jenkins job to build/deploy the selected Helm release from the list
K8S Cluster/NamespaceDisplays the K8S cluster/namespace where the Helm release is installed.
Type ClassificationChoose whether to use Ingress or Service to switch blue/green.
New ClassificationChoose whether to create a new Ingress or Service or use an existing one.
NameEnter the name
  • New: Enter the name of the Ingress or Service.
  • Existing: Select an existing Ingress or Service from the list
Service (Operation)Select the Kubernetes Service related to the currently operating Helm release from the list.
Service (Pre-operation)Select the Kubernetes Service related to the Helm release to be reflected in the next version of the operation from the list.
RulesEnter the information to be used in Ingress.
Table. Input Items for Ingress Type when Adding Blue/Green Deployment
ItemDescription
TypeSelect the type of Kubernetes Service from the list
  • ClusterIP
  • NodePort
  • LoadBalancer
Deployment (Operation)Select the Kubernetes Deployment related to the currently operating Helm release from the list.
Deployment (Pre-operation)Select the Kubernetes Deployment related to the Helm release to be reflected in the next version of the operation from the list.
PortsEnter the information to be used in Service.
Table. Input Items for Service Type when Adding Blue/Green Deployment

Switching Blue/Green

To switch blue/green, follow these steps:

  1. Click the Blue/Green Switch button on the Deployment Details page. The Blue/Green Switch popup window will open.
  2. Click the Confirm button in the Blue/Green Switch popup window to complete the blue/green switch.
    • The Helm releases for operation and pre-operation are swapped with each other.
    • The switch history is added.

Checking YAML of Ingress or Service Used in Blue/Green Deployment

To check the YAML of the Ingress or Service used in blue/green, follow these steps:

  1. Click the View icon of Ingress YAML or Service YAML on the Deployment Details page. The Ingress YAML or Service YAML popup window will open.
  2. Check the contents in the Ingress YAML or Service YAML popup window and click the Confirm button to close.

Managing Jenkins Job of Blue/Green Deployment

Viewing Jenkins Job Log

To view the Jenkins job log, follow these steps:

  1. Click the Log button in the Jenkins job item of the desired release on the Deployment Details page. The Pipeline Log popup window will open.
  2. Check the log in the Pipeline Log popup window and click the Confirm button.

Running Jenkins Job

To run a Jenkins job, follow these steps:

  1. Click the Run button in the Jenkins job item of the desired release on the Deployment Details page. The Pipeline Run Parameter Input popup window will open.
  2. Enter or select each item in the Pipeline Run Parameter Input popup window and click the Confirm button to complete the Jenkins job run.

Modifying Blue/Green Deployment

To modify a blue/green deployment, follow these steps:

  1. Click the Modify button on the Deployment Details page. The Modify Blue/Green Deployment popup window will open.
  2. Modify the desired items in the Modify Blue/Green Deployment popup window and click the Save button to complete the modification.

Deleting Blue/Green Deployment

To delete a blue/green deployment, follow these steps:

  1. Click the Delete button on the Deployment Details page. The Delete Blue/Green Deployment popup window will open.
  2. Select whether to execute the Ingress/Service Deletion Command and click the Confirm button to complete the deletion.
Note

Ingress/Service Deletion Command

  • Selected: The Ingress or Service used in the blue/green deployment is actually deleted from the cluster.
  • Not selected: The Ingress or Service used in the blue/green deployment is not deleted and remains in the cluster.

2.4 - Canary Deployment

Users can add canary deployments.

Canary addition refers to setting up two Helm releases to be bundled for canary testing.

Project, Cluster, Release Type, Chart Name, Chart Version, and Development Classification must all be the same for two Helm releases to be bundled.

Getting Started with Canary Deployment

To start using canary deployment, follow these steps:

  1. Click the Project card on the Main page to go to the Project Dashboard page.
  2. Click Build/Deployment > Kubernetes Deployment in the left menu to go to the Kubernetes Deployment page.
    ItemDescription
    NameDisplays the canary name. Click to view detailed information.
    ClusterDisplays the deployed cluster.
    (Operation)Displays the currently operating Helm release.
    (Canary)Displays the canary Helm release.
    TerminateTerminates the canary.
    Table. Kubernetes Deployment Screen Canary Card Items
  3. Click the name of the canary you want to use on the Kubernetes Deployment page’s deployment list to go to the Deployment Details page.

Adding a Canary

To add a canary, follow these steps:

Note

Canary is supported in the following environments. Check before adding a canary.

  • Kubernetes v1.17 or higher
  • nginx-ingress v0.29.0 or higher
Guide
To add a canary, you need two Helm releases installed using the same chart.
  1. Click the Project card on the Main page to go to the Project Dashboard page.
  2. Click Build/Deployment > Kubernetes Deployment in the left menu to go to the Kubernetes Deployment page.
  3. Click the Add Canary button at the top right of the Kubernetes Deployment page. The Add Canary popup window opens.
  4. Enter information in the Add Canary popup window and click the Save button to complete adding the canary.
ItemDescription
ClassificationSelect development or operation.
Canary NameEnter the canary name.
Operation
  • Release Name: Select the name of the currently operating Helm release from the list.
  • Jenkins Job: Select the Jenkins job for building and deploying the currently operating Helm release from the list.
Canary
  • Release Name: Select the name of the next operating Helm release from the list.
  • Jenkins Job: Select the Jenkins job for building and deploying the next operating Helm release from the list.
K8S ClusterDisplays the K8S cluster where the Helm release is installed.
Ingress AnnotationEnter the annotation item you want to apply from the canary annotation provided by nginx-ingress.
Table. Add Canary Input Items
Note
For detailed guidance on each item of nginx-ingress ingress annotations, see the next page.

Checking Ingress YAML of Canary

To check the operating Ingress YAML and canary Ingress YAML used by the canary, follow these steps:

  1. Click the View icon for Operating Ingress YAML or Canary Ingress YAML on the Deployment Details page. The Ingress YAML popup window opens.
  2. Check the contents in the Ingress YAML popup window and click the OK button to close it.

Managing Jenkins Job of Canary

Viewing Jenkins Job Log

To view the Jenkins job log, follow these steps:

  1. Click the Log button for the Jenkins job item of the desired release on the Deployment Details page. The Pipeline Log popup window opens.
  2. Check the log in the Pipeline Log popup window and click the OK button.

Running Jenkins Job

To run a Jenkins job, follow these steps:

  1. Click the Run button for the Jenkins job item of the desired release on the Deployment Details page. The Pipeline Run Parameter Input popup window opens.
  2. Enter or select each item in the Pipeline Run Parameter Input popup window and click the OK button to complete running the Jenkins job.

Modifying Canary

To modify a canary, follow these steps:

  1. Click the Modify button on the Deployment Details page. The Modify Canary popup window opens.
  2. Modify the desired items in the Modify Canary popup window and click the Save button to complete the modification.

Recovering Canary

When the ingress annotation information of the operating release and canary release does not work normally due to changes in the Helm release, recover it to work again.

To recover a canary, follow these steps:

  1. Click the Recover button on the Deployment Details page. The Recover popup window opens.
  2. Click the OK button in the Recover popup window to complete the recovery.

Terminating (Deleting) Canary

To terminate a canary, follow these steps:

  1. Click the Terminate button on the Deployment Details page. The Terminate Canary popup window opens.
  2. Select the desired items in the Terminate Canary popup window and click the OK button to complete the termination.
Item
Description
Canary ReleaseSelect the canary release
  • Ingress Host Reversion: Reverts the ingress host of the Helm release used for the canary to its original value.
  • Helm Release Deletion: Deletes the Helm release used for the canary.
Operation ReleaseSelect the operation release
  • Canary Image Upgrade: Upgrades the operation Helm release to the image used by the canary. You can modify the Values.yaml file.
  • No Action: Terminates the canary without changing the operation Helm release.
Table. Canary Termination Selection Items

2.5 - Istio

Note
For a detailed guide on Istio, please refer to the next page.
The list of Istio Traffic management Objects supported by DevOps Console is as follows:

  • Gateway
  • Virtual Service
  • Destination Rule

Getting Started with Istio

To start using Istio, follow these steps:

  1. Main page, click on the Project card. Move to the Project Dashboard page.
  2. In the left menu, click on Build/Deploy > Kubernetes Deploy. Move to the Kubernetes Deploy page.
    ItemDescription
    NameDisplays the Istio name. Click to view detailed information.
    Cluster/NamespaceDisplays the deployed cluster/namespace.
    DeleteDeletes the current item.
    Table. Kubernetes Deploy page Istio card item
  3. On the Kubernetes Deploy page, click on the name of the Istio you want to use. Move to the Istio Details page.

Adding Istio

To add Istio, follow these steps:

  1. Main page, click on the Project card. Move to the Project Dashboard page.
  2. In the left menu, click on Build/Deploy > Kubernetes Deploy. Move to the Kubernetes Deploy page.
  3. On the Kubernetes Deploy page, click the Add Istio button in the top right corner. The Add Istio popup window opens.
  4. In the Add Istio popup window, enter the information and click the Save button to add Istio.
ItemDescription
TypeSelect development or operation.
K8S ClusterSelect a K8S cluster.
NamespaceSelect a namespace.
Only namespaces that can use Istio are displayed in the list.
Table. Add Istio input items
Note

Although you have added Istio, you have not created an Istio object yet, so you cannot use the Istio-related functions yet.

Perform Create Wizard to add Istio object or Object addition to add Istio object to add an Istio object and use it.

Istio Objects

Adding Istio Objects

Using Create Wizard to Add Istio Objects

  1. On the Istio Details page, click on the Istio Objects tab.
  2. On the Istio Objects tab, click the Create Wizard button. Move to the Create Wizard page.

Helm Release

This is the step to select the Helm release to be used in Istio.

  1. On the 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

Istio Gateway is the front-end object that receives traffic from outside.

  1. On the Create Wizard page, on the Gateway screen, select whether to create a Gateway.
    • If you want to create a Gateway, enter each item.
    • If you do not want to create a Gateway, select Skip object creation.
  2. Click the Next button. The Destination Rule screen appears.
ItemDescription
Name PrefixSpecify the prefix name for the Istio Gateway object to be created.
HostSpecify the domain of the Gateway object to be accessed from outside.
Table. Create Wizard Gateway input items

Destination Rule

Destination Rule defines the traffic policy of Istio.

  1. On the Create Wizard page, on the Destination Rule screen, select whether to create a Destination Rule.
    • If you want to create a Destination Rule, enter each item.
    • If you do not want to create a Destination Rule, select Skip object creation.
  2. Click the Next button. The Virtual Service screen appears.
ItemDescription
Name PrefixEnter the prefix name for the Istio Destination Rule object to be created.
Load BalancerSelect the load balancer method.
  • ROUND_ROBIN: Round Robin
  • LEAST_CONN: Last connection continues to be used
  • RANDOM: Random
Max ConnectionsEnter the maximum number of allowed connections.
Table. Create Wizard Destination Rule input items

Virtual Service

Virtual Service plays a role in routing incoming traffic to a service.

  1. On the Create Wizard page, on the Virtual Service screen, enter each item if you want to create a Virtual Service.
  2. Click the Complete button to complete the creation of the Istio object using the Create Wizard.
ItemDescription
Name PrefixEnter the prefix name for the Istio Virtual Service to be created.
Prefix-UriEnter the prefix URI to route traffic to the corresponding URI.
Helm Release WeightIf there are multiple Helm releases, enter the connection weight. The sum of each number must be 100.
Table. Create Wizard Virtual Service input items

Using Object Addition to Add Istio Objects

  1. On the Istio Details page, click on the Istio Objects tab.
  2. On the Istio Objects tab, click the Object Addition button. The Object Addition popup window opens.
  3. In the Object Addition popup window, enter each item and click the Save button to complete the addition of the Istio object.
ItemDescription
ObjectSelect the object to be created
  • Gateway
  • Virtual Service
  • Destination Rule
InputThe input items vary depending on each object. Refer to the Create Wizard for input.
  • Gateway
  • Virtual Service
  • Destination Rule
GenerateClick the Generate button. A basic Yaml is created in the Yaml area based on the input above.
YamlModify the basic Yaml to complete the final Yaml of the object you want to create.
SaveClick the Save button to create the object.
Table. Object addition to add Istio object screen items

Modifying Istio Objects

To modify an Istio object, follow these steps:

  1. On the Istio Details page, click on the Istio Objects tab.
  2. On the Istio Objects tab, click on the object you want to modify in the Istio object list. The Object popup window opens.
  3. In the Object popup window, modify the Yaml and click the Save button to complete the modification of the Istio object.

Deleting Istio Objects

To delete an Istio object, follow these steps:

  1. On the Istio Details page, click on the Istio Objects tab.
  2. On the Istio Objects tab, click on the object you want to modify in the Istio object list. The Object popup window opens.
  3. In the Object popup window, click the Delete button to complete the deletion of the Istio object.

Helm Release

Adding Helm Release

To add a Helm release used in Istio, follow these steps:

  1. On the Istio Details page, click on the Helm Release tab.
  2. On the Helm Release tab, click the Add button. The Add Helm Release popup window opens.
  3. In the Add Helm Release popup window, enter each item and click the Save button to complete the addition of the Helm release.

Deleting Helm Release

To delete a Helm release used in Istio, follow these steps:

  1. On the Istio Details page, click on the Helm Release tab.
  2. On 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 window, click the Confirm button to complete the deletion of the Helm release.

Deleting Istio

To delete Istio, follow these steps:

  1. On the Istio Details page, click the Delete button at the bottom right.
  2. In the confirmation popup window, click the Confirm button to complete the deletion.

2.6 - ArgoCD

ArgoCD is a software used for GitOps deployment in a Kubernetes environment. Users can set up ArgoCD deployment when creating a project or through the Kubernetes deployment menu.

Getting Started with ArgoCD

To view the details of an ArgoCD application, follow these steps:

  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 on the left. You will be taken to the Kubernetes Deploy page.
  3. Click the ArgoCD Application Card you want to start. You will be taken to the Deploy Details page.
Category
Item
Description
ArgoCD
Application
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 status of the app.
Deployment ResultDisplays the current sync status.
Deployment TimeDisplays the deployment execution time.
RefreshClicking the Refresh icon refreshes the current item. The items that change are App Status and Deployment Result.
DeleteDeletes the current item.
Deployment DetailsEdit ArgoCD App SecretClicking the Edit Authentication Information icon on the right side of the application name opens a popup window to manage the image secret used for deployment.
Go to ArgoCD AppThe Application Details screen of the actual ArgoCD tool opens in a new window.
Table. ArgoCD Application Card and Deployment Details Items

Adding an ArgoCD Application

Creating a New ArgoCD Application using Helm Chart

To create a new ArgoCD application using a Helm chart and add it, follow these steps:

  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 on the left. 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 the ArgoCD Information and click the Confirm button. The Authentication Information input field will appear.
  5. Enter the Authentication Information and click the Connection Test button.
  6. The Application Basic Information and Deployment Target K8S Cluster input fields will appear.
  7. Enter the Application Name and click the Duplicate Check button.
  8. Enter the Project Name.
  9. Select Helm Chart to Create a New Repository as the Repository Type.
  10. Select the K8S Cluster and Namespace.
  11. Select the Helm Chart. The Helm Chart information and Helm Chart Git Repository information will appear.
  12. Modify the contents of the Values.yaml file located in the K8S Cluster Values of the Helm Chart and click the Validation Check button.
  13. Enter the Helm Chart Git Repository information and click the Connection Test button.
  14. Enter the Manifest Keys information.
  15. Click the Create button to complete the creation.
Note
The Deploy Strategy in the Manifest File and Key Information is not a required input value.
ItemDescription
URL Input MethodSelect the URL input method.
  • Select from the list: The registered ArgoCD tool appears.
  • Direct Input
ArgoCD URLEnter the ArgoCD URL and click the Confirm button.
Authentication InformationEnter the authentication information and click the Connection Test button.
Application NameEnter the ArgoCD application name and click the Duplicate Check button.
Project NameEnter the project name of the ArgoCD application.
Repository TypeSelect the repository type.
  • Create a new repository using Helm Chart: Create a Git repository using Helm Chart for GitOps.
  • Use an existing Git repository
K8S ClusterSelect the target cluster for deployment.
  • Only clusters with access rights can be selected from the DevOps Console K8S cluster.
NamespaceSelect the target namespace for deployment.
  • Only namespaces with access rights can be selected from the selected cluster.
Helm ChartSelect the Helm chart.
Helm Chart Git RepositoryEnter the information of the Git repository used for Helm Chart.
Manifest Key InformationEnter the information for continuous deployment (Manifest file/Key information).
Table. Create New ArgoCD Application - Helm Chart Creation Settings

Creating a New ArgoCD Application using an Existing Git Repository

To create a new ArgoCD application using an existing Git repository and add it, follow these steps:

  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 on the left. 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 the ArgoCD Information and click the Confirm button. The Authentication Information input field will appear.
  5. Enter the Authentication Information and click the Connection Test button.
  6. The Application Basic Information and Deployment Target K8S Cluster input fields will appear.
  7. Enter the Application Name and click the Duplicate Check button.
  8. Enter the Project Name.
  9. Select Use an Existing Git Repository as the Repository Type.
  10. Select the K8S Cluster and Namespace.
  11. Select the Helm Chart. The Helm Chart and Helm Chart Git Repository information will appear.
  12. Modify the contents of the Values.yaml file located in the K8S Cluster Values of the Helm Chart and click the Validation Check button.
  13. Enter the Helm Chart Git Repository information and click the Connection Test button.
  14. Enter the Manifest Keys information.
  15. Click the Create button to complete the creation.
Note
The Deploy Strategy in the Manifest File and Key Information is not a required input value.
Item
Description
URL Input MethodSelect the URL input method.
  • Select from the list: The registered ArgoCD tool appears.
  • Direct Input
ArgoCD URLEnter the ArgoCD URL and click the Confirm button.
Authentication InformationEnter the authentication information and click the Connection Test button.
Application NameEnter the ArgoCD application name and click the Duplicate Check button.
Project NameEnter the project name of the ArgoCD application.
Repository TypeSelect the repository type.
  • Create a new repository using Helm Chart: Create a Git repository using Helm Chart for GitOps.
  • Use an existing Git repository
K8S ClusterSelect the target cluster for deployment.
  • Only clusters with access rights can be selected from the DevOps Console K8S cluster.
NamespaceSelect the target namespace for deployment.
  • Only namespaces with access rights can be selected from the selected cluster.
Git RepositoryEnter the information of the Git repository where the Manifest information for creating the ArgoCD application is stored.
Manifest Keys InformationEnter the information for continuous deployment (Manifest Root path, Manifest type, Manifest file/Key information).
Table. Create New ArgoCD Application - Existing Git Repository Creation Settings

Adding an Existing ArgoCD Application

To add an existing ArgoCD application, follow these steps:

  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 on the left. You will be taken to the Kubernetes Deploy page.
  3. Click the Add ArgoCD App button at the top right. You will be taken 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 authentication information will appear.
  6. Enter the Existing Application Name and Authentication Information and click the Connection Test button.
    Note
    If the Git repository linked to the ArgoCD application is not registered in the DevOps Console, the URL Check popup window will open. Follow steps 7-8.
  7. The URL Check popup window will open to distinguish the Git repository linked to the ArgoCD application.
  8. Modify the Base URL and click the Confirm button.
  9. The information of the Git Repository linked to the application will appear.
  10. Enter the Git Repository Authentication Information and click the Connection Test button.
  11. Enter the Manifest Keys information.
  12. Click the Save button to complete the Add ArgoCD Application.
Item
Description
URL Input MethodSelect the URL input method.
  • Select from the list: The registered ArgoCD tool appears.
  • Direct Input
ArgoCD URLEnter the ArgoCD URL and click the Confirm button.
Application Name / Authentication InformationEnter the Existing Application Name and Authentication Information and click the Connection Test button.
Git Repository Authentication InformationEnter the authentication information of the Git repository used by the selected existing application.
Image Repo KeyEnter the YAML file path and key value where the image repository information is recorded.
Image Tag KeyEnter the YAML file path and key value where the image tag information is recorded.
Image Secret KeyEnter the YAML file path and key value where the image secret information is recorded.
Deploy Strategy KeyEnter the YAML file path and key value where the deployment strategy information is recorded. (Not a required value)
Table. Add Existing ArgoCD Application Settings

Managing ArgoCD Applications

To view the details of an ArgoCD application, follow these steps:

  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 on the left. You will be taken to the Kubernetes Deploy page.
  3. Click the ArgoCD Application Card you want to start. You will be taken to the Deploy Details page.

Editing Manifest Information

To edit the manifest information, follow these steps:

  1. Click the Git-related Information tab.
  2. Click the Edit icon next to Manifest Information. The Edit Manifest Key Information popup window will open.
  3. Modify the manifest key value and click the Save button.

Editing ArgoCD Authentication Information

To edit the ArgoCD authentication information, follow these steps:

  1. Click the Edit icon next to ArgoCD User ID. The Edit Authentication Information popup window will open.
  2. Modify the authentication information value and click the Save button to complete the modification.

Editing Linked Git Repository Authentication Information

To edit 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 window will open.
  2. Modify the authentication information and click the Save button to complete the modification.

Setting Sync

To change the sync setting, follow these steps:

  1. Click the Sync icon next to Current Sync. The ArgoCD App Sync popup window will open.
  2. Enter the modified contents and click the Sync button to complete the Sync Setting.
ItemDescription
RevisionSelect the target branch for synchronization.
Sync OptionsSelect the synchronization options.
Synchronize ResourcesSelect the synchronization target.
Table. Sync Settings
Note
For more information about ArgoCD synchronization, refer to the official website.

Setting Auto-Sync

To change the Auto-Sync setting of an ArgoCD application, follow these steps:

  1. Click the Edit icon next to Auto-Sync. The Auto-Sync Options popup window will open.
  2. Modify the contents and click the Save button to complete the setting.
ItemDescription
Prune ResourcesSelect whether to delete the synchronization target when the Git setting is deleted.
Self HealSelect whether to automatically change the value in the cluster to the value defined in Git when the value of the synchronization target is changed in the cluster.
Table. Auto-Sync Settings

Managing Application Secrets

If the ArgoCD application was created using a Helm chart, you can add, modify, or delete application secrets.

To start managing application secrets, follow these steps:

  1. Click the application secret icon to the right of the application name.
  2. The Application Secret Settings popup window will open.

Adding an Application Secret

To add an application secret, follow these steps:

  1. Click the Edit icon next to Application Name. The Application Secret Settings popup window will open.
  2. If you need to add a secret to pull the Chart Image, click the Add button in the Chart Install Secret section.
  3. If you need to add a secret to pull the App Image during build/deployment, click the Add button in the ImagePull Secret section.
  4. Enter the contents and click the Save button to complete the addition.
Item
Description
Registry URLSelect the image to use for ImagePull Secret from the image list registered in the image repository.
SecretSelect the method of entering ImagePull Secret information.
  • Auto-generation: Automatically generates ImagePull Secret using the authentication information of the selected image repository in the Docker URL.
  • Use an existing secret: Select one of the existing secrets to use as ImagePull Secret.
Table. Application Secret Addition Settings

Editing an Application Secret

To edit an application secret, follow these steps:

  1. Click the Edit icon next to Application Name. The Application Secret Settings popup window will open.
  2. Click the Name of the secret you want to modify in the application secret list.
  3. Enter the contents and click the Save button to complete the modification.

Deleting an Application Secret

… (rest of the text remains the same) To delete an application secret, follow these steps:

  1. Click the Edit Authentication Information icon next to the Application Name. The Application Secret Settings popup window will open.
  2. Click the Name of the secret you want to delete from the application secret list.
  3. Click the Delete button to complete the deletion.

Comparing Values.yaml Files

If you are using an ArgoCD application with Helm charts, you can compare values.yaml files.

To compare the values.yaml files used for each release, follow these steps:

  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 will open.

Rolling Back an Application

To roll back an 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 window will open.
  3. Click the Confirm button to complete the rollback.

Deleting an Application

To delete an application, follow these steps:

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

3 - VM Deployment

Users can register/manage VM deployments through the DevOps Console.
Before registering a VM deployment, there must be an available VM server group (VM server group), and registered VM deployments can be used in the build pipeline (Deploy to VM).
Users can distinguish deployment methods by icon.

  • (SSH method) VM deployment (SSH method) VM deployment
  • (Agent method) VM deployment (Agent method) VM deployment
Note
Difference by deployment method: Table. SSH method vs Agent method

Starting VM Deployment

To start a VM deployment, follow these steps.

  1. Click the Project card on the Main page. Move to the Project Dashboard page.
  2. Click the Build/Deployment > VM Deployment menu on the left. Move to the VM Deployment page.
ItemDescription
Deployment group nameDisplays the name of the deployment group.
VM deployment result(Success)/(Total): Displays the number of VM servers that are deployment targets and the number of VM servers that have been successfully deployed.
  • Green: All successes
  • Blue: In progress
  • Red: Partial failure
  • Gray: Ready, paused
Deployment timeDisplays the deployment time.
DeleteDeletes the VM deployment.
Table. VM deployment display items

Adding VM Deployment

To add a VM deployment, follow these steps.

  1. Click the Project card on the Main page. Move to the Project Dashboard page.
  2. Click the Build/Deployment > VM Deployment menu on the left. Move to the VM Deployment page.
  3. Click the Add VM Deployment button at the top right of the VM Deployment page. The Add VM Deployment popup window opens.
  4. Enter information in the Add VM Deployment popup window and click the Save button.
ItemDescription
Deployment groupEnter the deployment group name.
Execution methodSelect the execution method.
  • File transfer and command execution: Select this for general VM file deployment.
  • Command execution only: Select this for executing commands only without file transfer (e.g., Docker commands).
Deployment methodSelect the deployment method
Deployment orderSelect whether to deploy to multiple target servers in parallel or sequentially.
Deployment target VMSet the deployment target server.
  • Click the Settings button to open the Deployment Target VM Settings popup window.
Command before file deploymentEnter the command to be executed before file deployment.
File to transfer
  • Source: Enter the file path after the build pipeline execution path (Jenkins workspace).
  • Target: Enter the file path where the file will be deployed on the VM server.
  • Use the Add button to add files.
Command after file deploymentEnter the command to be executed after file deployment.
Auto-rollback settingSelect whether to enable auto-rollback.
  • If deployment fails, it will be rolled back to the previous successful deployment.
  • Enabled only when the deployment method is Agent.
Artifact repositorySelect whether to use an artifact repository for rollback.
  • Enabled only when the deployment method is Agent.
Repository nameOnly visible when using an artifact repository.
  • Displays a list of already registered artifact repositories.
Table. VM deployment addition input items
Note

The Deployment Target VM Settings popup window displays the server groups available for use.

For more information, see VM Server Group.

Viewing VM Deployment Details

To view the details of a VM deployment, follow these steps.

  1. Click the Project card on the Main page. Move to the Project Dashboard page.
  2. Click the Build/Deployment > VM Deployment menu on the left. Move to the VM Deployment page.
  3. Click the VM deployment you want to view in detail on the VM Deployment page. Move to the VM Deployment Details page.
  4. Click the server list on the History tab. The Deployment Details popup window opens.
  5. You can view detailed history in the Deployment Details popup window.
  6. Click the Log button of the execution pipeline to open the Pipeline Log popup window.
  7. You can view detailed logs in the Pipeline Log popup window.
  8. Click the Log button of the server you want to view logs for in the deployment server history list. The VM Agent Log popup window opens.
  9. You can view detailed logs in the VM Agent Log popup window.
ItemDescription
Pause/Start deploymentPause and Start Deployment buttons are enabled.
RollbackYou can roll back to a previous version.
History tabDisplays deployment history.
Pipeline Information tabDisplays the build pipeline information connected to the VM deployment.
LogYou can view the build pipeline log.
Table. VM deployment details screen items
ItemDescription
Execution pipeline logYou can view the build pipeline log.
Deployment server history logYou can view the deployment agent log.
  • Only visible for AGENT type
Table. Deployment details screen items

Deleting VM Deployment

Deleting from the List

To delete a VM deployment, follow these steps.

  1. Click the Project card on the Main page. Move to the Project Dashboard page.
  2. Click the Build/Deployment > VM Deployment menu on the left. Move to the VM Deployment page.
  3. Click the X icon of the VM deployment you want to delete on the VM Deployment page.
  4. Click the Confirm button in the confirmation popup window to complete the VM deployment deletion.

Deleting from the Details Page

To delete a VM deployment, follow these steps.

  1. Click the Project card on the Main page. Move to the Project Dashboard page.
  2. Click the Build/Deployment > VM Deployment menu on the left. Move to the VM Deployment page.
  3. Click the VM deployment you want to delete on the VM Deployment page. Move to the VM Deployment Details page.
  4. Click the Delete button on the VM Deployment Details page.
  5. Click the Confirm button in the confirmation popup window to complete the VM deployment deletion.

Using Environment Variables in VM Deployment Commands

You can use environment variables in file deployment commands before and after file deployment, source path of files to transfer, and target path of files to transfer.

You can use the $ symbol or the ${} symbol in the command to use the environment variables of the build pipeline.

Color mode
echo ${BUILD_NUMBER}
echo $JOB_NAME
echo ${BUILD_NUMBER}
echo $JOB_NAME
Environment variable usage example

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

Color mode
echo \${PATH}
echo \$LANG
echo \${PATH}
echo \$LANG
VM server environment variable reference example

Pausing VM Deployment

You can pause an ongoing VM deployment on the Deployment Details page. Click the Pause button in the recent deployment status section of the Deployment Details page to pause the VM deployment.

The deployment pause is possible in the following states, and the Pause button is only displayed when in these states.

Method
Status value
Description
SSHRequestBuild pipeline is running
AGENTRequestBuild pipeline is running
Build completeBuild pipeline has completed
  • Must set the manual_deploy parameter to Use when running the build pipeline. If not used, it changes to the ready state immediately.
  • The Start Deployment button is enabled, and clicking it changes to the ready state.
  • Can be changed to the ready state using the VM deployment task in release management.
ReadyAGENT can perform deployment
In progressAGENT is executing deployment
Table. States where deployment pause is possible

Understanding VM Deployment Status Values

You can check the current status of a VM deployment on the Deployment Details page.

Method
Status value
Description
SSHNot executedInitially created and never executed
RequestBuild pipeline is running
SuccessBuild/deployment was successful
FailureBuild or deployment failed
AGENTNot executedInitially created and never executed
RequestBuild pipeline is running
Build completeBuild pipeline has completed
  • Must set the manual_deploy parameter to Use when running the build pipeline. If not used, it changes to the ready state immediately.
  • The Start Deployment button is enabled, and clicking it changes to the ready state.
  • Can be changed to the ready state using the VM deployment task in release management.
ReadyAGENT can perform deployment after build pipeline completion
In progressAGENT is executing deployment
SuccessBuild/deployment was successful
FailureBuild or deployment failed
PausedBuild or deployment was paused
  • Pause button is enabled and can be paused by clicking.
Table. Description of deployment status values

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 start using Helm Install, follow these steps:

  1. Main page, click the Project card. Move to the Project Dashboard page.
  2. In the left menu, click Build/Deploy > Helm Install. The Helm Install page opens.
ItemDescription
K8S ClusterSelect the K8S cluster that will be the target for Helm Install.
The list of Helm charts below will only show charts that can be installed in the selected K8S cluster.
Chart NameDisplays the chart name.
Chart RepositoryDisplays the chart repository information where the Helm chart file is stored.
Table. Helm Install screen items

Viewing Helm Chart Details

To view Helm chart details, follow these steps:

  1. Main page, click the Project card.
  2. In the left menu, click Build/Deploy > Helm Install. The Helm Install page opens.
  3. In the Helm Install page, select the K8S cluster where you want to install from the K8S cluster item. The list of Helm charts belonging to the cluster appears.
  4. In the Helm Chart list, click the Helm chart card you want to view in detail. The Helm Chart Detail page opens.

Viewing Helm Chart Details

ItemDescription
VersionIf there are multiple versions, you can select the desired version.
DownloadYou can download the Helm chart file to your 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 check the information provided by the chart author.

Values.yaml Tab

Displays the values.yaml file included in the Helm chart. You can check the values that can be changed in the chart before Helm installation.

Detail Info Tab

Item
Description
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/CDDisplays whether it is possible to select the Helm chart type as Helm Release in the Deploy to K8S stage when creating a build pipeline.
New Installation Allowed
  • Y: New installation (Helm Install) is possible.
  • N: New installation (Helm Install) is not possible with the current Helm chart, and only existing installed Helm releases can be used.
Chart ImagesDisplays the image information used in the Helm chart.
Table. Detail info tab query items

Installing Helm

To install Helm, follow these steps:

  1. In the Helm Install page, select the K8S cluster where you want to install from the K8S cluster item. The list of Helm charts belonging to the cluster appears.
  2. In the Helm Install page, click the Helm chart card you want to view in detail. The Helm Chart Detail page opens.
  3. In the Helm Chart Detail page, click the Helm Install button. The Helm Install page opens.
  4. In the Helm Install page, enter each item on the screen and click the Next button. The Helm Chart Installation popup window opens.
  5. In the Helm Chart Installation popup window, check the contents and click the Run button to complete the Helm installation.
  6. Once the installation is complete, the Kubernetes Deployment page opens automatically.
Item
Description
Release NameEnter the name to be used in Helm.
It must be unique and cannot be duplicated within the namespace.
TypeDevelopment, operation
VersionSelect the version of the chart you want to install.
K8S ClusterDisplays the target K8S cluster where Helm will be installed.
Changes are not possible, and if you want to change, select the K8S cluster in Getting Started with Helm Install.
NamespaceSelect the target namespace where Helm will be installed from the list.
Reference InformationReference information provided by the selected K8S cluster.
You can check detailed information by clicking each tab.
Default Values.yaml included in the ChartYou can modify the values.yaml content to install Helm with the desired value.
If necessary, check the reference information and modify the values.yaml with the corresponding value.
Table. General Helm chart installation screen items
Item
Description
Release NameEnter the name to be used in Helm.
It must be unique and cannot be duplicated within the namespace.
TypeDevelopment, operation
VersionSelect the version of the chart you want to install.
K8S ClusterDisplays the target K8S cluster where Helm will be installed.
Changes are not possible, and if you want to change, select the K8S cluster in Getting Started with Helm Install.
NamespaceSelect the target namespace where Helm will be installed from the list.
Reference InformationReference information provided by the selected K8S cluster.
You can check detailed information by clicking each tab.
Default Values.yaml included in the ChartYou can modify the values.yaml content to install Helm with the desired value.
If necessary, check the reference information and modify the values.yaml with the corresponding value.
Input Type
  • Form: Enter the items displayed on the screen. The input type item is only displayed in Helm charts that support form input. For Helm chart authors who support form input, see Creating a Helm chart that supports form input.
  • Values.yaml: Modify the value in the general yaml editor screen.
Form/Values.yaml input can be switched, but the previously entered content will be initialized.
Form InputThe screen displayed when the input type is selected as Form, check each item, and enter the value. After entering, click the Validation Check button to verify the input value.
Table. Form input-supported Helm chart installation screen items

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. Main page, click the Project card. Move to the Project Dashboard page.
  2. Click the Build/Deploy > Ingress/Service Management menu in the left menu. Move to the Ingress/Service Management page.

Ingress Management

  1. Click the Ingress tab on the Ingress/Service Management page.
  2. Select K8S Cluster and Namespace in the Ingress tab. The Ingress list belonging to the selected namespace is retrieved.

Ingress

Note
Not all Ingress created in the namespace are displayed, and only Ingress created in DevOps Console are displayed.
ItemDescription
K8S ClusterSelect a K8S cluster from the list.
NamespaceSelect a namespace from the list. The Ingress created in the selected namespace is retrieved.
Ingress ListDisplays the Ingress list.
SearchYou can search for Ingress.
AddYou can add Ingress.
Table. Ingress Management Screen Items

Adding Ingress

To add Ingress, follow these steps:

  1. Click the Add button in the Ingress tab. The Add Ingress popup window opens.
  2. Enter information in the Add Ingress popup window and click the OK button.
  3. Click the OK button in the confirmation popup window to complete adding Ingress.
ItemDescription
Ingress NameEnter the Ingress name.
K8S ClusterDisplays the K8S cluster where Ingress will be created.
NamespaceDisplays the namespace where Ingress will be created.
ServiceSelect a Service from the Service list that Ingress will use as a target.
RulesEnter Host, Path, and Service Port to be set for Ingress.
You can enter multiple items by clicking Add.
Table. Ingress Addition Input Items

Ingress Details

To view Ingress details, follow these steps:

  1. Click the Ingress you want to view in the Ingress tab. Move to the Ingress Details page.
  2. Check the detailed information of Ingress on the Ingress Details page.
  3. Click the View icon to open the Ingress YAML popup window.
  4. You can check the Ingress YAML content in the Ingress YAML popup window.

Modifying Ingress

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

To modify Ingress, follow these steps:

  1. Click the Ingress you want to modify in the Ingress tab. Move to the Ingress Details page.
  2. Click the Modify button on the Ingress Details page. The Modify Ingress popup window opens.
  3. Modify the Ingress information in the Modify Ingress popup window and click the OK button.
  4. Click the OK button in the confirmation popup window to complete modifying Ingress.

Deleting Ingress

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

To delete Ingress, follow these steps:

  1. Click the Ingress you want to delete in the Ingress tab. Move to the Ingress Details page.
  2. Click the Delete button on the Ingress Details page.
  3. Click the OK button in the confirmation popup window to complete deleting Ingress.

Service Management

  1. Click the Service tab on the Ingress/Service Management page.
  2. Select K8S Cluster and Namespace in the Service tab. The Service list belonging to the selected namespace is retrieved.

Service

Note
Not all Services created in the namespace are displayed, and only Services created in DevOps Console are displayed.
ItemDescription
K8S ClusterSelect a K8S cluster from the list.
NamespaceSelect a namespace from the list. The Service created in the selected namespace is retrieved.
Service ListDisplays the Service list.
SearchYou can search for Service.
AddYou can add Service.
External Endpoint Information IconIf there is additional information, it is displayed.
Table. Service Management Screen Items

Adding Service

To add Service, follow these steps:

  1. Click the Add button in the Service tab. The Add Service popup window opens.
  2. Enter information in the Add Service popup window and click the OK button.
  3. Click the OK button in the confirmation popup window to complete adding Service.
ItemDescription
Service NameEnter the Service name.
K8S ClusterDisplays the K8S cluster where Service will be created.
NamespaceDisplays the namespace where Service will be created.
TypeSelect the type of Service
  • ClusterIP
  • NodePort
  • LoadBalancer
DeploymentSelect the Deployment that will be the target of Service from the list.
PortsEnter Port Name, Port, Target, and Protocol used by Service.
You can enter multiple items by clicking Add.
Table. Service Addition Input Items

Service Details

To view Service details, follow these steps:

  1. Click the Service you want to view in the Service tab. Move to the Service Details page.
  2. Check the detailed information of Service on the Service Details page.
  3. Click the View icon to open the Service YAML popup window.
  4. You can check the Service YAML content in the Service YAML popup window.

Modifying Service

Caution
Service used in blue/green deployment cannot be modified.

To modify Service, follow these steps:

  1. Click the Service you want to modify in the Service tab. Move to the Service Details page.
  2. Click the Modify button on the Service Details page. The Modify Service popup window opens.
  3. Modify the Service information in the Modify Service popup window and click the OK button.
  4. Click the OK button in the confirmation popup window to complete modifying Service.

Deleting Service

Caution
Service used in blue/green deployment cannot be deleted.

To delete Service, follow these steps:

  1. Click the Service you want to delete in the Service tab. Move to the Service Details page.
  2. Click the Delete button on the Service Details page.
  3. Click the OK button in the confirmation popup window to complete deleting Service.

6 - Managing Kubernetes Secrets

Users can view secrets created in a namespace. Moreover, users can create and delete secrets.

Getting Started with Kubernetes Secret Management

To start managing Kubernetes secrets, follow these steps:

  1. Main page, click the Project card. It moves to the Project Dashboard page.
  2. In the left menu, click Build/Deploy > Kubernetes Secret Management. It moves to the Kubernetes Secret Management page.
ItemDescription
K8S ClusterSelect a K8S cluster from the list.
NamespaceSelect a namespace from the list. The secrets created in the selected namespace are retrieved.
Secret ListDisplays the list of secrets.
SearchSearch for secrets.
Detailed FilterUse detailed filters for detailed searches.
AddAdd secrets.
Table. Kubernetes Secret Management Screen Items

Adding Secrets

Note
The secrets that can be added in Kubernetes Secret Management are Docker Config Secrets, and other secrets cannot be added on this screen.
Docker Config Secret refers to a secret used to store Docker registry access credentials for an image.

To add a Kubernetes secret, follow these steps:

  1. On the Kubernetes Secret Management page, select a K8S Cluster.
  2. Select a Namespace.
  3. Click the Add button. The Add Secret popup window opens.
  4. In the Add Secret popup window, enter the information and click the Connection Test button.
  5. If the Connection Test is successful, click the Save button.
  6. In the confirmation popup window, click the Confirm button to complete the addition.
ItemDescription
K8S ClusterDisplays the K8S cluster where the secret will be created.
NamespaceDisplays the namespace where the secret will be created.
Image Repository URLSelect the image repository to use for the secret.
Secret NameEnter the secret name.
Authentication Information Selection
  • New authentication information: Enter new authentication information.
  • Saved authentication information: Select one of the previously used authentication information.
Table. Add Secret Input Items

Viewing Secret Details

To view secret details, follow these steps:

  1. On the Kubernetes Secret Management page, click the secret for which you want to view detailed information. The Secret Details popup window opens.
  2. In the Secret Details popup window, check the detailed information of the secret.

Deleting Secrets

To delete a secret, follow these steps:

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

7 - Environment Variable Management

Users can add frequently used parameters and authentication information as environment variables to use when creating build pipelines.

Getting Started with Environment Variable Management

To manage environment variables used in build pipelines, follow these steps:

  1. Main page, click the Project card. Move to the Project Dashboard page.
  2. On the Project Dashboard page, click the Build/Deployment > Environment Variable Management menu in the left menu. Move to the Environment Variable Management page.

Adding Environment Variables

Adding Parameter Environment Variables

Parameter environment variables play the role of 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. In the Add Environment Variable popup window, select Parameter as the type.
  3. Enter the information and click the Save button.
  4. In the confirmation popup window, click the Confirm button to complete the addition.
ItemDescription
NameEnter the parameter name.
ValueEnter the parameter value.
DescriptionEnter a description for user reference.
Table. Parameter Environment Variable Addition Input Items

Adding Authentication Information Environment Variables

Authentication information environment variables store authentication information for use. Authentication information required for stages can be easily used (preventing duplicate input) by registering and sharing it in advance.

To add an authentication information environment variable, follow these steps:

  1. On the Environment Variable Management page, click the Add button. The Add Environment Variable popup window opens.
  2. In the Add Environment Variable popup window, select Authentication Information as the type.
  3. Enter the information and click the Save button.
  4. In the confirmation popup window, click the Confirm button to complete the addition.
ItemDescription
NameEnter the name of the authentication information.
ClassificationSelect a classification value
  • Development: Authentication information can only be used in development-type build pipelines.
  • Operation: Authentication information can only be used in operation-type build pipelines.
Authentication TypeSelect the authentication type.
IDEnter the ID.
Password/Private KeyEnter the password or private key according to the authentication type.
DescriptionEnter a description for user reference.
Table. Authentication Information Environment Variable Addition Input Items

Modifying Environment Variables

To modify an environment variable, follow these steps:

  1. On the Environment Variable Management page, click the environment variable you want to modify. The Modify Environment Variable popup window opens.
  2. In the Modify Environment Variable popup window, modify the desired item and click the Save button.
  3. In the confirmation popup window, click the Confirm button to complete the modification.

Deleting Environment Variables

To delete an environment variable, follow these steps:

Deleting from the List

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

Deleting from the Environment Variable Modification Popup Window

  1. On the Environment Variable Management screen, click the environment variable you want to delete. The Modify Environment Variable popup window opens.
  2. In the Modify Environment Variable popup window, click the Delete button.
  3. In the confirmation popup window, click the Confirm button to complete the deletion.