Skip to main content
Version: User Guides (BYOC)

Deploy BYOC-I on AWS

This page explains how to create a Bring-Your-Own-Cloud (BYOC) data plane with a BYOC agent in your AWS Virtual Private Cloud (VPC).

📘Notes

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

Prerequisites​

Ensure that

  • You are the owner of a BYOC-I organization.

Procedures​

Step 1: Prepare the deployment environment​

A deployment environment is a local machine, a virtual machine (VM), or a CI/CD pipeline configured to run the Terraform configuration files and deploy the data plane of your BYOC-I project. In this step, you need to

  • Configure AWS credentials (AWS profile or access key).

    For details on how to configure AWS credentials, refer to this document.

  • Install the latest Terraform binary.

    For details on how to install Terraform, refer to this document.

Step 2: Create a project​

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

Xd4ObksJao97jdxSFVTclO4Fno6

Step 3: Set up the general settings​

In General Settings, you need to set the project name and determine the cloud providers and regions where Zilliz Cloud deploys the data plane for the project.

B7VJbAkvao0lf8xAXzAc3ZeGnTd

  1. Set Project Name.

  2. Select Cloud Provider and Region.

  3. (Optional) Configure Instance Settings.

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

    For details, see Instance Settings.

  4. Click Create and Next.

Step 4: Deploy the data plane​

Follow the steps displayed in the dialog to deploy the data plane for the currently created project.

GHGqbw4UroKPu7xoEWmcDQaDnEd

For details on running the above Terraform scripts, refer to the Zilliz Cloud BYOC-I Project Setup Guide.

Manage projects​

AHEybTRhto0gcKxnKIucbm3inte

Projects with an Undeploy tag​

If the status tag on the right corner of a project card reads Undeploy, you can always click the Deploy Data Plane button on the project card to reopen it. To rename or delete the project, click the ... button in the project card and select Rename or Delete from the drop-down menu.

Projects with a Deploying tag​

Once you have prepared the deployment environment and executed the displayed commands, you must wait for the BYOC agent to activate. When the status tag on the project card reads Deploying and shows the progress percentage, you cannot rename or delete the project until the data plane is in place.

Projects with a Running tag​

Once the status tag on a project card reads Running, you can start creating clusters in the project. To rename or delete a running project, ensure that there are no clusters in the project.

Instance settings​

During the project deployment, Zilliz Cloud creates the fundamental database components and core support services. When the project is ready, you can create clusters in the project. At this point, Zilliz Cloud creates instances for search services on your behalf.

OvCTbAZuMo3LmSxTMAIcIUYMnZd