DOC - 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: I36d2b0c99472b470d11cac20854513c3d8b40b78
This commit is contained in:
Travis Truman 2016-06-24 16:25:13 -04:00 committed by Jesse Pretorius (odyssey4me)
parent 0b5b8dd88a
commit bc124efd94
2 changed files with 25 additions and 20 deletions

View File

@ -1,14 +1,31 @@
os_nova role OpenStack-Ansible Nova
############ ######################
:tags: openstack, cloud, ansible, os_nova
:category: \*nix
os_nova Role Ansible role that installs and configures OpenStack Nova and all of its
corresponding services.
Default Variables
=================
.. literalinclude:: ../../defaults/main.yml
:language: yaml
:start-after: under the License.
Required Variables
==================
.. code-block:: yaml .. code-block:: yaml
# comma separated list of Glance internalUrls
glance_api_servers: "http://glance_host:9292"
- name: os_nova role
hosts: "hosts" Example Playbook
================
.. code-block:: yaml
- name: Playbook for deploying nova
hosts: nova_all
user: root user: root
roles: roles:
- { role: "os_nova" } - { role: "os_nova" }

View File

@ -1,13 +1 @@
os_nova Docs .. include:: ../../README.rst
============
Ansible role for deploying OpenStack Nova and all of its corresponding
services.
Basic Role Example
^^^^^^^^^^^^^^^^^^
.. code-block:: yaml
- role: "os_nova"
ROLE_VARS...