TDengine Enterprise on AWS

Partner Solution Deployment Guide

May 2023
Yiqing Liu and Hao Guo, Taos Data
Wenjing Hu, AWS Partner SA and Chao Chen, AWS Migration SA
Troyt Ameigh, AWS Integration & Automation team

Refer to the GitHub repository to view source files, report bugs, submit feature ideas, and post feedback about this Partner Solution. To comment on the documentation, refer to Feedback.

This Partner Solution was created by Taos Data in collaboration with Amazon Web Services (AWS). Partner Solutions are automated reference deployments that help people deploy popular technologies on AWS according to AWS best practices. If you’re unfamiliar with AWS Partner Solutions, refer to the AWS Partner Solution General Information Guide.

Overview

This guide covers the information you need to deploy the TDengine Enterprise Partner Solution in the AWS Cloud.

This guide provides instructions for deploying the TDengine Enterprise Partner Solution reference architecture on the AWS Cloud. For more information on TDengine, refer to Deployment.

Costs and licenses

The TDengine Enterprise Partner Solution is free to try with an embedded 15 days license. To purchase an official license or extend the trial period, contact Taos Data or subscribe on AWS Marketplace.

Architecture

Deploying this Partner Solution with default parameters builds the following TDengine Enterprise environment in the AWS Cloud.

Figure 1. Quick Start architecture for TDengine Enterprise on AWS

As shown in Figure 1, this Partner Solution sets up the following:

A highly available architecture that spans two Availability Zones.*
A virtual private cloud (VPC) configured with public and private subnets, according to AWS best practices, to provide you with your own virtual network on AWS.*
In the public subnets:
- Managed NAT gateways to allow outbound internet access for resources in the private subnets.*
- A Linux bastion host in an Auto Scaling group to allow inbound Secure Shell (SSH) access to Amazon Elastic Compute Cloud (Amazon EC2) instances in public and private subnets.*
In the private subnets:
- The TDengine cluster nodes in an Auto Scaling group.
- A Network Load Balancer that passes RESTful requests to the group of data nodes.
- An ElastiCache for Redis replication group with primary and replica nodes.
An Amazon Simple Storage Service (Amazon S3) bucket for server-tiered storage (supported in TDengine Enterprise Edition only).*
AWS Identity and Access Management (IAM) to manage access to the needed resources.

* The template that deploys this Partner Solution into an existing VPC skips the components marked by asterisks and prompts you for your existing VPC configuration.

Deployment options

This Partner Solution provides the following deployment options:

Deploy TDengine Enterprise into a new VPC. This option builds a new AWS environment that consists of the VPC, subnets, NAT gateways, security groups, bastion hosts, and other infrastructure components. It then deploys TDengine Enterprise into this new VPC.
Deploy TDengine Enterprise into an existing VPC. This option provisions TDengine Enterprise in your existing AWS infrastructure.

This Partner Solution provides separate templates for these options. It also lets you configure Classless Inter-Domain Routing (CIDR) blocks, instance types, and TDengine Enterprise settings.

Predeployment steps

To start the workshop, you must have an AWS account. If you do not have an account, sign up for one at Amazon Free Tier. Generate an Amazon EC2 key pair for the AWS Region the solution is deployed in.

If you deploy in an existing VPC, verify you set up the NAT gateway, including NAT resource, NATEIP, and RouteNATGateway. Otherwise, the cluster doesn’t run as expected.

Deployment steps

Sign in to your AWS account, and launch this Partner Solution, as described under Deployment options. The AWS CloudFormation console opens with a prepopulated template.
Choose the correct AWS Region, and then choose Next.
On the Create stack page, keep the default setting for the template URL, and then choose Next.

On the Specify stack details page, change the stack name if needed. Review the parameters for the template. Provide values for the parameters that require input. For all other parameters, review the default settings and customize them as necessary. When you finish reviewing and customizing the parameters, choose Next.

Unless you’re customizing the Partner Solution templates or are instructed otherwise in this guide’s Predeployment section, don’t change the default settings for the following parameters: QSS3BucketName, QSS3BucketRegion, and QSS3KeyPrefix. Changing the values of these parameters will modify code references that point to the Amazon Simple Storage Service (Amazon S3) bucket name and key prefix. For more information, refer to the AWS Partner Solutions Contributor’s Guide.

On the Configure stack options page, you can specify tags (key-value pairs) for resources in your stack and set advanced options. When you finish, choose Next.
On the Review page, review and confirm the template settings. Under Capabilities, select all of the check boxes to acknowledge that the template creates AWS Identity and Access Management (IAM) resources that might require the ability to automatically expand macros.
Choose Create stack. The stack takes about 10-15 minutes to deploy.
Monitor the stack’s status, and when the status is CREATE_COMPLETE, the TDengine Enterprise deployment is ready.
To view the created resources, choose the Outputs tab.

Postdeployment steps

To start using TDengine with testing data sets, refer to Test data insert performance and Run TDengine.

Manually delete the S3 buckets if you want to clear all resource deployed by this Partner Solution.

Troubleshooting

For troubleshooting common Partner Solution issues, refer to the AWS Partner Solution General Information Guide and Troubleshooting CloudFormation.

Q. I encountered a CREATE_FAILED error when I launched the Partner Solution.

A. If AWS CloudFormation fails to create the stack, we recommend that you relaunch the template with Rollback on failure set to Disabled. (This setting is under Advanced in the AWS CloudFormation console, Options page.) With this setting, the stack’s state is retained, and instances remain running so you can troubleshoot the issue.

When you set Rollback on failure to Disabled, you continue to incur AWS charges for the stack. Ensure that you delete the stack when you finish troubleshooting.

For more information, see Troubleshooting AWS CloudFormation.

Q. I encountered a size limitation error when I deployed the AWS CloudFormation templates.

A. Launch the Partner Solution templates from the links in this guide or from another S3 bucket. If you deploy the templates from a local copy on your computer, or from a location other than Amazon S3, you might encounter template size limitations when you create the stack. For more information, see AWS CloudFormation quotas.

Q. Dnodes hasn’t been launched.

A. We recommend you don’t use SSH to access Amazon EC2 instances while the Amazon EC2 status is initializing.

Q. How to deploy in the China Region.

A. The China Region uses the same templates.

Customer responsibility

After you deploy a Partner Solution, confirm that your resources and services are updated and configured—including any required patches—to meet your security and other needs. For more information, refer to the Shared Responsibility Model.

Feedback

To submit feature ideas and report bugs, use the Issues section of the GitHub repository for this Partner Solution. To submit code, refer to the Partner Solution Contributor’s Guide. To submit feedback on this deployment guide, use the following GitHub links:

Notices

This document is provided for informational purposes only. It represents current AWS product offerings and practices as of the date of issue of this document, which are subject to change without notice. Customers are responsible for making their own independent assessment of the information in this document and any use of AWS products or services, each of which is provided "as is" without warranty of any kind, whether expressed or implied. This document does not create any warranties, representations, contractual commitments, conditions, or assurances from AWS, its affiliates, suppliers, or licensors. The responsibilities and liabilities of AWS to its customers are controlled by AWS agreements, and this document is not part of, nor does it modify, any agreement between AWS and its customers.

The software included with this paper is licensed under the Apache License, version 2.0 (the "License"). You may not use this file except in compliance with the License. A copy of the License is located at https://aws.amazon.com/apache2.0/ or in the accompanying "license" file. This code is distributed on an "as is" basis, without warranties or conditions of any kind, either expressed or implied. Refer to the License for specific language governing permissions and limitations.