Skip to main content
Version: User Guides (Cloud)

Manage Cluster

This guide describes the lifecycle of a cluster so that you can make full use of your Zilliz Cloud console to achieve your goals.

Free cluster​

After creating a free cluster, you will see the following in the console.

free-cluster-lifecycle

πŸ“˜Notes

You have the option to create one free cluster without charge. In addition, you can create up to two collections within the cluster.

Connect to cluster​

In the Connect section, you can find the Public Endpoint and Token used to connect to the cluster.

For details, refer to Connect to Cluster.

Drop cluster​

In the Actions drop-down button, select Drop to drop the cluster. Zilliz Cloud drops your cluster only after you confirm this operation in the Drop Cluster dialog box.

In addition to the web UI, you can also make an API request to drop a cluster. For details, refer to Drop Cluster.

Upgrade plan​

By upgrading your cluster, you can unlock a wide range of enterprise features, manage larger datasets, and enjoy enhanced performance. You can switch to a paid cluster plan when any of these conditions are met:

  • Your account has sufficient credits;

  • You have added a valid payment method;

  • Your account has a positive balance

To upgrade your plan, follow these steps:

  1. In the Actions drop-down button, select Upgrade Plan.

  2. On the page that opens, complete the following:

    • Select the subscription plan and Target Project,

    • Enter the Cluster Name and password,

    • Specify the Cloud Provider and Cloud Region, and

    • Determine the CU settings. Note that this step is only available when the subscription plan is Dedicated.

    • Set up your Payment Method.

migrate-to-dedicated

After you complete the form and click Upgrade, Zilliz Cloud will create a new paid cluster with your specified settings. Your data will be migrated from the original free cluster, and the free cluster will remain unchanged and available.

The cluster status will switch from CREATING to RESTORING, and finally to RUNNING. Once this is complete, you can connect to the new paid cluster and manipulate the restored data.

Serverless cluster​

After creating a Serverless cluster, you will see the following in the console.

serverless-cluster-lifecycle

  • Connect: This section provides the necessary details to begin interacting with your cluster, including the cluster ID, cluster cloud region, public endpoint for connections, and a token for secure access.

  • Summary: This offers a snapshot of your cluster's essentials. You can find the cluster plan and compatible Milvus version. Details on the creator, as well as the creation date and time, are also presented.

Connect to cluster​

In the Connect section, you can find the Public Endpoint and Token used to connect to the cluster.

For details, refer to Connect to Cluster.

Manage collections and data​

  • Collections

    On the Collections tab, you can manage the collections in the cluster. You can create collections, import data into them, load or release them, rename them, and drop them.

    For details on data import, refer to Data Import.

    manage-collections

  • Backups

    In the Backups tab, you can create backups of your cluster by selecting Create Snapshot. You can find all snapshots on the Backups tab. For details on backups and restores, refer to Backup & Restore.

  • Data migrations

    In the Migrations tab, you can create data migration tasks by selecting Migrate. For details, refer to Migrate Between Clusters.

Users and access control​

Each serverless cluster comes with a single default user. You can't add or drop users, but you can reset the default user's password.

manage-users

Drop cluster​

In the Actions drop-down button, select Drop to drop the cluster. Zilliz Cloud drops your cluster only after you confirm this operation in the Drop Cluster dialog box.

In addition to the web UI, you can also make an API request to drop a cluster. For details, refer to Drop Cluster.

Dedicated cluster​

View cluster details​

After setting up your Zilliz Cloud Dedicated cluster, here’s what you’ll find in each section for cluster details:

dedicated-cluster-lifecycle

  • Connect: This section provides the necessary details to begin interacting with your cluster, including the cluster ID, cluster cloud region, public endpoint for connections, a private link,, IP address whitelist, and a token for secure access.

  • Summary: This offers a snapshot of your cluster's essentials. You can find the cluster plan, CU type, and CU size, compatible Milvus version. Details on the creator, as well as the creation date and time, are also presented.

Establish connection​

  • Connect to cluster

    In the Connect section, you can find the Public Endpoint and Token that are used to connect to the cluster. The token can be an API key or a cluster credential that consists of a username and password pair.

    For more information, refer to Connect to Cluster.

  • Set up private link

    To establish a more secure connection to your cluster, you can create a private link instead of using the public endpoint provided. Refer to Set up a Private Link for further details.

Manage collections and data​

  • Collections

    On the Collections tab, you can manage the collections in the cluster. You can create collections, import data into them, load or release them, rename them, and drop them.

    For details on data import, refer to Data Import.

    manage-collections

  • Backups

    In the Backups tab, you can create backups of your cluster by selecting Create Snapshot. You can find all snapshots on the Backups tab. For details on backups and restores, refer to Backup & Restore.

  • Migrations

    In the Migrations tab, you can create data migration tasks by selecting Migrate. For details, refer to Migrate Between Clusters.

Users and access control​

  • Users

    On the Users tab, you can add users, reset their passwords, and drop them.

    For details, refer to Manage Cluster Credentials.

    manage-users

    πŸ“˜Notes

    You cannot drop db_admin. Zilliz Cloud grants access permissions to all collections in the cluster to any added users.

  • Whitelist

    In the Summary section, click on the IP address in Network Address to add IP address segments to the whitelist. Once an IP address segment, other than a full-zero one (0.0.0.0/0), is added to the whitelist, Zilliz Cloud only permits access from IP addresses within the listed IP address segments.

    By default, a full-zero IP address segment is added, indicating that your cluster can be accessed from anywhere.

    For details on how to set up the whitelist, refer to Set up Whitelist.

Manage and configure clusters​

  • Scale cluster

    Scaling a cluster involves adjusting the number of CUs to match workload fluctuations or storage requirements. You can enhance your cluster's performance by scaling up CUs in response to increased CPU or memory usage, and scale down to conserve expenses during periods of low demand.

    Methods for scaling your cluster:

    • Scaling on web UI

      To manually scale up a cluster, navigate to the Summary area of the Zilliz Cloud console and click Scale next to the CU Size to access the scaling options. Here, you can adjust the CU count within the same type and cloud region. For Dedicated-Standard clusters, you can scale up the size of a cluster up to 32 CUs. For Dedicated-Enterprise clusters, you can scale up the size of a cluster up to 256 CUs. If you require a larger scale, please reach out to our team.

      🚧Warning

      The scaling may lead to slight service jitter. Please exercise caution.

      To scale down the cluster CU size, please submit a support ticket.

    • Scaling via API requests

      Make an API request to scale your cluster. For more information, refer to Modify Cluster.

    • [Private Preview] Auto-scaling

      πŸ“˜Notes

      Auto-scaling is currently in private preview and is only available to Dedicated (Enterprise) clusters. To enable this feature, please contact us.

      Auto-scaling is designed for businesses with rapidly changing needs. It can prevent restrictions on user write access caused by insufficient cluster CU sizes and can reduce operational burden, thereby minimizing disruption to business operations.

      You can specify the maximum CU size that a cluster can automatically scale up to. Downward auto-scaling is currently not supported.

      After enabling this feature, you can configure auto-scaling options when a cluster is successfully created.

      configure_autoscaling

      Auto-scaling is triggered primarily based on the CU Capacity Threshold. Zilliz Cloud checks the cluster CU capacity every 1 minute. If it has exceeded the specified threshold (currently set at 70%) for the past 2 minutes, a scaling process is automatically initiated. For more information about the increment increase of the CU sizes during auto-scaling, refer to Pricing Calculator.

  • Upgrade service plan

    For Dedicated (Standard) cluster, click Upgrade right to the service Plan in the Summary section to upgrade your plan to Dedicated (Enterprise). Zilliz Cloud upgrades your service plan only after you confirm this operation in the Upgrade Cluster Plan dialog box.

    For the differences between all the available subscription plans, refer to Select Service Tiers.

  • Suspend & resume cluster

    In the Actions drop-down button, select Suspend to stop the cluster. Once you confirm this operation in the Suspend Cluster dialog box, the cluster status changes from RUNNING to SUSPENDING, during which you cannot perform other actions to the cluster.

    Once the status changes to SUSPENDED, you will only be charged for storage. Wisely suspending some of your clusters can save you money.

    Cloud Provider

    Storage Pricing

    AWS storage

    $0.025 / GB per month

    GCP storage

    $0.020 / GB per month

    To resume a suspended cluster, click on Actions and select Resume from the drop-down menu. Upon confirming this action in the Resume Cluster dialog box, the cluster's status will change from SUSPENDED to RESUMING, and then to RUNNING. At this point, you will be charged fully based on your CU settings and service plan.

    You can also use RESTful APIs to perform these actions. For details, refer to Suspend Cluster and Resume Cluster.

  • Drop cluster

    In the Actions drop-down button, select Drop to drop the cluster. Zilliz Cloud drops your cluster only after you confirm this operation in the Drop Cluster dialog box.

    In addition to the web UI, you can also make an API request to drop a cluster. For details, refer to Drop Cluster.