VM Deployment

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

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

Starting VM Deployment

To start a VM deployment, follow these steps.

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

Adding VM Deployment

To add a VM deployment, follow these steps.

1. Click the Project card on the Main page. Move to the Project Dashboard page.
2. Click the Build/Deployment > VM Deployment menu on the left. Move to the VM Deployment page.
3. Click the Add VM Deployment button at the top right of the VM Deployment page. The Add VM Deployment popup window opens.
4. Enter information in the Add VM Deployment popup window and click the Save button.

Viewing VM Deployment Details

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

1. Click the Project card on the Main page. Move to the Project Dashboard page.
2. Click the Build/Deployment > VM Deployment menu on the left. Move to the VM Deployment page.
3. Click the VM deployment you want to view in detail on the VM Deployment page. Move to the VM Deployment Details page.
4. Click the server list on the History tab. The Deployment Details popup window opens.
5. You can view detailed history in the Deployment Details popup window.
6. Click the Log button of the execution pipeline to open the Pipeline Log popup window.
7. You can view detailed logs in the Pipeline Log popup window.
8. Click the Log button of the server you want to view logs for in the deployment server history list. The VM Agent Log popup window opens.
9. You can view detailed logs in the VM Agent Log popup window.

Deleting VM Deployment

Deleting from the List

To delete a VM deployment, follow these steps.

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

Deleting from the Details Page

To delete a VM deployment, follow these steps.

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

Using Environment Variables in VM Deployment Commands

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

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

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 is executed, add a \ symbol.

echo \${PATH}
echo \$LANG

echo \${PATH}
echo \$LANG

Pausing VM Deployment

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

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

Understanding VM Deployment Status Values

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