Kyvos Manager, which is a cluster management tool for Kyvos, currently supports configuring multiple instances of services like BI Server, Query Engine, Kyvos Web Portal, and Postgres that work in high availability mode. Kyvos services can operate normally even in the absence of the Kyvos Manager. However, certain features such as Services HA, configuring properties, Postgres High Availability for bundled Postgres, Hadoop connection Configuration & Lib Sync from Compute cluster or DFS, regardless of SSH or non-SSH mode, are dependent on Kyvos Manager. If any of these features are required at any time, an instance of Kyvos Manager must be running for Kyvos to work properly. Therefore, from Kyvos 2024.1 onwards, Kyvos Manager supports high availability in case of instance failure, and immediately, another instance will be active to serve the requirement.
Prerequisites for using Kyvos Manager High Availability (HA)
Adding Kyvos Manager (KM) instances is supported only on nodes with Kyvos Web Portal, as a cost optimization strategy. Thus, Kyvos Manager HA requires Web Portal HA as a precondition.
For Kyvos Manager HA, the Zookeeper must be up and running.
Each node in a cloud cluster must have the respective CLI command (aws, azcopy, gsutil), while on-premises, it must have the HDFS command and access to HDFS.
For cloud environments, Load balancer must be configured in the cluster
Irrespective of the type of repository used for Kyvos Manager, the repository must always be accessible from all Kyvos Manager nodes.
All newly added instances of Kyvos Manager must have the same permissions (IAM Role, Managed Identity) and network access permissions (Security Group, Local Firewall) as the Kyvos Manager node.
To enable the Kyvos Manager High Availability mode, you need to navigate to the Kyvos Manager Settings > Kyvos Manager Properties. On the Kyvos Manager Properties page, search for ENABLE_KM_HA property, and then set the value of the ENABLE_KM_HA property to 'Yes'. By default, this property is set to 'No', which means that the Kyvos Manager HA mode is disabled and will not be displayed on the Kyvos Manager Dashboard. Therefore, if you want to make the Kyvos Manager HA available, you need to update the value of this property to 'Yes'.
The Kyvos Managers Nodes section is displayed on the Dashboard, as shown in the below image.
The Kyvos Manager nodes that you have added will be displayed at:
On the Kyvos Manager Dashboard, in the Kyvos Manager Nodes section.
On the Nodes and Services page, and then click the Nodes and Services mapping tab. The Kyvos Manager Nodes section is displayed.
To learn how to add Kyvos Manager nodes, refer to the https://kyvosdocumentation.atlassian.net/wiki/spaces/KD20241/pages/45352414/Adding+and+deleting+nodes#addingKMservice section.
Note
In the Mode column, the Active mode indicates that Kyvos Manager service is currently in use. Conversely, the Passive mode indicates that Kyvos Manager service has been added, but it is currently not in use.
Ensure that only one instance of Kyvos Manager service will be active at any given time.
If Kyvos Manager HA is enabled but no node is added, the default Kyvos Manager instance will be displayed in Kyvos Manager Nodes.
If the Active Kyvos Manager service becomes passive, the other added service will become active automatically.
Kyvos Manager instance properties
You can view the detailed Kyvos Manager instance properties for both Active and Passive mode. You can also modify the alias name of the node at any time.
To view the properties, perform the following steps.
In the Kyvos Manager Nodes section, click the circle (Red/Green), the Action menu (…) appears.
Click Properties. The Properties dialog is displayed.
On the Properties dialog, you can specify an Alias name to a node which can be easily modified later.
The Alias name will be displayed in the Alias column.
Start, Restart, or Stop Kyvos Manager Service for passive instance
You can start, restart, or stop single Kyvos Manager Service for the service which is in a Passive mode, as shown in below image.
Note
From this section, you cannot start, stop, or restart Kyvos Manager Service that is in Active mode.
Click Start Kyvos Manager Service, the following dialog is displayed.
Provide your Kyvos Manager password and then click Save. The Kyvos Manager Service will start.
Similarly, you can Restart Kyvos Manager Service or Stop Kyvos Manager Service.
Start, Restart, or Stop all passive Kyvos Manager Services
You can start, restart, or stop all Kyvos Manager Services for the services which are in a Passive mode, as shown in the image below.
Click Start Kyvos Manager Service, the following dialog is displayed.
Provide your Kyvos Manager password and then click Save. The Kyvos Manager Service will start.
Similarly, you can Restart Kyvos Manager Service or Stop Kyvos Manager Service.
Note
The Kyvos Manager service in Active mode is always disabled since only passive services can be started, stopped or restarted.
Restart Active Kyvos Manager Instance
You can also restart active Kyvos Manager instance. To do this, click the Action Menu appears at the right of the page.
Click Restart Active Kyvos Manager Instance. The following dialog is displayed.
Provide your Kyvos Manager password and then click Save. The Kyvos Manager Service will restart.
Known limitation
As this is a beta version of Kyvos Manager HA for the Kyvos 2024.1 release, you may encounter the following limitations:
Download logs of passive Kyvos Manager instances are not supported.
Make a passive Kyvos Manager instance as an active instance from Kyvos Manager is not supported.
Configuring Kyvos Manager HA during a cluster deployment (irrespective of whether automated or wizard based) is not supported.