Adopting the common role documentation pattern

As discussed during the Newton design summit, we
agreed to adopt the role documentation pattern laid
out in the os_keystone role

Change-Id: Ie148d8d3f24426e34780a68b2c18d18aa9f3b325
This commit is contained in:
Travis Truman 2016-06-03 12:12:23 -04:00
parent c9abd5134e
commit b855107bb1
2 changed files with 24 additions and 26 deletions

View File

@ -1,10 +1,26 @@
OpenStack host setup
####################
:tags: openstack, host, cloud, ansible
:category: \*nix
OpenStack-Ansible openstack_hosts
#################################
Role for basic setup and configuration of a host machine for the intended purpose of
use within OpenStack.
Role for basic setup and configuration of a host machine for the intended
purpose of use within OpenStack. This role was created to tune a host to
receive OpenStack. The basic operations within the role allow it to install,
setup, and tune specific kernel options that all OpenStack powered hosts will
need to perform nominally.
Default Variables
=================
.. literalinclude:: ../../defaults/main.yml
:language: yaml
:start-after: under the License.
Required Variables
==================
None
Example Playbook
================
.. code-block:: yaml
@ -12,4 +28,4 @@ use within OpenStack.
hosts: "hosts"
user: root
roles:
- { role: "openstack_hosts", tags: [ "openstack-hosts-setup" ] }
- { role: "openstack_hosts" }

View File

@ -1,19 +1 @@
OpenStack_hosts Role Docs
=========================
Role for basic setup and configuration of a host machine for the intended purpose of
use within OpenStack. This role was created to tune a host to receive OpenStack.
The basic operations within the role allow it to install, setup, and tune specific
kernel options that all OpenStack powered hosts will need to perform nominally.
Basic Role Example
^^^^^^^^^^^^^^^^^^
.. code-block:: yaml
- name: Basic host setup
hosts: "hosts"
user: root
roles:
- { role: "openstack_hosts", tags: [ "openstack-hosts-setup" ] }
.. include:: ../../README.rst