Skip to content

high_availability_config.yml

This file configures Kubernetes control plane high availability (HA) using a virtual IP address and load-balanced API servers.

Parameter Reference

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

Captures the name of the service cluster on which HA will be set up. Default value: service_cluster

enable_k8s_ha

boolean / required

Possible values: true

Default value: true

Indicates whether to enable HA for the Kubernetes (K8s) service node or not. Set to true to enable.

virtual_ip_address

string / required

This is a mandatory and user-configurable parameter.

Captures the virtual IP address for the K8s service node HA setup. Ensure that the virtual_ip_address does not belong to the dynamic_range or static_range mentioned in the network_spec.yml.

Default value: 172.16.107.1

Prerequisites

  • Minimum 3 control plane nodes for a quorum-based HA deployment.
  • The ha_virtual_ip must 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

File: /opt/omnia/input/project_default/high_availability_config.yml
---
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.