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.34.tar.gz (42.6 kB view details)

Uploaded Source

Built Distribution

stups_senza-1.0.34-py3-none-any.whl (54.2 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for stups-senza-1.0.34.tar.gz
Algorithm Hash digest
SHA256 1bb551a9cf13ca88b9274b4aa0c9fae1318a0138a45d602dff04336e9da6b5d6
MD5 cf0e3ee9e8df69c975758fa3311c6e30
BLAKE2b-256 7db5c71e85938b270d7f3bddf38a7b8ec789bb5c1d23536dbf44b21acf8a3847

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for stups_senza-1.0.34-py3-none-any.whl
Algorithm Hash digest
SHA256 00dc38a402b85739452d5e7336cd2367c2c8cc809fbfb72ce6c7fa8a1cf0440b
MD5 0689564ff5044ae60c94cd98f16472c5
BLAKE2b-256 e0da36c8430f90c9d034724546d02fba69f3f55c263e9c7a4b8a9aacffcea52e

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