From 821926694a920f8a1722c645271230cfa2a40e0a Mon Sep 17 00:00:00 2001 From: Robb Romans Date: Fri, 12 Aug 2016 10:01:44 -0500 Subject: [PATCH] [DOCS] move example playbook to separate file Change-Id: I0243088c36a24be9c989602d98a988f63256924b --- README.rst | 19 +++++++------------ doc/source/index.rst | 32 +++++++++++++++++++++++++++----- examples/playbook.yml | 5 +++++ 3 files changed, 39 insertions(+), 17 deletions(-) create mode 100644 examples/playbook.yml diff --git a/README.rst b/README.rst index 7d56763e..02001df8 100644 --- a/README.rst +++ b/README.rst @@ -1,14 +1,9 @@ -os_tempest role -############### -:tags: openstack, cloud, ansible, os_tempest -:category: \*nix +================================= +OpenStack-Ansible os_tempest role +================================= -os_tempest Role +Documentation for the project can be found at: + http://docs.openstack.org/developer/openstack-ansible-os_tempest -.. code-block:: yaml - - - name: os_tempest role - hosts: "hosts" - user: root - roles: - - { role: "os_tempest" } +The project home is at: + http://launchpad.net/openstack-ansible diff --git a/doc/source/index.rst b/doc/source/index.rst index 7ab1398e..7e2902ae 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -1,12 +1,34 @@ -os_tempest Docs -=============== +================================= +OpenStack-Ansible os_tempest role +================================= -Ansible role to deploy OpenStack Tempest +This is the Ansible role to deploy OpenStack Tempest. -Basic Role Example -^^^^^^^^^^^^^^^^^^ +:tags: openstack, cloud, ansible, os_tempest +:category: \*nix + +Basic role example +~~~~~~~~~~~~~~~~~~ .. code-block:: yaml - role: "os_tempest" ROLE_VARS... + +Default variables +~~~~~~~~~~~~~~~~~ + +.. literalinclude:: ../../defaults/main.yml + :language: yaml + :start-after: under the License. + +Required variables +~~~~~~~~~~~~~~~~~~ + +None + +Example playbook +~~~~~~~~~~~~~~~~ + +.. literalinclude:: ../../examples/playbook.yml + :language: yaml diff --git a/examples/playbook.yml b/examples/playbook.yml new file mode 100644 index 00000000..050c3fee --- /dev/null +++ b/examples/playbook.yml @@ -0,0 +1,5 @@ +- name: os_tempest role + hosts: "hosts" + user: root + roles: + - { role: "os_tempest" }