Zilliz BYOC Terraform Examples

Docker environment for deploying Zilliz BYOC (Bring Your Own Cloud) infrastructure on AWS.

Quick Start

Build and Deploy

# Build Docker image
docker build -t byoc-test:latest .

# Test environment
docker run -it --rm \
  -e AWS_ACCESS_KEY_ID=your_access_key \
  -e AWS_SECRET_ACCESS_KEY=your_secret_key \
  -e AWS_DEFAULT_REGION=us-west-2 \
  -e ZILLIZCLOUD_API_KEY=your_zilliz_api_key \
  -e PROJECT_NAME=your_project_name \
  byoc-test:latest /scripts/test.sh

# Deploy infrastructure
docker run -it --rm \
  -e AWS_ACCESS_KEY_ID=your_access_key \
  -e AWS_SECRET_ACCESS_KEY=your_secret_key \
  -e AWS_DEFAULT_REGION=us-west-2 \
  -e ZILLIZCLOUD_API_KEY=your_zilliz_api_key \
  -e PROJECT_NAME=your_project_name \
  byoc-test:latest /scripts/deploy.sh

Environment Variables

Required

• AWS_ACCESS_KEY_ID - AWS access key
• AWS_SECRET_ACCESS_KEY - AWS secret key
• AWS_DEFAULT_REGION - AWS region (e.g., us-west-2)
• ZILLIZCLOUD_API_KEY - Zilliz Cloud API key
• PROJECT_NAME - Unique project name

Optional

• VPC_CIDR - VPC CIDR block (default: 10.0.0.0/16)
• ENABLE_PRIVATE_LINK - Enable private link (default: false)
• CORE_VM - Core instance type (default: m6i.2xlarge)
• CORE_COUNT - Core instance count (default: 3)
• SEARCH_VM - Search instance type (default: m6id.4xlarge)
• SEARCH_MIN_COUNT - Search min count (default: 1)
• SEARCH_MAX_COUNT - Search max count (default: 2)
• AUTO_APPLY - Auto apply changes (default: false)
• SKIP_APPLY - Skip apply step (default: false)

Examples

Basic Deployment

docker run -it --rm \
  -e AWS_ACCESS_KEY_ID=your_access_key \
  -e AWS_SECRET_ACCESS_KEY=your_secret_key \
  -e AWS_DEFAULT_REGION=us-west-2 \
  -e ZILLIZCLOUD_API_KEY=your_zilliz_api_key \
  -e PROJECT_NAME=your_project_name \
  byoc-test:latest /scripts/deploy.sh

Production with Private Link

docker run -it --rm \
  -e AWS_ACCESS_KEY_ID=your_access_key \
  -e AWS_SECRET_ACCESS_KEY=your_secret_key \
  -e AWS_DEFAULT_REGION=us-west-2 \
  -e ZILLIZCLOUD_API_KEY=your_zilliz_api_key \
  -e PROJECT_NAME=your_project_name \
  -e ENABLE_PRIVATE_LINK=true \
  -e AUTO_APPLY=true \
  byoc-test:latest /scripts/deploy.sh

Docker Image

The byoc-test:latest image includes:

• Ubuntu 22.04, Terraform >= 1.6.0, AWS CLI v2
• kubectl, Docker CLI, AWS IAM Authenticator
• Git for cloning Terraform configurations
• Deployment scripts (/scripts/deploy.sh, /scripts/test.sh)

Prerequisites

• AWS account with permissions to create VPC, S3, IAM resources
• Valid Zilliz Cloud API key
• Support for us-west-2 or eu-central-1 regions

Troubleshooting

Common Issues

• AWS Credential Errors: Check access keys and permissions
• Invalid API Key: Verify Zilliz Cloud API key
• Resource Conflicts: Ensure project name is unique
• Network Issues: Check connectivity and firewall settings

Security Best Practices

• Use IAM roles instead of access keys when possible
• Enable private link for enhanced security
• Rotate API keys regularly

Supported Regions

• us-west-2 (US West - Oregon)
• eu-central-1 (Europe Central - Frankfurt)