[DOCS] - Use new documentation tree structure

Changes the rally role doc tree to the new structure
we are adopting for each role.

Change-Id: I8776c6953b65753d9bf54b13f3f7a282f3ce8df0
This commit is contained in:
Travis Truman 2016-08-17 14:16:28 -04:00 committed by Robb Romans
parent 0c26304c64
commit 3d6a643eac
4 changed files with 37 additions and 29 deletions

View File

@ -1,31 +1,11 @@
OpenStack-Ansible Rally
#######################
:tags: openstack, rally, cloud, ansible
:category: \*nix
================================
Rally role for OpenStack-Ansible
================================
This Ansible role installs and configures OpenStack Rally.
Default Variables
=================
.. literalinclude:: ../../defaults/main.yml
:language: yaml
:start-after: under the License.
Required Variables
==================
* rally_galera_address
* rally_galera_password
Example Playbook
================
.. code-block:: yaml
- name: Install Rally server
hosts: rally_all
user: root
roles:
- role: "os_rally"
Documentation for the project can be found at:
http://docs.openstack.org/developer/openstack-ansible-os_rally/
The project home is at:
http://launchpad.net/openstack-ansible

View File

@ -1 +1,24 @@
.. include:: ../../README.rst
================================
Rally role for OpenStack-Ansible
================================
This Ansible role installs and configures OpenStack Rally.
Default variables
~~~~~~~~~~~~~~~~~
.. literalinclude:: ../../defaults/main.yml
:language: yaml
:start-after: under the License.
Required variables
~~~~~~~~~~~~~~~~~~
* ``rally_galera_address``
* ``rally_galera_password``
Example playbook
~~~~~~~~~~~~~~~~
.. literalinclude:: ../../examples/playbook.yml
:language: yaml

5
examples/playbook.yml Normal file
View File

@ -0,0 +1,5 @@
- name: Install Rally server
hosts: rally_all
user: root
roles:
- role: "os_rally"

View File

@ -5,7 +5,7 @@ description-file =
README.rst
author = OpenStack
author-email = openstack-dev@lists.openstack.org
home-page = http://www.openstack.org/
home-page = http://docs.openstack.org/developer/openstack-ansible-os_rally/
classifier =
Intended Audience :: Developers
Intended Audience :: System Administrators