Skip to main content

AWS Cloud Formation deployment CLI

Project description

Build Status Code Coverage PyPI Downloads Latest PyPI version License

Senza is a command line tool for generating and executing AWS Cloud Formation templates in a sane way. It supports Cloud Formation templates as YAML input and adds own ‘components’ on top. Components are predefined Cloud Formation snippets that are easy to configure and generate all the boilerplate JSON that is required by Cloud Formation.

Installation

$ sudo pip3 install --upgrade stups-senza

Usage

$ senza init my-definition.yaml # bootstrap a new app
$ senza create ./my-definition.yaml 1 1.0

Please read the STUPS documentation on Senza to learn more.

Senza Definition

# basic information for generating and executing this definition
SenzaInfo:
  StackName: kio
  OperatorTopicId: kio-operators
  Parameters:
      - ImageVersion:
          Description: "Docker image version of Kio."

# a list of senza components to apply to the definition
SenzaComponents:
  - Configuration:
      Type: Senza::StupsAutoConfiguration # auto-detect network setup
  # will create a launch configuration and auto scaling group with min/max=1
  - AppServer:
      Type: Senza::TaupageAutoScalingGroup
      InstanceType: t2.micro
      SecurityGroups: [app-kio] # can be either name or id ("sg-..")
      ElasticLoadBalancer: AppLoadBalancer
      TaupageConfig:
        runtime: Docker
        source: stups/kio:{{Arguments.ImageVersion}}
        ports:
          8080: 8080
        environment:
          PGSSLMODE: verify-full
          DB_SUBNAME: "//kio.example.eu-west-1.rds.amazonaws.com:5432/kio?ssl=true"
          DB_USER: kio
          DB_PASSWORD: aws:kms:abcdef1234567890abcdef=
  # creates an ELB entry and Route53 domains to this ELB
  - AppLoadBalancer:
      Type: Senza::WeightedDnsElasticLoadBalancer
      HTTPPort: 8080
      HealthCheckPath: /ui/
      SecurityGroups: [app-kio-lb]
      Scheme: internet-facing

# just plain Cloud Formation definitions are fully supported:
Outputs:
  URL:
    Description: "The ELB URL of the new Kio deployment."
    Value:
      "Fn::Join":
        - ""
        -
          - "http://"
          - "Fn::GetAtt":
              - AppLoadBalancer
              - DNSName

During evaluation, you can mustache templating with access to the rendered definition, including the SenzaInfo, SenzaComponents and Arguments key (containing all given arguments).

See the STUPS documentation on Senza for details.

Unit Tests

$ python3 setup.py test --cov-html=true

Releasing

$ ./release.sh <NEW-VERSION>

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

stups-senza-1.0.10.tar.gz (37.6 kB view details)

Uploaded Source

Built Distribution

stups_senza-1.0.10-py3-none-any.whl (51.1 kB view details)

Uploaded Python 3

File details

Details for the file stups-senza-1.0.10.tar.gz.

File metadata

File hashes

Hashes for stups-senza-1.0.10.tar.gz
Algorithm Hash digest
SHA256 5af42663ba7a56bdda4ff752e992348eb4420581a9844220fc50449be3e9fa9b
MD5 2bdfdc3544cbf003a38e8bc77d02d09f
BLAKE2b-256 0ee36b7d197e66fbdd9a667b4ddd5908a4cc4ebea69774f2442b9b167ca13e83

See more details on using hashes here.

Provenance

File details

Details for the file stups_senza-1.0.10-py3-none-any.whl.

File metadata

File hashes

Hashes for stups_senza-1.0.10-py3-none-any.whl
Algorithm Hash digest
SHA256 456a5f11c127b6a7d05cca8cee13afa0b1e4436fa4cf4812da76eff5aaf6d7c3
MD5 1b83be43953d5d08ea2e21bef6b5d69a
BLAKE2b-256 22520dc53db6d80febfe50d011e443271944d64986dc446adbeacfab60dc9aa1

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page