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

Files @ 36e1c9460cd6

Branch filter:

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

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

branko

MAR-27: Added initial scaffolding for testing mail_forwarder role:

- Fixed issues reported by Ansible linting check (some mode-related syntax and
one ignore.
- Added Molecule configuration for testing mandatory and optional
parameters. Covers both Debian Jessie and Debian Stretch.
- Added test playbook for setting-up the test instances. A helper relay mail
server.
- Updated both mail_server and mail_forwarder to fall-back to using
native (/etc/hosts) resolving if DNS fails. Solves issue with test environment
not having proper DNS set-up for all domains etc.
- Added a number of data/config files associated with tests.
- Added dummy test file.

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`