Skip to main content
Version: User Guides (BYOC)

Deploy BYOC on GCP

This page describes how to manually create a fully managed Bring-Your-Own-Cloud (BYOC) data plane in your Google Cloud Platform (GCP) Virtual Private Cloud (VPC) using the Zilliz Cloud console and custom GCP configurations.

📘Notes

  • Zilliz BYOC is currently available in General Availability. For access and implementation details, please contact Zilliz Cloud sales.

  • This guide demonstrates how to create the necessary resources on the AWS console step-by-step. If you prefer to use a Terraform script to provision the infrastructure, see Terraform Provider.

Prerequisites​

Procedure​

To deploy BYOC on GCP, Zilliz Cloud needs to assume specific roles to access the Cloud Storage bucket and the GKE cluster within a customer-managed VPC on your behalf. Consequently, Zilliz Cloud needs to gather information about your Cloud Storage bucket, GKE cluster, and VPC, along with the roles necessary for accessing these infrastructure resources.

Within your BYOC organization, click the Create Project and Deploy Data Plane button to start the deployment.

Cl50bi7eVoxSoHxk4jrcclh6n5O

Step 1: Create a project​

In this step, you need to set the Zilliz BYOC project name, determine the cloud providers and regions, and the initial project size of your deployment.

S3a5behpSoDdj5xrphzcjoYdnEe

  1. Set Zilliz BYOC Project Name.

  2. Select Cloud Provider and Cloud Region.

  3. Determine whether to enable GCP Private Service Connect.

    This option allows private connectivity to the clusters within the current project. If you enable this option, you must create a Private Service Connect Endpoint for private connectivity.

  4. Select an architecture type that matches your application in Architecture.

    This determines the architecture type of the Zilliz BYOC image to use. Available options are X86 and ARM.

  5. In Resource Settings, you need to

    1. Enable or disable Auto-scaling to allow Zilliz Cloud to automatically adjust the number of EC2 instances within a defined range based on your project workloads, ensuring efficient resource use.

    2. Configure Initial Project Size.

      In a BYOC project, the search service, other database components, and core support services use different Google Compute Engine (GCE) instances. You can set instance types for these services and components.

      If Auto-scaling is disabled, simply specify the number of GCE instances required for each project component in the corresponding Count field.

      SKYfbLW76oEudZxyng2cT2Xmnsh

      Once Auto-scaling is enabled, you need to specify a range for Zilliz Cloud to automatically scale the number of GCE instances based on actual project workloads by setting the corresponding Min and Max fields.

      GjUvb2NGwoenR7xqxvSccaMdnMc

      To facilitate resource settings, there are four predefined project size options. The following table shows the mapping between these project size options and the number of clusters that can be created in the project, as well as the number of entities these clusters can contain.

      Size

      Maximum Cluster Quantity

      Maximum Number of Entities (Million)

      Performance-optimized CU

      Capacity-optimized CU

      Small

      3 clusters with 8 to 16 CUs

      10 Million - 25 Million

      40 Million - 80 Million

      Medium

      7 clusters with 16 to 64 CUs

      25 Million - 100 Million

      80 Million - 350 Million

      Large

      12 clusters with 64 to 192 CUs

      100 Million - 300 Million

      350 Million - 1 Billion

      X-Large

      17 clusters with 192 to 576 CUs

      300 Million - 900 Million

      1 Billion - 3 Billion

      You can also customize the settings by selecting Custom in Initial Project Size and adjusting the GCE instance types and counts for all data plane components. If your preferred GCE instance types are not listed, please contact Zilliz support for further assistance.

  6. Click Next to set up credentials.

Step 2: Set up credentials​

In Credential Settings, you must set up the storage and several service accounts for storage access, GKE cluster management, and data-plane deployment.

BbOOboWZAo5eu2xplJWcXyLonph

  1. In Google Cloud Platform Project ID, enter the ID of your GCP project.

  2. In Storage settings, set Bucket Name and Service Account Email obtained from GCP.

    Zilliz Cloud will use the specified bucket as the data-plane storage and access it on your behalf using the specified service account.

    For details on setting up the bucket and creating the service account, refer to Create Cloud Storage Bucket and Service Account.

  3. In GKE Settings, set GKE Cluster Name and Service Account Email for GKE management.

    Zilliz Cloud will use the specified service account to deploy a GKE cluster of the specified name on your behalf and deploy the data plane in the GKE cluster.

    For details on creating the service account, refer to Create GKE Service Account.

  4. In Cross-Account Settings, set Service Account Name for data-plane deployment.

    Once your service account is ready, copy the Zilliz BYOC principal provided in the read-only text box below and paste it into your GCP console to grant Zilliz BYOC the necessary permissions to deploy the data plane of the Zilliz Cloud BYOC project.

    For details on creating the cross-account service account, refer to Create a Cross-Account Service Account.

  5. Click Next to configure network settings.

Step 3: Configure network settings​

In Network Settings, create a VPC and several types of resources, such as subnet names and an optional Private Service Connect Endpoint in the VPC.

YVPNbLCjOoCkDTx9TEMcbV9LnPd

  1. In Network Settings, set the VPC Name, Subnet Names, and the optional Private Service Connect Endpoint.

    In the specified VPC, Zilliz Cloud requires

    • A primary subnet with two secondary subnets,

    • A load balancer subnet, and

    • An optional Private Service Connect endpoint.

    Note that Private Service Connect Endpoint is available only when you switch on GCP Private Service Connect in General Settings above.

  2. Click Next to view the summary.

  3. In Deployment Summary, review the configuration settings.

  4. Click Create if everything is as expected.

View deployment details​

After you create a project, you can view its status on the project page.

DS61bOBm9oC0b1xdLT9cuEUsnmh

Suspend & Resume​

Suspending a project halts the data plane and terminates all GCE instances associated with the GKE cluster supporting the project. This action does not impact the suspended Zilliz Cloud clusters within the project, which can be resumed once the data plane is restored.

YC2YbM9oyo6IcUxDQ5Bc3AzDnPc

You can only suspend a running project if there are no clusters in the project or all clusters have already been suspended.

SVLQbgURIoRqHBx2tWwc5caWnx7

Once the status tag on a project card reads Suspended, you cannot manipulate clusters in the project. In such a case, you can click Resume to resume the project. Once the status tag turns to Running again, you can continue manipulating clusters in the project.

EQKqbumOxoT1tVxw1ZRcZahXnDd

Procedures​