Skip to content

Commit

Permalink
imrpvoded state docs
Browse files Browse the repository at this point in the history
  • Loading branch information
michaelwittig committed Mar 5, 2018
1 parent f9ebccb commit 14d0588
Show file tree
Hide file tree
Showing 3 changed files with 57 additions and 3 deletions.
6 changes: 3 additions & 3 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,10 @@ Your source for free [AWS CloudFormation](https://aws.amazon.com/cloudformation/
* Rely on high-quality infrastructure templates: peer-reviewed by an expert (certified AWS solutions architect Professional) and verified with automated tests.
* All templates are production-ready. If no other limitations are documented, they are:
* Highly available: no single point of failure
* Scalable: increase or decrease the number of instances based on load
* Scalable: increase or decrease the capacity based on utilization
* Frictionless deployment: deliver new versions of your application automatically without downtime
* Secure: using the latest operating systems and software components, follow the least privilege principle in all areas
* Operations: provide tools like logging, monitoring and alerting to recognize and debug problems
* Secure: using the latest operating systems and software components, follow the least privilege principle in all areas, backups enabled
* Operations friendly: provide tools like logging, monitoring and alerting to recognize and debug problems
* Premium Support available: Get help in case of small and big emergencies and submit a feature request.

# Infrastructure Templates
Expand Down
51 changes: 51 additions & 0 deletions docs/state.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,9 @@ Some data stores are integrated into the VPC, others are only accessible via the
1. Click **Create** to start the creation of the stack.
1. Wait until the stack reaches the state **CREATE_COMPLETE**

## Dependencies
* `vpc/vpc-*azs.yaml` (**required**)

# DynamoDB table

DynamoDB table with auto scaling for read and write capacity.
Expand All @@ -31,6 +34,12 @@ DynamoDB table with auto scaling for read and write capacity.
1. Click **Create** to start the creation of the stack.
1. Wait until the stack reaches the state **CREATE_COMPLETE**

## Dependencies
* `operations/alert.yaml` (recommended)

## Limitations
* No backup

# ElastiCache memcached

Cluster of memcached nodes.
Expand All @@ -47,6 +56,18 @@ Cluster of memcached nodes.
1. Click **Create** to start the creation of the stack.
1. Wait until the stack reaches the state **CREATE_COMPLETE**

## Dependencies
* `vpc/vpc-*azs.yaml` (**required**)
* `state/client-sg.yaml` (**required**)
* `vpc/zone-*.yaml`
* `vpc/vpc-ssh-bastion.yaml`
* `operations/alert.yaml` (recommended)

## Limitations
* No backup
* No data replication (use as a in-memory cache only)
* No auto scaling

# Elasticsearch

Cluster of Elasticsearch nodes.
Expand All @@ -64,6 +85,16 @@ Cluster of Elasticsearch nodes.
1. Click **Create** to start the creation of the stack.
1. Wait until the stack reaches the state **CREATE_COMPLETE**

## Dependencies
* `vpc/vpc-*azs.yaml` (**required**)
* `state/client-sg.yaml` (**required**)
* `vpc/zone-*.yaml`
* `vpc/vpc-ssh-bastion.yaml`
* `operations/alert.yaml` (recommended)

## Limitations
* No auto scaling

# RDS Aurora

Two node Aurora cluster for HA.
Expand All @@ -80,6 +111,16 @@ Two node Aurora cluster for HA.
1. Click **Create** to start the creation of the stack.
1. Wait until the stack reaches the state **CREATE_COMPLETE**

## Dependencies
* `vpc/vpc-*azs.yaml` (**required**)
* `state/client-sg.yaml` (**required**)
* `vpc/zone-*.yaml`
* `vpc/vpc-ssh-bastion.yaml`
* `operations/alert.yaml` (recommended)

## Limitations
* No auto scaling

# RDS Postgres

Multi-AZ Postgres for HA.
Expand All @@ -96,6 +137,16 @@ Multi-AZ Postgres for HA.
1. Click **Create** to start the creation of the stack.
1. Wait until the stack reaches the state **CREATE_COMPLETE**

## Dependencies
* `vpc/vpc-*azs.yaml` (**required**)
* `state/client-sg.yaml` (**required**)
* `vpc/zone-*.yaml`
* `vpc/vpc-ssh-bastion.yaml`
* `operations/alert.yaml` (recommended)

## Limitations
* No auto scaling

# S3

S3 bucket with optional public read access.
Expand Down
3 changes: 3 additions & 0 deletions state/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# State Templates for AWS CloudFormation

Find the documentation here: http://templates.cloudonaut.io/en/stable/state/

0 comments on commit 14d0588

Please sign in to comment.