Skip to main content
Version: User Guides (BYOC)

Deploy BYOC on AWS

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

📘Notes

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

Prerequisites​

  • You must be a BYOC organization owner.

Procedure​

To deploy BYOC on AWS, Zilliz Cloud needs to assume specific roles to access the S3 bucket and the EKS cluster within a customer-managed VPC on your behalf. Consequently, Zilliz Cloud needs to gather information about your S3 bucket, EKS 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.

XtlJbBTIboHNbixzfqpc7H3nnvb

General Settings​

In General Settings, you need to set the project name, determine the cloud providers and regions, and choose the way for Zilliz Cloud to create the project and deploy the data plane.

ZZtcbZFa7odEA2xBs7Fc97XCnWb

  1. Set Project Name.

  2. Select Cloud Provider and Region.

  3. Configure Instance Settings.

    In a BYOC project, the search service, fundamental database components, and core support services use different EC2 instances. You can set instance types for these services and components.

    For details, see Instance Settings.

  4. Determine whether to enable AWS PrivateLink.

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

  5. Choose the way for Zilliz Cloud to carry on the task in Deploy Method.

    There are three options for provisioning the infrastructure for your BYOC project on AWS. You can either

    • Use AWS CloudFormation to provision the infrastructure.

      If you prefer to use AWS CloudFormation to provision the data plane infrastructure for the project, select the Quickstart tile in the Deploy Method section. This is also the recommended method for starting a BYOC project.

      If you decide to use AWS CloudFormation, click Next, and you will be prompted with the following dialog box to choose whether to deploy the project to a new VPC or an existing VPC.

      EWCsb9An2oM6dkxjCuOcM5hRnCe

      Then, you can click Create Stack with CloudFormation to start deploying the project.

    • Use a Terraform script to provision the infrastructure.

      If you prefer to use a Terraform script to provision the infrastructure, you need to copy and paste the script output back to Zilliz Cloud. For details, see Bootstrap Project Infrastructure (Terraform).

      Note that you still need to fill in the information returned by the Terraform script to the Zilliz Cloud console, as specified in Credential Settings and Network Settings.

    • Use the AWS console to create the necessary resources and roles.

      You need to create necessary resources, such as a storage bucket and several IAM roles, on the AWS console. Then, copy and paste their names and IDs back to the Zilliz Cloud console. If you prefer to create the project this way, select the Manually tile in the Deploy Method section and click Next.

      Zilliz Cloud splits the process into Credential Settings and Network Settings to facilitate your configurations.

Credential Settings​

In Credential Settings, you must set up the storage and several IAM roles for storage access, EKS cluster management, and data-plane deployment.

LEGhbUbZwoPdwSx1PjxcHBjQnab

  1. Follow the steps listed below to configure storage, EKS, and cross-account settings.

    1. In Storage settings, set Bucket Name and IAM Role ARN obtained from AWS.

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

      For more on the procedure for creating an S3 bucket, read Create S3 Bucket and IAM Role.

    2. In EKS Settings, set IAM Role ARN for EKS management.

      Zilliz Cloud will use the specified role to deploy an EKS cluster on your behalf and deploy the data plane in the EKS cluster.

      For more on the procedure for creating an EKS role, read Create EKS IAM Role.

    3. In Cross-Account Settings, set IAM Role ARN for data-plane deployment.

      You need to copy the External ID provided in the dialog box. Zilliz Cloud will use the specified role to deploy the data plane of the Zilliz Cloud BYOC project.

      For more on the procedure for creating the cross-account role, read Create Cross-Account IAM Role.

  2. Click Next to configure network settings.

Network Settings​

In Network Settings, you need to create a VPC and several types of resources, such as subnets, security group, and optional VPC endpoint in the VPC.

NeKmbmKVhoNWcOx18IjcC1eLnDb

  1. In Network Settings, set the VPC ID, Subnet IDs, the Security Group ID, and the optional VPC endpoint ID.

    In the specified VPC, Zilliz Cloud requires

    • A public subnet and three private subnets.

    • A security group, and

    • An optional VPC endpoint.

    Note that VPC Endpoint ID is available only when you switch on AWS PrivateLink in General Settings above. For more on the procedure for creating a VPC and its associated resources, refer to Configure a Customer-Managed VPC.

  2. Click Next to view the summary.

  3. In Deployment Summary, review the configurations.

  4. Click Create if everything is as expected.

Instance Settings​

The data plane of a Zilliz BYOC project comprises three types of components: Search Services, Fundamental Database Components, and Core Support Services, which use different EC2 instances.

HIQBbyOFOozC9GxYnKZc4KE6nyf

In the General settings, you need to determine the EC2 instance types for the three data plane components mentioned above. Additionally, you need to specify the number of EC2 instances for Core Support Services, which determines the maximum number of clusters that can be created within the project.

There are four predefined project size options, and they are described as follows:

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 choose to customize the settings by selecting Custom in Initial Project Size and adjusting the EC2 instance types and counts for all data plane components. If your preferred EC2 instance types are not listed, please contact Zilliz support.

View deployment details​

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

Wstab2JghoTZ51xdSFQc2JHknJb

Suspend & Resume​

Suspending a project halts the data plane and terminates all EC2 instances associated with the EKS 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.

BN8KbqawgoErlZxtNYFcEvrjne4

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

QXK1bRewYoasCzx1AHNcpbSBnhe

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.

Procedures​