Skip to content
README.rst 2.04 KiB
Newer Older
nimrod's avatar
nimrod committed

nimrod's avatar
nimrod committed
An Ansible role to install and configure a MySQL server. The role creates an
admin account, force SSL usage, configures UFW and daily backup.
nimrod's avatar
nimrod committed

Requirements
------------

See :code:`meta/main.yml`, :code:`requirements.yml` and assertions at top of
:code:`tasks/main.yml`.

Adding the role as a dependency
-------------------------------

Add the following to your :code:`meta/main.yml`:

.. code:: yaml

    dependencies:
    - src: https://www.shore.co.il/git/ansible-role-example
      scm: git
      name: example

When :code: `ansible-galaxy` downloads your role it will also download its
dependencies, ensuring this role will be present and run everytime your role
runs.

Adding the role to your playbooks
---------------------------------

Add the following to your :code:`requirements.yml`:

.. code:: yaml

    - src: https://www.shore.co.il/git/ansible-role-example
      scm: git
      name: example

and update your roles by running :code: `ansible-galaxy install -r
requirements.yml`.
nimrod's avatar
nimrod committed

Role Variables
--------------

See :code:`defaults/main.yml`.
nimrod's avatar
nimrod committed

Dependencies
------------

nimrod's avatar
nimrod committed
See :code:`meta/main.yml`.
nimrod's avatar
nimrod committed

Example Playbook
----------------

nimrod's avatar
nimrod committed
See :code:`tests/playbook.yml`.
nimrod's avatar
nimrod committed
Testing
-------

Testing requires Virtualbox and Vagrant (out of scope for this documentation).
Install the Python dependencies, add pre-commit hooks by running:
nimrod's avatar
nimrod committed

.. code:: shell

    pip install -r tests/requirements.txt
    pre-commit install
nimrod's avatar
nimrod committed
To run the full test suite:
nimrod's avatar
nimrod committed
.. code:: shell

    ansible-galaxy install git+file://$(pwd),$(git rev-parse --abbrev-ref HEAD) -p .molecule/roles
    pre-commit run --all-files
    molecule test --platform all
nimrod's avatar
nimrod committed

License
-------

nimrod's avatar
nimrod committed
This software is licensed under the MIT license (see the :code:`LICENSE.txt`
file).
nimrod's avatar
nimrod committed

Author Information
------------------

nimrod's avatar
nimrod committed
Nimrod Adar, `contact me <nimrod@shore.co.il>`_ or visit my `website
<https://www.shore.co.il/>`_. Patches are welcome via `git send-email
<http://git-scm.com/book/en/v2/Git-Commands-Email>`_. The repository is located
nimrod's avatar
nimrod committed
at: https://www.shore.co.il/git/.

TODO
----

- Backup script.
- Testing.