Deploy AWS Fargate on Nested CloudFormation Stacks
Deployment guide for PlaceOS on Nested AWS CloudFormation templates.
This page assists with deploying PlaceOS on AWS using CloudFormation templates. The templates configure a PlaceOS Fargate deployment including an optional VPC configuration. The basic premise is:
- 1.Upload the nested templates to an S3 bucket
- 2.Orchestrate the deployment using a root stack template
You can use the
upload-s3.sh script in the AWS command-line tool to upload the required files to a configurable S3 bucket.A CloudFormation template specifies all the components. Each component is designed to deploy as its own CloudFormation stack.
The root stack requires the following files and directory structure:
- Security Groups:
infra/sec_groups.yml - Application Load Balancer:
infra/load-balancer-https.yml - Elastic File System:
infra/EFS.yml - Elasticsearch:
managed/elasticsearch.yml - ElastiCache:
managed/elasticache-redis-cluster.yml - Fargate Cluster:
fargate/ecs-cluster.yml - RethinkDB:
fargate/rethinkdb/single/rethinkdb-primary.yml - etcd:
fargate/etcd-service.yml - dispatch:
fargate/dispatch-service.yml - NGINX:
fargate/nginx-service.yml - Frontends:
fargate/frontends-service.yml auth:fargate/auth-service.ymlcore:fargate/core-service.yml- triggers:
fargate/triggers-service.yml rubber-soul:fargate/rubber-soul-service.yml- REST API:
fargate/rest-api-service.yml init:fargate/init-service.yml
The VPC root stack template
infra/vpc.yml deploys two private and two public subnets. For each of these the user can configure:- CIDR ranges
- An internet gateway
- Two NAT gateways
- Routes and route tables
The application load balancer is the only component that should deploy in public subnets.
Once you have uploaded the files to S3, use
root-stack-templates/placeos/deploy.yml to deploy PlaceOS. The required parameters are:BucketNameS3 Bucket name where nested templates liveCertificateIdCertificate Identifier from AWS ACM - required for TLS/SSLEnvironmentNameAn environment name that is a suffix for resource namesPLACEEMAILEmail address to login initially to the applicationPLACEPASSWORDPassword to login initially to BackofficePLACEUSERNAMEUsers NamePrivateSubnet1Select a private subnetPrivateSubnet2Select another private subnetPublicSubnet1Select a public subnetPublicSubnet2Select another public subnetVPCSelect the VPC containing the public and private subnetsVpcCIDRIP range (CIDR notation) for the VPC
The
EnvironmentName parameter's uses include:- Tagging
- Service discovery
- Linking outputs of templates with inputs of later templates
PlaceOS is the default but each deployment in the same VPC should configure its own
EnvironmentName. The Stack name you choose for each component has no effect on the function of the deployment.This service will never actually finish as the task will exit after it has run. You can update the ECS Service to have zero Number of tasks once it has been successful.
You can expect the deployment to take 20-30 minutes, most of which is Elasticsearch. The Backoffice application will be available at:
https://{Application_Load_Balancer_DNS_NAME}/login?continue=/backofficeThe credentials are the email and password set by the
init service. You can also find the application URL listed as an output for the init nested stack.