tyler.durden
/
compose
mirror of https://github.com/docker/compose.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Basic architecture documentation 

Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com>
This commit is contained in:
Nicolas De Loof 2020-04-22 15:39:02 +02:00
parent 87f053d710
commit 5110cb6b85
1 changed files with 30 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
ecs/README.md
View File

@ -1 +1,31 @@
# Docker CLI plugin for Amazon ECS
## Architecture
ECS plugin is a [Docker CLI plugin](https://docs.docker.com/engine/extend/cli_plugins/)
root command `ecs` require aws profile to get API credentials from `~/.aws/credentials`
as well as AWS region - those will later be stored in a docker context
A `compose.yaml` is parsed and converted into a [CloudFormation](https://aws.amazon.com/cloudformation/)
template, which will create all resources in dependent order and cleanup on
`down` command or deployment failure.
```
+-----------------------------+
| compose.yaml file |
+-----------------------------+
- Load
+-----------------------------+
| compose-go Model |
+-----------------------------+
- Convert
+-----------------------------+
| CloudFormation Template |
+-----------------------------+
- Apply
+---------+ +------------+
| AWS API | or | stack file |
+---------+ +------------+
```
(if this sounds familiar, see [Kompose](https://github.com/kubernetes/kompose/blob/master/docs/architecture.md))