.. _ug_introduction:

Introduction
************

* Supported systems: `FreeBSD Supported Production Releases`_

* Requirements:

  * `ansible.posix`_

  * `community.general`_

* The collection is shipped with:

  * `module vbotka.freebsd.iocage`_
  * `inventory plugin vbotka.freebsd.iocage`_
  * `role vbotka.freebsd.iocage`_
  * various playbooks

.. seealso::

   `Managing BSD hosts with Ansible`_

.. hint::

   * Run Ansible in Python virtual environment. See `venv — Creation of virtual environments`_.
   * Use YAML callback `community.general.yaml`_


.. _vbotka.freebsd: https://galaxy.ansible.com/ui/repo/published/vbotka/freebsd/
.. _FreeBSD Supported Production Releases: https://www.freebsd.org/releases
.. _ansible.posix: https://docs.ansible.com/ansible/latest/collections/ansible/posix
.. _community.general: https://docs.ansible.com/ansible/latest/collections/community/general
.. _Installing collections: https://docs.ansible.com/ansible/latest/collections_guide/collections_installing.html
.. _Managing BSD hosts with Ansible: https://docs.ansible.com/ansible/latest/os_guide/intro_bsd.html
.. _venv — Creation of virtual environments: https://docs.python.org/3/library/venv.html#module-venv
.. _community.general.yaml: https://docs.ansible.com/ansible/latest/collections/community/general/yaml_callback.html

.. _module vbotka.freebsd.iocage: https://galaxy.ansible.com/ui/repo/published/vbotka/freebsd/content/module/iocage/
.. _inventory plugin vbotka.freebsd.iocage: https://galaxy.ansible.com/ui/repo/published/vbotka/freebsd/content/inventory/iocage/
.. _role vbotka.freebsd.iocage: https://galaxy.ansible.com/ui/repo/published/vbotka/freebsd/content/role/iocage/
