Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/phuurl/ec2-mac-releaser
Automation to release EC2 Macs after their minimum 24 hour period.
https://github.com/phuurl/ec2-mac-releaser
aws aws-sam ec2 ec2-mac mac step-functions
Last synced: 8 days ago
JSON representation
Automation to release EC2 Macs after their minimum 24 hour period.
- Host: GitHub
- URL: https://github.com/phuurl/ec2-mac-releaser
- Owner: Phuurl
- License: mit
- Created: 2022-08-06T20:31:28.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-12-18T19:14:34.000Z (about 1 year ago)
- Last Synced: 2024-12-29T16:46:08.306Z (12 days ago)
- Topics: aws, aws-sam, ec2, ec2-mac, mac, step-functions
- Homepage:
- Size: 12.7 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ec2-mac-releaser
Automation to release EC2 Mac dedicated hosts after their [minimum 24 hour period](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-mac-instances.html#mac-instance-release-dedicated-host).
This stack comprises of a Step Function, and associated EventBridge trigger rule to allow automatic invocation whenever a new `mac1` or `mac2` dedicated host is provisioned.
High level Step Function flow:
```mermaid
stateDiagram-v2
waitSecondsCheck: Check for waitSeconds input
setDefaultWait: Set 24hr default value
preserveTagCheck: Check for 'preserve' tag on host
instanceTerminateCheck: Check if 'terminateInstances' is true in input
state if_waitSeconds <>
state if_preserveTag <>
state if_terminateInstances <>
[*] --> waitSecondsCheck
waitSecondsCheck --> if_waitSeconds
if_waitSeconds --> Wait: waitSeconds input present
if_waitSeconds --> setDefaultWait : waitSeconds not specified
setDefaultWait --> Wait
Wait --> DescribeHosts
DescribeHosts --> preserveTagCheck
preserveTagCheck --> if_preserveTag
if_preserveTag --> [*]: 'preserve' tag present - skip
if_preserveTag --> instanceTerminateCheck: No 'preserve' tag - continue
instanceTerminateCheck --> if_terminateInstances
if_terminateInstances --> TerminateInstances: 'terminateInstances' == true
if_terminateInstances --> ReleaseHosts: 'terminateInstances' == false or not specified
TerminateInstances --> ReleaseHosts
ReleaseHosts --> [*]
```
## Usage
This stack uses [SAM](https://aws.amazon.com/serverless/sam/) - once you have that setup, you can then build and deploy with
```bash
sam build
sam deploy --guided
```
Once deployed, the Step Function will automatically trigger and begin its 24 hour countdown whenever any new `mac1.metal` or `mac2.metal` dedicated hosts are created in that region.
If you want to opt out a new host from being automatically released, you can tag it with the key `preserve` (value doesn't matter), and this will cause it to be ignored when the Step Function executes.
### Manual invocation
You can also execute the Step Function manually. At a minimum it requires the target dedicated host ID - this will cause it to use the default 24 hour wait duration:
```json
{
"targetHosts": [
"the target dedicated host ID - will start with h-"
]
}
```
You can also override the default wait duration with a custom value (in seconds), as well as specifying whether to terminate instances on the dedicated host (`false` by default):
```json
{
"targetHosts": [
"the target dedicated host ID - will start with h-"
],
"waitSeconds": 60,
"terminateInstances": true
}
```
## Caveats
As with releasing any other types of dedicated hosts, the call will fail if there are any instances running on them at the time. By default, this Step Function does not attempt to release any instances running on the target dedicated host, and instead marks the execution as failed.
This can be overridden by setting the `TerminateInstances` CloudFormation parameter to `"true"` in stack deployment, or for manual executions specifying `"terminateInstances": true` in the event.