Skip to content
README.rst 1.63 KiB
Newer Older
nimrod's avatar
nimrod committed
ansible-modules
###############

.. image:: https://travis-ci.org/adarnimrod/ansible-modules.svg?branch=master
    :target: https://travis-ci.org/adarnimrod/ansible-modules

nimrod's avatar
nimrod committed
A repository of Ansible modules.

Installation
------------

nimrod's avatar
nimrod committed
To use these modules, add a git submodule under the :code:`library` directory
at the root of the playbooks directory

.. code:: shell
nimrod's avatar
nimrod committed

    mkdir library
    touch library/__init__.py
nimrod's avatar
nimrod committed
    git submodule add https://www.shore.co.il/git/ansible-modules library/shore master
    sudo pip install -r library/shore/requirements.txt
nimrod's avatar
nimrod committed

nimrod's avatar
nimrod committed
To update the submodule

.. code:: shell
nimrod's avatar
nimrod committed

    git submodule update --remote library/shore

nimrod's avatar
nimrod committed
Remember to commit :code:`.gitmodules`!
nimrod's avatar
nimrod committed

Modules
-------

nimrod's avatar
nimrod committed
- collectd_facts
- ldap_attr
- nginx_facts
- dhparams
nimrod's avatar
nimrod committed

Usage
-----

See example usage in the test playbooks under :code:`tests/`.

nimrod's avatar
nimrod committed
License
-------

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

Testing
-------

Modules are tested on Ubuntu Precise, Trusty and Xenial and Debian Wheezy,
Jessie and Stretch with Ansible version 2.0.2.0, 2.1.6.0, 2.2.3.0 and 2.3.1.0
in `TravisCI <https://travis-ci.org/adarnimrod/ansible-modules>`_. To tests
require `Tox <https://tox.readthedocs.io/>`_ and `Docker
<https://docker.com>`_. `Pre-commit <http://pre-commit.com/>`_ is also setup
for this project.
nimrod's avatar
nimrod committed

Author
------

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/.
nimrod's avatar
nimrod committed

TODO
----

- Test installation and update instructions.