richardsonjf / pyinfra Goto Github PK

pyinfra automates infrastructure super fast at massive scale

Documentation • Getting Started • Examples • Help & Support • Contributing

pyinfra automates/provisions/manages/deploys infrastructure. It can be used for ad-hoc command execution, service deployment, configuration management and more. Design features include:

• 🚀 Super fast execution over thousands of hosts with predictable performance.
• 🚨 Instant debugging with stdout & stderr output on error or as required (-v|-vv|-vvv).
• 📦 Extendable with any Python package as configured & written in standard Python.
• 💻 Agentless execution against SSH/Docker/subprocess/winrm hosts.
• ❗️ Two stage process that enables --dry runs before executing any changes.
• 🔌 Integrated with Docker, Vagrant/Mech & Ansible out of the box.

When you run pyinfra you'll see something like (non animated version):

Install pyinfra with pipx (recommended) or pip:

pipx install pyinfra

Now you can execute commands on hosts via SSH:

pyinfra my-server.net exec -- echo "hello world"

Or execute in Docker, on the local machine, and other connectors:

pyinfra @docker/ubuntu exec -- echo "Hello world"
pyinfra @local exec -- echo "Hello world"

As well as executing commands you can define state using operations:

# Install iftop apt package if not present
pyinfra @docker/ubuntu apt.packages iftop update=true _sudo=true

Which can then be saved as a Python file like deploy.py:

from pyinfra.operations import apt

apt.packages(
    name="Ensure iftop is installed",
    packages=['iftop'],
    update=True,
    _sudo=True,
)

The hosts can also be saved in a file, for example inventory.py:

targets = ["@docker/ubuntu", "my-test-server.net"]

And executed together:

pyinfra inventory.py deploy.py

Now you know the building blocks of pyinfra! By combining inventory, operations and Python code you can deploy anything.

See the more detailed getting started or using operations guides. See how to use inventory & data, global arguments and the CLI or check out the documented examples.