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

Uploaded Source

Built Distribution

stups_senza-1.0.22-py3-none-any.whl (165.6 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for stups-senza-1.0.22.tar.gz
Algorithm Hash digest
SHA256 aa7185f8b2a68d575fd8a55a726788758a65ecedca47a1a89fb001f648d50f8b
MD5 fd419c5708a9db447c91cb863d5e209c
BLAKE2b-256 60c8a56a9a80945c158b4e90594f82b85ab50ce203b3f575363997ef274a15bf

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for stups_senza-1.0.22-py3-none-any.whl
Algorithm Hash digest
SHA256 976b2a84fd9a1af43c231e086775c24e57e0a2b5c46fe6f6004179b752b34b35
MD5 1ae350c60dad3a1caaa37fdc34186b5f
BLAKE2b-256 c9b111f48ffefa95e19415c6ad807a302d013069d324840f20792ea8233a3b5a

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