Components of Kyvos Manager Dashboard

In this section, you will learn about the components of the Kyvos Manager Dashboard.

	Cloud	On-Prem	Single Node Installation
Node Details
Node Utilization
App Master and YARN Query Engines
External Repository	If External Repository is used.
Kyvos Manager Instances	If Kyvos Manager Instance is used	If Kyvos Manager Instance is used
Delete Cluster	Applicable only to non-Marketplace

Title bar icons

You can also view cluster-related information using the following icons provided on the top-right of the page.

Icon	Name	Description
	Toolbox	Click the toolbox, the Kyvos Manager menu items will be displayed. See the Managing and Monitoring Kyvos Clusters section for more details. The cluster name is displayed after the toolbox icon.
	Help	Clicking this icon will take you to Kyvos online documentation and display help relevant to the application.
	Home	Clicking this icon shows the Kyvos Manager Dashboard, which is the home page. See the Kyvos Manager Dashboard section for more details.
	Operations List	Clicking this icon lists recently performed operations on the cluster. Clicking View Details takes you to the corresponding operations details page. Click the View All option to view the Operations section for more details.
	Notifications	Clicking this icon displays alerts, notification configurations, and how to set up rules that specify alert and warning threshold levels for CPU, disk, and memory utilization, such as high, medium, or low. Clicking the Manage Subscriptions button opens the ‘Manage Subscription’ dialog box, where you can perform the following: Subscribe users for email alert notification Configure rules for alerts. For more details, see the Configuring alerts and notification section.
	User menu	Clicking this icon shows the following options: Cluster details: Click this option to view the current cluster details. You can also click View All Details to Cluster Snapshot. Change Password: Click this option to change the current password. See the Changing Password section for more details. About: Click this option to view the Kyvos and Kyvos Manager build details. Sign out: Click this option to exit from the application. See the Signing out of the Kyvos Manager section for details.

You can also perform the following actions on the right of the Kyvos Manager Dashboard.

Actions Menu: Click the Actions menu (…) to perform cluster actions. See the Cluster actions section for more details.
External Repository: This option is displayed only when an external repository is configured for Kyvos. Clicking the External Repository link opens the information about the configured repository for Kyvos. To exit the dialog box, click Close.
Kyvos Web Portal link: Open the Kyvos Web Portal directly from Kyvos Manager by clicking the Kyvos Web Portal link.

Note

In cloud-based environments where Load Balancer is configured for Kyvos, clicking the Kyvos Web Portal link will open the Load Balancer URL.
When the Load Balancer is not configured for Kyvos, clicking the Kyvos Web Portal link will open the URL of any of the Kyvos Web Portal (in case multiple Kyvos Web Portal nodes).

Refresh Button: Refresh the content manually by clicking Refresh Now. The content also auto-refreshes after 120 seconds. You can stop auto refreshing the content by clicking the Stop Auto Refresh option.

Cluster details

The Kyvos Manager dashboard shows a summary of each node instance configured in the cluster.

The left side of the home page shows cluster details in the Cluster Overview section. This section provides a snapshot of the Kyvos cluster deployed in your environment. You can see the details of all the nodes instances configured in the cluster, along with their status.

You will see a number corresponding to each component of the cluster indicating the number of instances or nodes on which the component is configured.

For example, the following figure shows 2 instances for BI Server, 1 Query Engine, 1 Web Portal, 1 Postgres Server, 3 Zookeepers, and 4 KM Agent instances.

Note

The Query Engine column is displayed only when the cluster is on non-YARN based Query Engine deployment.
The Postgres Server column is displayed only when the Bundled Postgres is configured.
The Zookeeper column is displayed only when the Managed Zookeeper is configured.

Filtering nodes

You can filter the nodes in the cluster on the basis of their current state using the Filter box in the Cluster Overview area.

Searching nodes

The intelligent search feature in Kyvos Manager displays the search results simultaneously as you type in the Search box.

Sorting columns in tables

You can sort a column in ascending or descending order by clicking the column header. A small arrow is displayed on the column at which sorting is applied.

Service status legends

Legends depict the status of cluster services and cluster nodes using color coding. Each color of the legend shows the status of services and nodes of the cluster, as shown in the following figure.

Node status legend:

The various states of nodes are:

Running: Indicates cluster node is working correctly.
Stopped: Indicates cluster node is stopped.
Inactive: Indicates cluster node is inactive. You can activate or deactivate a node on the cluster, as explained.
Unknown: Indicates cluster node is unavailable, or Kyvos Manager is not able to fetch the node status.

Whenever an operation is performed on the cluster, the state is displayed on the header and can have any of the following states:

Deploying: Indicates a cluster is being set up.
Registering: Indicates the status of cluster components is registered.
Deployment Error: Indicates an error thrown during the cluster setup.
Running: Indicates a cluster is up and running.
Critical: Indicates a critical error or issue with two possible reasons:
- Any node of the cluster is working with utilization above alert levels.
- Any service is down.
Warning: Indicates a cluster is running above the warning level but below the alert levels.
Maintenance: Indicates a node undergoing maintenance.
Removing: Indicates that the cluster is in the process of being removed.

Viewing node usage

The right side of the home page shows a summary of the node usage, such as CPU, Memory, and Installation Disk usage.

Hover over the mouse anywhere on the usage details will display the Show disk usage link.

Click the link to open the Disk Usage dialog box and view disk usage information for the selected node.

Refresh All: To refresh the content for all nodes that appear in the Nodes section.
Show Description: To view the details of the selected node.

Note

You can view the disk usage of any node by selecting it from the Node section.

Usage Status Legend:

Indicates Low, High, or Moderate node usage for CPU, memory and installation disk.
- Low indicates usage below warning level.
- Moderate indicates usage in warning level.
- High indicates usage in critical level.

Kyvos Manager High Availability (HA)

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.

If Kyvos Manager HA is enabled, the Kyvos Manager Nodes section is displayed. To enable Kyvos Manager HA, set the ENABLE_KM_HA property to ‘Yes’ from Kyvos Manager. By default, this property is set to 'No', which means that the Kyvos Manager HA mode is disabled and Kyvos Manager Nodes section will not be displayed on the Kyvos Manager Dashboard.

For more details, see the Kyvos Manager High Availability section.

YARN based App Master and Query Engine details

YARN App Master and Query Engines are displayed on Dashboard page of Kyvos Manager.

To view App Master details, click the i icon. The following information is displayed.