openstack
/
openstack-ansible-specs
Code Issues Proposed changes

Fix warnings in specs repo 

The specs job hasn't been published in a while and I wondered if
warnings could be causing it. This patch clears up those warnings.

Change-Id: I5e888782d2e62781f44862f2821069fa5b34bec4
This commit is contained in:
Major Hayden 2017-05-16 13:01:38 -05:00 committed by Jesse Pretorius (odyssey4me)
parent ec488c172c
commit a3cbeb649b
5 changed files with 21 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
doc/source/index.rst
View File

@ -66,13 +66,4 @@ Kilo Specifications
specs/kilo/* specs/kilo/*
Index and tables
================
.. toctree::
:glob:
:maxdepth: 1
specs/*
* :ref:`search` * :ref:`search`

1
specs/newton/monasca-ha-monasca-agent.rst
View File

@ -46,6 +46,7 @@ Notable changes:
* Storm Nimbus & Supervisor * Storm Nimbus & Supervisor
* Zookeeper * Zookeeper
* Grafana & Monasca-ui * Grafana & Monasca-ui
* Not clustered, but for HA to work correctly on Grafana, session * Not clustered, but for HA to work correctly on Grafana, session
sharing and configuration database connection must be set to the Openstack-Ansible sharing and configuration database connection must be set to the Openstack-Ansible
Galera cluster Galera cluster

4
specs/newton/only-install-venvs.rst
View File

@ -73,8 +73,8 @@ N/A.
Deployer impact Deployer impact
--------------- ---------------
The *_venv_enabled variables will no longer exist and will have no effect if The ``*_venv_enabled`` variables will no longer exist and will have no effect
set by a deployer. if set by a deployer.
Developer impact Developer impact

23
specs/newton/osa-install-guide-overhaul.rst
View File

@ -39,27 +39,34 @@ content so a deployer makes very few decisions and minimal configuration
to deploy an OpenStack test environment and production environment. to deploy an OpenStack test environment and production environment.
The proposed changes are: The proposed changes are:
* Clearly define reference architecture and develop use case configuration * Clearly define reference architecture and develop use case configuration
examples in an appendix. examples in an appendix.
* Removal of the configuration information from the current installation guide * Removal of the configuration information from the current installation guide
and including it in the OpenStack-Ansible role documentation. and including it in the OpenStack-Ansible role documentation.
* Migrate operations content temporarily to openstack-ansible-ops repo * Migrate operations content temporarily to openstack-ansible-ops repo
until an operations guide can be produced. until an operations guide can be produced.
* Restructure the guide to include basic deployment configuration. * Restructure the guide to include basic deployment configuration.
* Appendices that include configuration file examples, neutron plugins, * Appendices that include configuration file examples, neutron plugins,
cinder options and additional resources relevant to an OpenStack-Ansible cinder options and additional resources relevant to an OpenStack-Ansible
installation. installation.
* Include links to role based documentation from the Installation Guide. * Include links to role based documentation from the Installation Guide.
Alternatives Alternatives
------------ ------------
* Leaving the installation guide as is, and migrating only the configuration * Leaving the installation guide as is, and migrating only the configuration
information to the developer docs. information to the developer docs.
* Consider revising the installation guide to meet criteria in `project-specific installation guide * Consider revising the installation guide to meet criteria in
<http://specs.openstack.org/openstack/docs-specs/specs/newton/project-specific-installguides.html>`_ `project-specific installation guide
and publish to docs.openstack.org <http://specs.openstack.org/openstack/docs-specs/specs/newton/project-specific-installguides.html>`_
and publish to docs.openstack.org
Playbook/Role impact Playbook/Role impact
-------------------- --------------------
@ -143,8 +150,8 @@ This is a documentation change, N/A.
References References
========== ==========
* Design Summit discussion: * `Design Summit discussion
`https://etherpad.openstack.org/p/openstack-ansible-newton-role-docs`_ <https://etherpad.openstack.org/p/openstack-ansible-newton-role-docs>`_
* ToC planning: * `ToC planning
`https://docs.google.com/document/d/1WdcA7jIp8w1C52pJu4JmympFe8cOvcxi1I2E19Y6XYE/edit?ts=5743fe3f#heading=h.jg8guj3uzhzw`_ <https://docs.google.com/document/d/1WdcA7jIp8w1C52pJu4JmympFe8cOvcxi1I2E19Y6XYE/edit?ts=5743fe3f#heading=h.jg8guj3uzhzw>`_

3
specs/ocata/create-ops-guide.rst
View File

@ -40,10 +40,13 @@ The proposed changes are:
* Removal of duplicated content from the OpenStack manuals operations guide * Removal of duplicated content from the OpenStack manuals operations guide
(so that this guide focuses primarily upon OpenStack-Ansible operations). (so that this guide focuses primarily upon OpenStack-Ansible operations).
* Structuring the guide in a 'runbook' format for the following reasons: * Structuring the guide in a 'runbook' format for the following reasons:
#. Ensuring the guide includes lower-level how-to's for anyone starting to #. Ensuring the guide includes lower-level how-to's for anyone starting to
operate their own cloud. operate their own cloud.
#. Ensuring the guide includes higher-level troubleshooting information for #. Ensuring the guide includes higher-level troubleshooting information for
more experienced operator. more experienced operator.
#. It is structured to make it easy for operators to find the information #. It is structured to make it easy for operators to find the information
they are looking for. they are looking for.