https://github.com/nfultz/pumpkin
Turns an EC2 node into a 🎃
https://github.com/nfultz/pumpkin
devops ec2
Last synced: 10 months ago
JSON representation
Turns an EC2 node into a 🎃
- Host: GitHub
- URL: https://github.com/nfultz/pumpkin
- Owner: nfultz
- Created: 2017-03-10T19:02:48.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2020-07-14T22:03:28.000Z (over 5 years ago)
- Last Synced: 2025-04-05T03:41:21.449Z (10 months ago)
- Topics: devops, ec2
- Language: Shell
- Size: 5.86 KB
- Stars: 6
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Turn into a pumpkin
This is a short script for AWS to downsize a box after a heavy job has finished.
## Example usage
To turn into a pumpkin after a long job:
./long_job.sh && pumpkin2
To turn into a big pumpkin immediately:
pumpkin2 m4.10xlarge
## The problem
I used to have to manually resize my development EC2 box, which is a comically tedious process:
1. Go to AWS console
2. Type in password
3. Take out phone, type in 2FA
4. Open EC2 instances tab
5. Find my node in the list
6. Shut it down
7. Wait for it to shut down
8. Right click and change the type
9. Restart the box
10. Wait for it to boot
Instead, I wanted a script that could do all this for me.
## Implementation
Amazon provides a CLI tool for most of the services, which is capable of resizing a box; however,
it is not able to resize a box that is running; you can't resize yourself.
To work around this, you can instead create a lambda function, which can shut down the dev box, resize
and restart it.
## Setup
1. Create a AWS lambda function using `lambda_pumpkin.py` - it will need EC2 permissions.
2. Copy `pumpkin2` to your box, and run it as needed.
Old `pumpkin` is still here for historical reasons, but you probably don't want to use it.
### IAM Permissions deep dive
The way pumpkin works is by using a lambda function to resize a box in-situ. The lambda will need
permission to modify the ec2 node, and the node will need permission to call the lambda.
1. When creating the lambda, it needs Ec2 permission to Shutdown, Modify, and Start.
* *IMPORTANT:* Crank the timeout to like 5 minutes. The default (3s) is long enough to shutdown the box, but too short to automatically restart it.
* You may want to restrict which boxes pumpkin can cycle using tags. See also https://aws.amazon.com/premiumsupport/knowledge-center/iam-ec2-resource-tags/
2. Create a role that can invoke the lambda function
* And a policy holding that role
* Add the policy to the ec2 node - can use the same tag conditions as above if you like.
* If using tags, set them also