Introduction

• Supported systems: FreeBSD Supported Production Releases

• Requirements:

  • ansible.posix

  • ansible.utils

  • community.crypto

  • community.general

The collection is shipped with:

Plugins:

• module iocage - Manage iocage jails.

• module service - Control or query system services.

• module ucl - CRUD-like interface for managing UCL files.

• inventory iocage - iocage inventory source.

• inventory iocage2 - iocage inventory source (using libzfs & iocage_lib).

• filter ast_to_nginx - Convert an AST list to an NGINX configuration.

• filter dict_to_ast - Convert a YAML dictionary to an AST list.

• filter from_ucl - Parse a UCL string to a YAML dictionary.

• filter iocage - Parse iocage output lists.

• filter to_ucl - Convert a YAML dictionary to a UCL string.

• lookup galaxy_info - Retrieve metadata from galaxy.yml.

Roles:

• apache - Install, configure, and manage the Apache HTTP server.

• certificate - Generate and verify OpenSSL certificates.

• config_light - Install packages and configure files, services, and handlers.

• custom_image - Download, mount, and customize system images.

• dhcp - Install, configure, and manage the DHCP server.

• iocage (role) - Install and configure iocage.

• iocage_template - Create and configure iocage templates.

• lib - Task library providing reusable utilities.

• network - Configure system networking.

• nginx - Install, configure, and manage NGINX.

• packages - Configure package repositories and install packages.

• pf - Configure the Packet Filter (PF) firewall.

• postinstall - Perform post-installation system configuration.

• poudriere - Install and configure the Poudriere build system.

• rsnapshot - Install and configure rsnapshot backups.

• zfs - Configure ZFS storage pools and datasets.

Various Playbooks.

Tip

• See the Concepts.

• See the Examples and proofs of concept in the Sandbox.

See also

• Managing BSD hosts with Ansible

• Jails and Containers - FreeBSD Handbook

• Jails - FreeBSD Wiki

Note

• All collections listed in the above Requirements are included in the standard Ansible distribution.

• The roles may require other collections and/or roles not listed here. See each role’s requirements.yml file and install the missing collections and/or roles manually when needed.

Hint

• Run Ansible in a Python virtual environment. See venv — Creation of virtual environments.

• Use result_format=yaml.

Important

• Ansible claims:

  BSD support is important to us at Ansible. ... we have an
  active BSD community and strive to be as BSD-friendly as
  possible.
  

  Search the official Ansible documentation for the current status of FreeBSD support.