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)

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.

   Item	Explanation
   Repository type	Select 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 usage	Select Create new repository or Use existing repository The activation status varies depending on specific conditions. For details, see Table. Conditions for activating new repository creation and existing repository usage.
   Repository information	Enter repository information When creating a new repository, the URL is formed from the project group name/project name.
   Authentication information	Enter authentication credentials.
   Repository information	Enter 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)

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.

   Item	Explanation
   Select repository type	Select 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 repository	Choose 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 tool	Enter repository information.
   Unregistered tool	Enter 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)

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.

   Item	Explanation
   Select whether to create a repository	Choose whether to create a new repository or use an existing one.
   Enter basic information	Base URL, select repository type and enter repository/authentication information.

   Table. Input fields for adding an artifact repository

Add VM Server Group/VM Server (Option)

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.

   Item	Explanation
   Server group name	Enter the VM server group name.
   Explanation	Please enter a description.
   type	Select 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.

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.

   Item	Explanation
   Server name	Enter the VM server name.
   Explanation	Enter the description.
   IP	Please enter the IP.
   SSH Port	Enter the port of the VM server to use for SSH connections.
   OS	Please enter the OS.
   Location	Please select a location.
   Authentication information	Enter the authentication information for the VM server to be used for SSH connections.
   Secret Key	This 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.

   Item	Explanation
   Category	Select Development or Operations The actions that each role can perform differ depending on development or operations. Refer to Table. Role-specific permissions within the project (1) for role-specific permissions.
   Jenkins URL	Select Jenkins from the list to add a build pipeline.
   Build Agent	Select 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 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 already created 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 a new folder to create.
   Pipeline name	Please enter the pipeline name.
   Parameter setting	Set the parameters to be used in the pipeline.
   Environment variable configuration	Set the environment variables to be used in the pipeline.
   Stage Settings	Configure the stage to be used in the pipeline.
   Configure email recipients for build results	Set 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.)

   Item	description
   URL	Select the code repository to perform the checkout.
   Branch name	Enter 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.

   Item	Explanation
   language	Select the programming language used by the application.
   Build tool	Select the Build tool used for building the application. Provides default Shell commands based on the selected Build tool.
   Shell command	Enter 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).)

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.

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