Skip to main content

Prerequisites

Before creating a deployment in the EZ-CDC portal, you need certain cloud resources already in place. This page explains what you need before starting the deployment wizard.

What does the portal handle?

The deployment wizard guides you through the IAM/Service Account setup and automatically provisions security groups (AWS) or firewall rules (GCP), worker instances, and private connectivity resources. You only need to prepare your networking and databases beforehand.

Choose Your Cloud Provider

EZ-CDC supports deployment in both AWS and GCP:

CloudComputeConnectivity Modes
AWSEC2 (Auto Scaling Group)Standard, PrivateLink
GCPGCE (Managed Instance Group)Standard, Cloud NAT

Choose Your Connectivity Mode

ModeCloudDescriptionBest For
StandardAWS & GCPWorkers connect to control-plane via public internet (HTTPS)Most use cases, simpler setup
PrivateLinkAWS onlyWorkers connect via AWS PrivateLink (no public internet)Enterprise, strict security requirements
Cloud NATGCP onlyWorkers have no public IP, egress via Cloud NATPrivate GCP deployments

AWS Prerequisites

Standard Mode

For standard connectivity, workers connect to the EZ-CDC control-plane over the public internet using HTTPS/TLS encryption.

What You Need

1. A VPC

Any VPC in a supported region. No special configuration required.

2. At Least 2 Subnets with Internet Access
  • In different Availability Zones (for high availability)
  • Must have outbound internet access

Workers need outbound connectivity to the EZ-CDC control-plane on port 443 (HTTPS/gRPC).

Standard Mode Architecture
Optional: NAT Gateway

By default, workers run in subnets with direct internet access. If you prefer workers to remain in private subnets without public IPs, you can add a NAT Gateway to provide outbound connectivity.

3. Network Access to Your Databases

From the subnets you select, workers must be able to reach:

DatabasePort
PostgreSQL (source)5432
StarRocks (sink)9030, 8040

Standard Mode Checklist

□ VPC in a supported region
□ 2+ subnets in different AZs with outbound internet access
□ PostgreSQL reachable from subnets (port 5432)
□ StarRocks reachable from subnets (port 9030, 8040)

For PrivateLink connectivity, workers connect to the EZ-CDC control-plane through AWS PrivateLink. Traffic never leaves the AWS network.

Automatic VPC Endpoint

The VPC Endpoint that connects workers to the EZ-CDC control-plane is created automatically during deployment. You do not need to create it yourself.

What You Need

1. A VPC with DNS Enabled

Critical: Your VPC must have these settings enabled:

enable_dns_support   = true
enable_dns_hostnames = true

Without these settings, the VPC Endpoint created during deployment will not work.

Verify with AWS CLI:

aws ec2 describe-vpc-attribute --vpc-id vpc-xxx --attribute enableDnsSupport
aws ec2 describe-vpc-attribute --vpc-id vpc-xxx --attribute enableDnsHostnames
2. At Least 2 Private Subnets
  • In different Availability Zones (for high availability)
PrivateLink Mode Architecture

No outbound internet access is needed. Workers download binaries and communicate with the control-plane entirely through the VPC Endpoint.

3. Network Access to Your Databases

From the subnets you select, workers must be able to reach:

DatabasePort
PostgreSQL (source)5432
StarRocks (sink)9030, 8040
□ VPC with DNS support ENABLED
□ VPC with DNS hostnames ENABLED
□ 2+ private subnets in different AZs
□ PostgreSQL reachable from subnets (port 5432)
□ StarRocks reachable from subnets (port 9030, 8040)

GCP Prerequisites

Standard Mode

Workers connect to the EZ-CDC control-plane over the public internet. Each worker gets an ephemeral external IP.

What You Need

1. A GCP Project with Required APIs

Enable the following APIs in your GCP project:

gcloud services enable compute.googleapis.com \
logging.googleapis.com \
monitoring.googleapis.com \
--project=YOUR_PROJECT_ID
2. A VPC Network with a Subnetwork
  • A VPC network (default or custom)
  • A subnetwork in the target region with outbound internet access
3. Network Access to Your Databases

From the subnetwork, workers must be able to reach:

DatabasePort
PostgreSQL (source)5432
StarRocks (sink)9030, 8040

Standard Mode Checklist

□ GCP project with Compute, Logging, and Monitoring APIs enabled
□ VPC network with a subnetwork in the target region
□ Subnetwork has outbound internet access
□ PostgreSQL reachable from subnetwork (port 5432)
□ StarRocks reachable from subnetwork (port 9030, 8040)

Cloud NAT Mode

Workers have no public IPs. All egress goes through Cloud NAT, which is created automatically during deployment.

What You Need

1. A GCP Project with Required APIs

Same as Standard mode:

gcloud services enable compute.googleapis.com \
logging.googleapis.com \
monitoring.googleapis.com \
--project=YOUR_PROJECT_ID
2. A VPC Network with a Private Subnetwork
  • A VPC network (default or custom)
  • A subnetwork in the target region (no external IP required — Cloud NAT handles egress)
3. Network Access to Your Databases

From the subnetwork, workers must be able to reach:

DatabasePort
PostgreSQL (source)5432
StarRocks (sink)9030, 8040

Cloud NAT Mode Checklist

□ GCP project with Compute, Logging, and Monitoring APIs enabled
□ VPC network with a subnetwork in the target region
□ PostgreSQL reachable from subnetwork (port 5432)
□ StarRocks reachable from subnetwork (port 9030, 8040)
Automatic Cloud NAT

Cloud Router and Cloud NAT are created automatically during deployment. You do not need to set them up yourself.


Database Requirements

Both clouds require your databases to be properly configured.

PostgreSQL Source

RequirementValue
VersionPostgreSQL 12+
WAL Levellogical
Max Replication SlotsAt least 1 available per job
Max WAL SendersAt least 1 available per job

Verify with:

SHOW wal_level;             -- Must be 'logical'
SHOW max_replication_slots; -- Must have available slots
SHOW max_wal_senders; -- Must have available senders

See PostgreSQL Requirements for detailed setup.

StarRocks Sink

RequirementValue
VersionStarRocks 2.5+
Stream LoadEnabled
HTTP Port8040 accessible
MySQL Port9030 accessible

See StarRocks Requirements for detailed setup.


Supported Regions

AWS

RegionName
us-east-1N. Virginia
us-east-2Ohio
us-west-2Oregon
eu-west-1Ireland
eu-central-1Frankfurt
ap-southeast-1Singapore

GCP

RegionName
us-central1Iowa
us-east1South Carolina
europe-west1Belgium
asia-southeast1Singapore

Summary

RequirementAWS StandardAWS PrivateLinkGCP StandardGCP Cloud NAT
NetworkVPC + 2 subnetsVPC (DNS enabled) + 2 private subnetsVPC + subnetworkVPC + subnetwork
Internet accessRequiredNot requiredRequired (external IPs)Not required (Cloud NAT)
DB accessFrom subnetsFrom subnetsFrom subnetworkFrom subnetwork

Created Automatically During Deployment

These resources are provisioned by EZ-CDC when you create a deployment — you do not need to set them up:

ResourceAWSGCP
IdentityIAM Role (via CloudFormation)Service Account
Network RulesSecurity GroupsFirewall Rules
ComputeAuto Scaling GroupManaged Instance Group
Private ConnectivityVPC Endpoint (PrivateLink only)Cloud NAT (Cloud NAT mode only)
LoggingCloudWatch Log GroupsCloud Logging (automatic)
Instance PermissionsIAM Instance ProfileService Account scopes

Next Steps

Once you have all prerequisites in place: