Skip to main content

The world is a circus and you are the ringmaster!

Project description

Ringmaster

         _
       _[_]_
       _(_)______.-'`-.
      /, >< ,----'     `-._.-'*
      \\|::|  Welcome to the Circus
        |/\|  We already got enough Clowns,
        ||||  You got any experiance with
        ||||  Being shot from a canon??
     __(_/\_)
    /`-..__.,-'\
   /   __/\__   \
   `._ \    / _.'MJP
      ``|/\|-'

Ringmaster organises a bunch of other tools on your behalf so that you don't have to. The aim is you can create, updated and delete entire stacks crossing cloudformation, EKS, kubectl, helm and random Python/BASH scripts with a single command.

Ringmaster helps you create and share your automation scripts with others, so you can get up and running as quick as possible. There are no agents, hubs, gits or daemons - unless you add them yourself.

There is also no custom DSL or new programming language to learn, although jinja2 is used for templating.

Ringmaster is just files on a disk and calls to other systems made in an order you decide.

How does it work?

You create a directory of scripts to process, like this:

stack/
├── 0010-iam
│     ├── AWSLoadBalancerController.iam_policy.json
│     ├── Certbot.iam_policy.json
│     ├── EksDeploy.iam_policy.json
│     ├── EksExternalSecrets.iam_policy.json
│     ├── ExternalDns.iam_policy.json
│     └── metadata.yaml
├── 0020-efs
│     ├── efs.cloudformation.yaml
│     └── metadata.yaml
├── 0030-vpc
│     ├── metadata.yaml
│     ├── vpc.remote_cloudformation.yaml
│     └── vpc.yaml
...

Then you run ringmaster like this:

ringmaster stack up

Ringmaster will carry out the create action of each script, running each script in alphabetical order by directory and then file

ringmaster stack down

Ringmaster will carry out the delete action of each script, in reverse alphabetical order

The up and down actions are idempotent so you can run them as many times as you like

What's in the scripts? do I have to learn a new language?

No! The scripts use the languages and tools you already know and love, eg:

  • Cloudformation
  • Bash
  • Python
  • Kubernetes deployment descriptors
  • ...etc

Ringmaster uses a databag to give each script the right inputs and collects outputs that may be required later. Combined with a simple built-in variable substitution system, this makes gluing completely different systems together easy, eg:

cloudformation -> ekscl -> more cloudformation -> heml -> kubectl -> ...

To reduce dependency on ringmaster and allow easy debugging and repeatable deployments, substitution results are stored adjacent to their input files, so they can be added to git or use directly by tools such as kubectl.

Reference

  1. Concepts
  2. Setup
  3. Authentication
  4. Handlers
  5. Scripts
  6. Variables
  7. Worked Example

Project details


Download files

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

Source Distribution

ringmaster.show-0.4.2.tar.gz (29.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ringmaster.show-0.4.2-py3-none-any.whl (34.5 kB view details)

Uploaded Python 3

File details

Details for the file ringmaster.show-0.4.2.tar.gz.

File metadata

  • Download URL: ringmaster.show-0.4.2.tar.gz
  • Upload date:
  • Size: 29.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.5 CPython/3.8.6 Linux/5.4.0-70-generic

File hashes

Hashes for ringmaster.show-0.4.2.tar.gz
Algorithm Hash digest
SHA256 69f52e15fafc8581620f52fd216059610cefd6fd29f0184f479058be9b0549d9
MD5 ef08d2cbbfd9dfd3b2cfd85b7670e78e
BLAKE2b-256 6cb085f0883f807b7616cfc4b43e58834662657c2e7040ff4c91cf717d188bcc

See more details on using hashes here.

File details

Details for the file ringmaster.show-0.4.2-py3-none-any.whl.

File metadata

  • Download URL: ringmaster.show-0.4.2-py3-none-any.whl
  • Upload date:
  • Size: 34.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.5 CPython/3.8.6 Linux/5.4.0-70-generic

File hashes

Hashes for ringmaster.show-0.4.2-py3-none-any.whl
Algorithm Hash digest
SHA256 a9c87e8810a9b9f5274522880d22d3294cb7d391e6593d188aba748eb6a4bc7c
MD5 1b99ca23985f442041d79c1b64fa55ce
BLAKE2b-256 f8fc8195a125b83a08d7b9a202d35d9fcb964ca9e1cc4167a3ae24378bda9f52

See more details on using hashes here.

Supported by

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