ansible-role-nodepool/README.rst
Paul Belanger 93157d2f9e Clean up references to openstack.org
With opendev.org now online, we can start using it over openstack.org.

Change-Id: Ia28113926efd70bee28aec7b88edcfdb365e6665
Depends-On: https://review.opendev.org/654017
Signed-off-by: Paul Belanger <pabelanger@redhat.com>
2019-04-20 14:02:59 -04:00

63 lines
1.5 KiB
ReStructuredText

=====================
ansible-role-nodepool
=====================
Ansible role to manage Nodepool
* License: Apache License, Version 2.0
* Documentation: https://ansible-role-nodepool.readthedocs.org
* Source: https://opendev.org/windmill/ansible-role-nodepool
* Bugs: https://bugs.launchpad.net/ansible-role-nodepool
Description
-----------
Nodepool is a system for launching single-use test nodes on demand based on
images built with cached data. It is designed to work with any OpenStack based
cloud, and is part of a suite of tools that form a comprehensive test system
including Jenkins and Zuul.
Requirements
------------
* pip3 to be installed if using nodepool_install_method: (git|pip)
* docker to be installed if using nodepool_install_method: docker
*NOTE*
Docker support should be consider experimental. You will need to create
systemd service files manually. There are too many possible settings
for docker, which make is almost impossible to support via Ansible.
Packages
~~~~~~~~
Package repository index files should be up to date before using this role, we
do not manage them.
Sudo
~~~~
You will be required to create the appropriate sudoers file if you plan on
creating DIBs.
Role Variables
--------------
.. literalinclude:: ../../defaults/main.yaml
:language: yaml
:start-after: under the License.
Dependencies
------------
Example Playbook
----------------
.. code-block:: yaml
- name: Install nodepool
hosts: nodepool
roles:
- ansible-role-nodepool