Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/codesuki/ecs-gen
docker-gen for AWS ECS
https://github.com/codesuki/ecs-gen
aws config config-template container docker docker-gen docker-image ecs elastic-container-service template
Last synced: about 10 hours ago
JSON representation
docker-gen for AWS ECS
- Host: GitHub
- URL: https://github.com/codesuki/ecs-gen
- Owner: codesuki
- License: mit
- Created: 2016-11-25T06:12:46.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2019-11-04T20:21:39.000Z (about 5 years ago)
- Last Synced: 2024-06-18T23:02:08.802Z (5 months ago)
- Topics: aws, config, config-template, container, docker, docker-gen, docker-image, ecs, elastic-container-service, template
- Language: Go
- Size: 28.3 KB
- Stars: 48
- Watchers: 5
- Forks: 21
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ecs-gen
[](./LICENSE)
[](https://travis-ci.org/codesuki/ecs-gen)
Inspired by [docker-gen](https://github.com/jwilder/docker-gen) ecs-gen lets you generate config files from templates using AWS ECS cluster information. [ecs-nginx-proxy](https://github.com/codesuki/ecs-nginx-proxy) uses ecs-gen to generate nginx config files.
## Installation
### Go
`go get -u github.com/codesuki/ecs-gen`
### Docker
Use the `codesuki/ecs-gen` docker image.
## Usage
```
usage: ecs-gen --cluster=CLUSTER --template=TEMPLATE --output=OUTPUT []
docker-gen for AWS ECS.
Flags:
--help Show context-sensitive help (also try --help-long and --help-man).
-r, --region="ap-northeast-1" AWS region.
-c, --cluster=CLUSTER ECS cluster name.
-t, --template=TEMPLATE Path to template file.
-o, --output=OUTPUT Path to output file.
--task="ecs-nginx-proxy" Name of ECS task containing nginx.
-s, --signal="nginx -s reload"
Command to run to signal change.
-f, --frequency=30 Time in seconds between polling. Must be >0.
--once Only execute the template once and exit.
--version Show application version.
```
### Using with Docker
When using the docker image directly you can set all parameters using environment variables:
* ECS_GEN_REGION
* ECS_GEN_CLUSTER
* ECS_GEN_TEMPLATE
* ECS_GEN_OUTPUT
* ECS_GEN_TASK
* ECS_GEN_SIGNAL
* ECS_GEN_FREQUENCY
* ECS_GEN_ONCE
## Example
### Fill a template once
Running the following on the commandline `ecs-gen` will query the specified cluster, execute the template and exit.
```
ecs-gen --once --region=ap-northeast-1 --cluster="Cluster name" --template=template.tmpl --output=output.conf
```
### Continuously update a config
To keep a config up to date try a variation of the following.
```
ecs-gen --signal="nginx -s reload" --cluster=my-cluster --template=nginx.tmpl --output=/etc/nginx/conf.d/default.conf
```
## Template parameters
For now the available parameters are limited to things needed to make a nginx reverse proxy. If there is demand any information available from the AWS ECS API can be exposed.
```go
type Container struct {
Name string // first host (space delimited) in VIRTUAL_HOST
Host string // VIRTUAL_HOST environment variable
Port string
Address string
Env map[string]string
}
```
**Note:** The Host field can contain more than one (space delimited) hostname - this is to allow for tasks to respond to more than one hostname (for instance, `example.com` and `www.example.com`). If using the nginx template, using the VIRTUAL_HOST string `example.com www.example.com` would result in a single upstream definition for `example.com`, and a server_name of `example.com www.example.com`, so that nginx responds to both (an advanced use case would be to use a regex definition for the second hostname).
## TODO
* Expose more information
* Expose VIRTUAL_HOST under environment variables instead of `Host`