Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/eraclitux/ecsundo
Rollback ECS deployments
https://github.com/eraclitux/ecsundo
aws devops docker ecs
Last synced: about 8 hours ago
JSON representation
Rollback ECS deployments
- Host: GitHub
- URL: https://github.com/eraclitux/ecsundo
- Owner: eraclitux
- License: mit
- Created: 2018-12-01T14:21:45.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2023-09-04T20:55:34.000Z (about 1 year ago)
- Last Synced: 2024-06-20T16:37:22.476Z (5 months ago)
- Topics: aws, devops, docker, ecs
- Language: Go
- Size: 18.6 KB
- Stars: 27
- Watchers: 3
- Forks: 2
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ecsundo
[](https://goreportcard.com/report/github.com/eraclitux/ecsundo)
[](https://circleci.com/gh/eraclitux/ecsundo)
`ecsundo` is cli tool able to rollback ECS
[services](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html)
in a given cluster to their previous or to specific
[task](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definitions.html)
versions.
It is capable of making and restoring "snapshots" of service versions.
## Motivations
Probably your code is automatically deployed by a CI/CD pipeline.
If something goes wrong it may take several minutes to bring a rollback commit in production, with `ecsundo` this time is cut to seconds.
## Prerequisites
To use this tool, the deploy procedure must involve creating a new task version with a new image tag.
A great way to tag container images is to include the commit hash of the code that they contain, doing so it will
be possible to find the task version you want to come back to if problems arise.
[Learn more](https://medium.com/@eraclitux/deployment-rollback-in-a-containers-world-aws-ecs-edition-4bc8e34c0d5a) about this.
## Usage examples
Rollback _all_ services in a cluster to previous version:
```
$ ecsundo cluster
```
Rollback a service to the previous version:
```
$ ecsundo service -c
```
Make a _snapshot_ of all services versions in a cluster:
```
$ ecsundo cluster snapshot
```
Restore a _snapshot_ of a versions of all services in a cluster:
```
$ ecsundo cluster restore
```
To learn more, use on line help:
```
$ ecsundo help
```
## Configuration
To avoid to specify cluster name, an environment variable can be used:
```
ECSUNDO_CLUSTER=
```
or a configuration file (default path `~/.ecsundo.yml`):
```
cluster:
```
Proper **permissions** must be granted for the tool to operate properly.
If you install this tool inside AWS, the best way, from a security standpoint, is to use an IAM role that lets you avoid copying around `AWS_SECRETS`. The role should have at least this permissions:
```
{
"Version": "2012-10-17",
"Statement": [
{
"Sid": "VisualEditor0",
"Effect": "Allow",
"Action": [
"ecs:ListAttributes",
"ecs:DescribeTaskDefinition",
"ecs:DescribeClusters",
"ecs:ListServices",
"ecs:UpdateService",
"ecs:ListTasks",
"ecs:ListTaskDefinitionFamilies",
"ecs:RegisterTaskDefinition",
"ecs:DescribeServices",
"ecs:ListContainerInstances",
"ecs:DescribeContainerInstances",
"ecs:DescribeTasks",
"ecs:ListTaskDefinitions",
"ecs:ListClusters"
],
"Resource": "*"
}
]
}
```
### Use from local shell
A prerequisite is that aws-cli is installed and configured, this is true if credentials file exists (e.g. `ls ~/.aws/credentials`). To use these credentials:
```
AWS_SDK_LOAD_CONFIG=1 ecsundo cluster snapshot
```
Your credentials must have at least same permissions of the role above.
## Installation
[//]: # "Precompiled binaries can be found [here](https://github.com/eraclitux/ecsundo/releases)."
To install the latest (unstable) version:
```
go get -u github.com/eraclitux/ecsundo
```