Document toolboxDocument toolbox

Scaling nodes and services

Owned by Sarabjeet Kaur
Last updated: Jul 22, 2024
8 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)

Important

  • For GCP,

    • If using shared VPC, the post-upgrade permission (compute.subnetworks.use) is required to scale Kyvos nodes for the GCP Marketplace.

  • The post-deployment steps are required if you use an existing Virtual Network while deployment and required to scale the Kyvos Web Portal and BI Server nodes.

  • To scale Web Portal nodes on GCP, the deployment script currently does not support creating a load balancer. Therefore, you will need to manually create an external Load Balancer. For further details, see the Configuring External Load Balancer for GCP section.

  • For Kyvos Free deployment in AWS, Azure, and GCP Marketplace, the scaling nodes are not supported.

  • All the cluster nodes must be up for creating BI Server, Query Engine, and Web Portal nodes in AZURE and GCP cloud. 

  • In the AWS Managed Service, you can specify the availability zone while creating and terminating a node.

 

AWS Managed Services

AWS Marketplace

AZURE Marketplace

GCP Marketplace

Create Node (Query Engine)

Terminate Node (Query Engine)

Increase Query Engine Disks

Decrease Query Engine Disks

Show Query Engine Disk / storage size

Create Node (BI Server)

Terminate Node (BI Server)

Show BI Disk / storage size

Create Node (Web Portal)

Terminate Node (Web Portal)

Add Kyvos Reporting Service Node

Create Kyvos Reporting Service Node

Delete Kyvos Reporting Service Node

Terminate Kyvos Reporting Service Node

Add Kyvos Core Service Nodes

Delete Kyvos Core Service Nodes

From the Nodes and Services > Overview page, you can manage scaling for the following:

  • Nodes for supported Kyvos core services (Query Engine, BI Server, and Web Portal)

  • Disk for Query Engine node

On the Overview page, you can view the number of nodes for each supported Kyvos services and disk details added to each Query Engine node and BI Server nodes.

This allows for efficient modification of the Query Engine, BI Server, and Web Portal node count and disk allocation for cloud deployments.

To scale nodes and services, do the following:

Creating and add Kyvos Core Service Node for Marketplace 

Important

To scale BI Server and Web Portal nodes in Azure Marketplace, the network interface attached to the existing BI Server and Web Portal nodes must be in the same resource group as the BI Server, Web Portal and other resources. If the network interface attached to the BI Server and Web Portal machines exist in a resource group other than the BI Server and Web Portal machine's resource group, assign the Microsoft.Network/virtualNetworks/subnets/join/action permission to MI (Managed Identity) over VN (Virtual Network) by creating a custom role.

Steps for creating a node for Query Engine and BI Server, and Web Portal are the same for both Azure and AWS Marketplace.

To create and add a Kyvos Core Service node, perform the following steps. 

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

  2. On the Overview page, you will see the number of nodes for Kyvos Core Services; BI Server Storage and Query Engine Storage (in GB), the size of the disk attached to each Query Engine node, and the number of service instances (BI Server, Query Engine, and Web Portal) configured for the Kyvos cluster.

    Add_nodes_4.png

  3. Click Create. The Create Kyvos Core Service Nodes (Azure Marketplace) dialog box is displayed. 
    Please note that the dialog box to create Kyvos Core Services for each Marketplace deployment may vary.

    image-20240412-120058.png

  4. Enter the number of nodes for Query Engines, BI Server, and Web Portal service that you want to create. enter your Kyvos Manager password to create the node.
    NOTE:

    • Enter the Instance Group Name (GCP) to add Web Portal Service on the cluster where Kyvos Services have already been installed. After adding the instance group name, click Validate. This will validate the instance group. If it is validated, the Validated Successfully message is displayed. In case of any error, you need to provide a valid instance group name.

  5. Enter your Kyvos Manager password to create the node and click Create. The Nodes will be created and you will be redirected to the Operations page where you can view the status. 

Terminating Kyvos Core Service Node for Marketplace 

Similarly, you can delete a node for Query Engine, BI Server, and Web Portal by clicking the three dots, and then click Terminate > Kyvos Core Service Node. 

The Terminate Kyvos Core Service Nodes dialog is displayed. Enter the number of nodes you want to terminate, and then enter your Kyvos Manager password to terminate the node.

Click Terminate. The node will be terminated. 

Important

  • After deleting the BI Server, Zookeeper must be removed before redeploying it. You will see the following message after the deletion.

  • Click Remove. This will take you to the Zookeeper Configuration page.

Adding a disk for Marketplace

Steps for adding a disk for Query Engine node is the same for both Azure and AWS Marketplace.

To add a disk for Query Engine Storage, perform the following steps.

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

  2. On the Overview page, you will see the number of nodes, BI Server Storage (in GB), the size of the disk attached to each Query Engine node, and the number of service instances configured for the Kyvos cluster.

  3. Click the three dots, and then click Add > Query Engine Node Disk.

    The Add Disk on Query Engine Nodes dialog box is displayed.

  4. Enter the number of disk you want to add to the Query Engine node, and then enter your Kyvos Manager password. The disk is added to the Query Engine node and you will be redirected to the Operations page where you can view the status.

Deleting a disk from Marketplace

  1. To remove the disk from the Query Engine node, click the three dots and then click Delete > Query Engine Node Disk.

  2. The Delete Disk from Query Engine Nodes dialog is displayed.

  3. Enter the number of disk you want to remove, and then enter your Kyvos Manager password.

  4. Click Delete. The disk will be deleted.

Creating Kyvos Reporting Service node

To create Kyvos Reporting Service node, 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 Create > Kyvos Reporting Service Node option from the three-dots menu.

    The Create Kyvos Reporting Service Node dialog is displayed.

  4. Select Bundle or upload a new bundle.

  5. Click Create. The Kyvos Reporting Service Node is added and displayed on the Kyvos Manager dashboard.

Terminate Kyvos Reporting Service

To terminate 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 Terminate > Kyvos Reporting Service Node option from the three-dots menu.

  4. The Terminate Kyvos Service Node is displayed. Enter the number of Kyvos Reporting Service to be deleted.

  5. Click Terminate and you will be redirected to the Operations page.

Creating a Kyvos Core Service Node for AWS Managed Services

To create a node, perform the following steps. 

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

  2. On the Overview page, you will see the number of nodes and the number of service instances configured for the Kyvos cluster.

  3. Click Create. The Create Kyvos Core Service Nodes dialog box is displayed. 

  4. Enter the number of nodes for Query Engines, BI Server, and Web Portal that you want to create for the required zone, and then enter your Kyvos Manager password to create the node. The Nodes will be created in that zone and you will be redirected to the Operations page where you can view the status. 

Terminating a Kyvos Core Service Node for AWS Managed Services

To terminate a node from AWS Managed Services, perform the following steps.

  1. Terminate a node for Query Engine, BI Server, and Web Portal by clicking the three dots, and then click Terminate. 

  2. The Terminate Node dialog is displayed. Enter the number of nodes for Query Engine, BI Server, and Web Portal you want to terminate, and then enter your Kyvos Manager password to delete the node. The node will be terminated. 

  3. Click Terminate. The Nodes will be terminated and you will be redirected to the Operations page where you can view the status. 

For other deployments

Similarly, for cloud deployments (Azure, AWS, GCP), and on-premises, you can add or delete a node.

 

Copyright Kyvos, Inc. All rights reserved.