Skip to main content

A tool to provision, configure and maintain FreeBSD jails

Project description

BSDploy is a tool to deploy `FreeBSD <>`_ `jails <>`_.

Not wanting to re-invent the wheel, under the hood it uses `mr.awsome <>`_ for provisioning, `ansible <>`_ for configuration and `fabric <>`_ for maintenance.


- configure multiple hosts and jails in one canonical ini-file
- bootstrap complete jail hosts from scratch - both virtual machines, as well as physical ones. ``bsdploy`` will take care of installing FreeBSD for you, including configuration of `ZFS pools <>`_ and even encrypts them using `GELI <>`_.
- create new jails simply by adding two or more lines to your configuration file and running ``ploy start`` – bsdploy will take care of configuring the required IP address on the host
- **ansible support** – no more mucking about with host files: all hosts and their variables defined in ``ploy.conf`` are automatically exposed to ansible. Run them with ``ploy playbook path/to/playbook.yml``.
- ditto for **Fabric** – run fabric scripts with ``ploy do JAILNAME TASKNAME`` and have all your hosts and their variables at your disposal in ``fab.env``.
- jails receive private IP addresses by default, so they are not reachable from the outside - for configuration access (i.e. applying ansible playbooks to them or running fabric scripts inside of them) bsdploy transparently configures SSH ProxyCommand based access.
- Easily configure ``ipnat`` on the jail host to white-list access from the outside – this greatly reduces the chance of accidentally exposing services to the outside world that shouldn't be.
- **Amazon EC2** support – provision and configure jailhosts on EC2.

With bsdploy you can create and configure one or more jail hosts with one or more jails inside them, all configured in one canonical ``ini`` style configuration file (by default in ``etc/ploy.conf)``::

host =
port = 47022

ip =
fqdn = test.local
fabfile = deployment/

ip =
dbname = production

ip =
version = 1.2.3


To give it a spin, best `check out the example repository <>`_.


To develop ``bsdploy`` itself use the provided Makfile – running ``make`` will install a development version of itself and its direct dependencies (i.e. the ``mr.awsome.*`` packages).


- documentation *cough*
- include poudriere support
- make the private network for the jails configurable (the hard coded 10.0.0.x is not always desirable)


Miscellaneous notes that should eventually make their way into the proper documentation.

Selectively applying jailhost configuration

``ploy configure-jailhost`` applies the ``jails_host`` role (see ``roles/jails_host``. if you don't want to apply it wholesale or want to re-apply certain tags of it, you can use a top-level playbook like so::

- hosts: my-jailhost
user: root
- { role: jails_host, tags: ['configure'] }

i.e. to then only update the ipnat rules, do this::

bin/ploy playbook staging.yml -t configure -t ipnat_rules

the 'trick' is to use multiple tags to narrow down the tasks to only what you need.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date (24.9 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page