Skip to content
kix /docs
Install the CLI

Reference Cluster module

cluster.availability

The cluster-wide availability requirement and the maximum level supported by the declared substrate.

cluster.availability contains the cluster default and the level its declared capabilities can support.

FieldTypeDefaultMeaning
defaultnone | pod | node | zonesubstrateAvailability level passed to instances that do not override it.
substrateread-only levelderivedHighest level supported by cluster.capabilities.

The levels form an ordered scale:

LevelWorkload must tolerate
noneNo failure guarantee.
podOne pod loss or a rolling update.
nodeOne node loss.
zoneOne availability-zone loss.
Capabilitiessubstrate
multiNode = falsenone
more than one availabilityZones entryzone
otherwisenode

The result is certain only when the capabilities needed for that decision are declared. Kix warns when a capability is unknown. It rejects a requested default above a certain substrate.

cluster.capabilities.multiNode = true;
cluster.capabilities.availabilityZones = [ "eu-west-1a" "eu-west-1b" ];
cluster.availability.default = "zone";

Packages receive the resolved level and map it onto replica counts, quorums, or HA features. Kix derives topology spread and PodDisruptionBudgets from the same level.