RainMaker Cloud
Deployment Model
ESP RainMaker is entirely based on Serverless Architecture. It uses services like Lambda, DynamoDB, which are internally provisioned by AWS into multiple Availability Zones in a Region.
Currently, ESP RainMaker can be deployed into only one region per AWS Account. Previously, we used SAR as a deployment model for Rainmaker. Now, we have developed the SAM deployment model, which we will explain in this section.
Note: We will support upgrades using SAR, but all new deployments will be done exclusively with SAM.
RainMaker Deployment
To deploy Rainmaker components, we use SAM package templates, which internally generate CloudFormation CF templates.
Terminologies
-
SAM (Serverless Application Model) Templates: These are configuration files used to define the serverless application you want to deploy. They simplify the setup by handling the complex CloudFormation syntax. Reference link
-
SAR (Serverless Application Repository): AWS SAR is a managed repository that enables developers to easily discover, deploy, and share serverless applications. It streamlines application deployment by providing access to pre-built serverless solutions.Reference link
-
Resources: These are the components or services (like DynamoDB, S3, Lambda) that you create and manage on AWS.
-
Stacks: A collection of AWS resources that you can manage as a single unit. CloudFormation templates are used to create, update, and delete these stacks.
-
Submodule Stacks: Smaller stacks within the main stack, each handling a specific function or service (e.g., user management, node management).
Required Components
We need to deploy two mandatory components for ESP Rainmaker Deployment:
There are two SAM templates for the backend:
1. ESP-RainMaker-Base
- It Includes DynamoDB, S3, Base API gateway, etc.
2. ESP-RainMaker-Core
- It Includes Lambda, APIs, SNS, etc.
The parent ESP RainMaker stack includes all sub-module stacks like user management, node management, access control, Over the Air upgrade (OTA), etc. Deploying the parent stack will deploy all required sub-module stacks in sequence.
Optional Components
There are additional optional components:
- Add-on Services
- Voice Assistant Integrations
There will be one SAM template for all the add-on services where users can optionally choose which add-on stacks to deploy in their account. There will be one SAM template for Alexa and GVA Voice assistant integration.
The Espressif Administrators should have given you access to these templates for deploying them into your AWS account.
Supported Rainmaker Version and Region
| Rainmaker Version |
|---|
| 2.5.0 |
| 2.6.0 |
| 2.7.0 |
| 2.7.1 |
| 2.8.0 |
| 2.8.1 |
| Region name | Region |
|---|---|
| US East (N. Virginia) | us-east-1 |
| US West (N. California) | us-west-1 |
| US West (Oregon) | us-west-2 |
| Asia Pacific (Mumbai) | ap-south-1 |
| Asia Pacific (Singapore) | ap-southeast-1 |
| Asia Pacific (Sydney) | ap-southeast-2 |
| Europe (Frankfurt) | eu-central-1 |
| Europe (Ireland) | eu-west-1 |
| South America (São Paulo) | sa-east-1 |
| US East (Ohio) | us-east-2 |
| Europe (London) | eu-west-2 |
| Europe (Paris) | eu-west-3 |
| Asia Pacific (Tokyo) | ap-northeast-1 |
| Europe (Stockholm) | eu-north-1 |
| Middle East (Bahrain) | me-south-1 |
| China (Beijing) | cn-north-1 |
Please contact the Espressif RainMaker team (esp-rainmaker-support@espressif.com) if you want to deploy RainMaker in regions other than the ones listed above.
Please make sure that you have selected the region for which the RainMaker SAM access was granted for your account. Before proceeding for the rainmaker backend deployment, please make sure you have completed all the Pre Deployment Steps. All AWS cases should be resolved correctly.
Time Needed for Deployment
The approximate time required for deploying RainMaker components is as below:
| Component | Time (in minutes) |
|---|---|
Backend Services
| 80 |
ESP-RainMaker-AddOns
| 50 |