From a3cbeb649b145535246e53a3469a0ea2f12ee67b Mon Sep 17 00:00:00 2001 From: Major Hayden Date: Tue, 16 May 2017 13:01:38 -0500 Subject: [PATCH] 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 --- doc/source/index.rst | 9 -------- specs/newton/monasca-ha-monasca-agent.rst | 1 + specs/newton/only-install-venvs.rst | 4 ++-- specs/newton/osa-install-guide-overhaul.rst | 23 ++++++++++++++------- specs/ocata/create-ops-guide.rst | 3 +++ 5 files changed, 21 insertions(+), 19 deletions(-) diff --git a/doc/source/index.rst b/doc/source/index.rst index 9097f04..0a114a9 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -66,13 +66,4 @@ Kilo Specifications specs/kilo/* -Index and tables -================ - -.. toctree:: - :glob: - :maxdepth: 1 - - specs/* - * :ref:`search` diff --git a/specs/newton/monasca-ha-monasca-agent.rst b/specs/newton/monasca-ha-monasca-agent.rst index 979944d..f785359 100644 --- a/specs/newton/monasca-ha-monasca-agent.rst +++ b/specs/newton/monasca-ha-monasca-agent.rst @@ -46,6 +46,7 @@ Notable changes: * Storm Nimbus & Supervisor * Zookeeper * Grafana & Monasca-ui + * Not clustered, but for HA to work correctly on Grafana, session sharing and configuration database connection must be set to the Openstack-Ansible Galera cluster diff --git a/specs/newton/only-install-venvs.rst b/specs/newton/only-install-venvs.rst index a8fb56e..28e3831 100644 --- a/specs/newton/only-install-venvs.rst +++ b/specs/newton/only-install-venvs.rst @@ -73,8 +73,8 @@ N/A. Deployer impact --------------- -The *_venv_enabled variables will no longer exist and will have no effect if -set by a deployer. +The ``*_venv_enabled`` variables will no longer exist and will have no effect +if set by a deployer. Developer impact diff --git a/specs/newton/osa-install-guide-overhaul.rst b/specs/newton/osa-install-guide-overhaul.rst index 9e8a9ce..8a4f2cb 100644 --- a/specs/newton/osa-install-guide-overhaul.rst +++ b/specs/newton/osa-install-guide-overhaul.rst @@ -39,27 +39,34 @@ content so a deployer makes very few decisions and minimal configuration to deploy an OpenStack test environment and production environment. The proposed changes are: + * Clearly define reference architecture and develop use case configuration examples in an appendix. + * Removal of the configuration information from the current installation guide and including it in the OpenStack-Ansible role documentation. + * Migrate operations content temporarily to openstack-ansible-ops repo until an operations guide can be produced. + * Restructure the guide to include basic deployment configuration. + * Appendices that include configuration file examples, neutron plugins, cinder options and additional resources relevant to an OpenStack-Ansible installation. + * Include links to role based documentation from the Installation Guide. Alternatives ------------ * 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 -`_ -and publish to docs.openstack.org +* Consider revising the installation guide to meet criteria in + `project-specific installation guide + `_ + and publish to docs.openstack.org Playbook/Role impact -------------------- @@ -143,8 +150,8 @@ This is a documentation change, N/A. References ========== -* Design Summit discussion: - `https://etherpad.openstack.org/p/openstack-ansible-newton-role-docs`_ +* `Design Summit discussion + `_ -* ToC planning: - `https://docs.google.com/document/d/1WdcA7jIp8w1C52pJu4JmympFe8cOvcxi1I2E19Y6XYE/edit?ts=5743fe3f#heading=h.jg8guj3uzhzw`_ \ No newline at end of file +* `ToC planning + `_ diff --git a/specs/ocata/create-ops-guide.rst b/specs/ocata/create-ops-guide.rst index 161075d..babf84b 100644 --- a/specs/ocata/create-ops-guide.rst +++ b/specs/ocata/create-ops-guide.rst @@ -40,10 +40,13 @@ The proposed changes are: * Removal of duplicated content from the OpenStack manuals operations guide (so that this guide focuses primarily upon OpenStack-Ansible operations). * Structuring the guide in a 'runbook' format for the following reasons: + #. Ensuring the guide includes lower-level how-to's for anyone starting to operate their own cloud. + #. Ensuring the guide includes higher-level troubleshooting information for more experienced operator. + #. It is structured to make it easy for operators to find the information they are looking for.