/
Managing Cluster
Document toolboxDocument toolbox

Managing Cluster

Owned by Sarabjeet Kaur
Mar 05, 2025
6 min read

This section contains details about a cluster created for Kyvos, which is a set of resources created in the Kyvos-managed AWS environment. It includes functionalities related to subscriptions, namely creating, viewing, deleting, starting/stopping, and viewing history for any cluster. The Kyvos SaaS Portal interacts with Kyvos Manager and Kyvos Web Portal to fetch current cluster configurations, cost/Usage consumption by the cluster, and the deployment status of the Kyvos cluster.

Viewing cluster details

To view cluster details, perform the following steps.

  1. On the navigation bar, click Clusters. The Clusters page is displayed.

    • Case 1: For the first time login or when no cluster is created, the following page is displayed.

      image-20240807-113436.png

    • Case 2: After creating clusters, a list will display clusters that have been added using the required subscription.

  2. Clicking a cluster will display the following details on the right of the page.

    image-20240807-113635.png

    • Status: Displays a current state of the cluster, such as Offline, Online and Failed.

    • Subscription: Displays a subscription name used to create the cluster. Clicking the subscription name will redirect you to the Subscriptions page and the subscription details will display on the right of the page.

    • Region: Displays the region in which the cluster is deployed.

    • Open Kyvos Manager: Clicking the Open Kyvos Manager link will redirect you to the Kyvos Manager Login page.
      See the Kyvos Manager Management and Monitoring Guide for more details.

    • Open Kyvos Web Portal: Clicking the Open Kyvos Web Portal link will redirect you to the Kyvos Login page.

  3. Additionally, you can also view the Overview, Cost Analysis, Audit Logs, and Deployment Details tabs to view further details of the selected cluster.

Deploying a new cluster

You can create and deploy a new cluster. After deploying the cluster, the deployment details are displayed.

To deploy a cluster, perform the following steps.

  1. On the navigation bar, click Clusters.

  2. Click the New button. The New Cluster dialog is displayed.

  3. Select the required Subscription from the list. The current balance of the selected subscription is displayed.

Note

If the current balance for the selected subscription is low, first you must add funds to that subscription to create a new cluster.

  1. Enter the Cluster Name.

  2. Enter Description of the cluster if required.

  3. Select AWS Region from the list where the cluster needs to be created.

  4. Enter CIDR range.

Note

CIDR range starts from 10.0.0.0/16 to 10.255.255.255/16. You will receive an auto-assigned CIDR based on availability, but it can be modified within the permitted range if needed.

  1. Select the required Kyvos version (the Kyvos Preview version and GA version) from the list. The Kyvos Preview Release feature provides customers with early access to experimental features, allowing them to choose between the Preview Release and the General Availability (GA) release during cluster deployment. When enabled by Admin, it offers the flexibility to test new functionalities before their official release. If disabled, only the GA release will be available for deployment.

  2. Select the Disaster Recovery checkbox to enable or disable backup and disaster recovery services for the region.

Note

The Backup region must be AWS Region.

  1. Enter Password. Retype the password to confirm. Ensure that the user name (Admin) and password will remain the same for the Kyvos Manager and Kyvos Web Portal.

Note

The password must be:

  • Minimum of 8 characters

  • At least one capital letter

  • At least one special character

  • At least one number

For example, PassW0rd@100

  1. Click Review and Deploy to create and deploy cluster

Once the cluster is deployed, the Kyvos SaaS Portal will give you access to Kyvos Manager and Kyvos Web Portal. User must provide the password setup for cluster to log into these portals.

image-20250213-071249.png

Once the cluster is deployed, you can view the deploying details.

image-20240527-140545.png

Starting a cluster

To start a stopped cluster, perform the following steps.

  1. Select the cluster from the Clusters section that you want to restart.

  2. Click the Start button to restart the cluster.

    image-20240807-114513.png

Note:

Once the cluster is started, Kyvos services (Web Portal, Query Engine, and BI Server) will be started.

Stopping a cluster

To stop a running or started cluster, perform the following steps.

  1. Select the cluster from the Clusters section that you want to stop.

  2. Click the Stop button to stop the cluster.

    image-20240807-114626.png

    The confirmation dialog box is displayed.

    image-20240807-114757.png

  3. Click Stop.

Note:

Once the cluster is stopped,

  • Kyvos services (Web Portal, Query Engine, and BI Server) will be stopped.

  • The links to Open Kyvos Manager and Kyvos Web Portal will be disabled.

When you stop the cluster, the cluster status is displayed as Stopped. You also have the option to restart the cluster using the Start button.

image-20240807-115219.png

 

Deleting a cluster

You can delete the running cluster. To delete a cluster, you can either stop it first and then delete it or delete the cluster directly.

  1. Select the cluster from the Clusters section that you want to delete.

  2. Click the Actions menu (...) option and then click the Delete Cluster button.

    image-20240807-115348.png

    The confirmation message is displayed.

    image-20240807-115535.png

  3. Click the I understand the Consequences, delete the cluster. The cluster will be deleted.

Note:

Once the cluster is deleted, Kyvos services (Web Portal, Query Engine, and BI Server) will be stopped and deleted.

Related content

Copyright Kyvos, Inc. All rights reserved.