Add and Manage Docker Deployment VMs

You can add and manage Docker deployment VMs from the Organization Administration page's Build Executors tab.

Note:

You can't add or manage Docker deployment VMs if VB Studio is connected to the built-in free account. If you want to add Docker deployment VMs, you'll need to configure VB Studio to connect to your OCI account.

1. In the left navigator, click Organization .
2. Click the Build Executors tab.
3. Click the VM Pool tab and follow one of these procedures:
   • To add Docker deployment VMs after you have added the initial VM, see Add Docker Deployment VMs.
   • To view, start, stop, delete, or view the Docker VM logs, see Manage Docker VMs.
   • To manage disk usage for a Docker VM, see Manage Docker VM Resources.

Add Docker Deployment VMs

When you add a Docker deployment VM, you allocate an OCI VM compute instance to run your builds in Docker executors.

1. From the VM Pool tab, click + Add VMs.
2. Add details to the Creating Docker Executors dialog:
   1. Number of VMs: Specify the number of Docker deployment VMs you want to create.
   2. Executors created per VM: Enter the maximum number of Docker executors you want to deploy in each Docker deployment VM.
   3. Region: Select the same region that you chose for the Management VM in Step 5c of Add Your First Docker Deployment VM.
      The drop-down list displays regions your OCI account is subscribed to.
   4. Shape: Select the Docker executor's shape.
      Wait for a few seconds. VB Studio calculates the number of Compute VM instances that can be created with the selected shape and displays it in the dialog box. If the required number of Compute VM instances aren't available, choose another shape.
   5. Volume: Specify the storage capacity for each Docker deployment VM.
   6. Number of OCPUs: If you've selected a Flex shape, specify the number of OCPUs to add in each Docker deployment VM.
   7. Amount of Memory: If you've selected a Flex shape, specify each Docker deployment VM's memory.
   8. Use only for project(s): (Optional) Select one or more projects to assign to this Docker deployment VM. After the Docker deployment VM is created, it will be restricted to running builds for the assigned projects. Builds for these projects will only run on this VM, and builds from other projects won't run on this VM.
3. For VCN Select, choose Default or Custom.
   • If you chose Default, click Create. You are finished with this task.
   • If you chose Custom, continue to the next step.
4. Fill out the additional details for the custom VCN:
   1. VCN Compartment: Select the compartment.
      If you're an Oracle Cloud OS Management Service (OSMS) user, don't select the OSMS compartment or a compartment with an OSMS policy.
   2. VCN: Select the VCN.
   3. Subnets Compartments: Select the compartments where your public subnets are. By default, it adds your VCN's compartment. If required, you can add more compartments.
   4. Subnets: Select a subnet. The list shows public subnets only.
      You can add multiple public subnets. If VB Studio can't create a Docker executor on the first subnet you've added, it tries to create it on the second subnet, and so on.
5. Click Validate Network Setup.
6. Click Create.

Manage Docker VMs

You can view, start, stop, or delete a Docker deployment VM,view the VM log from the Organization Administration page's Build Executors tab, or show available resources for the VM. You can also reset, view the log, or show available resources for the Docker management VM.

From the VM Pool tab, choose one of the actions shown in the following table:

Action	How To
View a Docker deployment VM’s or Docker management VM's log	Click Action and select Show Log. In the Docker Executor VM Log window, review the log.
Start or stop a Docker deployment VM	Click Action and select Start or Stop. To start or stop multiple Docker deployment VMs, select their check boxes, click Update Selected and select Start selected VMs or Stop selected VMs.
Delete a Docker deployment VM	Click Action and select Delete. In the confirmation dialog box, click OK. To delete multiple Docker deployment VMs, select their check boxes, click Update Selected and select Delete selected VMs.
Reset a Docker management VM	Click Action and select Reset. In the confirmation dialog box, click OK
View and clean up VM resources	Click Action and select Show Resources.. For more information, see Manage Docker VM Resources.
View the projects associated with a restricted Docker deployment VM.	In the Restricted column, hover over to view the projects associated with the VM.

Manage Docker VM Resources

You can view the total disk usage available for a Docker Management VM or Docker Deployment VM and delete images or containers to free up disk space.

For a quick look at the disk usage for a Docker VM, hover over the Disk Usage bar to view usage percentage, GB used, total GB available, and the date that the data was last updated.

Description of the illustration vbs_docker_disk_usage.bmp

The data on this page is only updated every hour or so. For real time usage and additional detail, view the Resources page for the VM.

To view the Resources page for a Docker VM, click and select Show Resources.

Description of the illustration vbs_docker_resources.bmp

Note:

If you are viewing Docker Management VM resources, you will see the Internal Registry Size instead of the Builds Workspace Size.

From here you can view total disk usage for the VM, as well as usage for individual images and containers.

The following table describes actions you can take to free disk space.

Action	How To
Delete an individual image (for Docker deployment VMs).	In the Images tab, click the trash can next to the image.
Free disk space by removing images that are no longer in use.	In the Images tab, click the Clean Images/Free Diskspace button at the bottom.