Skip to main content
Version: latest

Configuration Reference

The CAPI Image Builder utility is configured using a configuration file that includes the parameters documented below. Review these parameters to understand how to tailor the CAPI Image Builder to your specific use case.

warning

At this time, VMware vSphere is the only supported infrastructure provider for the CAPI Image Builder.

Operating System Configuration

ParameterDescriptionRequired
os_versionsA list of operating system versions to build. Available options are rhel-8, rhel-9, rockylinux-8, rockylinux-9.Yes
image_typeThe type of image to build. Available options are standard or fips.Yes
rhel_subscription_userThe RHEL subscription username to use when building the image.No
rhel_subscription_passThe RHEL subscription password to use when building the image.No

Image Configuration

ParameterDescriptionRequired
image_nameThe name of the image to build.Yes
cloud_typeThe cloud type to build the image for. Available options are aws, azure, gcp and vmware,Yes

Kubernetes Configuration

Refer to the CAPI Image Builder Compatibility Matrix file for a list of supported Kubernetes versions and the corresponding compatible versions of its dependencies.

ParameterDescriptionRequired
k8s_versionThe Kubernetes version to use when building the image.Yes
cni_versionThe Container Network Interface (CNI) version to use when building the image.Yes
containerd_versionThe containerd version to use when building the image.Yes
crictl_versionThe crictl version to use when building the image.Yes

ISO Configuration

ParameterDescriptionRequired
iso_nameThe name of the ISO file to use when building the image. The ISO file is expected to be located inside the output folder.Yes
iso_checksumThe SHA256 checksum of the ISO file to use when building the image. The checksum is used to verify the integrity of the ISO file.Yes

Infrastructure Configuration

Fill out the parameters below for the infrastructure provider for which you are building the image. These parameters are required for authenticating with the provider and uploading the image. Do not fill in the parameters for any other providers.

info

Only one infrastructure provider can be used at a time. If you need to build images for multiple providers, you need to create a separate configuration file for each.

AWS

ParameterDescriptionRequired
aws_access_keyThe AWS access key to use when building the image.Yes
aws_secret_keyThe AWS secret key to use when building the image.Yes

Azure

ParameterDescriptionRequired
azure_client_idThe Azure client ID to use when building the image.Yes
azure_client_secretThe Azure client secret to use when building the image.Yes
azure_subscription_idThe Azure subscription ID to use when building the image.Yes
azure_locationThe Azure location to use when building the image.Yes
azure_storage_accountThe Azure storage account to use when building the image.Yes
azure_resource_groupThe Azure resource group to use when building the image.Yes

GCP

ParameterDescriptionRequired
google_app_credsThe path to the Google Application Credentials file to use when building the image.Yes
gcp_project_idThe GCP project ID to use when building the image.Yes

VMware

ParameterDescriptionRequired
vcenter_serverThe vCenter server to use when building the image. Provide either a Fully Qualified Domain Name (FQDN) or an IP address.Yes
vcenter_userThe vCenter user to use when building the image.Yes
vcenter_passwordThe vCenter password to use when building the image.Yes
vcenter_datacenterThe vCenter data center to use when building the image.Yes
vcenter_datastoreThe vCenter datastore to use when building the image.Yes
vcenter_networkThe vCenter network to use when building the image.Yes
vcenter_folderThe vCenter folder to use when building the image.Yes
vcenter_clusterThe vCenter cluster to use when building the image.Yes
vcenter_resource_poolThe vCenter resource pool to use when building the image.Yes

Airgap Configuration

Fill out the parameters below if you are building the image in an air-gapped environment. Otherwise, you can skip this section.

ParameterDescriptionRequired
airgapSet to true if you are building the image in an air-gapped environment.Yes
airgap_ipThe IP address or hostname of the airgap support VM that has the required dependencies. Refer to the Self-Hosted Palette and Vertex Environment Setup pages for instructions on how to deploy an airgap support VM.Yes

Example Configuration

os_version=rhel-8
image_type=standard
rhel_subscription_user='demo@spectrocloud.com'
rhel_subscription_pass='***********'


image_name=rhel-8-custom
cloud_type=vmware


k8s_version=1.28.9
cni_version=1.2.0
containerd_version=1.7.13
crictl_version=1.26.0


iso_name=rhel-8.8-x86_64-dvd.iso
iso_checksum=517abcc67ee3b7212f57e180f5d30be3e8269e7a99e127a3399b7935c7e00a09


vcenter_server=example.vcenter.dev
vcenter_user=demo@vsphere.local
vcenter_password='***********'
vcenter_datacenter=Datacenter
vcenter_datastore=vsanDatastorePrimary
vcenter_network=NETOWRK-1
vcenter_folder=teamA
vcenter_cluster=teamA-cluster
vcenter_resource_pool=teamA-resource-pool