Full disclosure: I'm the CTO of - the first API Load Testing SaaS platform, 100% Serverless, API driven, finally available for SMBs, the company which has built this open-source software - . https://rungutan.com Stackuchin What is Stackuchin? It's a CLI tool developed by and designed to automatically create, update and delete CloudFormation stacks in multiple AWS accounts and regions at the same time. Rungutan Why use the CLI? This CLI has been designed for: versioning AWS CloudFormation parameters in GIT deploying to multiple AWS accounts or AWS regions either in PARALLEL or SEQUENTIAL send notifications to Slack channels with AWS CloudFormation errors support , and commands create update delete can be ran either manually or through a pipeline definition in your CI/CD system supports parent/child stacks supports NoEcho parameters supports tagging of resources at stack level supports unattended deployment (through a CI/CD system) supports both JSON and YAML versions of AWS CloudFormation And this is just the tip of the iceberg... Is it production ready? We, at , in order to support global concurrency for load testing and ensure high availability as well, have around 200 stacks on average deployed in each and every of the 15 regions our platform currently supports. Rungutan In short, yes, we use to handle updates for around 3000 AWS CloudFormation stacks. Stackuchin And no, we're not exagerating or bumping the numbers :-) What are the normal use cases? If simply the fact that you can now git-version all your stacks AND their stack parameters, isn't enough, then: your developers can now manage AWS CloudFormation stack themselves, WITHOUT needing to have any "write" IAM permissions you can use CI/CD for automated deployments you can use pull requests to review parameter/stack changes How to install the CLI? pip install stackuchin How to run the CLI? Check the overall help menu $ stackuchin help

usage: stackuchin <command> [ ]

To see help text, you can run:
 stackuchin help
 stackuchin version
 stackuchin create --help
 stackuchin delete --help
 stackuchin update --help
 stackuchin pipeline --help

CLI tool to automatically create, update and delete AWS CloudFormation stacks in multiple AWS accounts and regions at the same time

positional arguments:
 command Command to run

optional arguments:
 -h, --help show this help message and exit < > args Check the help menu for a specific command $ stackuchin create --help

usage: stackuchin --stack_name STACK_NAME 

Create command system

optional arguments:
 -h, --help show this help message exit
 --stack_file STACK_FILE
 The YAML file which contains your stack definitions.
 Defaults not specified.
 --stack_name STACK_NAME
 The stack that you wish create
 --secret Parameter=Value
 Argument used specify values NoEcho parameters your stack
 --slack_webhook SLACK_WEBHOOK
 Argument used overwrite environment variable STACKUCHIN_SLACK.
 If argument is specified, any notifications will be sent this URL.
 If not specified, the script will check env var STACKUCHIN_SLACK.
 If neither argument nor environment variable is specified, no notifications will be sent.
 --s3_bucket S3_BUCKET
 Argument used overwrite environment variable STACKUCHIN_BUCKET_NAME.
 If argument is specified, the template is first uploaded here before used the stack.
 If not specified, the script will check env var STACKUCHIN_BUCKET_NAME.
 If neither argument nor environment variable is specified, the script will attempt feed the template directly the AWS API call, however, due AWS CloudFormation API call limitations, you might up a bigger template byte size than the max value allowed by AWS.
 Details here -&gt; https: --s3_prefix S3_PREFIX
 Argument used overwrite environment variable STACKUCHIN_BUCKET_PREFIX.
 The bucket prefix path be used the S3 bucket is defined.
 -p PROFILE, --profile PROFILE
 The AWS profile you'll be using.
 If not specified, the profile will be used. 
 If no profiles are defined, the AWS credential mechanism starts. class "o" "box-sizing: inherit;" [-h] class "o" "box-sizing: inherit;" [--stack_file STACK_FILE] class "o" "box-sizing: inherit;" [--secret Parameter=Value] class "o" "box-sizing: inherit;" [--slack_webhook SLACK_WEBHOOK] class "o" "box-sizing: inherit;" [--s3_bucket S3_BUCKET] class "o" "box-sizing: inherit;" [--s3_prefix S3_PREFIX] class "o" "box-sizing: inherit;" [-p PROFILE] class "nb" "box-sizing: inherit; color: rgb(0, 45, 71);" class "nb" "box-sizing: inherit; color: rgb(0, 45, 71);" and class "nb" "box-sizing: inherit; color: rgb(0, 45, 71);" to class "s2" "box-sizing: inherit; color: rgb(213, 45, 64);" "./cloudformation-stacks.yaml" class "k" "box-sizing: inherit; color: rgb(0, 45, 71);" if to class "nv" "box-sizing: inherit; color: rgb(0, 120, 189);" class "o" "box-sizing: inherit;" to class "k" "box-sizing: inherit; color: rgb(0, 45, 71);" for in to to class "k" "box-sizing: inherit; color: rgb(0, 45, 71);" for class "k" "box-sizing: inherit; color: rgb(0, 45, 71);" then to class "k" "box-sizing: inherit; color: rgb(0, 45, 71);" then in class "k" "box-sizing: inherit; color: rgb(0, 45, 71);" for class "k" "box-sizing: inherit; color: rgb(0, 45, 71);" then to to to end with in //docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cloudformation-limits.html to to when class "err" "box-sizing: inherit; color: rgb(130, 26, 38);" class "s2" "box-sizing: inherit; color: rgb(213, 45, 64);" "default" class "k" "box-sizing: inherit; color: rgb(0, 45, 71);" then default How do you actually use it ? The logic of the app is simple: Specify the operation that you want to perform Specify the file which contains the parameters for your stack Add any secrets (aka NoEcho parameters) that your stack might need (optional) Here's the most basic simple definition of a "stack file": your-first-stack: Account: 123112321123 Region: us-east-1 Template: cloudformation-template.yaml # All parameters except NoEcho. Parameters: paramA: valA Tags: Environment: UTILITIES Team: DevOps MaintainerEmail: support@rungutan.com MaintainerTeam: Rungutan another-stack-name: Account: 123112321123 Region: us-east-1 Template: some-folder/cloudformation-some-other-template.yaml # Stack without readable parameters. Parameters: {} Tags: Environment: UTILITIES Team: DevOps MaintainerEmail: support@rungutan.com MaintainerTeam: Rungutan Running it as a pipeline cat > input.yaml <<EOL pipeline: update: - stack_name: TestUpdateStack delete: - stack_name: TestDeleteStack create: - stack_name: TestCreateStack secrets: - Name: SomeSecretName Value: SomeSecreValue EOL stackuchin pipeline --pipeline_file input.yaml Get alerts in Slack Use the environment variable or the argument --slack_webhook to specify a Slack incoming webhook to push your alerts. STACKUCHIN_SLACK You get notified with , so that you wouldn't need to have to open your AWS Console to fix your stuff. ALL PROPER MESSAGES Here's a sample: Running it in a CI/CD process Here's a sample pipeline that uses our official Docker image to run it in using GitLab CI/CD: image: rungutancommunity/stackuchin:latest

stages:
 - deploy_updates

variables:
 AWS_DEFAULT_REGION: us-east STACKUCHIN_SLACK: https: STACKUCHIN_BUCKET_NAME: some-deployment-bucket- -us-east STACKUCHIN_BUCKET_PREFIX: some/prefix/ /is/optional

deploy_updates:
 only:
 refs:
 - master
 stage: deploy_updates
 script:
 - |
 cat > pipeline.yaml <<EOF
 pipeline:
 pipeline_type: parallel
 update:
 - stack_name: My-First-Stack
 - stack_name: My-Second-Stack
 EOF
 - stackuchin pipeline --stack_file stack_file.yaml --pipeline_file pipeline.yaml -1 //hooks.slack.com/services/some_slack_webhook in -1 this Notes This app currently does support contracted forms of verbs in AWS CloudFormation when using YAML templates. *NOT* In short, if your AWS CF templates written in YAML use stuff like , then you have to update them to use their respective version -> . !If Fn::If

Stacks

Amazon

Slack

Too Long; Didn't Read

In your car, at home, or at work — Bosch technology shapes many areas of life.

GIT-version Your AWS CloudFormation Parameters using Stackuchin

Too Long; Didn't Read

Companies Mentioned

Coin Mentioned

Marius Mitrofan

About Author

TOPICS

THIS ARTICLE WAS FEATURED IN...

GIT-version Your AWS CloudFormation Parameters using Stackuchin

Too Long; Didn't Read

Companies Mentioned

Coin Mentioned

Marius Mitrofan

About Author

TOPICS

THIS ARTICLE WAS FEATURED IN...

RELATED STORIES