Skip to content
kix /docs
Install the CLI

Reference Cluster module

cluster.topology

The node-label keys Kix uses for zone and host failure domains.

cluster.topology names the node labels used by derived workload placement.

FieldTypeDefaultMeaning
zoneKeystringtopology.kubernetes.io/zoneLabel whose value identifies an availability zone or equivalent outer failure domain.
hostKeystringkubernetes.io/hostnameLabel whose value identifies a node or equivalent host failure domain.
failureDomainKeysread-only list of stringsderivedOrdered keys Kix uses for spread, outermost first.

failureDomainKeys is derived from cluster capabilities:

CapabilitiesValue
multiNode = false[ ]
more than one declared availability zone[ zoneKey hostKey ]
otherwise[ hostKey ]

Cloud controllers normally apply the default labels. Set another key for a cluster organized around racks, hypervisors, or provider-specific labels:

cluster.topology.zoneKey = "infrastructure.example.com/rack";

Packages whose operator creates the eventual Pods can read clusterConfig.cluster.topology.failureDomainKeys and write the corresponding affinity into their custom resource. Ordinary Deployments and StatefulSets do not need to read it; Kix derives their spread constraints.