VM Deployment

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

• (SSH method) VM deployment
• (Agent mode) VM deployment

Start VM deployment

To start VM deployment, follow these steps.

1. Click the Project card on the Main page. You will be taken to the Project Dashboard page.
2. From the left menu, click the Build/Deploy > VM Deploy menu. You will be taken to the VM Deploy page.

   Item	Explanation
   Deployment group name	Displays the name of the deployment group.
   VM deployment result	(Success)/(Total): Displays the number of VM servers targeted for deployment and the number of VM servers successfully deployed. Green: All successful Blue: In progress Red: Partial failure Gray: Ready, Stopped
   Deployment time	Displays the deployment time.
   Delete	Delete the VM deployment.

   Table. VM deployment display items

Add VM deployment

To add a VM deployment, follow these steps.

1. Click the Project card on the Main page. You will be taken to the Project Dashboard page.
2. From the left menu, click the Build/Deploy > VM Deploy menu. You will be taken to the VM Deploy page.
3. VM Deployment page, click the Add VM Deployment button in the top right. The Add VM Deployment popup opens.
4. Add VM deployment After entering the information in the popup window, click the Save button.

   Item	Explanation
   deployment group	Please enter the deployment group name.
   Execution method	Select the execution mode. File transfer and command execution: Choose this when you typically deploy files to a VM. Execute command only: Choose this when you run only commands without transferring files to the VM (e.g., Docker commands).
   Deployment method	Select deployment method Table: SSH method vs agent method
   Deployment order	If there are multiple target servers, choose whether to deploy in parallel or sequentially.
   Deployment target VM	Set the deployment target server. Click the Settings button to open the Configure Deployment Target VM popup.
   Command before file deployment	Write the commands that need to be executed before file distribution.
   File to send	Source: Enter the file path after the build pipeline execution directory (Jenkins workspace). Target: Enter the path where the file will be deployed on the VM server. Add button can be used to add files.
   Command after file distribution	Write the commands to be executed after file deployment.
   Automatic restore setting	Select whether to enable automatic rollback If the deployment fails, it will be rolled back to the most recent successful deployment. Deployment method is enabled when it is Agent.
   Artifact repository	Select whether to use the artifact repository for rollback. deployment method is activated when it is Agent.
   Repository name	Only exposed when using an artifact repository. A list of already registered artifact repository is displayed

   Table. Additional Input Items for VM Deployment

VM Deployment Details

To view the detailed information of the VM deployment, follow these steps.

1. On the Main page, click the Project card. You will be taken to the Project Dashboard page.
2. From the left menu, click the Build/Deploy > VM Deploy menu. You will be taken to the VM Deploy page.
3. On the VM deployment page, in the VM deployment list, click the VM deployment you want to view in detail. You will be taken to the VM deployment details page.
4. In the History tab, click the server list. The Deployment Details popup opens.
5. Deployment Details You can view the detailed history in the popup window.
6. When you click the Log button of the execution pipeline, the Pipeline Log popup window opens.
7. Pipeline Log You can view detailed logs in the popup window.
8. In the history list for each deployment server, click the Log button of the server whose logs you want to view, and the VM Agent Log popup window will open.
9. VM Agent log You can view detailed logs in the popup window.

   Item	Explanation
   Stop / Start Deployment	Stop, Start Deployment button becomes active.
   rollback	You can roll back to a previous version.
   History tab	Deployment history is displayed.
   Pipeline Information tab	The build pipeline information associated with this VM deployment is displayed.
   log	You can view the logs of the build pipeline.

   Table. VM deployment detail screen items

   Item	Explanation
   Execution pipeline log	You can view the logs of the build pipeline.
   History logs per deployment server	You can view the deployment agent’s logs. Only displayed for AGENT type

   Table. Deployment Detail Screen Items

Delete VM deployment

Delete from list

To delete a VM deployment, follow these steps.

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

Delete on the detail page

To delete a VM deployment, follow these steps.

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

Using environment variables in VM deployment commands

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

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

echo ${BUILD_NUMBER}
echo $JOB_NAME

echo ${BUILD_NUMBER}
echo $JOB_NAME

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

echo \${PATH}
echo \$LANG

echo \${PATH}
echo \$LANG

Stop VM deployment

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

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

Understanding VM deployment status values

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