Skip to content

Add optional availabilityZone.from:Machine to disks. #263

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
garloff wants to merge 4 commits into
base: main
Choose a base branch
from
+89 −6
Open

Add optional availabilityZone.from:Machine to disks. #263

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
1fe4580
Add optional availabilityZone.from:Machine to disks.
garloff Apr 24, 2026
6ee7609
Merge branch 'main' into feat/support-multi-az-volumepin
garloff Apr 29, 2026
c7df8ed
Use one setting diskPinAZ to control all volumes.
garloff May 28, 2026
ac9587e
Merge branch 'main' into feat/support-multi-az-volumepin
garloff May 28, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/providers/openstack/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,5 +80,6 @@ topology:
| `oidc_config.username_prefix` | string | oidc: | oidc: | Prefix prepended to username claims to prevent cla shes with existing names (such as system: users). For example, the value oid c: will create usernames like oidc:jane.doe. If this flag isn't provided and --o idc-username-claim is a value other than email the prefix defaults to ( Iss uer URL )# where ( Issuer URL ) is the value of --oidc-issuer-url. The value - c an be used to disable all prefixing. | |
| `oidc_config.groups_prefix` | string | oidc: | oidc: | Prefix prepended to group claims to prevent clashes wit h existing names (such as system: groups). For example, the value oidc: will cre ate group names like oidc:engineering and oidc:infra. | |
| `network_mtu` | integer | | 1500 | NetworkMTU sets the maximum transmission unit (MTU) value to address fragmentation for the private network ID. | False |
| `diskPinAZ` | boolean | | False | This tells capo to create volumes in the same AZ as the VM that they are attached to. This affects cinder volumes used as controlPlane and worker machine root disks as well as additionalBlockDevices. Only works for clouds where volume AZs are matched with compute AZs. There it might be a performance optimization or a requirement.
| `controlPlaneAvailabilityZones` | array | | ['nova'] | ControlPlaneAvailabilityZones is the set of availability zones which control plane machines may be deployed to. | False |
| `controlPlaneOmitAvailabilityZone` | boolean | | True | ControlPlaneOmitAvailabilityZone causes availability zone to be omitted when creating control plane nodes, allowing the Nova scheduler to make a decision on which availability zone to use based on other scheduling constraints. | False |
94 changes: 88 additions & 6 deletions providers/openstack/scs2/cluster-class/templates/cluster-class.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,21 @@ spec:
Cluster actuator will create a network, a subnet with nodeCIDR,
and a router connected to this subnet.
If you leave this empty, no network will be created.
- name: diskPinAZ
required: false
schema:
openAPIV3Schema:
type: boolean
example: true
default: false
description: |-
Pass availabilityZone (failureDomain) of the machine to its (root) disk volumes.
Some clouds have a 1:1 relationship of storage availability zones with compute AZs.
In these, attaching a disk from another AZ often comes with a performance penalty
or is not possible at all. You can set this to true to tell capo to create the root
disk in the stated failureDomain of this machine. This setting applies to controlPlane
root disks (if they use root volumes), worker machine root disks (if they use root
volumes) and workerAdditionalBlockDevices (if any are configured).
# Control plane
- name: controlPlaneFlavor
required: false
Expand All @@ -119,8 +134,9 @@ spec:
default: "SCS-2V-4"
example: "SCS-2V-4-20s"
description: |-
OpenStack instance flavor for control plane nodes.
(Default: SCS-2V-4, specify a controlPlanRootDisk or better replace by SCS-2V-4-20s.)
OpenStack instance flavor for control plane nodes. (The default, SCS-2V-4, is not ideal;
recommendation is to replace this by SCS-2V-4-20s and set controlPlaneRootDisk to 0
or specify a non-zero controlPlaneRootDisk with a diskless flavor.)
- name: controlPlaneRootDisk
required: false
schema:
Expand All @@ -132,7 +148,7 @@ spec:
description: |-
Root disk size in GiB for control-plane nodes.
OpenStack volume will be created and used instead of an ephemeral disk defined in flavor.
Should only be used for the diskless flavors (>= 20), otherwise set to 0.
Should only be used for the diskless flavors (and then be set >= 20), otherwise set to 0.
- name: controlPlaneServerGroupID
required: false
schema:
Expand Down Expand Up @@ -193,6 +209,9 @@ spec:
schema:
openAPIV3Schema:
type: array
description: |-
You may pass an array with additional volumes (disks) here, consisting of
name, sizeGiB (default: 20) and type (aka storage class, default: __DEFAULT__).
default: []
items:
type: object
Expand Down Expand Up @@ -570,7 +589,7 @@ spec:
variable: controlPlaneFlavor
- name: controlPlaneRootDisk
description: "Sets the root disk size in GiB for control-plane nodes."
enabledIf: {{ `'{{ if .controlPlaneRootDisk }}true{{end}}'` }}
enabledIf: {{ `'{{ if and .controlPlaneRootDisk (not .diskPinAZ) }}true{{end}}'` }}
definitions:
- selector:
apiVersion: infrastructure.cluster.x-k8s.io/v1beta1
Expand All @@ -583,6 +602,23 @@ spec:
valueFrom:
template: |
sizeGiB: {{ `{{ .controlPlaneRootDisk }}` }}
- name: controlPlaneRootDiskPinned
description: "Sets the root disk size in GiB for control-plane nodes and pins them to the failureDomain of the machine."
enabledIf: {{ `'{{ if and .controlPlaneRootDisk .diskPinAZ }}true{{end}}'` }}
definitions:
- selector:
apiVersion: infrastructure.cluster.x-k8s.io/v1beta1
kind: OpenStackMachineTemplate
matchResources:
controlPlane: true
jsonPatches:
- op: add
path: "/spec/template/spec/rootVolume"
valueFrom:
template: |
sizeGiB: {{ `{{ .controlPlaneRootDisk }}` }}
availabilityZone:
from: Machine
- name: controlPlaneServerGroupID
description: "Sets the server group to assign the control plane nodes to."
enabledIf: {{ `'{{ ne .controlPlaneServerGroupID "" }}'` }}
Expand Down Expand Up @@ -697,7 +733,7 @@ spec:
variable: workerFlavor
- name: workerRootDisk
description: "Sets the root disk size in GiB for worker nodes."
enabledIf: {{ `'{{ if .workerRootDisk }}true{{end}}'` }}
enabledIf: {{ `'{{ if and .workerRootDisk (not .diskPinAZ) }}true{{end}}'` }}
definitions:
- selector:
apiVersion: infrastructure.cluster.x-k8s.io/v1beta1
Expand All @@ -713,6 +749,26 @@ spec:
valueFrom:
template: |
sizeGiB: {{ `{{ .workerRootDisk }}` }}
- name: workerRootDiskPinned
description: "Sets the root disk size in GiB for worker nodes and pins the to the AZ of the machine."
enabledIf: {{ `'{{ if and .workerRootDisk .diskPinAZ }}true{{end}}'` }}
definitions:
- selector:
apiVersion: infrastructure.cluster.x-k8s.io/v1beta1
kind: OpenStackMachineTemplate
matchResources:
controlPlane: false
machineDeploymentClass:
names:
- default-worker
jsonPatches:
- op: add
path: "/spec/template/spec/rootVolume"
valueFrom:
template: |
sizeGiB: {{ `{{ .workerRootDisk }}` }}
availabilityZone:
from: Machine
- name: workerServerGroupID
description: "Sets the server group to assign the worker nodes to."
enabledIf: {{ `'{{ ne .workerServerGroupID "" }}'` }}
Expand All @@ -732,7 +788,31 @@ spec:
template: |
id: {{ `{{ .workerServerGroupID }}` }}
- name: workerAdditionalBlockDevices
enabledIf: {{ `'{{ if .workerAdditionalBlockDevices }}true{{end}}'` }}
enabledIf: {{ `'{{ if and .workerAdditionalBlockDevices (not .diskPinAZ) }}true{{end}}'` }}
definitions:
- selector:
apiVersion: infrastructure.cluster.x-k8s.io/v1beta1
kind: OpenStackMachineTemplate
matchResources:
controlPlane: false
machineDeploymentClass:
names:
- default-worker
jsonPatches:
- op: add
path: /spec/template/spec/additionalBlockDevices
valueFrom:
template: |
{{ `{{- range .workerAdditionalBlockDevices }}` }}
- name: {{ `{{ .name }}` }}
sizeGiB: {{ `{{ .sizeGiB }}` }}
storage:
type: Volume
volume:
type: {{ `{{ .type }}` }}
{{ `{{- end }}` }}
- name: workerAdditionalBlockDevicesPinned
enabledIf: {{ `'{{ if and .workerAdditionalBlockDevices .diskPinAZ }}true{{end}}'` }}
definitions:
- selector:
apiVersion: infrastructure.cluster.x-k8s.io/v1beta1
Expand All @@ -750,6 +830,8 @@ spec:
{{ `{{- range .workerAdditionalBlockDevices }}` }}
- name: {{ `{{ .name }}` }}
sizeGiB: {{ `{{ .sizeGiB }}` }}
availabilityZone:
from: Machine
storage:
type: Volume
volume:
Expand Down
Loading