Backend
- The first repository to be deployed will be "ESP-RainMaker-Base-API".
- Click on the ESP-RainMaker-Base-API SAR repository, the details for the repository will be displayed as below.
- Scroll down and click on the checkbox - "I acknowledge that this app creates custom IAM roles".
StageName - The API gateway stage, which will be part of your API base URL. Can be one of [dev, stage, prod].
Click on Deploy button.
Click on Deploy button, the deployment will start and the below screen will be displayed. The deployment process will be finished in a few minutes.
You can check the status of the deployment of this SAR repository, from CloudFormation.
Go to AWS Console -> Services -> CloudFormation. The list of stacks deployed will be shown.
You will see an entry for the "serverlessrepo-ESP-RainMaker-Base-API" stack. "CREATE_COMPLETE" status indicates that this repository is successfully deployed, as shown below.
- The next repository to be deployed is "ESP-RainMaker-Base".
- From the SAR repositories menu, search for "ESP-RainMaker-Base" repository and click on it.
- The below screen will be displayed (the version may be different).
Scroll down and click on the checkbox - " I acknowledge that this app deploys nested applications ".
Log - The Log level value can be set to various levels like - Debug, Error, Info.
Note: Debug log level will offer verbose logs which will help debug issues faster. This will however incur more costs. (You can change this later using API with per lambda granularity)
- StageName - The stage entered in the previous steps for "ESP-RainMaker-Base-API"
Click on deploy button.
The deployment will start. This SAR repository will be deployed in around 10- minutes.
You can check the status of the deployment of this SAR repository, from CloudFormation.
Go to AWS Console -> Services -> CloudFormation. The list of stacks deployed will be shown.
You will see an entry for the "serverlessrepo-ESP-RainMaker-Base" stack. "CREATE_COMPLETE" status indicates that this repository is successfully deployed, as shown below.
- The next repository to be deployed is "ESP-RainMaker-Core"
- From the SAR repositories menu, search for "ESP-RainMaker-Core" repository and click on it.
- From the SAR repositories menu, search for "ESP-RainMaker-Core" repository and click on it, below screen will be displayed. (The version may be different)
- Scroll down and enter the values for the parameters.
- Email - Email Address for sending user notifications. When a new user signs-up, they will receive the verification code from this email address. Please note that this email address should be verified by AWS Simple Email Service, as mentioned in the Section - Configuring the Email Sending Service
- Username - Email address to create the super-admin user. User with this email will automatically get created after deployment is successful. The login credentials and deployment details will be sent to this email after successful deployment.
It is not recommended to use personal mail ID for the super-admin user, Please use a generic mail ID instead. Access to this generic email should be limited to very few set of people as this user will be the most privileged user in RainMaker deployment.
e.g. service@<company_domain_name>
Note - This user, which will be created during the deployment will have SuperAdmin privileges. Only this user will have access to services like Bulk Node Registration CLI. For full list of SuperAdmin operations, refer SuperAdmin Swagger.
Click the checkbox - I acknowledge that this app creates custom IAM roles, resource policies and deploys nested applications.
Click on Deploy button and the deployment for the RainMaker backend will start.
The deployment of this repository will be completed in approximately 20-30 minutes.
You can check the status of the deployment of this SAR repository from CloudFormation.
Go to AWS Console -> Services -> CloudFormation. The list of stacks deployed will be shown.
You will see an entry for the "serverlessrepo-ESP-RainMaker-Core" stack. "CREATE_COMPLETE" status indicates that this repository is successfully deployed, as shown below.
- An email containing the credentials for the RainMaker super-admin user will be sent to the email address which was configured during deployment of the stack. These credentials will be required for login to the RainMaker dashboard.
- Another email which contains the deployment details of the RainMaker platform will be sent after sometime. This email contains the details about the Base API URL and other details.
