Skip to main content

CloudStack CAPI Override Reference

This page provides examples and references for overriding Cluster API (CAPI) properties on Apache CloudStack clusters using the Cluster API Provider CloudStack (CAPC).

CloudStack​

Cluster-level overrides target the CloudStackCluster resource, and pool-level overrides target the CloudStackMachineTemplate resource.

LevelCAPI KindAPI References
All-CAPC Book
*Use with caution as this reference guide is not semantically versioned.
ClusterCloudStackClusterv0.6.1 CloudStackCluster API types
PoolCloudStackMachineTemplatev0.6.1 CloudStackMachineTemplate API types

Examples​

These examples demonstrate how to override CAPI properties using YAML directly targeting the underlying CAPC resources.

info

CloudStackMachineTemplate has an extra level of nesting. The spec wraps a template, which contains another spec field that holds the actual machine configuration. All pool-level CloudStack overrides use this structure.

Cluster-Level​

Sync the cluster with CloudStack Kubernetes Service (CKS)
cloudStackCluster:
spec:
syncWithACS: true

Pool-Level​

cloudstackMachineTemplate has an extra level of nesting. The spec wraps a template, which contains another spec field that holds the actual machine configuration. All pool-level CloudStack overrides use this structure.

warning

The pool-level top-level key is cloudstackMachineTemplate with a lowercase s, unlike the cluster-level cloudStackCluster key.

Set the SSH key and compute offering
cloudstackMachineTemplate:
spec:
template:
spec:
sshKey: my-ssh-key
offering:
name: compute-offering-2

Unsupported First-Class Properties​

The following properties are not exposed as first-class properties in the supported interfaces for Palette but can be configured using override. To learn more about the difference between first-class properties and override properties, refer to the First-Class Support vs. Override section.

CAPC Resource TypeProperties
CloudStackClusterNone
CloudStackMachineTemplateaffinity, cloudstackAffinityRef, diskOffering.device, diskOffering.filesystem, diskOffering.label, diskOffering.mountPath, uncompressedUserData