メインコンテンツまでスキップ
バージョン: User Guides (BYOC)

Deploy BYOC-I on Microsoft Azure

This page explains how to deploy a Bring-Your-Own-Cloud (BYOC) data plane with a BYOC agent in your Microsoft Azure Virtual Network.

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

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

Prerequisites

Ensure that

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

  • You have been granted the permissions listed in Required permissions.

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 Microsoft Azure credentials.

    Microsoft Azure credentials include your subscription ID and resource group name.

    Azure Portal (UI)

    • Subscription ID:

      UCcVbQX7boMNMLxoiK8ccyM9ngd

      1

      Navigate to Subscriptions in the top search bar or from the home page.

      2

      Select your subscription.

      3

      Find the Subscription ID in the Essentials section of the Overview page.

    • Resource Group Name:

      A resource group is a container that holds related resources for an Azure solution.

      HY2ybEyBHoOrwTxvvsxcvBDFnOe

      1

      Navigate to Resource groups in the left-hand menu.

      2

      The name is listed in the Name column.

      If none is displayed, you may need to create one and provide it to Zilliz Cloud. When you run the Terraform scripts later, all necessary resources will be added to the resource group, including virtual machines (VMs), virtual networks (VNets), and Azure Kubernetes Service (AKS) clusters.

  • Add access control (IAM) permissions

    Assign the Contributor and User Access Administrator permissions to the role that will run the Terraform scripts.

    P0NbbtVyTofpGmxtk1jcpQYsnTe

    1

    Navigate to Access control (IAM) in the left-hand menu.

    2

    Click + Add and select Add role assignment in the drop-down list.

    3

    In the Role tab, click Privileged administrator roles, filter for Contributor, and click Next.

    4

    In the Members tab, select User, group, or service principal or Managed entity in Assign access to, and click + Select members.

    Select User, group, or service principal if a user, group, or service principal is used to run the Terraform script. Otherwise, select Managed entity.

    5

    Click Next, review the settings, and click Review + assign to save.

    6

    Repeat the steps above for the User Access Administrator role.

  • Install the latest Terraform binary.

    For details on installing 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.

YYgcbgENMo6672xja9ucq9Dsnne

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.

Ugm3bsxb9oCsxzxqOYkclb7ZnRb

1

Set Project Name.

2

Select Cloud Provider and Region.

3

Determine whether to enable Azure Private Service Connect.

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.

4

Fill in your Azure Subscription ID and Resource Group Name obtained in Step 1.

5

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.

6

In Resource Settings, you need to

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

  2. Configure Initial Project Size.

    In a BYOC project, the query node, index services, Milvus components, and dependencies use different types of VM instances. You can set instance types and counts for these services and components individually.

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

    Ut9fbvTUDoXYxOxfp99cZIAGnMd

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

    VS2UbJ1cDoIqj0x3fiKc4vhMnLg

    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, along with the number of entities each cluster 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 VM instance types and counts for all data plane components. If your preferred VM instance types are not listed, please contact Zilliz support for further assistance.

7

Click Next.

Step 4: Deploy the data plane

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

X3s2bYas0o5ICVxZ18rcta5TnLd

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

Manage projects

J3Xibh9vtozuRHxt8Hjc0SqwnYg

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.

Technical support access

To assist you with troubleshooting and maintenance operations, Zilliz Cloud enables technical support to access your project's data plane by default.

LozAb735eoX00UxLYAKcWqY2nkG

When you click Technical Support Access from the target project's drop-down menu to view the current settings.

NdnSbwFbkokOPpxaW1ocGwklnab

You can disable it to meet data governance and security requirements.