Manage virtual machines with machine provisioner
Machine provisioner controls how machine executor and Remote Docker jobs are run.
This section describes the available configuration options for machine provisioner.
| Prescaling controls will be exposed in a future release for tuning. |
Provider
The following configuration options are for the machine provisioner provider, either AWS or GCP.
AWS
Configure machine provisioner to work with AWS EC2 in your values.yaml file. During installation you will have set up a security group and authentication. See the Installation Phase 3 - Execution Environments page for more information.
The information in this section describes post-installation configuration options for machine provisioner.
Windows image
If you require Windows executors, you can supply an AMI ID in your values.yaml file. To create a Windows image, use the CircleCI server Windows image builder.
machine_provisioner:
providers:
ec2:
...
windowsAMI: "<my-windows-ami>"Alternative Linux VM image
If you wish to provide a custom AMI for Linux machine executors, you can supply an AMI ID in your values.yaml file. To create a Linux image, use the CircleCI server Linux image builder.
machine_provisioner:
providers:
ec2:
...
linuxAMI: "<my-linux-ami>"Default AWS AMI lists
The default AMIs for server v4.6 are based on Ubuntu 22.04.
x86 AMI list
| Region | AMI |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Arm AMI list
| Region | AMI |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
GCP
Configure machine provisioner to work with GCP in your values.yaml file. During installation you will have set up a security group and authentication. See the Installation Phase 3 - Execution Environments page for more information.
The information in this section describes post-installation configuration options for machine provisioner.
Windows image
If you require Windows executors, you can supply an AMI ID in your values.yaml file. To create a Windows image, use the CircleCI server Windows image builder.
machine_provisioner:
providers:
gcp:
...
windowsImage: "<my-windows-image>"Alternative Linux VM image
If you wish to provide a custom AMI for Linux machine executors, you can supply an AMI ID in your values.yaml file. To create a Linux image, use the CircleCI server Linux image builder.
machine_provisioner:
providers:
gcp:
...
linuxImage: "<my-linux-image>"Instance preallocation
| When using preallocated instances be aware that a cron job is scheduled to cycle through these instances once per minute to ensure they do not end up in an unworkable state. |
To configure server to keep instances preallocated, use the keys shown in the following machine-provisioner-config.yaml examples:
# -- Configuration options for, and numbers of, prescaled instances for remote Docker jobs.
scheduled:
- executor: linux
class: medium
image: docker-default
cron: ""
count: 2# -- Configuration options for, and numbers of, prescaled instances for machine jobs.
scheduled:
- executor: linux
class: medium
image: default
cron: ""
count: 2Apply changes
Apply the changes made to your values.yaml file:
namespace=<your-namespace>
helm upgrade circleci-server oci://cciserver.azurecr.io/circleci-server -n $namespace --version 4.6.2 -f <path-to-values.yaml>