MMX documentation

Each page answers one question. Start with Get started if you have not run MMX yet.

Start here

  • Get started: install mmx, create a project for one server, preview a change, and make it.
  • How MMX works: what happens on your computer and on each server during a run, the two connections, and what MMX protects.
  • When something fails: an error message or a surprise, what it means, and what to do.
  • Examples: whole example projects.

Write and run playbooks

Describe and reach your servers

Choose servers and roll out

Values, results, and reuse

Secrets

  • Keep secrets: the encrypted vault, unlocking it for automation, secrets from environment variables, and a vault for each inventory.
  • Secrets reference: which secrets a run needs and each server receives, and where secrets can appear.

Control runs and servers

Modules, software, and data

Work as a team

Change risky settings, move in, and upgrade

Look things up

  • Commands: every mmx command and flag, exit codes, output, and the JSON of a run.
  • Project settings: every field of mmx_project_settings.yml, and what the .mmx/ directory holds.
  • Inventory file: every field of an inventory: nodes, groups, variables, and connection settings.
  • Playbook file: every field of a playbook, retries and time limits, templates, and node facts.
  • Shared module behavior: file modes and owners, file previews, package versions, service recovery, conditions, and the environment of a command.
  • Module pages: one page for each module. mmx describe-module NAME prints the same page.
  • Limits on each distribution: what is limited on each tested distribution, and why.
  • Performance: the measurements, including the comparison with Ansible.

Changing MMX itself

  • Changing MMX: the design, the acceptance contracts, testing, and the rules for MMX's own code.

This page is docs/README.md in the MMX repository.