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

Return to the regular view of this page.

Tutorial (Project Creation to Build/Deployment)

1: (Helm Chart Deployment) Adding Build/Deployment

2: (Workload Deployment) Adding Build/Deployment

3: (VM Deployment) Adding Build/Deployment

4: (Before Project Creation) Checking Deployment Target Namespace Permissions

The user can create a DevOps Console project and build the source to create an image and deploy a Helm chart to a Kubernetes cluster through the following procedure.

Creating a Project Group

The user can create a project group. The user must be a member of the tenant to create a project group.

Creating a Project Group

To create a project group, follow these steps:

Click the Create Project Group and Start button or Create Project Group button on the Main page. The Create Project Group popup window opens.
Enter the items and click the Save button to complete the project group creation.

Note

Approval from the tenant administrator may be required.
If there are no available tenants to choose from, click the Join Tenant Quick Link to proceed with tenant registration.

Joining a Tenant

To join a tenant, follow the procedure below.

Project Group Creation popup window, click the Join Tenant Shortcut link. The Tenant Join Request popup window will open.
In the Tenant Search field, enter the tenant code you want to join exactly and click the Search icon. The tenant information will be retrieved.
Verify that the searched tenant is correct, enter the Reason for Request, and click the Add button. It will be added to the list below.
Select the authority for the tenant added to the list below and click the Save button.

Creating a Project (Helm Chart Deployment)

Note

The user must be a member of the project group and tenant to create a project.
For project group and tenant registration, refer to Creating a Project Group.

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

Starting Project Creation

To start creating a project, follow these steps:

Click the Create Project button on the Main page. The Create Project page opens.

Entering Basic Information

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

To enter basic information, follow these steps:

Project Creation page, select Project Configuration Method item’s App. Template Utilization.
Select Kubernetes for the Deployment Target item.

Enter additional content and click the Start button.

Item	Description
Project Name	Enter the project name.
Project ID	Enter the project ID.
Project Configuration Method	Select the project configuration method App. Template Utilization: Select a pre-provided App. template. Direct Configuration: Configure directly without an App. template.
Deployment Target	Select the 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): Deploy the application to a VM server as a Docker image. N/A: Select if the build result is not deployed.
K8S Cluster	Select the target cluster to deploy `DevOps Console` K8S cluster’s cluster, only clusters with user access rights can be selected.
Namespace	Select the target namespace to deploy K8S cluster’s retrieved cluster, only namespaces with user access rights can be selected.

Table. Project Creation Basic Information Input Items

Selecting an Application Template

Note

For more information on application templates, see App Template.

Users can select an application template to configure their project.

If you create a project based on an application template with sample source code, you can verify the application to be deployed.

On the other hand, using a template marked as Environment Only configures only the build/deployment environment without sample source code.

If you are using an already configured source code repository to configure your project, select a template marked as Environment Only.

To start choosing an application template, follow these steps:

Application Template screen, enter the template name to select the desired application template card and click it.
When the Next button is activated, click the Next button.

Item	Description
Filter	You can easily find application templates through predefined filters.
Search	You can easily find application templates through search.

Table. Project Creation Application Template Items

Setting Up a Code Repository

The user can set up a repository to manage the source code through the code repository setting step.

Creating a New Repository and Using an Existing Repository activation conditions vary depending on the Application Template and Tool.

Repository Type	App. template with source code + DevOps Console registered tool / DevOps Code	App. template with source code + DevOps Console unregistered tool	App. template without source code (Environment Only) + DevOps Console registered tool / DevOps Code	App. template without source code (Environment Only) + DevOps Console unregistered tool
New Repository Creation	○	X	○	X
Existing Repository Use	X	X	○	○

Table. New Repository Creation and Existing Repository Activation Conditions

Note

Authentication information, once saved, can be used for Using Saved Authentication Information without entering account information, and Connection Test can be performed from then on.

To modify or delete saved authentication information, please refer to Managing Authentication Information.

To set up a code repository, follow these steps:

In the Code Repository section, select the Code Repository type.
Select Create a New Repository or Use an Existing Repository and enter the information.
Enter the Authentication Information and click the Connection Test button.
If the Next button is activated, click the Next button.

Item	Description
Repository Type	Select the code repository to use Registered Tool: You can select and use the types of SCM Repository tools available to the user (`Github`, `Gitlab`, etc.). DevOps Code: Available if you have applied for `DevOps Code` in the Samsung Cloud Platform Console. Unregistered Tool: You can use it by entering the domain of an unregistered tool. The unregistered tool item only appears when the App. template is Environment Only (without source code).
New/Existing Usage	Select whether to Create a New Repository or Use an Existing Repository. The activation status varies depending on specific conditions. For more information, see Table. New Repository Creation and Existing Repository Usage Activation Conditions.
Repository Information	Enter repository information When creating a new repository, the URL is composed of the project group name/project name.
Authentication Information	Enter authentication information If you don’t have an account, you can create one by clicking the Don’t have an account? link and opening the Account Creation Information popup window. After creating a new account, please change your password through the Initial Password Setting link.
(Unregistered Tool) Repository Information	Enter repository information You can use a code repository that is not registered as a tool in `DevOps Console`. You must go through an additional verification process by clicking the URL Check button.

Table. Project Creation Code Repository Setting Items

Setting Up Code Quality

The user can configure a repository for quality management.

To set up code quality, follow the procedure below.

Code Quality item, select the Repository Type.
Enter Basic Information and Authentication Information, then click the Connection Test button.
When the Next button is activated, click the Next button.

Item	Description
Repository Type	Select the repository to use The types of Code Quality tools available to the user are displayed.
New/Existing/Not Used	Select the repository creation method If you select Create New Repository, you must enter the quality project name/quality project key. If you select Not Created, you can proceed to the next step immediately.
Base URL	Select the `SonarQube` URL.
Quality Project Name	Enter the name of the `SonarQube` project.
Quality Project Key	Enter the key of the `SonarQube` project.
Authentication Information	Enter authentication information You can create a new user or use existing authentication information.

Table. Project Creation Code Quality Setting Items

Setting Up an Image Repository

The user can set up the repository to store the built container image through the image repository setting step.

Note

Authentication information, once saved, can be used for Using Saved Authentication Information without entering account information, and Connection Test can be performed from then on.

To modify or delete saved authentication information, please refer to Managing Authentication Information.

To set up an image repository, follow these steps:

Image Repository section, select the Repository Type.
Select Create New Repository/Use Existing Repository and enter the information.
Enter the Authentication Information and click the Connection Test button.
When the Next button is activated, click the Next button.

Item	Description
Repository Type	Select the type of repository to use The types of Image Registry tools available to the user are displayed.
Repository Information	Select the repository creation method. When creating a new repository, the URL is composed of the project group name/project name.
Authentication Information	Enter the authentication information.

Table. Project Creation Image Repository Setting Items

Setting Up a Release Target Environment

The user can deploy through direct configuration using Helm charts.

When selecting Helm release name and Helm chart, the Helm chart installation items and the default Values.yaml items included in the chart are displayed.

Available Helm charts are linked to App templates. You can modify or delete them through Managing Supported Helm Charts.

To set up the deployment target environment, follow these steps:

Select direct configuration using Helm charts in the deployment target section.
Enter the Helm release name.
Click the Search button to select the Helm chart to use.
Modify the Values.yaml and click the Validation Check button.
Click the Next button when it is activated.

Item	Description
Deployment Target	Select the deployment target.
Helm Release Name	Enter the name of the Helm release to be created. This name must be unique within the namespace of the cluster to be deployed.
Helm Chart	Select the Helm chart. When a Helm chart is selected, detailed information about the selected chart is displayed below.
K8S Information	Displays the information of the Kubernetes cluster required for the Value.yaml configuration.
Values.yaml	Modify the Values.yaml content. This is the `values.yaml` file used when installing the Helm chart.

Table. Project Creation Deployment Target Environment Setting Items

Setting Up a Build Pipeline

Users can configure pipelines for building and deploying applications.

You can check each stage of the pipeline to be configured and change the build job name.

To set up a build pipeline, follow these steps:

Build Pipeline screen branches according to IDP connection.
- For IDP-connected Jenkins, click the User Check button to verify user registration.
- For non-IDP-connected Jenkins, enter authentication information and click the Connection Test button.
When the Next button is activated, click the Next button.

Item	Description
Build/Deploy Pipeline	Displays build/deploy pipeline information. Build/deploy pipeline is displayed based on the information registered in the pipeline template management of the App template.
Classification	Select development/operation classification. Authority for the pipeline varies depending on the development/operation classification. Refer to Table. Authority by Role in Project (1) for role-based authority.
URL	Select `Jenkins` to configure the pipeline and enter the job name. A list of `Jenkins` available to the user will be displayed.
Build Agent	Select the agent to be used for pipeline build. Refer to Agent (Kubernetes) Management and Agent (VM) Management for information on agents.
Build Environment OS	Displays the OS information of the environment where the build agent runs.
User Information	IDP-connected Jenkins Click the User Check button to verify user registration. If not registered as a Jenkins user, a User Registration Guide popup window will open; click the Go to Jenkins link to proceed with User Registration or Initial Jenkins Login. Non-IDP-connected Jenkins Enter authentication information and click the Connection Test button.
Environment Variable Setting	Set environment variables to be registered in the Jenkins pipeline.
Image Tag Pattern	Select the method for assigning tags to container images.
Deploy Strategy	Select the deployment method for container images.
Deployment Result Recipient	Select the user to receive the result after the build pipeline is completed.

Table. Build Pipeline Setting Items for Project Creation

Setting Up User Definitions

Users can specify and modify the path of the Dockerfile file to be used for building.

Additionally, you can check and modify the final script generated based on the information set up in Configuring the Build Pipeline.

To configure Dockerfile and pipeline scripts, follow these steps:

Customize settings page, enter information, and click the Connection Test button.
When the Next button is activated, click the Next button.

Item	Description
Dockerfile Settings	Choose whether to Create a new Dockerfile or Use an existing Dockerfile. Using an existing Dockerfile can only be selected if you choose the `Environment Only` App template and select Use an existing repository in Configuring the Code Repository.
Dockerfile Path	Specify the path of the `Dockerfile` file in the source code.
Branch Name	The branch name is automatically registered when setting up Configuring the Code Repository.
Dockerfile	Check and modify the contents of the `Dockerfile`.
Pipeline Script	Check and modify the pipeline script.

Table. Project Creation Customization Settings

Note

For more information on Jenkins pipeline scripts, refer to the official website.

Completing Project Creation

The user can finally check the project and tool information to be created and start creating the project.

To complete the project creation, follow the procedure below.

Summary Information screen, check the information and click the Complete button.
The Project Creation popup window opens and the project creation proceeds.
After the project creation is complete, click the Confirm button to move to the Project page.

Notice

It cannot be canceled during creation, and if the project is created normally, the Confirm button is activated.

Checking Build Pipeline Execution

On the Project page, you can check the pipeline execution status, and the build pipeline is automatically executed when the project is created for the first time.

If the build pipeline fails, modify and re-execute the pipeline through the Build Pipeline menu on the left.

To check the build pipeline execution, follow these steps:

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

Checking Deployment Results

After the pipeline execution is complete, you can check the Helm chart deployment results.

For more information on Helm chart deployment results, refer to Helm Release.

To check the deployment results, follow these steps:

Click the Project card on the Main page. Move to the Project Dashboard page.
Click the Build/Deployment > Kubernetes Deployment menu on the left. Move to the Kubernetes Deployment page.
Click the Helm Release list to check the detailed deployment results.

1 - (Helm Chart Deployment) Adding Build/Deployment

The user can create a new build pipeline in an already created DevOps Console project and build the source to create an image and deploy it to a Kubernetes cluster through the following procedure.

The Helm Release deployed through Helm Installation will be used in Deploy to K8S Stage Settings.

Start Adding Build/Deployment

To start adding build/deployment, follow the procedure below.

Click the Project card on the Main page. It will move to the Project Dashboard page.

Adding Code Repository (Option)

Note

Proceed only if a new code repository is required.

Repository Type	App. template with source code + DevOps Console registered tool / DevOps Code	App. template with source code + DevOps Console unregistered tool	App. template without source code (Environment Only) + DevOps Console registered tool / DevOps Code	App. template without source code (Environment Only) + DevOps Console unregistered tool
New Repository Creation	○	X	○	X
Existing Repository Use	X	X	○	○

Table. New Repository Creation and Existing Repository Activation Conditions

To add a code repository, follow the procedure below.

Click the Project card on the Main page. It will move to the Project Dashboard page.
Click Repository > Code Repository in the left menu.
Click the Add Code Repository button at the top right. The Add Code Repository page will open.
Enter/set each item and click the Connection Test button.
Click the Save button to complete Add Code Repository.

Item	Description
Repository Type	Select the type of repository to use Registered Tool: Select and use the type of `SCM Repository` tool available to the user (`Github`, `Gitlab`, etc.). DevOps Code: Available when a DevOps Code application has been made in `Samsung Cloud Platform Console`. Unregistered Tool: Enter the domain of an unregistered tool to use it. The unregistered tool item only appears when the App template is `Environment Only`.
New/Existing Usage	Select whether to Create a New Repository or Use an Existing Repository Activation status may vary depending on specific conditions. Refer to Table. New Repository Creation and Existing Repository Usage Activation Conditions for details.
Repository Information	Enter repository information When creating a new repository, the URL is composed of the project group name/project name.
Authentication Information	Enter authentication information.
Repository Information	Enter repository information Code repositories not registered as tools in `DevOps Console` can be used. Click the URL Check button to proceed with the verification process.

Table. Code Repository Setting Items

Adding Image Repository (Option)

Note

Proceed only if a new image repository is required.

To add an image repository, follow the procedure below.

Adding App Image Repository

Image Repository page, click the App Image Repository Addition button in the top right. Move to the App Image Repository Addition page.
On the App Image Repository Addition page, enter/settings for each item.
Click the Connection Test button.
Click the Save button.

Item	Description
Repository Type Selection	Select the image repository type. If you want to use an image repository not registered in Devops Console, select the Image Registry type.
Repository Creation Selection	Choose whether to create a new repository or use an existing one. If you selected `Docker hub` or `Image Registry` type earlier, you can only select Use Existing Repository.
Registered Tool	Enter repository information.
Unregistered Tool	Enter repository information You can register an image repository that has not been registered as a tool in DevOps Console. Click the URL Check button to proceed with the verification process. You can only select Use Existing Repository.

Table. App Image Repository Addition Input Items

Adding Pull-only Image Repository

Image Repository page, click the Add Pull-only Image Repository button at the top right. It moves to the Add Pull-only Image Repository page.
On the Add Pull-only Image Repository page, enter/set each item.
Click the Connection Test button.
Click the Save button.

Helm Installation

To install Helm, follow the procedure below.

Click the Project card on the Main page. It will move to the Project Dashboard page.
Click Build/Deployment > Helm Installation in the left menu.
Select the K8S cluster to install in the K8S cluster item.
Click the desired Helm chart to move to the Helm Chart Details screen.
Click the Helm Installation button. It will move to the Helm Chart Installation screen.

Enter each item and click the Next button.

Item	Description
Release Name	Enter the name to use for the Helm chart release. It must be unique and not duplicated within the namespace.
Type	Development, operation
Version	Select the version of the chart to install Helm.
K8S Cluster	Displays the target K8S cluster for Helm installation. It cannot be changed, and if a change is desired, select the K8S cluster in Helm Installation Start.
Namespace	Select the target namespace for Helm installation from the list.
Reference Information	Reference information provided by the selected K8S cluster. Click each tab to check detailed information.
Chart Included Default Values.yaml	The `values.yaml` file can be modified to run Helm installation with the desired value. If necessary, check the reference information and modify the `values.yaml` file with the corresponding value.
Input Type	The input type item is only displayed for Helm charts that support form input. Form: Enter the items displayed on the screen. Refer to Form Input Support Helm Chart Creation for Helm chart creation that supports form input. `values.yaml`: Modify the value in the general Helm chart yaml editor screen. Form/values.yaml input can be switched, but the previously entered content will be initialized.
Form Input	The screen displayed when Form is selected as the input type, check each item, and enter the value. After entering, click the Validation Check button to verify the input value.

Table. Helm Installation Setting Items

The Helm Chart Installation popup window will open. Click the Run button to complete Helm installation.
Once the installation is complete, the Kubernetes deployment page will open.

Adding Build Pipeline

To add a build pipeline, follow the procedure below.

Main page, click the Project card. Move to the Project Dashboard page.
Click the Build/Deployment > Build Pipeline menu in the left menu. Move to the Build Pipeline page.
On the Build Pipeline page, click the Add Pipeline button at the top right. Move to the Add Pipeline page.
Enter/set each item on the Add Pipeline page.
Click the Next button.

Item	Description
Classification	Select development or operation classification Actions that can be performed by role vary depending on development and operation. Refer to Table. Authority by Role in Project (1) for role-based permissions.
Jenkins URL	Select `Jenkins` to add a build pipeline from the list.
Build Agent	Select 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 OS	Displays the OS information of the environment where the build agent runs.
Folder Type	Select 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	Select a folder from the list or enter the name of the new folder to be created.
Pipeline Name	Enter the pipeline name.
Parameter Setting	Set the parameters to be used in the pipeline.
Environment Variable Setting	Set the environment variables to be used in the pipeline.
Stage Setting	Set the stages to be used in the pipeline.
Build Result Email Recipient Setting	Set 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 the pipeline, follow the procedure below.

Click the Parameters area. The Parameter Registration page will open on the right.
Click the Add button to open the Add Parameter popup window.
Add parameters and click the Apply button to complete parameter settings.

Setting Environment Variables

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

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

Setting Build Result Email Recipients

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

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

Setting Additional Stages

Setting Checkout Stage

To add a Checkout stage, follow the procedure below.

Click the New Stage area. The stage setting page will open on the right.
Select Checkout as the Stage Type.
Enter information and click Apply. (The code repository added in Adding Code Repository (Option) can be selected from the URL.)

Item	Description
URL	Select the code repository to perform checkout.
Branch Name	Enter the branch name to checkout.

Table. Checkout Stage Setting Items

Setting Build Stage

To add a Build stage, follow these steps:

Click the plus icon to add a new stage.
Click the new stage area. The Stage Settings page opens on the right.
On the Stage Settings page, select Build as the Stage Type.
On the Stage Settings page, enter the information and click the Apply button.

Item	Description
Language	Select the programming language used by the application.
Build Tool	Select the Build tool used for application building. Provides default Shell commands based on the selected Build tool.
Shell Command	Enter the command to use for application building. All commands available in the Shell can be used.

Table. Build Stage Input Items

Setting Docker Build Stage

To add a Docker Build stage, follow these steps:

Plus icon을 클릭하여 새로운 스테이지를 추가하세요.
New Stage 영역을 클릭하세요. Stage Settings 페이지가 오른쪽에 열립니다.
Stage Type으로 Docker Build를 선택하세요.
정보 입력 후 Apply 버튼을 클릭하세요. (Registry URL에서 Adding Image Repository (Option)에서 추가한 이미지 저장소를 선택할 수 있습니다.)

Item	Description	Example
Registry URL (`docker push`)	Select the image repository where the completed Docker build result image will be pushed.
ID	ID value of the account to be used in the image repository
Image Tag Pattern	The 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 Repository	The Add Base Image Repository popup window will open. For more information, see Add Base Image Repository.
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 Tool	Displays the image build tool.
Pre-build Command	If there are commands that must be executed before building the Docker image, write them in Shell command format.	`cp target/*.jar docker/`
Image Build Folder	If the Docker image build needs to be executed in a specific folder, select the checkbox and enter the folder path.	`docker`
Dockerfile	Enter the Dockerfile file name.	`Dockerfile`
Image Build Options	If additional options are required for the image build tool, enter them.	`--no-cache`
Build Command	Displays the actual image build command to be executed.
Post-build Command	If 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

Setting Deploy to K8S Stage

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

Click the Add icon to add a new stage.
Click the New Stage area. The stage setting page will open on the right.
Select Deploy to K8S as the Stage Type.
Enter information and click the Apply button. (When selecting Helm Release (Helm Chart Type) in Type, the Helm release added in Helm Installation can be selected.)

Item	Description
Type	Select deployment type Helm Release (Helm Chart Type) Workload ArgoCD
K8S Cluster	Select K8S cluster Helm Release (Helm Chart Type) selection will display a list of Helm releases deployed through DevOps Console.
Namespace	Select namespace.
Helm Release	Select Helm release.
Deployment Method	Select deployment method Recreate Rolling Update
Registry URL	Select the image repository where the image to be deployed to Kubernetes is `docker push`ed.
Secret	Select 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

Checking Final Pipeline Script

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

Result of Adding Pipeline

Note

The added pipeline will not be executed automatically. If execution is required, run the pipeline directly.

2 - (Workload Deployment) Adding Build/Deployment

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

The workload added through Adding Workload will be used in Setting up Deploy to K8S Stage.

Starting Build/Deployment Addition

To start adding build/deployment, follow the procedure below.

Click the Project card on the Main page. It moves to the Project Dashboard page.

Adding Code Repository (Option)

Guide

Proceed only if a new code repository is needed.

To add a code repository, follow the procedure below.

Code Repository page, click the Add Code Repository button in the top right corner. It will move to the Add Code Repository page.
On the Add Code Repository page, enter/set each item.
Click the Connection Test button.
Click the Save button.

Item	Description
Repository Type	Select the repository to use Registered Tool: You can select and use the types of SCM Repository tools available to the user (`Github`, `Gitlab`, etc.). DevOps Code: Available if you have applied for `DevOps Code` use in the Samsung Cloud Platform Console. Unregistered Tool: You can use it by entering the domain of an unregistered tool. The unregistered tool item only appears when the App template is `Environment Only` (without source code).
New/Existing Usage	Select Create New Repository or Use Existing Repository Activation status may vary depending on specific conditions. For more information, see Table. Conditions for Creating New Repository and Activating Existing Repository.
Repository Information	Enter repository information When creating a new repository, the URL is composed of the project group name/project name.
Authentication Information	Enter authentication information.
Repository Information	Enter repository information You can use a code repository that is not registered as a tool in the DevOps Console. An additional URL check process is required.

Table. Add Code Repository Input Items

Adding Image Repository (Option)

Guide

Proceed only if a new image repository is needed.

To add an image repository, follow the procedure below.

App. Adding Image Repository

Image Repository page, click the App Image Repository Addition button in the top right. Move to the App Image Repository Addition page.
On the App Image Repository Addition page, enter/settings for each item.
Click the Connection Test button.
Click the Save button.

Item	Description
Repository Type Selection	Select the image repository type. If you want to use an image repository not registered in Devops Console, select the Image Registry type.
Repository Creation Selection	Choose whether to create a new repository or use an existing one. If you selected `Docker hub` or `Image Registry` type earlier, you can only select Use Existing Repository.
Registered Tool	Enter repository information.
Unregistered Tool	Enter repository information You can register an image repository that has not been registered as a tool in DevOps Console. Click the URL Check button to proceed with the verification process. You can only select Use Existing Repository.

Table. App Image Repository Addition Input Items

Adding Pull-only Image Repository

Image Repository page, click the Add Pull-only Image Repository button at the top right. It moves to the Add Pull-only Image Repository page.
On the Add Pull-only Image Repository page, enter/set each item.
Click the Connection Test button.
Click the Save button.

Adding Workload

To add a workload, follow the procedure below.

Main page, click the Project card. It moves to the Project Dashboard page.
In the left menu, click the Build/Deploy > Kubernetes Deployment menu. It moves to the Kubernetes Deployment page.
On the Kubernetes Deployment page, click the Add Workload menu. The Add Workload popup window opens.
In the Add Workload popup window, enter the information and click the Save button.
In the confirmation popup window, click the Confirm button to complete adding the workload.

Item	Description
Target to be retrieved	Only workloads deployed with the same image as the base image of the App template used when creating the project for the first time are displayed.
Workload already registered in the project	It shows the workload already registered in the project. Workloads already registered in the project cannot be added.

Table. Input items for adding workload

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.

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

Adding Build Pipeline

To add a build pipeline, follow the procedure below.

Main page, click the Project card. Move to the Project Dashboard page.
Click the Build/Deployment > Build Pipeline menu in the left menu. Move to the Build Pipeline page.
On the Build Pipeline page, click the Add Pipeline button at the top right. Move to the Add Pipeline page.
Enter/set each item on the Add Pipeline page.
Click the Next button.

Item	Description
Classification	Select development or operation classification Actions that can be performed by role vary depending on development and operation. Refer to Table. Authority by Role in Project (1) for role-based permissions.
Jenkins URL	Select `Jenkins` to add a build pipeline from the list.
Build Agent	Select 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 OS	Displays the OS information of the environment where the build agent runs.
Folder Type	Select 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	Select a folder from the list or enter the name of the new folder to be created.
Pipeline Name	Enter the pipeline name.
Parameter Setting	Set the parameters to be used in the pipeline.
Environment Variable Setting	Set the environment variables to be used in the pipeline.
Stage Setting	Set the stages to be used in the pipeline.
Build Result Email Recipient Setting	Set the recipient to receive the result email after the pipeline is completed (success/failure).

Table. Build Pipeline Addition Setting Items

Setting up Parameters

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

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

Setting up Environment Variables

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

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

Setting up Build Result Email Recipients

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

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

Setting up Additional Stages

Setting up Checkout Stage

To add a Checkout stage, follow these steps:

Click the New Stage area. The Stage Settings page opens on the right.
On the Stage Settings page, select Checkout as the Stage Type.
Enter the information and click the Apply button. (You can select the code repository added in Adding a Code Repository (Option) from the URL.)

Item	Description
URL	Select the code repository to perform checkout.
Branch Name	Enter the `branch` name to checkout.

Table. Checkout Stage Input Items

Setting up Build Stage

To add a Build stage, follow these steps:

Click the plus icon to add a new stage.
Click the new stage area. The Stage Settings page opens on the right.
On the Stage Settings page, select Build as the Stage Type.
On the Stage Settings page, enter the information and click the Apply button.

Item	Description
Language	Select the programming language used by the application.
Build Tool	Select the Build tool used for application building. Provides default Shell commands based on the selected Build tool.
Shell Command	Enter the command to use for application building. All commands available in the Shell can be used.

Table. Build Stage Input Items

Setting up Docker Build Stage

To add a Docker Build stage, follow these steps:

Plus icon을 클릭하여 새로운 스테이지를 추가하세요.
New Stage 영역을 클릭하세요. Stage Settings 페이지가 오른쪽에 열립니다.
Stage Type으로 Docker Build를 선택하세요.
정보 입력 후 Apply 버튼을 클릭하세요. (Registry URL에서 Adding Image Repository (Option)에서 추가한 이미지 저장소를 선택할 수 있습니다.)

Item	Description	Example
Registry URL (`docker push`)	Select the image repository where the completed Docker build result image will be pushed.
ID	ID value of the account to be used in the image repository
Image Tag Pattern	The 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 Repository	The Add Base Image Repository popup window will open. For more information, see Add Base Image Repository.
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 Tool	Displays the image build tool.
Pre-build Command	If there are commands that must be executed before building the Docker image, write them in Shell command format.	`cp target/*.jar docker/`
Image Build Folder	If the Docker image build needs to be executed in a specific folder, select the checkbox and enter the folder path.	`docker`
Dockerfile	Enter the Dockerfile file name.	`Dockerfile`
Image Build Options	If additional options are required for the image build tool, enter them.	`--no-cache`
Build Command	Displays the actual image build command to be executed.
Post-build Command	If 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

Setting up Deploy to K8S Stage

To add the Deploy to K8S stage, follow the procedure below.

Click the + icon to add a new stage.
Click the New Stage area. The Stage Setting page opens on the right.
On the Stage Setting page, select Deploy to K8S as the Stage Type.
On the Stage Setting page, enter the information and click the Apply button. (If you select the type as workload, you can select the workload added in Adding Workload.)

Item	Description
Type	Select deployment type Helm Release (Helm Chart Type) Workload ArgoCD
K8S Cluster	Select K8S cluster Helm Release (Helm Chart Type) selection will display a list of Helm releases deployed through DevOps Console.
Namespace	Select namespace.
Helm Release	Select Helm release.
Deployment Method	Select deployment method Recreate Rolling Update
Registry URL	Select the image repository where the image to be deployed to Kubernetes is `docker push`ed.
Secret	Select 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

Checking the Final Pipeline Script

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

Result of Adding Pipeline

Note

The added pipeline will not be executed automatically. If execution is required, run the pipeline directly.

3 - (VM Deployment) Adding Build/Deployment

The user can create a new build pipeline in an already created DevOps Console project, build the source, create an image, and deploy it to a VM server (VM Deployment) through the following procedure.

The VM server group/VM server added through Adding VM Server Group/VM Server (Option) will be used in Setting up Deploy to VM Stage.

Starting to Add Build/Deployment

To start adding build/deployment, follow the procedure below.

Click the Project card on the Main page. It will move to the Project Dashboard page.

Adding Code Repository (Option)

Notice

Proceed only if a new code repository is needed.

To add a code repository, follow the procedure below.

Code Repository page, click the Add Code Repository button in the top right corner. It will move to the Add Code Repository page.
On the Add Code Repository page, enter/set each item.
Click the Connection Test button.
Click the Save button.

Item	Description
Repository Type	Select the repository to use Registered Tool: You can select and use the types of SCM Repository tools available to the user (`Github`, `Gitlab`, etc.). DevOps Code: Available if you have applied for `DevOps Code` use in the Samsung Cloud Platform Console. Unregistered Tool: You can use it by entering the domain of an unregistered tool. The unregistered tool item only appears when the App template is `Environment Only` (without source code).
New/Existing Usage	Select Create New Repository or Use Existing Repository Activation status may vary depending on specific conditions. For more information, see Table. Conditions for Creating New Repository and Activating Existing Repository.
Repository Information	Enter repository information When creating a new repository, the URL is composed of the project group name/project name.
Authentication Information	Enter authentication information.
Repository Information	Enter repository information You can use a code repository that is not registered as a tool in the DevOps Console. An additional URL check process is required.

Table. Add Code Repository Input Items

Adding Image Repository (Option)

Notice

Proceed only if a new image repository is needed.

To add an image repository, follow the procedure below.

App. Adding Image Repository

Image Repository page, click the App Image Repository Addition button in the top right. Move to the App Image Repository Addition page.
On the App Image Repository Addition page, enter/settings for each item.
Click the Connection Test button.
Click the Save button.

Item	Description
Repository Type Selection	Select the image repository type. If you want to use an image repository not registered in Devops Console, select the Image Registry type.
Repository Creation Selection	Choose whether to create a new repository or use an existing one. If you selected `Docker hub` or `Image Registry` type earlier, you can only select Use Existing Repository.
Registered Tool	Enter repository information.
Unregistered Tool	Enter repository information You can register an image repository that has not been registered as a tool in DevOps Console. Click the URL Check button to proceed with the verification process. You can only select Use Existing Repository.

Table. App Image Repository Addition Input Items

Adding Pull-only Image Repository

Image Repository page, click the Add Pull-only Image Repository button at the top right. It moves to the Add Pull-only Image Repository page.
On the Add Pull-only Image Repository page, enter/set each item.
Click the Connection Test button.
Click the Save button.

Adding Artifact Repository (Option)

Notice

Proceed only if a new artifact repository is needed.

If used as a rollback artifact repository, only Nexus with raw(hosted) repository type is available.

To add an artifact repository, follow these steps:

Artifact Repository page, click the Add Artifact Repository button in the top right corner. It will move to the Add Artifact Repository page.
On the Add Artifact Repository page, enter/set each item.
Click the Connection Test button.
Click the Save button.

Item	Description
Repository Creation Option	Select whether to create a new repository or use an existing one.
Basic Information Input	Enter Base URL, select repository type, and enter repository/authentication information.

Table. Input Items for Adding an Artifact Repository

Adding VM Server Group/VM Server (Option)

Notice

Proceed only if a new VM server group/VM server is needed.

To add a VM server group, follow these steps:

Main page, click the Management icon at the top right. Move to the Tenant Dashboard page.
Click the Deployment Target > VM Server Group menu from the left menu. Move to the VM Server Group page.
On the VM Server Group page, click the Add button. Move to the Add VM Server Group page.
Enter the basic information and click the Save button to complete the VM server group settings.

Item	Description
Server Group Name	Enter the name of the VM server group.
Description	Enter a description.
Type	Select the type of VM server group SSH: Deployment is performed through SSH commands during VM deployment. Agent: Deployment is performed using an agent during VM deployment. (Agent Connection)
VM Server	Add: Add the VM server to be included in the VM server group. Delete: Check the checkbox of the VM server to be deleted from the VM server group and click Delete to delete it.

Table. Input Items for Adding a VM Server Group

Adding VM Server

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

Note

The VM server addition popup window may open differently depending on the type of VM server group.

To add a VM server, follow these steps:

Click the Manage icon in the top right corner of the Main page. You will be taken to the Tenant Dashboard page.
Click the Deployment Target > VM Server Group menu from the left menu. You will be taken to the VM Server Group page.
Click the VM server group where you want to add the VM server from the VM server group list on the VM Server Group page. You will be taken to the VM Server Group Details page.
Click the Add button on the VM Server Group Details page. You will be taken to the Add VM Server page.
Enter the basic information on the Add VM Server page and click the Add button to complete the VM server settings.

Item	Description
Server Name	Enter the name of the VM server.
Description	Enter a description.
IP	Enter the IP address.
SSH Port	Enter the port of the VM server to use for SSH connection.
OS	Enter the operating system.
Location	Select a location.
Authentication Information	Enter the authentication information of the VM server to use for SSH connection.
Secret Key	This is a secret key to authenticate the VM server where the agent is installed.

Table. Input Items for Adding a VM Server

Adding Build Pipeline

To add a build pipeline, follow the procedure below.

Main page, click the Project card. Move to the Project Dashboard page.
Click the Build/Deployment > Build Pipeline menu in the left menu. Move to the Build Pipeline page.
On the Build Pipeline page, click the Add Pipeline button at the top right. Move to the Add Pipeline page.
Enter/set each item on the Add Pipeline page.
Click the Next button.

Item	Description
Classification	Select development or operation classification Actions that can be performed by role vary depending on development and operation. Refer to Table. Authority by Role in Project (1) for role-based permissions.
Jenkins URL	Select `Jenkins` to add a build pipeline from the list.
Build Agent	Select 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 OS	Displays the OS information of the environment where the build agent runs.
Folder Type	Select 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	Select a folder from the list or enter the name of the new folder to be created.
Pipeline Name	Enter the pipeline name.
Parameter Setting	Set the parameters to be used in the pipeline.
Environment Variable Setting	Set the environment variables to be used in the pipeline.
Stage Setting	Set the stages to be used in the pipeline.
Build Result Email Recipient Setting	Set the recipient to receive the result email after the pipeline is completed (success/failure).

Table. Build Pipeline Addition Setting Items

Setting up Parameters

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

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

Setting up Environment Variables

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

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

Setting up Build Result Email Recipients

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

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

Setting up Additional Stages

Setting up Checkout Stage

To add a Checkout stage, follow these steps:

Click the New Stage area. The Stage Settings page opens on the right.
On the Stage Settings page, select Checkout as the Stage Type.
Enter the information and click the Apply button. (You can select the code repository added in Adding a Code Repository (Option) from the URL.)

Item	Description
URL	Select the code repository to perform checkout.
Branch Name	Enter the `branch` name to checkout.

Table. Checkout Stage Input Items

Setting up Build Stage

To add a Build stage, follow these steps:

Click the plus icon to add a new stage.
Click the new stage area. The Stage Settings page opens on the right.
On the Stage Settings page, select Build as the Stage Type.
On the Stage Settings page, enter the information and click the Apply button.

Item	Description
Language	Select the programming language used by the application.
Build Tool	Select the Build tool used for application building. Provides default Shell commands based on the selected Build tool.
Shell Command	Enter the command to use for application building. All commands available in the Shell can be used.

Table. Build Stage Input Items

Setting up Docker Build Stage

To add a Docker Build stage, follow these steps:

Plus icon을 클릭하여 새로운 스테이지를 추가하세요.
New Stage 영역을 클릭하세요. Stage Settings 페이지가 오른쪽에 열립니다.
Stage Type으로 Docker Build를 선택하세요.
정보 입력 후 Apply 버튼을 클릭하세요. (Registry URL에서 Adding Image Repository (Option)에서 추가한 이미지 저장소를 선택할 수 있습니다.)

Item	Description	Example
Registry URL (`docker push`)	Select the image repository where the completed Docker build result image will be pushed.
ID	ID value of the account to be used in the image repository
Image Tag Pattern	The 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 Repository	The Add Base Image Repository popup window will open. For more information, see Add Base Image Repository.
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 Tool	Displays the image build tool.
Pre-build Command	If there are commands that must be executed before building the Docker image, write them in Shell command format.	`cp target/*.jar docker/`
Image Build Folder	If the Docker image build needs to be executed in a specific folder, select the checkbox and enter the folder path.	`docker`
Dockerfile	Enter the Dockerfile file name.	`Dockerfile`
Image Build Options	If additional options are required for the image build tool, enter them.	`--no-cache`
Build Command	Displays the actual image build command to be executed.
Post-build Command	If 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

Setting up Deploy to VM Stage

To add the Deploy to VM stage, follow the procedure below.

Click the + icon to add a new stage.
Click the New Stage area. The Stage Setting page will open on the right.
On the Stage Setting page, select Deploy to VM as the Stage Type.
Enter information on the Stage Setting page and click the Apply button.

Item	Description
Deployment Configuration	Select 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 Group	Select the deployment group Add VM Deployment can be added through this.
Deployment Information	Contents saved in the deployment group are automatically set.
Manual Deployment	Select 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

Checking the Final Pipeline Script

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

Result of Adding Pipeline

Note

The added pipeline will not be executed automatically. If execution is required, run the pipeline directly.

4 - (Before Project Creation) Checking Deployment Target Namespace Permissions

Users should follow the procedure to create a DevOps Console project and check if they have usage permissions for the target cluster/namespace before building/deploying, and request the person in charge to add permissions to the cluster/namespace if necessary.

Checking Namespace Permissions for DevOps Console K8S Cluster

To check the permissions for the namespace of the K8S cluster in use in DevOps Console, follow the procedure below.

Main page, click the Management icon at the top right. Move to the Tenant Dashboard page.
Click the Deployment Target > K8S Cluster menu on the left menu. Move to the K8S Cluster list page.
Click on a K8S cluster. Move to the Details page of the selected K8S cluster.
Click the Namespace tab. The Namespace List screen appears.
When you click on a namespace, you will be moved to the Namespace Details page.

Note

You must have Administrator or User permissions. If you do not have permissions, request permissions from the cluster administrator.

Reference

If the deployment target cluster is not registered, register the deployment target cluster directly. For more information, see K8S Cluster.