Terraform Provider
Zilliz offers a fully managed Milvus service, streamlining the deployment and scaling of vector search applications with security in mind, and eliminating the need to build and maintain complex infrastructure, including both the cloud infrastructure Zilliz provides and your own.
The Zilliz Cloud Terraform Provider is an open-source Infrastructure as Code (IaC) solution that enables you to dynamically build, change, and version your Zilliz Cloud resources. Before using it, you must configure the provider with proper credentials, such as a Zilliz Cloud API key with appropriate permissions.
Authentication
Before you begin a resource deployment using Terraform, you must authenticate Terraform with the Zilliz Cloud platform. You must use a Zilliz Cloud API key with the appropriate permissions to complete authentication before any operations with this Terraform provider. To create a Zilliz Cloud API key, follow these steps:
-
Sign in to the Zilliz Cloud console.
-
On the right of the top navigation bar, click API Keys.
-
Click + API Key in the top right corner on the API Keys page.
-
In the Create API Key dialog box that appears, enter an API key name and configure its access privileges, and click Create to generate an API key.
For more information about managing API keys, refer to API Keys.
Manageable Resources
Currently, you can use this provider to manage the following types of resources:
Clusters
A Zilliz Cloud cluster is a Milvus instance that operates on Zilliz Cloud. Zilliz Cloud categorizes its clusters into various offerings, including Free, Serverless, Dedicated (Standard), Dedicated (Enterprise), and Bring Your Own Cloud (BYOC). For details on these offerings, refer to the Detailed Plan Comparison.
You can use the Zilliz Cloud Terraform Provider to create and manage clusters of any specific offering. For details, refer to the following tutorials:
Database
In Zilliz Cloud, a database serves as a logical unit for organizing and managing data. It is available only in dedicated clusters. Upon the creation of a cluster, a default database will be created. For details about how to manage database using Zilliz Cloud Terraform Provider, refer to the resources and data sources below:
Collection
A collection is a two-dimensional table with fixed columns and variant rows. Each column represents a field, and each row represents an entity. For details about how to manage collections using Zilliz Cloud Terraform Provider, refer to the following resources and data sources below:
Partition
A partition is a subset of a collection. Each partition shares the same data structure with its parent collection but contains only a subset of the data in the collection. This page helps you understand how to manage partitions. For details on how to manage partitions using Zilliz Cloud Terraform Provider, refer to the following resources and data sources below:
Index
Zilliz Cloud employs AUTOINDEX to enable efficient similarity searches. It also offers these metric types: Cosine Similarity (COSINE), Euclidean Distance (L2), Inner Product (IP), JACCARD, and HAMMING to measure the distances between vector embeddings. AUTOINDEX also applies to scalar fields to accelerate metadata filtering. For details about how to manage indexes using Zilliz Cloud Terraform Provider, refer to the following resources and data sources below:
Users & Roles
In Zilliz Cloud, you can create cluster users and assign them cluster roles to define the privileges, achieving data security. A user represents a database user with properly configured credentials and is assigned a set of roles, while a role is an entity that encapsulates a set of privileges and can be assigned to users. You can use this section's resources and data sources to implement role-based access control (RBAC). For details, refer to the resource and data sources below: