Metadata-Version: 2.3
Name: stackedup_helper_scripts
Version: 0.0.2
Summary: Tooling to help manage CloudFormation stacks
Project-URL: Homepage, https://github.com/ombu/stackedup-helper-scripts
Author-email: Martin Rio <martin@ombuweb.com>
License-File: LICENSE
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.9
Description-Content-Type: text/markdown

# Stacks Helper Scripts

[![main](https://github.com/ombu/stacks-helper-scripts/actions/workflows/main.yml/badge.svg)](https://github.com/ombu/stacks-helper-scripts/actions/workflows/main.yml)

This repository contains various helper scripts for deploying with OMBU
infrastructure Cloudformation packaged templets.

The target Python version of these scripts is documented in `.python-version`.

## Adding to infrastructure

### Add to the `requirements.txt` with:

```
git+ssh://git@github.com/ombu/stacks-helper-scripts.git@<version>
```

### Add to install MakeFile command:

```
	@$(eval PKG_LOCATION := $(shell pip show stacks-helper-scripts | grep Location | sed -n 's/Location: //p')/stacks_helper_scripts)
	@ln -s -f -n ${PKG_LOCATION} scripts
```

### Add `/infrastructure/scripts` to .gitignore

### Templete changes:

Rehome `CodeUri` in `Properties` sections to refer to the `infrastructure/scripts`
directory.

## Types of scripts

### cloudformation-update-script

This script sends a notification to SNS when an ECS deployment is detected from
a CloudFormation update. A starting deployment notification to the SNS topic
then send another notification once the ECS deployment is complete.

### cluster-lifecyclehook-script

Auto Scaling Lifecycle Hook to drain Tasks from your Container Instances
when an Instance is selected for Termination in your Auto Scaling Group.

### deploy-notification-script

This script sends a notification to SNS when an ECR image is built.

### email-notification-script

This script sends email to recipients from an SNS topic.

### reset-task-notification-script

This script sends a SNS notification when the reset task is requested.

### slack-notification-script

This script sends a Slack notification to a Webhook endpoint from an SNS topic.

### web-deploy-script

When a ECS task is configured to use automatic deployment of the latest tag
this script will restart the ECS task and send a starting deployment
notification to the SNS topic then send another notification once the ECS
deployment is complete.
