openbsd-run

openbsd-run is an Ansible playbook embedded in Python for performing actions against OpenBSD hosts.

If you are looking for a hosting provider that offers OpenBSD, consider using OpenBSD.Amsterdam which contributes to The OpenBSD Foundation.

Usage

This project only supports OpenBSD. You may test it by using the included Vagrantfile or by setting up an instance on a hosting provider.

Playbook

If you would rather use the raw playbook you may do so without any atypical setup.

Command Line Interface

By wrapping the Ansible playbook and the various plays with a command line interface we can provide familiar commands that run in parallel on hosts defined in an inventory.

Installing

You may use pip instead of poetry, though we’ll only cover using the latter since that’s what’s used for running, developing and testing.

$ poetry install --no-dev
$ poetry run openbsd-run -h
Usage: openbsd-run [OPTIONS] COMMAND [ARGS]...

Options:
  -H, --host_pattern TEXT  Host pattern to match against inventory
  -i, --inventory TEXT     Ansible inventory file
  -q, --quiet              Suppress Ansible output
  -v, --verbose            Increase Ansible output
  --version                Show the version and exit.
  -h, --help               Show this message and exit.

Commands:
  pkg_add     Add or update packages
  pkg_delete  Remove packages
  syspatch    Patch host(s) using syspatch
  sysupgrade  Upgrade host(s) using sysupgrade

Contributing

The primary goal of this project is to make doing native OpenBSD “things” from a remote system trivially possible. General administration and setting up a mirror are two good examples, and you’re likely to see scaffolding in the raw playbook.

Custom OpenBSD Vagrant box

If you would like to run OpenBSD via Vagrant for testing locally, please see https://github.com/jcmdln/openbsd-vagrant which provides an OpenBSD box that only uses what is already provided in a base install.