https://github.com/muckamuck/stackility
Simple tool to create CloudFormation stacks
https://github.com/muckamuck/stackility
aws-cloudformation boto3 cloudformation-stacks python python27 python3 vpc
Last synced: 1 day ago
JSON representation
Simple tool to create CloudFormation stacks
- Host: GitHub
- URL: https://github.com/muckamuck/stackility
- Owner: muckamuck
- License: apache-2.0
- Created: 2017-07-03T13:12:28.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2022-07-16T19:57:59.000Z (about 3 years ago)
- Last Synced: 2025-09-25T15:54:42.188Z (13 days ago)
- Topics: aws-cloudformation, boto3, cloudformation-stacks, python, python27, python3, vpc
- Language: Python
- Size: 107 KB
- Stars: 8
- Watchers: 7
- Forks: 3
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## Stackility
Description: a utility for creating, updating, listing and deleting AWS
CloudFormation stacks. Also, the utility can be used for determining the
drift status of CloudFormation stacks.
#### Usage:
```
stackility upsert [OPTIONS]
The main reason we have arrived here. This is the entry-point for the
utility to create/update a CloudFormation stack.
Options:
-v, --version TEXT code version
-s, --stack TEXT stack name
-i, --ini TEXT INI file with needed information [required]
-d, --dryrun dry run, generate a change set report
-y, --yaml YAML template (deprecated - YAMLness is now
detected at run-time)
--no-poll Start the stack work but do not poll
-w, --work-directory TEXT Start in the given working directory
--help Show this message and exit.
See the *Properties* section below for a description of the INI file format.
```
```
stackility delete [OPTIONS]
Delete the given CloudFormation stack.
Options:
-s, --stack TEXT [required]
-r, --region TEXT
-f, --profile TEXT
--help Show this message and exit.
```
```
stackility list [OPTIONS]
List all the CloudFormation stacks in the given region.
Options:
-r, --region TEXT
-f, --profile TEXT
--help Show this message and exit.
```
```
stackility drift [OPTIONS]
Produce a CloudFormation drift report for the given stack.
Options:
-s, --stack TEXT stack name [required]
-r, --region TEXT region where the stack lives
-f, --profile TEXT AWS profile to access resources
--help Show this message and exit.
```
#### Properties:
The INI file fed to the ```upsert``` command has the followning sections:
**[environment]:**
The environment for the creation/update of a CloudFormation stack. These are the following
elements of this section:
* bucket - an S3 bucket where the template can be uploaded *[required]*
* template - the name of the CloudFormation to be used in the operation *[required]*
* stack_name - the name of the stack. If this element is not present then the
```--stack``` argument must be given *[optional]*
* region - specify the target region for this stack *[optional]*
* profile - the credentials profile to be used *[optional]*
**[tags]:** - key/value pairs that will be created as tags on the stack and
supported resources.
**[parameters]:** - key/value pairs that will be injected as parameter(s) for the
stack. You can, of course, enter the values as text. However, there are two
special ways to specify the value in this section:
* [ask] - this will ask for (and not echo) the values when a stack upsert is
done (example below).
* [ssm:] - specify a parameter key that will be used to retrieve
the value from [AWS Systems Manager Parameter Store](https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-paramstore.html)
**[meta-parameters]:** - (optional) if this section exists in the INI file it is assumed
that the template file given in the ```[environment]``` section is a [Jinja2](http://jinja.pocoo.org/docs/)
template file. The given template is rendered with the key/value pairs injected before the upload to the S3
bucket.
**[analysis]:** - (experimental) if this section exists in the INI file then
[CloudFormation Validator](https://github.com/rubelw/cloudformation-validator) is used to
perform static analysis on the given template. Items in this section:
* enforced - true | false, if *true* then stack create/update is aborted when errors are found
else if *false* the analysis is only advisory.
#### Example parameters file:
```
[environment]
template=template.json
bucket=account-cf-artifacts-bucket
stack_name=example-stack
region=us-west-2
[tags]
OWNER=nobody@gmail.com
PROJECT=Stackility Examples
THE_DATA=important
Name=example-stack
[parameters]
theCIDR=10.22.0.0/16
subnetCIDROne=10.22.10.0/24
bar=some value
db_password=[ask]
api_key=[ssm:api_key]
[meta-parameters]
food=pizza
drink=beer
[analysis]
enforced=false
```
#### Example invocations:
```stackility upsert --ini vpc_stack.ini --region us-east-2```
* use the template in vpc_stack.ini to create a VPC in the us-east-2 region.
```stackility delete --stack example-stack --region us-east-2```
* tear down the example-stack stack from us-east-2
```stackility list --region us-east-2```
* list the CloudFormation stacks in us-east-2
```stackility drift --stack example-stack --region us-east-2```
* Generate a CloudFormation drift report in us-east-2
#### Environment notes:
By default the utility polls the status of stack operation every 30 seconds. If
needed ```CSU_POLL_INTERVAL``` can be set to a number of seconds to override the
poll interval
---
#### Development notes:
Do some work on the thing:
```bash
virtualenv stkvenv
. stkenv/bin/activate
pip install --editable .
```
Publish the thing:
```bash
python setup.py sdist bdist_wheel
twine upload dist/*
```
#### TODO:
* print CloudFormation Outputs at the end of the upsert command
* investigate giving an IAM role, something like the profile selection