From 5772632e0e464c89a924f7604fc8ceb56b116f56 Mon Sep 17 00:00:00 2001 From: Robb Romans Date: Tue, 16 Aug 2016 14:27:02 -0500 Subject: [PATCH] [DOCS] Add links to README; minor restructure Change-Id: Idc4f409c5ef0e1514de52eaa858ce60bd9c17baa --- README.rst | 6 ++++++ doc/source/app-nuage.rst | 4 ++-- doc/source/app-plumgrid.rst | 2 +- doc/source/index.rst | 19 ------------------- doc/source/overview.rst | 10 ++++++++++ 5 files changed, 19 insertions(+), 22 deletions(-) diff --git a/README.rst b/README.rst index bbe9bc40..56892836 100644 --- a/README.rst +++ b/README.rst @@ -3,3 +3,9 @@ OpenStack-Ansible neutron ========================= Ansible role that installs and configures OpenStack neutron. + +Documentation for the project can be found at: + http://docs.openstack.org/developer/openstack-ansible-os_neutron/ + +The project home is at: + http://launchpad.net/openstack-ansible diff --git a/doc/source/app-nuage.rst b/doc/source/app-nuage.rst index 158ade85..7c5a5167 100644 --- a/doc/source/app-nuage.rst +++ b/doc/source/app-nuage.rst @@ -24,7 +24,7 @@ Prerequisites #. The deployment environment is configured according to OSA best practices such as cloning OSA software and bootstrapping Ansible. See `OpenStack-Ansible Install Guide - `_ + `_. #. VCS stand-alone components, VSD and VSC, are configured and deployed. See the Nuage Networks VSD and VSC Install Guides. @@ -106,7 +106,7 @@ VCS environment: #. Replace *Local Package Repository* with the link of the local repository hosting the Nuage VRS packages. For example: - ``http://192.0.2.10/debs/3.2/vrs/`` + ``http://192.0.2.10/debs/3.2/vrs/``: .. code-block:: yaml diff --git a/doc/source/app-plumgrid.rst b/doc/source/app-plumgrid.rst index 141bc08d..fd8966f1 100644 --- a/doc/source/app-plumgrid.rst +++ b/doc/source/app-plumgrid.rst @@ -79,7 +79,7 @@ configure the following parameters: pg_vip: PG_VIP #. Replace ``FABRIC_IFC`` with the name of the interface to be used - for PLUMgrid Fabric. + for PLUMgrid Fabric: .. note:: diff --git a/doc/source/index.rst b/doc/source/index.rst index f9270af5..06738948 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -11,22 +11,3 @@ Neutron role for OpenStack-Ansible :tags: openstack, neutron, cloud, ansible :category: \*nix - -This role will install the following Upstart services: - * neutron-server - * neutron-agents - -Example playbook -~~~~~~~~~~~~~~~~ - -.. literalinclude:: ../../examples/playbook.yml - :language: yaml - -Tags -~~~~ - -This role supports two tags: ``neutron-install`` and ``neutron-config`` - -The ``neutron-install`` tag can be used to install and upgrade. - -The ``neutron-config`` tag can be used to manage configuration. diff --git a/doc/source/overview.rst b/doc/source/overview.rst index 5b2d6a9d..490c5cdf 100644 --- a/doc/source/overview.rst +++ b/doc/source/overview.rst @@ -2,6 +2,11 @@ Overview ======== +This role installs the following Upstart services: + + * neutron-server + * neutron-agents + Default variables ~~~~~~~~~~~~~~~~~ @@ -9,6 +14,11 @@ Default variables :language: yaml :start-after: under the License. +Required variables +~~~~~~~~~~~~~~~~~~ + +None. + Example playbook ~~~~~~~~~~~~~~~~