high_availability_config.yml Reference¶
File path: /opt/omnia/input/project_default/high_availability_config.yml
This file configures Kubernetes control plane high availability (HA) using a virtual IP address and load-balanced API servers.
HA configuration parameters¶
|
Parameter |
Details |
|---|---|
|
service_k8s_cluster_ha list / elements=dict / required |
High Availability (HA) configuration for Kubernetes (K8s) service clusters. Service K8s clusters are supported only in HA mode. |
|
cluster_name string / required |
Name of the Kubernetes cluster for which you want to set up HA. Must match the service cluster name defined elsewhere. |
|
enable_k8s_ha boolean / required |
Set to true to enable HA for the Kubernetes cluster. Service Kubernetes cluster deployment is supported only in HA mode. Accepted values: true or false. |
|
virtual_ip_address string / required |
Virtual IP address of the admin network used as the Kubernetes API endpoint for the service cluster setup. Ensure that the virtual IP is not assigned to any node in the cluster. Example: 10.11.255.10. |
Prerequisites¶
- Minimum 3 control plane nodes for a quorum-based HA deployment.
- The
ha_virtual_ipmust be a free IP on the admin network subnet -- it must not be assigned to any physical server or DHCP range. - All control plane nodes must have L2 connectivity on the admin network for ARP-based virtual IP failover.
Usage example¶
---
service_k8s_cluster_ha:
- cluster_name: service_cluster
enable_k8s_ha: true
virtual_ip_address: "172.16.107.1"
Info
- Omnia Config -- Kubernetes deployment settings.
- Minimum Nodes -- Minimum node counts for HA deployments.
- Ports -- Kubernetes ports including the API server.