Skip to content
This repository has been archived by the owner on Sep 28, 2022. It is now read-only.

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
complex64 committed Mar 23, 2019
1 parent 9077909 commit c44f8f3
Showing 1 changed file with 19 additions and 1 deletion.
20 changes: 19 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Rolling Cluster Node Upgrades for AWS EKS

**Project Status:** Work in progress and not ready for use at this moment.
**Project Status:** Used in production at Tenjin, some caveats apply.

## Use Case

Expand All @@ -14,3 +14,21 @@ In general terms:
- Your cluster is made up of [EC2 Auto Scaling Groups (ASG)](https://docs.aws.amazon.com/autoscaling/ec2/userguide/AutoScalingGroup.html)
- You want to replace one or all nodes in those ASGs (e.g. to [activate a new launch configuration](https://docs.aws.amazon.com/autoscaling/ec2/userguide/LaunchConfiguration.html))
- The replacement has to be done gracefully, node-by-node, and respects [availability constraints in your cluster](https://kubernetes.io/docs/tasks/run-application/configure-pdb/)

## Usage

You can run this tool from your CI or locally. Typically we bundle it as a script and inject secrets within the CI.

Example using standard AWS SDK credentials and an assumed role:

```bash
#!/bin/bash
set -ex
docker run --rm -it \
-e ACCESS_KEY_ID=${ACCESS_KEY_ID:?}
-e SECRET_ACCESS_KEY=${SECRET_ACCESS_KEY:?}
-e ROLE_ARN=${ROLE_ARN:?}
-e CLUSTER=your-cluster-name \
-e AUTOSCALING_GROUPS=${AUTOSCALING_GROUP:?} \
rotate-eks-asg:latest
```

0 comments on commit c44f8f3

Please sign in to comment.