pyinfra Documentation¶

Welcome to the pyinfra v3 documentation. If you're new to pyinfra you should start with Getting Started.

Using pyinfra¶

• Getting Started — Start here! The quickest way to learn the basics of pyinfra and get started.
• Using Operations — The guide to writing reusable, committable operations in Python files.
• Inventory & Data — Use groups, host, and group data to control and configure operations for any environment.
• Using the CLI — The pyinfra CLI is extremely powerful for ad hoc command execution and management.
• FAQ — Quick answers to the most commonly asked questions for using pyinfra.

Deploy Reference¶

• Operations — A list of all available operations and their arguments, e.g. apt.packages.
• Facts — A list of all facts pyinfra can gather from hosts, e.g. server.Hostname.
• Connectors — A list of connectors to target different hosts such as @docker, @local and @terraform.
• Arguments — Arguments available in all operations & facts such as _sudo, _serial and _env

How pyinfra Works¶

• Deploy Process — Discover how pyinfra orders, diffs and executes operations against target hosts.
• Writing Deploys — How to package, redistribute and share pyinfra deploys as Python packages.
• Writing Connectors — How to write your own connectors for pyinfra.
• Writing Operations — How to write your own operations for pyinfra.
• Writing Facts — How to write your own facts for pyinfra.
• Using the API — How to use the pyinfra API.