1 - Getting Started with DevOps Console

Describes how to log in to the DevOps Console and set the display language and user information.

Sign up

To use DevOps Console, you need to create a DevOps Console account that is separate from Samsung Cloud Platform, and you can create the account through sign‑up.

To create an account in DevOps Console, follow the steps below.

  1. Click the Sign Up link on the login page. You will be taken to the sign‑up page.
  2. Please proceed with Identity verification. When identity verification is complete, click the Next button.
    Item
    Required status
    Explanation
    Auto Input PreventionRequiredEnter the characters displayed in the image into the input field.
    Table. Authentication Information
  3. Please agree to the terms of the Sign-up Information item.
    Item
    Required status
    Explanation
    Terms of ServiceRequiredCheck if the service terms are agreed
    Privacy PolicyRequiredCheck consent for collection and use of personal information
    Must be at least 14 years old.RequiredCheck whether the user is 14 or older.
    Table. Sign-up Information Input
  4. Enter the required information for the Member Information field.
    Item
    Whether required
    Explanation
    User ID (email)RequiredEmail to be used as the subscriber ID
    mobile phone numberRequiredEnter mobile phone number
    • Enter the mobile phone number and click the OTP Send button to generate an OTP
    • Enter the OTP number received on the mobile phone and click the Verify button
    • If the OTP is valid, mobile phone number verification is completed
    PasswordRequiredThe password that the subscriber can use must be entered within 8 to 20 characters
    • User ID or name cannot be used as the password
    • Must include at least one uppercase letter (English), one lowercase letter (English), one digit, and one special character (! @ # $ % ^ & *)
    • The same character cannot be used three or more times
    • Sequences of four or more consecutive letters or numbers are not allowed
    • Password change interval: 90 days
    Confirm PasswordRequiredConfirm the password the subscriber will use
    NameRequiredSubscriber name
    • Can be entered using letters, numbers, and spaces, up to 100 characters
    languageRequiredNotification language settings for email, SMS, etc.
    Time zoneRequiredSet user’s timezone information
    Table. Member Information Input
  5. After entering all the information, click the Complete button, and a verification email will be sent to the entered email address.
    • Click the Email address verification button in the received email to complete registration.

Log in

To log in to DevOps Console, enter your account information on the login page and click the Next button.

After entering the OTP number issued for the selected OTP type on the OTP authentication page, click the Login button.

If you cannot remember your ID or password, click the ID/Password Recovery link, locate your account information first, and then attempt to log in.

After logging in, the DevOps Console main page opens.

Caution

If you enter the password incorrectly more than five times, your account will be locked, so please enter it correctly.

To unlock your account, click the ID/Password Recovery link to reset your password.

Edit User Information

To edit user information, follow these steps.

  1. Click the Shortcut icon at the upper right of the Main page.
  2. DevOps IDP Click the link. DevOps IDP page opens in a new tab.
  3. You can change information such as mobile phone number, password, name, timezone, and language on the user information page.
Information
The timezone and language settings of DevOps IDP are not synchronized with DevOps Console.

To modify the information used in DevOps Console, follow these steps.

  1. Click the User icon in the top menu of the Main page.
  2. Click the Account Information menu. The Account Information popup window opens.
  3. After changing the language and time zone information, click the Save button to complete updating your account information.

Changing Console Language

To change the language displayed in DevOps Console, after logging in, click Language Settings located below the DevOps Console page to select the desired language.

Manage authentication keys

Information
The authentication key is used when accessing the Open API service of DevOps Console.

You can manage each user’s individual authentication keys through the Authentication Key Management menu after clicking the User icon in the top menu of the Main page.

Add authentication key

To add an authentication key, follow these steps.

  1. Click the User icon at the top right of the Main page.
  2. Click the Authentication Key Management menu. The Authentication Key Management popup window opens.
  3. Click the Create Authentication Key button. The Create Authentication Key popup will appear.
  4. After setting the expiration date, click the Save button to complete the creation of the authentication key.
Information
If an authentication key has already been added, you cannot add another one.

Configure security settings

You can restrict the IPs that are allowed to use this authentication key through security settings.

To add security settings, follow these steps.

  1. Click the User icon at the top right of the Main page.
  2. Click the Authentication Key Management menu. The Authentication Key Management popup window opens.
  3. Click the Security Settings tab, then click the Edit button. The Change Security Settings popup window opens.
  4. Set IP access control to use.
  5. After entering the allowed IP, click the Save button to complete the security settings.

Delete authentication key

To delete the authentication key, follow these steps.

  1. Click the User icon at the top right of the Main page.
  2. Click the Authentication Key Management menu. The Authentication Key Management popup window opens.
  3. Click the Status Change button.
  4. When the Authentication Key Status Change popup opens, process it as Unused and click the Save button.
  5. Click the Delete button to complete the authentication key deletion.
Information
Authentication keys that are in use cannot be deleted. Change them to Unused status before deletion.

Check My Activity History

If you click the User Icon > My Activity History menu in the top menu of the Main page, you can view your DevOps Console activity history.

Configure Access Control IP

You can register IP addresses that are allowed to access the DevOps Console to control access.

Follow these steps to register an access control IP.

  1. Click the Main page’s top‑right shortcut icon.
  2. DevOps IDP Click the link. DevOps IDP page opens in a new tab.
  3. Click the Access Control menu in the left menu.
  4. On the Access Control page, click the Edit button below. You will be taken to the Access Control Edit page.
  5. Set Access Control IP Settings to Enable.
  6. After adding the IP to allow access, click the Save button to complete the access control settings.
Information
If the IP has changed or is incorrectly registered making access impossible, you can click the Access Control IP Settings link below the login page to change the settings.

Delete Account

Caution
DevOps Console When the account is deleted, all permissions related to the collected user information and resources are terminated.

To delete your DevOps Console account, follow the steps below.

  1. Click the Main page’s top‑right shortcut icon.
  2. DevOps IDP Click the link. DevOps IDP page opens in a new tab.
  3. On the user information page, click the Delete Account button at the top right. The Delete Account popup will appear.
  4. Enter your current password in the input field, then click the Delete Account button to complete the deletion.

1.1 - Registration Information

Users can view and manage their basic information, authentication information, subscribed tenants, subscribed project groups, and subscribed projects.

Getting Started with Sign-up Information

To start managing your registration information, follow these steps.

  1. Main page, click the Admin icon in the upper right. Navigate to the Tenant Dashboard page.
  2. Please click the Sign-up Information menu in the left menu. It navigates to the Sign-up Information page.

Managing authentication information

Authentication information automatically saves the credentials the user used for tool registration, usage, and related activities. If necessary, you can add new credentials, or modify or delete existing credentials.

To manage authentication information, follow the steps below.

  1. Click the Admin icon at the top right of the Main page. You will be taken to the Tenant Dashboard page.
  2. Click the Registration Information menu in the left menu. You will be taken to the Registration Information page.
  3. On the Registration Information page, click the Authentication Information tab.

Add authentication information

To add authentication information, follow these steps.

  1. In the Credentials tab, click the Add button. The Add Credentials popup opens.
  2. Add Authentication Info Enter the information in the popup window.
  3. All tools and URLs that the user can access are displayed.
  4. After completing the information entry, click the Connection Test button.
  5. Click the Save button.

Modify authentication information

To modify the authentication information, follow these steps.

  1. In the Authentication Information tab, click the authentication information you want to edit. The Edit Authentication Information popup will open.
  2. Edit Authentication Information After entering the information in the popup window, click the Connection Test button.
  3. Save button is enabled, click the Save button.

Delete authentication information

To delete the credentials, follow these steps.

  1. In the Credential tab, select the checkbox of the credential you want to delete.
  2. Click the Delete button in the Authentication information list.
  3. In the confirmation popup, click the Confirm button.
Caution
If the authentication information is in use, it cannot be deleted.

Manage Subscribed Tenants

Users can view the list of tenants they have joined.
You can also request to join a new tenant, and you can leave a tenant you are already a member of.

To manage the tenant you have joined, follow these steps.

  1. Click the Admin icon at the top right of the Main page. You will be taken to the Tenant Dashboard page.
  2. Click the Sign-up Information menu in the left menu. You will be taken to the Sign-up Information page.
  3. On the Registration Info page, click the Registered Tenant tab.

Request tenant registration

To request tenant enrollment, follow the steps below.

  1. Click the Join button in the Joined Tenant tab. The Tenant Join Request popup window opens.
  2. Tenant Registration Request In the popup window, enter the tenant code you wish to register and click the Search icon.
  3. Enter the request reason and click the Add button.
  4. After selecting the permissions of the added tenant, click the Save button.
  5. Click the Confirm button in the confirmation popup.

Leave tenant

To withdraw from the tenant, follow the steps below.

  1. In the Joined Tenants tab, select the checkbox of the tenant you wish to withdraw.
  2. Click the Delete button.
  3. In the confirmation popup, click the Confirm button.

Manage Joined Project Groups

Users can view the list of project groups they have joined.

To manage the project groups you have joined, follow these steps.

  1. Click the Admin icon at the top right of the Main page. You will be taken to the Tenant Dashboard page.
  2. From the left menu, click the Sign-up Information menu. You will be taken to the Sign-up Information page.
  3. On the Sign-up Information page, click the Joined Project Group tab.

When you click a project group in the project group list, you are taken to the Project Group Management page.

For detailed information on project group management, please refer to the Project Group Overview.

Manage Joined Projects

Users can view the list of projects they have joined.

To manage the projects you have joined, follow these steps.

  1. Click the Admin icon at the top right of the Main page. You will be taken to the Tenant Dashboard page.
  2. Click the Sign-up Information menu in the left menu. You will be taken to the Sign-up Information page.
  3. On the Sign-up Information page, click the Joined Projects tab.

When you click a project in the project list, you are taken to the Project Management page.

For detailed information about the project, see the 프로젝트.

2 - Tutorial (From Project Creation to Build/Deploy)

Through the following steps, the user can create a DevOps Console project, build the source to create an image, and deploy the Helm chart to a Kubernetes cluster.

Create Project Group

Users can create a project group. Users must be a member of the tenant where they will create the project group.

Create Project Group

To create a project group, follow these steps.

  1. On the Main page, click the Create Project Group and Start button or the Create Project Group button. The Create Project Group popup opens.
  2. After entering the items, click the Save button to complete the creation of the project group.
Reference
  • Approval from the tenant administrator may be required.
  • If there are no selectable tenants, click the Tenant Registration Shortcut link to proceed with tenant registration.

Register Tenant

To join a tenant, follow these steps.

  1. In the Create Project Group popup, click the Tenant Join Shortcut link. The Tenant Join Request popup opens.
  2. Enter the tenant code to register in the Tenant Search field accurately and click the Search icon. The tenant information will be retrieved.
  3. Verify that the displayed tenant is correct, enter the request reason, and click the Add button. It will be added to the list below.
  4. After selecting the permissions for the tenant added to the list below, click the Save button.

(Helm chart deployment)Create a project

Reference
  • Users must be members of a project group and tenant to be able to create projects.
  • Refer to Creating a Project Group for how to join a project group and tenant.

Users can create a project that deploys an application to a specific Kubernetes cluster using App.Template, Helm Chart, and Tool Management.

Start Project Creation

To start creating a project, follow these steps.

  1. On the Main page, click the Create Project button. The Create Project page opens.

Enter basic information

Enter the basic information of the project. The project name and project ID must be unique and cannot be duplicated.

To enter the basic information, follow the steps below.

  1. On the Project Creation page, select the App. Template Utilization option of the Project Configuration Method item.
  2. For the deployment target field, select Kubernetes.
  3. After entering additional content, click the Start button.
    ItemExplanation
    Project namePlease enter the project name.
    Project IDPlease enter the project ID.
    Project configuration methodSelect a project configuration method
    • Use App template: select a pre‑provided App template.
    • Manual configuration: configure without an App template.
    deployment targetSelect deployment target
    • Kubernetes: Deploy the application to a Kubernetes cluster.
    • Kubernetes(ArgoCD): Deploy the application to a Kubernetes cluster using ArgoCD.
    • VM(Artifact): Deploy the application to a VM server.
    • VM(Docker): Package the application as a Docker image and deploy it to a VM server.
    • N/A: Choose this when you do not deploy the build output.
    K8S clusterSelect the target cluster for deployment
    • DevOps Console Only clusters that the user has access rights to can be selected among the K8S clusters.
    namespaceSelect the target namespace for deployment
    • Only namespaces that the user has access rights to, among the clusters retrieved from the K8S cluster, can be selected.
    Table. Project creation basic information entry items

Select Application Template

Note
For detailed information about the application template, see App.템플릿.

The user can select an application template to configure the project.

If you create a project based on an application template that includes sample source code, you can view the application that will be deployed.

In contrast, using a template labeled Environment Only configures only the build/deployment environment without sample source code.

If you configure a project using an already set up source code repository, select the template marked Environment Only.

To start selecting an application template, follow these steps.

  1. On the Application Template screen, enter the template name, select the application template card you want, and then click.
  2. When the Next button is enabled, click the Next button.
    ItemExplanation
    FilterYou can easily find application templates using predefined filters.
    searchYou can easily find application templates through search.
    Table. Project Creation Application Template Items

Set up the code repository

Users can configure a repository for managing source code through the code repository setup step.

Create new repository and use existing repository activation conditions differ depending on the application template and tool.

Repository typeApp with source code. Template
+
DevOps Console registration tool
App with source code included. Template
+
DevOps Console unregistered tool
Source code not included (EnvironmentOnly)
App. Template
+
DevOps Console registration tool
Source code not included (Environment Only)
App. Template
+
DevOps Console unregistered tool
Create new repositoryXX
Use existing repositoryXX
Table. Conditions for creating a new repository and enabling use of existing repository

Note
Once authentication information is saved, you can perform a Connection Test without entering account information by using Use Saved Authentication Information thereafter.

To modify or delete stored credentials, refer to Manage Authentication Information.

To set up the code repository, follow these steps.

  1. In the Code repository item, select the Code repository type.
  2. Select Create new repository or Use existing repository, then enter the information.
  3. Enter authentication information and click the Connection Test button.
  4. When the Next button is enabled, click the Next button.
    ItemExplanation
    Repository typeSelect the code repository to use
    • Registered tool: The user can select and use the types of SCM Repository tools (Github, Gitlab, etc.) that are available.
    • Unregistered tool: You can enter the domain of an unregistered tool to use it. The unregistered tool entry appears only when the source code is not included (Environment Only) App. Template.
    New/Existing usagePlease select New repository creation or whether to use an existing repository.
    Repository informationEnter repository information
    • When creating a new repository, the URL is formed from the project group name/project name.
    Authentication informationEnter authentication information
    • If you do not have an account, Don’t have an account? click the link to open the Account Creation Information popup where you can create an account.
    • After creating a new account, be sure to change your password via the Set Initial Password link.
    (Unregistered tool)
    Repository information
    Enter repository information
    • You can use a code repository that is not registered as a tool in DevOps Console.
    • Click the URL Check button to undergo an additional verification process.
    Table. Project Creation Code Repository Settings

Configure code quality

Users can configure a repository for quality management.

To set code quality, follow these steps.

  1. In the Code Quality item, select Repository Type.
  2. Enter Basic Information and Authentication Information, then click the Connection Test button.
  3. Next button is enabled, click the Next button.
    ItemExplanation
    Repository typeSelect the repository to use
    • The types of Code Quality tools available to the user are displayed.
    New / Existing / Unused statusSelect repository creation method
    • If you select Create new repository, you must enter the quality project name/quality project key.
    • If you select Do not create, you can proceed directly to the next step.
    Base URLSelect the SonarQube URL.
    Quality Project NameEnter the name of the SonarQube project.
    Quality Project KeyEnter the Key of the SonarQube project.
    authentication informationEnter authentication credentials
    • You can create a new user or use existing authentication credentials.
    Table. Project Creation Code Quality Settings

Configure image repository

Users can configure a repository to store the built container images through the image repository configuration step.

Note
Once authentication information is saved, you can perform a Connection Test without entering account information by using Use Saved Authentication Information thereafter.

To modify or delete stored credentials, refer to Manage Authentication Information.

To set up the image repository, follow these steps.

  1. In the Image Repository item, select the Repository Type.
  2. Create new repository / Use existing repository select, then enter the information.
  3. Enter authentication information and click the Connection Test button.
  4. When the Next button is enabled, click the Next button.
    ItemExplanation
    Repository typeSelect the repository type to use
    • The types of Image Registry tools available to the user are displayed.
    Repository informationSelect the repository creation method.
    • When creating a new repository, the URL is formed with the project group name/project name.
    Authentication informationEnter your credentials.
    Table. Project Creation Image Repository Settings

Configure the deployment target environment

Users can deploy by directly configuring via Helm charts.

Helm release name and Helm chart when selected, the Helm chart installation options and the default Values.yaml entries included in the chart are displayed.

Available Helm charts are associated with the App template. You can edit or delete them through Manage supported Helm charts.

To set the deployment target environment, follow these steps.

  1. In the Deployment target field, select Configure directly via Helm chart.
  2. Please enter the Helm release name.
  3. Click the Search button to select the Helm chart to use.
  4. After editing Values.yaml, click the Validation Check button.
  5. When the Next button is enabled, click the Next button.
    ItemExplanation
    deployment targetPlease select the deployment target.
    Helm release nameEnter the name of the Helm release to create.
    • The name must be unique within the namespace of the target cluster.
    Helm chartSelect a Helm chart.
    • When a Helm chart is selected, detailed information about the chosen chart is displayed below
    K8S informationShows the information of the Kubernetes cluster required for configuring Value.yaml.
    Values. yamlEdit the contents of Values.yaml.
    • values.yaml file to be used when installing the Helm chart.
    Table. Project creation deployment target environment configuration items

Setting up the Build Pipeline

Users can configure pipelines that build and deploy applications.

You can view each stage of the pipeline to be configured and rename the build job.

To set up the build pipeline, follow these steps.

  1. Build Pipeline screen branches based on IDP integration status.
    • For IDP-integrated Jenkins, click the User Check button to perform User Registration Confirmation.
    • For Jenkins not integrated with IDP, enter the authentication information and click the Connection Test button.
  2. When the Next button is enabled, click the Next button.
    Item
    Explanation
    Build/Deployment pipelineDisplays build/deployment pipeline information.
    • The build/deployment pipeline is displayed based on the information registered in the App template’s Manage Pipeline Templates.
    CategorySelect the development/operation distinction.
    • The permissions for the pipeline vary according to the development/operation distinction.
    URLSelect Jenkins to configure the pipeline, then enter the job name.
    • The Jenkins instances available to the user are displayed.
    Build AgentSelect the agent to be used for pipeline builds.
    Build environment OSDisplays the OS information of the environment in which the build agent runs.
    User informationIDP Integrated Jenkins
    • Click the User Check button to verify user registration.
    • If you are not registered as a Jenkins user, when the User Registration Guide popup appears, click the Go to Jenkins link to proceed with User Sign‑Up or Initial Jenkins Login.
    IDP Non‑Integrated Jenkins
    • Enter the authentication information and click the Connection Test button.
    Set environment variablesSet the environment variables to be registered in the Jenkins pipeline.
    Image Tag PatternSelect the tag assignment method for the container image.
    Deploy StrategySelect the deployment method for the container image.
    Recipient of deployment resultsSelect the user who will receive the results after the build pipeline completes.
    Table. Project creation build pipeline configuration items

Customize Settings

The user can specify and modify the path of the Dockerfile file used for the build.

Additionally, you can view the final script generated based on the information configured in 빌드 파이프라인 설정하기 and also edit it.

Dockerfile, follow these steps to configure the pipeline script.

  1. After entering information on the Custom settings page, click the Connection Test button.
  2. Click the Next button when the Next button is enabled.
    ItemExplanation
    Dockerfile configurationCreate New Dockerfile or Use Existing Dockerfile. Please select.
    • «Use Existing Dockerfile is only selectable after choosing the Environment Only App template and, in 코드 저장소 설정하기, selecting Use Existing Repository.
    Dockerfile pathSpecify the Dockerfile file path in the source code.
    Branch nameThe branch name is automatically registered when you set it in Code Repository Configuration.
    DockerfileCheck and modify the contents of the Dockerfile.
    pipeline scriptCheck and modify the pipeline script.
    Table. Project Creation Custom Settings Items
Note
For detailed information about Jenkins pipeline scripts, see the official site.

Complete project creation

The user can review the project and tool information to be created and start project creation.

To complete project creation, follow the steps below.

  1. Summary Information After checking the information on the screen, click the Complete button.
  2. Project Creation popup window opens and the project creation proceeds.
  3. After the project creation is complete, click the Confirm button to go to the Project page.
Notice
It cannot be canceled during creation, and when the project is created successfully, the Confirm button becomes active.

Check Build Pipeline Execution

On the Project page, you can view the pipeline execution status, and once the initial project creation is complete, the build pipeline runs automatically.

If the build pipeline fails, use the left Build Pipeline menu to modify and rerun the pipeline.

To verify the build pipeline execution, follow these steps.

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

Check deployment results

After the pipeline finishes running, you can check the Helm chart deployment results.

For detailed information about the Helm chart deployment results, refer to the Helm release.

To verify the deployment results, follow the steps below.

  1. Main page, click the Project card. Project Dashboard page will be displayed.
  2. Click the Build/Deploy > Kubernetes Deploy menu in the left menu. You will be taken to the Kubernetes Deploy page.
  3. Click the Helm Release list to view detailed deployment results.

2.1 - Add Build/Deploy (Helm Chart Deployment)

The user can, through the following steps, create a new build pipeline in an already created DevOps Console project, build the source to create an image, and perform Helm chart deployment to a Kubernetes cluster.

Through Helm install, the deployed Helm release will be used in Deploy to K8S stage configuration.

Getting Started with Build/Deploy Additions

To begin adding build and deployment, follow these steps.

  1. Click the Project card on the Main page. You will be taken to the Project Dashboard page.

Add code repository (Option)

Reference
Proceed only if a new code repository is needed.

Repository typeApp with source code. Template
+
DevOps Console registration tool
App with source code included. Template
+
DevOps Console unregistered tool
Source code not included (EnvironmentOnly)
App. Template
+
DevOps Console registration tool
Source code not included (Environment Only)
App. Template
+
DevOps Console unregistered tool
Create new repositoryXX
Use existing repositoryXX
Table. Conditions for creating a new repository and enabling use of existing repository

To add a code repository, follow these steps.

  1. On the Main page, click the Project card. You will be taken to the Project Dashboard page.
  2. Click Repository > Code Repository in the left menu.
  3. Click the Add Code Repository button at the top right. The Add Code Repository page opens.
  4. Enter/set each item and click the Connection Test button.
  5. Click the Save button to complete Add code repository.
    ItemExplanation
    Repository typeSelect the repository to use
    • Registered tool: The user can select and use the types of SCM Repository tools (Github, Gitlab, etc.) that are available.
    • Unregistered tool: You can enter the domain of a tool that will not be registered to use it. The unregistered tool option appears only for App templates that do not include source code (Environment Only).
    New/Existing usageSelect Create new repository or Use existing repository
    Repository informationEnter repository information
    • When creating a new repository, the URL is formed from the project group name/project name.
    Authentication informationEnter authentication credentials.
    Repository informationEnter repository information
    • You can use a code repository that is not registered as a tool in DevOps Console.
    • Click the URL Check button to proceed with the verification process.
    Table. Code Repository Configuration Items

Add image repository (Option)

Note
Proceed only if a new image repository is needed.

To add an image repository, follow these steps.

App. Add image repository

  1. On the Image Repository page, click the App. Add Image Repository button in the upper right. You will be taken to the App. Add Image Repository page.
  2. App. Add Image Repository page, enter and configure each item.
  3. Connection Test Click the button.
  4. Click the Save button.
    ItemExplanation
    Select repository typeSelect the image repository type.
    To use an image repository not registered in the Devops Console, select the Image Registry type.
    Choose whether to create a repositoryChoose whether to create a new repository or use an existing one.
    • If you selected the Docker hub or Image Registry type earlier, you can only select Use existing repository.
    Registered toolEnter repository information.
    Unregistered toolEnter repository information
    • You can register an image repository that is not registered with the DevOps Console tool.
    • Click the URL Check button to proceed with the verification process.
    • Only Use existing repository can be selected.
    Table. App. Add Image Repository Input Fields

Add pull-only image repository

  1. On the Image Repository page, click the Add Pull-Only Image Repository button in the upper right. You will be taken to the Add Pull-Only Image Repository page.
  2. Add Pull‑only Image Repository On the page, enter and configure each field.
  3. Connection Test Click the button.
  4. Click the Save button.

Install Helm

To install Helm, 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 > HelmInstall menu in the left menu.
  3. In the K8S cluster field, select the K8S cluster you wish to install.
  4. Click the Helm chart you want to install to go to the Helm Chart Details screen.
  5. Click the Helm Install button. It navigates to the Helm Chart Install screen.
  6. Enter each item and click the Next button.
    ItemExplanation
    Release nameEnter the name to use in the Helm chart release.
    It must be unique and cannot be duplicated within the namespace.
    CategoryDevelopment, Operations
    VersionSelect the version of the chart you want to install with Helm.
    K8S clusterDisplays the target K8S cluster for Helm install.
    Changes cannot be made, and if you wish to change, please select the K8S cluster from Start Helm Install.
    namespaceSelect the target namespace for the helm install from the list.
    Reference informationThis is reference information provided by the selected K8S cluster. Click each tab to view detailed information.
    Default Values.yaml included in the chartYou can edit the values.yaml file to run helm install with the desired values.
    If needed, refer to the reference information and edit the values.yaml file with those values.
    Writing typeForm type items are displayed only for Helm charts that support Form input
    • Form: Enter the items shown on the screen. For creating Helm charts that support Form input, see Creating Helm charts that support Form input.
    • values.yaml: Edit values in the yaml editor screen just like a regular Helm chart.
    Form / values.yaml input can be toggled, but switching clears any previously entered data.
    Form inputThis is the screen displayed when you select Form in the creation type; review each item and enter the values. After completing the entry, click the Validation Check button to verify the input values.
    Table. Helm Install Configuration Items
  7. Helm chart installation A popup window opens. Click the Run button to complete the Helm install.
  8. When the installation is complete, the Kubernetes deployment page opens.

Add Build Pipeline

To add a build pipeline, follow these steps.

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

Setting parameters

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

  1. Click the Parameter area. The Parameter registration page opens on the right.
  2. When you click the Add button, the Add Parameter popup window opens.
  3. Add a parameter and click the Apply button to complete the parameter configuration.

Setting Environment Variables

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

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

Configure email recipients for build results

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

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

Configure additional stage

Setting up the Checkout stage

To add a Checkout stage, follow these steps.

  1. Click the New Stage area. The stage settings page opens on the right.
  2. Choose Checkout as the Stage type.
  3. Enter the information and click Apply. (In the URL, you can select the code repository you added from Add Code Repository (Option).)
    ItemExplanation
    URLSelect the code repository to perform the checkout.
    Branch nameEnter the name of the branch to checkout.
    Table. Checkout Stage Settings

Configure the Build stage

To add a Build stage, follow these steps.

  1. Click the Add icon to add a new stage.
  2. Click the New Stage area. The Stage Settings page opens on the right.
  3. On the Stage Settings page, select Build as the Stage Type.
  4. After entering information on the Stage Settings page, click the Apply button.
    ItemExplanation
    languageSelect the programming language used by the application.
    Build toolSelect the Build tool used for building the application.
    Provides default Shell commands based on the selected Build tool.
    Shell commandEnter the command to use for building the application.
    All commands available in the Shell can be used.
    Table. Build stage input items

Setting Up Docker Build Stages

To add a Docker Build stage, follow these steps.

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

Deploy to K8S Stage Configuration

Deploy to K8S To add a stage, follow the steps below.

  1. Click the Add icon to add a new stage.
  2. Click the New Stage area. The stage settings page opens on the right.
  3. Select Deploy to K8S as the Stage type.
  4. After entering the information, click the Apply button. (Type Helm Release (Helm Chart type) can be selected to choose the Helm Release added in 헬름인스톨 하기.)
Item
Explanation
typeSelect deployment type
  • Helm release (Helm chart type)
  • Workload
  • ArgoCD
K8S clusterSelect a K8S cluster
  • Helm release (Helm chart type) When selected, a list of Helm releases deployed via the DevOps Console is displayed.
namespacePlease select a namespace.
Helm releaseSelect HelmRelease.
Deployment methodSelect deployment method
  • Recreate
  • Rolling Update
Registry URLSelect the image repository where the image to be deployed to Kubernetes has been docker pushed.
SecretSelect the secret information input method
  • Auto-generate: Automatically create the secret corresponding to the selected image repository from the Registry URL in the DevOps Console and use it.
  • Use existing secret: Use a pre-created secret through K8S secret management.
Table. Deploy to K8S stage input items

Check the final pipeline script

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

Pipeline addition result

Note
The added pipeline does not run automatically. If execution is required, run the pipeline manually.

2.2 - Add Build/Deploy (Workload Deployment)

The user can, through the following steps, create a new build pipeline in an already created DevOps Console project, build the source to create an image, and perform workload deployment on a Kubernetes cluster.

The workload added via Add Workload will be used in Deploy to K8S Stage Setup.

Build/Deploy Add Getting Started

To begin adding build/deployment, follow these steps.

  1. Click the Project card on the Main page. You will be taken to the Project Dashboard page.

Add code repository (Option)

Info
Proceed only if a new code repository is needed.

To add a code repository, follow these steps.

  1. On the Code Repository page, click the Add Code Repository button in the upper right. You will be taken to the Add Code Repository page.
  2. On the Add Code Repository page, enter and configure each item.
  3. Connection Test Click the button.
  4. Click the Save button.
    ItemExplanation
    Repository typeSelect the repository to use
    • Registered tools: Users can select and use the types of SCM Repository tools (Github, Gitlab, etc.) that are available.
    • Unregistered tools: You can enter the domain of a tool that is not registered. The unregistered tool entry appears only for App templates that do not include source code (Environment Only).
    New/Existing usageSelect Create new repository or Use existing repository
    Repository informationEnter repository information
    • When creating a new repository, the URL is formed from the project group name/project name.
    Authentication informationEnter authentication credentials.
    Repository informationEnter repository information
    • You can use a code repository that is not registered as a tool in DevOps Console.
    • You must also go through the URL check process.
    Table. Code Repository Add Input Items

Add image repository (Option)

Information
Proceed only if a new image repository is needed.

To add an image repository, follow these steps.

App. Add image repository

  1. On the Image Repository page, click the App. Add Image Repository button in the upper right. You will be taken to the App. Add Image Repository page.
  2. App. Add Image Repository page, enter and configure each item.
  3. Connection Test Click the button.
  4. Click the Save button.
    ItemExplanation
    Select repository typeSelect the image repository type.
    To use an image repository not registered in the Devops Console, select the Image Registry type.
    Choose whether to create a repositoryChoose whether to create a new repository or use an existing one.
    • If you selected the Docker hub or Image Registry type earlier, you can only select Use existing repository.
    Registered toolEnter repository information.
    Unregistered toolEnter repository information
    • You can register an image repository that is not registered with the DevOps Console tool.
    • Click the URL Check button to proceed with the verification process.
    • Only Use existing repository can be selected.
    Table. App. Add Image Repository Input Fields

Add pull-only image repository

  1. On the Image Repository page, click the Add Pull-Only Image Repository button in the upper right. You will be taken to the Add Pull-Only Image Repository page.
  2. Add Pull‑only Image Repository On the page, enter and configure each field.
  3. Connection Test Click the button.
  4. Click the Save button.

Add workload

To add a workload, follow the steps below.

  1. On the Main page, click the Project card. You will be taken to the Project Dashboard page.
  2. Click the Build/Deploy > Kubernetes Deploy menu in the left menu. You will be taken to the Kubernetes Deploy page.
  3. On the Kubernetes deployment page, click the Add workload menu. The Add workload popup opens.
  4. Add Workload Enter the information in the popup window and click the Save button.
  5. In the confirmation popup, click the Confirm button to complete adding the workload.
    Item
    Explanation
    Query targetOnly workloads deployed with the same Base image as the App template used when the project was first created are displayed.
    Workload already registered in the projectShows the workload already registered in the project.
    • Workloads already registered in the project cannot be added.
    Table. Additional Workload Input Items

Modify K8S authentication information

K8S credentials are the authentication information used to verify permission to use a K8S cluster/namespace when performing a deployment in the build pipeline.

To modify the K8S credentials, follow these steps.

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

Add Build Pipeline

To add a build pipeline, follow these steps.

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

Setting Parameters

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

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

Setting Environment Variables

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

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

Configure email recipients for build results

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

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

Add additional stage

Checkout stage setup

To add a Checkout stage, follow these steps.

  1. Click the New Stage area. The Stage Settings page opens on the right.
  2. On the Stage Settings page, select Checkout as the Stage Type.
  3. After entering the information, click the Apply button. (You can select the code repository you added from 코드 저장소 추가하기 (Option) on the URL.)
    Itemdescription
    URLSelect the code repository to perform the checkout.
    Branch nameEnter the name of the branch to checkout.
    표. Checkout 스테이지 입력 항목

Setting up the Build stage

To add a Build stage, follow these steps.

  1. Click the Add icon to add a new stage.
  2. Click the New Stage area. The Stage Settings page opens on the right.
  3. On the Stage Settings page, select Build as the Stage Type.
  4. After entering information on the Stage Settings page, click the Apply button.
    ItemExplanation
    languageSelect the programming language used by the application.
    Build toolSelect the Build tool used for building the application.
    Provides default Shell commands based on the selected Build tool.
    Shell commandEnter the command to use for building the application.
    All commands available in the Shell can be used.
    Table. Build stage input items

Docker Build Stage Setup

To add a Docker Build stage, follow these steps.

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

Deploy to K8S Stage Setup

Deploy to K8S To add a stage, follow the steps below.

  1. Click the + icon to add a new stage.
  2. Click the New Stage area. The Stage Settings page opens on the right.
  3. On the Stage Settings page, select Deploy to K8S as the Stage Type.
  4. On the Stage Settings page, after entering the information, click the Apply button. (If you select a workload in the type, you can select the workload added in 워크로드 추가하기.)
Item
Explanation
typeSelect deployment type
  • Helm release (Helm chart type)
  • Workload
  • ArgoCD
K8S clusterSelect a K8S cluster
  • Helm release (Helm chart type) When selected, a list of Helm releases deployed via the DevOps Console is displayed.
namespacePlease select a namespace.
Helm releaseSelect HelmRelease.
Deployment methodSelect deployment method
  • Recreate
  • Rolling Update
Registry URLSelect the image repository where the image to be deployed to Kubernetes has been docker pushed.
SecretSelect the secret information input method
  • Auto-generate: Automatically create the secret corresponding to the selected image repository from the Registry URL in the DevOps Console and use it.
  • Use existing secret: Use a pre-created secret through K8S secret management.
Table. Deploy to K8S stage input items

Check the final pipeline script

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

Pipeline addition result

Note
The added pipeline does not run automatically. If execution is required, run the pipeline manually.

2.3 - Add Build/Deploy (VM Deployment)

The user can, through the following steps, create a new build pipeline in an already created DevOps Console project, build the source to create an image, and proceed with (VM deployment) on the VM server.

The VM server group/VM server added via Add VM Server Group/VM Server (Option) will be used in Configure Deploy to VM Stage.

Build/Deploy Add Getting Started

To begin adding build/deployment, follow these steps.

  1. On the Main page, click the Project card to go to the Project Dashboard page.

Add code repository (Option)

information
Proceed only if you need a new code repository.

To add a code repository, follow these steps.

  1. On the Code Repository page, click the Add Code Repository button in the upper right. You will be taken to the Add Code Repository page.
  2. On the Add Code Repository page, enter and configure each item.
  3. Connection Test Click the button.
  4. Click the Save button.
    ItemExplanation
    Repository typeSelect the repository to use
    • Registered tools: Users can select and use the types of SCM Repository tools (Github, Gitlab, etc.) that are available.
    • Unregistered tools: You can enter the domain of a tool that is not registered. The unregistered tool entry appears only for App templates that do not include source code (Environment Only).
    New/Existing usageSelect Create new repository or Use existing repository
    Repository informationEnter repository information
    • When creating a new repository, the URL is formed from the project group name/project name.
    Authentication informationEnter authentication credentials.
    Repository informationEnter repository information
    • You can use a code repository that is not registered as a tool in DevOps Console.
    • You must also go through the URL check process.
    Table. Code Repository Add Input Items

Add image repository (Option)

information
Proceed only if a new image repository is needed.

To add an image repository, follow these steps.

App. Add image repository

  1. On the Image Repository page, click the App. Add Image Repository button in the upper right. You will be taken to the App. Add Image Repository page.
  2. App. Add Image Repository page, enter and configure each item.
  3. Connection Test Click the button.
  4. Click the Save button.
    ItemExplanation
    Select repository typeSelect the image repository type.
    To use an image repository not registered in the Devops Console, select the Image Registry type.
    Choose whether to create a repositoryChoose whether to create a new repository or use an existing one.
    • If you selected the Docker hub or Image Registry type earlier, you can only select Use existing repository.
    Registered toolEnter repository information.
    Unregistered toolEnter repository information
    • You can register an image repository that is not registered with the DevOps Console tool.
    • Click the URL Check button to proceed with the verification process.
    • Only Use existing repository can be selected.
    Table. App. Add Image Repository Input Fields

Add pull-only image repository

  1. On the Image Repository page, click the Add Pull-Only Image Repository button in the upper right. You will be taken to the Add Pull-Only Image Repository page.
  2. Add Pull‑only Image Repository On the page, enter and configure each field.
  3. Connection Test Click the button.
  4. Click the Save button.

Add artifact repository (Option)

information

Proceed only if a new artifact repository is needed.

When using a rollback artifact repository, Nexus can only use the raw(hosted) repository type.

To add an artifact repository, follow these steps.

  1. Click the Add Artifact Repository button at the top right of the Artifact Repository page. You will be taken to the Add Artifact Repository page.
  2. On the Add Artifact Repository page, enter and configure each item.
  3. Connection Test Click the button.
  4. Click the Save button.
    ItemExplanation
    Select whether to create a repositoryChoose whether to create a new repository or use an existing one.
    Enter basic informationBase URL, select repository type and enter repository/authentication information.
    Table. Input fields for adding an artifact repository

Add VM Server Group/VM Server (Option)

information
Proceed only if a new VM server group or VM server is required.

To add a VM server group, follow these steps.

  1. Click the Management icon at the top right of the Main page. You will be taken to the Tenant Dashboard page.
  2. Click the Deployment Target > VM Server Group menu in the left menu. You will be taken to the VM Server Group page.
  3. On the VM Server Group page, click the Add button. It navigates to the Add VM Server Group page.
  4. Enter the basic information, then click the Save button to complete the VM server group configuration.
    ItemExplanation
    Server group nameEnter the VM server group name.
    ExplanationPlease enter a description.
    typeSelect the type of VM server group
    • SSH: Perform deployment using SSH commands when deploying a VM.
    • Agent: Perform deployment using an agent when deploying a VM. (Connect Agent)
    VM server
    • Add: Add the VM server that belongs to the VM server group.
    • Delete: Check the checkbox of the VM server you want to delete from the VM server group, then click Delete to remove it.
    Table. VM Server Group Add Input Items

Add VM server

To add a VM server, you need Manager permission for the corresponding VM server group.

Note
The Add VM Server popup opens differently depending on the type of VM server group.

To add a VM server, follow the steps below.

  1. Click the Admin icon at the top right of the Main page. Navigate to the Tenant Dashboard page.
  2. Click the Deployment Target > VM Server Group menu in the left menu. You will be taken to the VM Server Group page.
  3. VM server group page, click the VM server group in the VM server group list where you want to add a VM server. You will be taken to the VM server group detail page.
  4. On the VM Server Group Details page, click the Add button. You will be taken to the Add VM Server page.
  5. Add VM Server page, after entering the basic information, click the Add button to complete the VM server configuration.
    ItemExplanation
    Server nameEnter the VM server name.
    ExplanationEnter the description.
    IPPlease enter the IP.
    SSH PortEnter the port of the VM server to use for SSH connections.
    OSPlease enter the OS.
    LocationPlease select a location.
    Authentication informationEnter the authentication information for the VM server to be used for SSH connections.
    Secret KeyThis is the secret key for authenticating the VM server where the agent is installed.
    Table. VM Server Additional Input Items

Add Build Pipeline

To add a build pipeline, follow these steps.

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

Setting Parameters

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

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

Setting Environment Variables

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

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

Configure email recipients for build results

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

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

Configure additional stage

Setting up the Checkout stage

To add a Checkout stage, follow these steps.

  1. Click the New Stage area. The Stage Settings page opens on the right.
  2. On the Stage Settings page, select Checkout as the Stage Type.
  3. After entering the information, click the Apply button. (You can select the code repository you added from 코드 저장소 추가하기 (Option) on the URL.)
    Itemdescription
    URLSelect the code repository to perform the checkout.
    Branch nameEnter the name of the branch to checkout.
    표. Checkout 스테이지 입력 항목

Setting up the Build stage

To add a Build stage, follow these steps.

  1. Click the Add icon to add a new stage.
  2. Click the New Stage area. The Stage Settings page opens on the right.
  3. On the Stage Settings page, select Build as the Stage Type.
  4. After entering information on the Stage Settings page, click the Apply button.
    ItemExplanation
    languageSelect the programming language used by the application.
    Build toolSelect the Build tool used for building the application.
    Provides default Shell commands based on the selected Build tool.
    Shell commandEnter the command to use for building the application.
    All commands available in the Shell can be used.
    Table. Build stage input items

Configuring Docker Build Stage

To add a Docker Build stage, follow these steps.

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

Deploy to VM Stage Setup

To add a Deploy to VM stage, follow these steps.

  1. + Click the icon to add a new stage.
  2. Click the New Stage area. The Stage Settings page opens on the right.
  3. On the Stage Settings page, select Deploy to VM as the Stage Type.
  4. On the Stage Settings page, after entering the information, click the Apply button.
ItemExplanation
Deployment configurationSelect deployment configuration method
  • Set deployment target (SSH command/Agent): Deploy using SSH commands or an Agent.
  • Write script manually: The user enters all commands directly to deploy.
deployment groupSelect a deployment group
Release InformationThe contents stored in the deployment group are automatically configured.
Manual deploymentSelect the default value for manual deployment
  • Select the default setting for manual deployment parameters when running the pipeline.
Table. Deploy to VM stage input items

Check the final pipeline script

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

Pipeline addition result

Note
The added pipeline does not run automatically. If execution is required, run the pipeline manually.

2.4 - Check Deployment Target Namespace Permissions (Before Project Creation)

The user should create a DevOps Console project following the steps below, verify that they have permission for the target cluster / namespace before building and deploying the source, and, if necessary, request the responsible person to add permissions to the cluster / namespace.

DevOps Console K8S Cluster Namespace Permission Check

To verify permissions for a namespace of the K8S cluster used in the DevOps Console, follow these steps.

  1. Main page, click the Admin icon in the top right. Tenant Dashboard page will open.
  2. In the left menu, click the Deployment Target > K8S Cluster menu. You will be taken to the K8S Cluster list page.
  3. Click the K8S cluster. You will be taken to the Details page of the selected K8S cluster.
  4. Click the Namespace tab. The Namespace List screen appears.
  5. Clicking the namespace takes you to the Namespace Details page.
Caution
You must have Administrator or User permissions. If you do not have permission, request access from the cluster administrator.
Reference
If the deployment target cluster is not registered, register the deployment target cluster manually. For detailed information, refer to the K8S Cluster.