Skip to main content

A system deployment tool

Project description

Paracrine

PyPI version

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

Uploaded Source

Built Distribution

paracrine-0.0.2-py3-none-any.whl (37.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: paracrine-0.0.2.tar.gz
  • Upload date:
  • Size: 32.8 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.2.tar.gz
Algorithm Hash digest
SHA256 f89d6bc89f4ec2bde3343525911ce5b5620e4941d2ce5fd5f870103d966d5c2c
MD5 897dd81fe211343df96370dbbb9b9933
BLAKE2b-256 2e4c2251e83dd93e3e788a06464b7a703b9aafb779bd1a9816eb957d9c7abe93

See more details on using hashes here.

File details

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

File metadata

  • Download URL: paracrine-0.0.2-py3-none-any.whl
  • Upload date:
  • Size: 37.9 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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 5e7f93da88e34a145c6919a98c30558c05036e4221dc3cd75f94c58c28d2617a
MD5 b998b52d95adf633e24e15026f6f7759
BLAKE2b-256 f499ef0af7e3e013fa3753ece45d736f7503bcba73eb051a1f43ab2aed029546

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