Skip to content

⚡ Deploy stuff by diff-ing the state you want against the remote server

License

Notifications You must be signed in to change notification settings

czha168/pyinfra

 
 

Repository files navigation

pyinfra

PyPI version Travis.CI status

pyinfra manages the state of one or more servers. It can be used for app/service deployment, config management and ad-hoc command execution. Deploys are asynchronous, highly performant and can target thousands of hosts in parallel. The inventory of servers and deploy state are written in Python, allowing for near-infinite extendability.

When you run pyinfra you'll see something like:

Design Features

pyinfra was designed from day one to enable ops to deploy things in a consistent, debuggable and maintainable manner. Notable design decisions:

  • outputs shell commands and files to upload
  • two-step deploy that enables dry-runs
  • fail fast where possible (eg touching a directory)
  • -v means print out remote stdout & stderr in realtime
  • always print raw stderr on operation failure for instant debugging
  • uses pure, 100% Python for the inventory and deploy scripts
    • with operations/hooks to safely use Python mid-deploy
  • properly agentless - even Python isn't required on the remote side (just a shell!)

Development

pyinfra is still under heavy development, and while the CLI/API should be considered fairly stable there's no guarantee of no breaking changes until v1. There are a number of critical specifications to be properly fleshed out before the v1 release:

  • spec/docs for roles/sub-deploys
  • spec/docs for extension modules/facts
  • spec/docs for extension deploys

To develop pyinfra itself:

# Create a virtualenv
venv create pyinfra

# Install pyinfra in dev mode, with dev requirements
pip install -e .[dev]

Use nosetests or the bundled helper script to run tests. This helper script also counts coverage:

# Test everything (API, modules & facts)
scripts/test.sh

# Set individual bits
scripts/test.sh [api|modules|facts]

About

⚡ Deploy stuff by diff-ing the state you want against the remote server

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 98.1%
  • Shell 1.2%
  • Ruby 0.7%