From bc124efd94487ce981705ef4021c3b68ef3890ab Mon Sep 17 00:00:00 2001
From: Travis Truman Date: 2016年6月24日 16:25:13 -0400
Subject: [PATCH] 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
---
README.rst | 31 ++++++++++++++++++++++++-------
doc/source/index.rst | 14 +-------------
2 files changed, 25 insertions(+), 20 deletions(-)
diff --git a/README.rst b/README.rst
index 8d98b97c..914dcffd 100644
--- a/README.rst
+++ b/README.rst
@@ -1,14 +1,31 @@
-os_nova role
-############
-:tags: openstack, cloud, ansible, os_nova
-:category: \*nix
+OpenStack-Ansible Nova
+######################
-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
+ # 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
roles:
- { role: "os_nova" }
diff --git a/doc/source/index.rst b/doc/source/index.rst
index 55a30ec4..38ba8043 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -1,13 +1 @@
-os_nova Docs
-============
-
-Ansible role for deploying OpenStack Nova and all of its corresponding
-services.
-
-Basic Role Example
-^^^^^^^^^^^^^^^^^^
-
-.. code-block:: yaml
-
- - role: "os_nova"
- ROLE_VARS...
+.. include:: ../../README.rst
\ No newline at end of file