Get Started with Helios BYOC

Prerequisites

Amazon EKS VPC and Subnet Requirements (Optional)

Note

If the required privileges are provided to SingleStore, a VPC is created in the customer's AWS account during Bootstrapping.

While setting up the Amazon Elastic Kubernetes Services (EKS) cluster, ensure that the Virtual Private Cloud (VPC) and subnets meet the following requirements:

  • IPv4 Only: The VPC and subnets must only use IPv4 addresses. IPv6 addresses are not supported.

  • Distributed across Availability Zones (AZs): The VPC must span at least three different AZs to ensure high availability and fault tolerance.

  • Public and Private Subnets: Set up 1 public subnet and 1 private subnet for each AZ.

    • Public subnets must have routes to an Internet Gateway to enable outbound internet access. Explicitly associate the routes table to the subnet.

    • Private subnets must have access to a NAT (network address translation) gateway or NAT instance for outbound internet access. Explicitly associate the routes table to the subnet.

  • CIDR Block Limitation: SingleStore recommends a minimum of 30 hosts per subnet (/27 CIDR mask). The CIDR block defined per subnet limits the number of nodes that can be deployed within each subnet.

  • DNS Configuration: Enable DNS support and DNS hostnames to ensure proper resolution of DNS queries. Set the corresponding enableDnsSupport and enableDnsHostnames attributes to true when creating or configuring the VPC. Refer to DNS attributes for your VPC for more information.

  • Tag Private Subnets for Internal Load Balancer: Load balancers require specific tags on subnets for identification. Tag the private subnets with kubernetes.io/role/internal-elb=1 to enable provisioning of internal load balancers via VPC private link automation.

Set Up Helios BYOC

To deploy a SingleStore cell to your VPC, select Create Cell on the Cloud Portal. Alternatively, you can also select the Getting Started workflow. Provide the following information:

  • AWS Account ID

  • AWS Region

  • Availability Zones (for example, "a,b,c" or "a,b,c,d")

  • Whitelist CIDRs

  • Private subnet names

  • Public subnet names

  • VPC ID

SingleStore uses the provided information to create a customized image. Download this image from the Cloud Portal, and proceed to Bootstrapping.

Bootstrapping

“Bootstrapping” refers to the process of deploying the required infrastructure within the customer's VPC. Confirm that the required privileges are assigned to SingleStore before proceeding.

Perform the following tasks:

  1. Create a member account in your AWS organization.

  2. Optionally create a VPC that meets the Amazon EKS VPC and Subnet Requirements. If the necessary permissions are provided to Cloud Portal, a VPC with the required configurations is automatically created by the provided scripts in the customer's AWS account.

  3. Run the image provided by SingleStore to deploy an agent within the VPC with the required configurations which establishes a secure connection with the Control Plane. The scripts also enable the Control Plane to manage the infrastructure in the customer's member AWS account.

    Note

    The scripts do not grant access to the data on the Data Plane.

Once the scripts are run and a connection is established, the Control Plane automatically creates the infrastructure required to run a SingleStore cluster within the customer's AWS VPC. The scripts use the AWS APIs to create S3 buckets, EKS clusters, and EKS node groups.

Access Helios BYOC

Use the Cloud Portal to access your Helios BYOC cluster, SingleStore users, and databases.

Last modified: June 27, 2024

Was this article helpful?