Document toolboxDocument toolbox

Managing Services Mapping

Owned by Sarabjeet Kaur
Last updated: Sep 30, 2024
10 min read

Applies to: Kyvos Enterprise  Kyvos Cloud (SaaS on AWS) Kyvos AWS Marketplace

Kyvos Azure Marketplace   Kyvos GCP Marketplace Kyvos Single Node Installation (Kyvos SNI)

Services Mapping

Kyvos Manager lets you configure services for the BI Server, Web Portal, Postgres Server, and Standby Postgres Server on the cluster nodes.

You can configure services for nodes at the time of adding new nodes or migrate roles later at any time.

Note

  • From Kyvos 2024.3 onwards, you can only configure one service either BI Server or Query Engine on a node. No other service can be configured on a BI Server or Query Engine node. Ensure that this applies to all Cloud Deployments.

  • You can see the last performed node and service mapping operation details, including progress status and start time, by clicking the i icon located next to the Revert button.  To view more comprehensive details, simply click the View Details link, which will take you to the Operations page, where you can view the operation information in detail. 

  • On Azure Marketplace, the license information for the Query Engine and BI Server will not be available for Kyvos Managed Application and Kyvos Single Node Standard installation. 

Migrate Services

To migrate services from one node to another, perform the following steps.

  1. On the navigation pane, click Kyvos and Ecosystem > Node and Services. 

  2. On the Node and Services page, you will see a list of all the nodes configured in the cluster.

  3. On the right, you will see the number of instances configured in the system for each service and the number allowed in your license. 

  4. Use the Services drop-down lists to select the role that you want to assign to the node.

Note

  • The service assignment must comply with the number of instances allowed by your licenses. For example, if your license allows two BI Servers, you cannot assign the BI Server service to more than two nodes. Ensure that this is not applicable to Kyvos Marketplace.

  • When enabling Kyvos Manager HA, if the node being removed has a Kyvos Manager instance, it must be removed before removing the Kyvos Web Portal node.

  1. Once done, click the Save button.

    Add_nodes_12.png

     

  2. Enter your Kyvos Manager Password to continue and then click Save. 
    NOTE: From Kyvos 2023.3 onwards, if you want to start Kyvos services, select the Start Kyvos Services checkbox. 

    The Operations page displays the details of role migration. Once the operation completes, you will see the new services on the Dashboard and Node and Service Mapping page.

Managing Nodes

Kyvos allows you to add as many nodes to your cluster as you want. However, the roles that you can assign to the nodes are governed by your Kyvos License.

In this section, you will learn the following:

Adding a Kyvos Core Service Node

Note

To add a Kyvos Core Service Node to your Kyvos cluster, perform the following steps.

  1. On the title bar, click the Menu button (hamburger icon).
    The Kyvos Manager menu appears. 

  2. On the navigation pane, click Kyvos and Ecosystem > Node and Services.  
    The Node and Service Mapping page shows the current instances configuration and the configuration allowed in your Kyvos license.

  3. On the Node and Services page, select the Add >Kyvos Core Service Node option from the three-dots menu.

    Add_nodes_1.png

  4. On the Add Nodes to Cluster dialog, enter space-separated hostnames or IP addresses for the nodes that you want to add.

    Add-1.png

  5. Click the Fetch Details button.

  6. Once the node list is retrieved, you will see a tabular view of nodes along with options to configure the Services and the number of Instances for the service on the node.
    You will also see the status in the corresponding column.

    The Node Details and Prerequisite Checks on the right show detailed information for the node, as shown in the following figure.

  7. At the time of adding nodes, you can also configure high availability for the Kyvos Web Portal and Postgres Server nodes.

  8. Select the Web Portal option from the Services list, and then click Next.
    The Web Portal HA Configuration dialog is displayed.  

  9. To configure high availability for the Web portal, select the Enable Web Portal High Availability option and provide details as:

Parameter

Description

Parameter

Description

Virtual IP/Hostname

Enter the virtual IP/Hostname in the protocol://host:port format to access the Kyvos Web Portal when the Web Portal is configured with high availability mode. It is the single IP/Hostname that will be used to access the Kyvos Web Portal, regardless of the IP/Hostname on which the Web Portal is actually running.
NOTE: If protocol and port are not specified, those will be picked from the Web Portal URL. 

Enable Session Management

Select to enable Tomcat-based session management. Do not select this for cloud clusters with a load balancer configured for Web Portal HA.
NOTE : This option is recommended for On-Premise clusters (e.g., node-1 or http://node-1:80).

Multicast Address

Specify the multicast IP address that will be used for multi-casting messages to all web portal IP/Hostname. It is a logical identifier for a group of hosts in a computer network that is available for processing. Read more

Multicast Port

Enter the multicast port to be used for sending multicast messages.

Receiver Port

Enter the port that will be used as the receiver port

  1. Once done, click the Next button. The system validates the node information and shows the Validation Logs. 
    You can Filter the logs to view Info, Warnings, or Error.
    In case of any errors or warnings, click the Back button and make the requisite changes. Click the Revalidate button to recheck the configuration.

  2. Provide your Kyvos Manager Password at the bottom left of the page. 

     

  3. Click the Add button. You will be redirected to the Add node Operation page.
    Once the operation completes, you can refresh the Node and Service Mapping page to view the new node added to the list. It will also show up on the Dashboard.

Deleting a Kyvos Core Service Node

Note

  • Nodes once deleted, cannot be retrieved.

  • Applicable in all environments except Kyvos Single Node Standard (SNS) and Kyvos Single Node Installation (SNI).

To delete a node from your Kyvos cluster, perform the following steps.

  1. On the navigation pane, click the click Kyvos and Ecosystem > Node and Services option. 

  2. On the Node and Services page, select the Delete Nodes option from the three-dots menu.

  3. On the Delete Nodes dialog box, select the nodes that you want to delete.

  4. Enter your credentials in the Password box, and click the Delete button.

Note

  • When you delete a BI Server node from a multiple BI Server nodes cluster, and that has Zookeeper configured on it, in this case, you need to remove Zookeeper and redeploy it using the Zookeeper configuration page.

  • You cannot delete a node if it is the ONLY BI Server node in the cluster.

  • You cannot delete the Postgres Server node from the cluster.

  • You cannot delete Web Portal node till the Kyvos Manager Service is configured on it.

Adding Kyvos Reporting Service

Before adding a Kyvos Reporting Service, you must complete the prerequisites mentioned in the Kyvos Reporting Service section.

To add Kyvos Reporting Service, perform the following steps.

  1. On the title bar, click the Menu button (hamburger icon).
    The Kyvos Manager menu appears. 

  2. On the navigation pane, click Kyvos and Ecosystem > Node and Services.  
    The Node and Service Mapping page shows the current instances configuration and the configuration allowed in your Kyvos license.

  3. On the Node and Services page, select the Add > Kyvos Reporting Service Node option from the three-dots menu. The Add Kyvos Reporting Service Node dialog is displayed.

    Dashboard-1.png

  4. On the dialog box, select a Kyvos Reporting Bundle file. You can also change the bundle file using the Change bundle link.

    image (44).png

    1. Change bundle: Use this link to change the existing bundle file. The Select Kyvos Reporting Bundle dialog is displayed. Select the required bundle file from the list and then click Select.

      image (46).png

    2. Upload new bundle: Use this link to upload a new bundle file.

      image (47).png

  5. Upload the Kyvos Reporting Service license file. You can also change the license file using Change License link.

  6. Click Next. The Kyvos Reporting Service Node is added and displayed on the Kyvos Manager dashboard.

    image (45).png

  7. Click the Kyvos Reporting Portal link. This will redirect you to the Kyvos Reporting Sign in page.

Note

  • When adding Kyvos Reporting Service, no other service (BI Server, Query Engine, and Web Portal) on the same or any other node.

  • The option to add Kyvos Reporting Service Node will appear only if it is not deployed.

Removing Kyvos Reporting Service

To remove Kyvos Reporting Service, perform the following steps.

  1. On the title bar, click the Menu button (hamburger icon).
    The Kyvos Manager menu appears. 

  2. On the navigation pane, click Kyvos and Ecosystem > Node and Services.  
    The Node and Service Mapping page shows the current instances configuration and the configuration allowed in your Kyvos license.

  3. On the Node and Services page, select the Delete > Kyvos Reporting Service Node option from the three-dots menu. The Delete Kyvos Reporting Service Node dialog is displayed.

    Dashboard-2.png

  4. On the dialog box, select the Kyvos Reporting Service portal that to be deleted.

    Dashboard-6.png

  5. Click Delete. The Kyvos Reporting Service Node is deleted. After deleting the node, the Kyvos Reporting Service Node will not display on the Kyvos Manager Dashboard.

Note

When removing Kyvos Reporting Service, you can remove other service (BI Server, Query Engine, and Web Portal).

Adding Kyvos Manager Service

Important

  • Before adding a Kyvos Manager Service, you must complete the Prerequisites mentioned in the Kyvos Manager High Availability section.

  • To manually add Kyvos Manager services if UI is unavailable, download a script file named kyvosmanager-instance-setup-script from the DFS at path <engine_work>/setup/scripts/ and execute that script. This will set up the Kyvos Manager service on the current node.

To add a Kyvos Manager Service, perform the following steps.

  1. On the title bar, click the Menu button (hamburger icon).
    The Kyvos Manager menu appears. 

  2. On the navigation pane, click Kyvos and Ecosystem > Node and Services.  
    The Node and Service Mapping page shows the current instances configuration and the configuration allowed in your Kyvos license.

  3. On the Node and Services page, select the Add Kyvos Manager Service option from the three-dots menu.

    Add_Kyvos_Manager_Service.png

  4. On the Add Kyvos Manager to Cluster dialog, select hostnames or IP addresses for the nodes that you want to add.

Note

  • The drop-down list for selecting hostnames or IP addresses includes only:

    • The nodes that have the Web Portal configured on them.

    • The nodes that do not have the Kyvos Manager services on them.

  1. Click the Fetch Details button.

  2. Once the node list is retrieved, you will see a tabular view of nodes along with options to configure the Services and the number of Instances for the service on the node.
    You will also see the status in the corresponding column.

  3. Click the Add button. The Kyvos Manager Service is added and displayed on the Kyvos Manager Dashboard and Node and Service Mapping page in the Kyvos Manager Nodes section.

Important

For cloud environments where Load Balancer is used, after adding Kyvos Manager Service, you need to perform manual steps to add newly added entry of Kyvos Manager nodes in the target group of Load Balancer. See the Manual Steps for Load Balancer Entry section.

Removing Kyvos Manager Service

Note

Kyvos Manager Service cannot be removed from the Active Kyvos Manager instance.

To remove a Kyvos Manager Service, perform the following steps.

  1. On the title bar, click the Menu button (hamburger icon).
    The Kyvos Manager menu appears. 

  2. On the navigation pane, click Kyvos and Ecosystem > Node and Services.  
    The Node and Service Mapping page shows the current instances configuration and the configuration allowed in your Kyvos license.

    Delete_Kyvos_Manager_Service.png

  3. On the right side of the Node and Services page, click Delete from the three-dots menu, and then click the Remove Kyvos Manager Service option. The Remove Kyvos Manager Service dialog is displayed.

  4. Select the check box to remove the required node, and then click Remove.

Important

For cloud environments where Load Balancer is used, after removing Kyvos Manager Service, you need to perform manual steps for removing entry of Kyvos Manager nodes in the target group of Load Balancer. See the Manual Steps for Load Balancer Entry section.

 

Copyright Kyvos, Inc. All rights reserved.