Skip to content

Latest commit

 

History

History
91 lines (54 loc) · 4.16 KB

README.md

File metadata and controls

91 lines (54 loc) · 4.16 KB

Container Manager

This is designed so you only need one base stack that you deploy first, then you can deploy any number of leaf stacks on it. This lets you modify one leaf/container stack, without affecting the rest, and still have shared resources to reduce cost/complexity where appropriate.

Note: The word Stack is overloaded here. Both the "base" and "leaf" stacks each contain two stacks inside them (one in a region of your choice, and one in us-east-1 for Route53). There's just no better word, "app" is the entire project.

  • The ./leaf_stack is what runs a single container. One leaf_stack for one container.
  • The ./base_stack is common architecture that different containers can share (i.e VPC, HostedZone). Multiple "Leaf Stacks" can point to the same "Base Stack".
  • The ./utils are functions that don't fit in the other two. Mainly config readers/parsers.

Click here to jump to 'Base Stack Config Options'. It's the last section, since it's the longest.

Leaf Stack Summary

picture

Not an all inclusive diagram: There's more not shown, like EFS mounted to both the EC2 Task and ASG Instance, SNS Alerts, etc.

The system is designed all around the Auto Scaling Group (ASG). This way, if the ASG spins up in any way (DNS query comes in, or you change the desired_count in the console), everything spins up around it. If a alarm triggers, it just has to spin the ASG back down and everything will naturally follow suit.

See the leaf_stack's README.md for more info.

Moving Variables between the Stacks (cross-region)

This section is has been moved to the utils README.

Base Stack Summary

The base stack is broken into two components (or "stacks"). One must be in us-east-1 for Route53, and the other has to be in the same region as you want to run the containers from.

Anything that can be here instead of the leaf stacks, should be.

Base Stack Config Options

These are config options for when you deploy the base stack, to fine-tune it to your needs. Update the base-stack-config.yaml file in the root of this repo.

Vpc

  • (dict, Required): Config options for the VPC.

Vpc.MaxAZs

  • (int, Default: 1): The number of AZ's (Availability Zones) to use in the VPC. Two means high-availability, BUT your EFS storage costs will double.

    Vpc:
  MaxAZs: 1

Domain

  • (dict, Required): Config options for the domain.

Domain.Name

  • (str, Required): The root domain name for all the leaf_stack's.

    Domain:
  Name: example.com

Domain.HostedZoneId

  • (str, Optional - kinda): The Route53 Hosted Zone ID for the domain of the domain name above. If not provided, it will be created. (Though you'll probably have to manually update the NS records in your registrar or something. I haven't tested this path yet). If you buy a AWS Domain, put it's HostedZoneId here.

    Domain:
  HostedZoneId: Z1234567890

AlertSubscription

  • (list, Optional): Any number of key-value pairs, where the key is the protocol (i.e "Email"), and the value is the endpoint (i.e [email protected])

    AlertSubscription:
  - Email: [email protected]
  - Email: [email protected]

    This is to get notified for ANY leaf stack events. Intended for admin to keep an eye on everything without having to subscribe to every leaf stack config's AlertSubscription

    Options like SMS and HTTPS I hope to add at some point, but Email was the easiest to just get off the ground.

    Only have someone subscribed to this, OR the leaf stack, NOT BOTH. Otherwise you'll get an alert from each one any time something happens.