Skip to main content

A system deployment tool

Project description

Paracrine

Paracrine is a system deployment tool. It's based around Mitogen and standard Python packages for features (although, currently there's only the one core package). Current status is essentially, "works for me, probably won't eat your computer", but thoughts and patches are welcomed.

It's designed towards rapid idempotent deploys i.e. a zero-changes deploy should take in the order of a small number of seconds ideally, and so can be used as your application deployment option as well as for system changes, which has the design benefit of you could use it for GitOps-style deploys. Obviously, if you do more changes, it'll take longer, but that's generally less of an issue, but it should still be faster than most other tooling options. It assumes it's got a host system to run from, which probably can be anything that runs Python, but the testing for that so far has been on a Debian laptop.

It's named after Paracrine signaling "a type of cellular communication in which a cell produces a signal to induce changes in nearby cells" which feels pretty accurate for a deployment tool.

Main documentation is at https://palfrey.github.io/paracrine/

Usage

  1. Setup Python. Tested against 3.8+
  2. pip install paracrine
  3. Write a main file describing what you want to setup. integration_test/main.py is a reasonable example. It must call the run function, which takes arguments for the inventory file, and list of modules to run.
  4. Write an inventory file for the machines this is managing. Current setup assumes they're all the same. integration_test/docker/inventory.yaml is a reasonable example file, but I suggest generating it from whatever you're using to create the servers (e.g. Terraform).
  5. Write a config.yaml. This has a main top-level key of environments with keys below that for each inventory file you've got (integration_test/config.yaml just has one, but in most scenarios you'll have at least a dev and prod setup). What you do below that is up to you, but typically it'll be environment variables and secrets to feed into the main file.
  6. Run python -m paracrine.setup <inventory file> - this will install the minimum python bits so that everything else works.
  7. Run the main file (e.g. python main.py ./docker/inventory.yaml)

Limitations

  • All the servers are assumed to be Debian Linux boxes (although Debian-derivatives like Ubuntu should work)
  • Direct SSH access is assumed possible (Mitogen supports jump boxes, but there's no setup for that yet here) with keys, not passwords
  • There's no "dry run" mode yet, which would be useful for GitOps

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

paracrine-0.0.1.tar.gz (31.6 kB view details)

Uploaded Source

Built Distribution

paracrine-0.0.1-py3-none-any.whl (37.1 kB view details)

Uploaded Python 3

File details

Details for the file paracrine-0.0.1.tar.gz.

File metadata

  • Download URL: paracrine-0.0.1.tar.gz
  • Upload date:
  • Size: 31.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.2

File hashes

Hashes for paracrine-0.0.1.tar.gz
Algorithm Hash digest
SHA256 dd55e6ef195d55cce3fbddc32305bb87965bc561b187b486e6b61b51e79eb088
MD5 3b80900a7f112e8042cbeb0f838b43a4
BLAKE2b-256 2a9a03eaea203139e9e108fccbf151f1d6490e86386992308b013ec87ea37fd4

See more details on using hashes here.

File details

Details for the file paracrine-0.0.1-py3-none-any.whl.

File metadata

  • Download URL: paracrine-0.0.1-py3-none-any.whl
  • Upload date:
  • Size: 37.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.2

File hashes

Hashes for paracrine-0.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 888a74382120f817d149579acb6f663c9784e8869c2e014c0d6695208564a904
MD5 fa865d1b4337cd5c888c7fe79f2cf2aa
BLAKE2b-256 8644cf4eeec675feda0b9d93446ea8c3888e7ff411023a61a58af1c58ec816ed

See more details on using hashes here.

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