majic-ansible-roles Files · docs/index.rst

Files @ ea69b2719d8e

Branch filter:

Location: majic-ansible-roles/docs/index.rst

ea69b2719d8e 1.7 KiB text/prs.fallenstein.rst Show Annotation Show as Raw Download as Raw

branko

MAR-22: Implemented tests for the common role:

- Added missing documentation for pipreqcheck_uid and pipreqcheck_gid
parameters.
- Use static-hashed passwords for reproducibility during testing in test
playbook.
- Install Emacs and libmariadb-client-lgpl-dev-compat via test playbook on one
of the testing instances in order to test related tasks.
- Fixed parameter for connection limitting in test playbook.
- Added explicit parameters to test playbook for pipreqcheck_gid and
pipreqcheck_uid.
- Fixed deployment of ferm configuration file ot include setting user/group and
mode.
- Added tests covering common deployment, deployment when only mandatory
parameters are provided, and deployment when optional parameters are set as
well.

Majic Ansible Roles documentation
=================================

Majic Ansible Roles is a collection of Ansible roles that are used on regular
basis for deployment and maintenance of Majic infrastructure.

The roles are kept as a separate project in hope of making them potentially
useful to wider audience, and for reference purposes.

Roles cover different aspects of infrastructure, such as mail servers, web
servers, web applications etc. The roles are mainly well-suited for smaller
installations.

Roles are mainly written for use with *Debian 8 Jessie*, although some support
*Debian 9 Stretch* as well. You can find out more about distribution
compatibility in :ref:`rolereference`.

At the moment, the roles have been written for and tested against **Ansible
1.9.x**.

Roles should work for the most part with **Ansible 2.0.x** and **Ansible
2.1.x**, but due to bugs in those releases they should not be used for
production purposes. Roles are kept forward-compatible as much as possible until
a couple of breaking bugs get fixed in **Ansible 2.x** series. The main blockers
are:

* Inability to use dynamic name handlers (handlers that include variables in
  their name).
* Referencing non-existing handlers does not produce error.
* Referencing non-existing tags does not produce error.

The role also utilises the ``dig`` lookup plugin which requires ``dnspython``
package to be installed. Make sure you have the package available on controller
machine.


Contents
========

.. toctree::
   :maxdepth: 2

   about
   usage
   rolereference
   development
   releaseprocedures
   releasenotes

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`