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

.. image:: https://git.shore.co.il/ansible/ansible-modules/badges/master/pipeline.svg
    :target: https://git.shore.co.il/ansible/ansible-modules/-/commits/master
    :alt: pipeline status
nimrod's avatar
nimrod committed
A repository of Ansible modules.

This project is deprecated. All of the modules in this repo have equivalents in
the Ansible project making them obsolete. Right now the only tests that are done
are linters with pre-commit.

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

- collectd_facts (use the :code:`package_facts` module instead)
- ldap_attr (has been accepted in to the Ansible project)
- nginx_facts (use the :code:`package_facts` module instead)
- dhparams (use the :code:`openssl_dhparams` module instead)
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.
The 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
at: https://git.shore.co.il/explore/.
nimrod's avatar
nimrod committed

TODO
----

- Test installation and update instructions.