[DOCS] Adds a cookie cutter deploy guide for d.o.o

Also removes old install guide in favor of the commited deploy guide

TODO: Link for the deploy guide to be commited

Change-Id: I72c1d344a4cc8df4d92ff296200704639771eb88

.gitignore

@@ -10,6 +10,7 @@
 build/
 dist/
 doc/build/
+deploy-guide/build/
 
 # Packages #
 ############

deploy-guide/source/app-config-prod.rst

@@ -84,7 +84,7 @@ following is the ``/etc/network/interfaces`` file for ``infra1``.
    configuration files are replaced with the appropriate name. The same
    applies to additional network interfaces.
 
-.. literalinclude:: ../../../etc/network/interfaces.d/openstack_interface.cfg.prod.example
+.. literalinclude:: ../../etc/network/interfaces.d/openstack_interface.cfg.prod.example
 
 Deployment configuration
 ~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -97,7 +97,7 @@ environment layout.
 
 The following configuration describes the layout for this environment.
 
-.. literalinclude:: ../../../etc/openstack_deploy/openstack_user_config.yml.prod.example
+.. literalinclude:: ../../etc/openstack_deploy/openstack_user_config.yml.prod.example
 
 Environment customizations
 --------------------------
@@ -111,7 +111,7 @@ For this environment, the ``cinder-volume`` runs in a container on the
 infrastructure hosts. To achieve this, implement
 ``/etc/openstack_deploy/env.d/cinder.yml`` with the following content:
 
-.. literalinclude:: ../../../etc/openstack_deploy/env.d/cinder-volume.yml.container.example
+.. literalinclude:: ../../etc/openstack_deploy/env.d/cinder-volume.yml.container.example
 
 User variables
 --------------
@@ -123,4 +123,4 @@ For this environment, implement the load balancer on the infrastructure
 hosts. Ensure that keepalived is also configured with HAProxy in
 ``/etc/openstack_deploy/user_variables.yml`` with the following content.
 
-.. literalinclude:: ../../../etc/openstack_deploy/user_variables.yml.prod.example
+.. literalinclude:: ../../etc/openstack_deploy/user_variables.yml.prod.example

deploy-guide/source/app-config-test.rst

@@ -71,7 +71,7 @@ following is the ``/etc/network/interfaces`` file for ``infra1``.
    configuration files are replaced with the appropriate name. The same
    applies to additional network interfaces.
 
-.. literalinclude:: ../../../etc/network/interfaces.d/openstack_interface.cfg.test.example
+.. literalinclude:: ../../etc/network/interfaces.d/openstack_interface.cfg.test.example
 
 Deployment configuration
 ~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -84,7 +84,7 @@ environment layout.
 
 The following configuration describes the layout for this environment.
 
-.. literalinclude:: ../../../etc/openstack_deploy/openstack_user_config.yml.test.example
+.. literalinclude:: ../../etc/openstack_deploy/openstack_user_config.yml.test.example
 
 Environment customizations
 --------------------------

deploy-guide/source/conf.py

@@ -0,0 +1,341 @@
+#!/usr/bin/env python3
+
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+# implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# This file is execfile()d with the current directory set to its
+# containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+import openstackdocstheme
+import os
+import pbr.version
+import sys
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+sys.path.insert(0, os.path.abspath('../../playbooks/inventory/'))
+
+# -- General configuration ------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+# needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+# TODO(ajaeger): enable PDF building, for example add 'rst2pdf.pdfbuilder'
+extensions = ['sphinx.ext.autodoc','sphinxmark']
+
+# Add any paths that contain templates here, relative to this directory.
+#templates_path = ['_templates']
+
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+# The encoding of source files.
+# source_encoding = 'utf-8-sig'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+author = 'OpenStack-Ansible Contributors'
+category = 'Miscellaneous'
+copyright = '2014-2016, OpenStack-Ansible Contributors'
+description = 'OpenStack-Ansible deploys OpenStack environments using Ansible.'
+project = 'OpenStack-Ansible'
+target_name = 'openstack-ansible'
+title = 'OpenStack-Ansible Documentation'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version_info = pbr.version.VersionInfo(target_name)
+# The full version, including alpha/beta/rc tags.
+release = version_info.version_string_with_vcs()
+# The short X.Y version.
+version = version_info.canonical_version_string()
+
+# A few variables have to be set for the log-a-bug feature.
+#   giturl: The location of conf.py on Git. Must be set manually.
+#   gitsha: The SHA checksum of the bug description. Automatically extracted from git log.
+#   bug_tag: Tag for categorizing the bug. Must be set manually.
+# These variables are passed to the logabug code via html_context.
+giturl = ("http://git.openstack.org/cgit/openstack/{0}"
+          "/tree/doc/source").format(target_name)
+git_cmd = "/usr/bin/git log | head -n1 | cut -f2 -d' '"
+gitsha = os.popen(git_cmd).read().strip('\n')
+bug_title = "Documentation bug"
+html_context = {"gitsha": gitsha, "giturl": giturl,
+                "bug_tag": "docs", "bug_title": bug_title,
+                "bug_project": target_name}
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+# language = None
+
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+# today = ''
+# Else, today_fmt is used as the format for a strftime call.
+# today_fmt = '%B %d, %Y'
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+exclude_patterns = []
+
+# The reST default role (used for this markup: `text`) to use for all
+# documents.
+# default_role = None
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+# add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+# add_module_names = True
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+# show_authors = False
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# A list of ignored prefixes for module index sorting.
+# modindex_common_prefix = []
+
+# If true, keep warnings as "system message" paragraphs in the built documents.
+# keep_warnings = False
+
+# -- Options for HTML output ----------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+html_theme = 'openstackdocs'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+# html_theme_options = {}
+
+# Add any paths that contain custom themes here, relative to this directory.
+html_theme_path = [openstackdocstheme.get_html_theme_path()]
+
+# The name for this set of Sphinx documents.  If None, it defaults to
+# "<project> v<release> documentation".
+# html_title = None
+
+# A shorter title for the navigation bar.  Default is the same as html_title.
+# html_short_title = None
+
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+# html_logo = None
+
+# The name of an image file (within the static path) to use as favicon of the
+# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+# html_favicon = None
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+# html_static_path = []
+
+# Add any extra paths that contain custom files (such as robots.txt or
+# .htaccess) here, relative to this directory. These files are copied
+# directly to the root of the documentation.
+# html_extra_path = []
+
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
+# using the given strftime format.
+html_last_updated_fmt = '%Y-%m-%d %H:%M'
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+# html_use_smartypants = True
+
+# Custom sidebar templates, maps document names to template names.
+# html_sidebars = {}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+# html_additional_pages = {}
+
+# If false, no module index is generated.
+# html_domain_indices = True
+
+# If false, no index is generated.
+html_use_index = False
+
+# If true, the index is split into individual pages for each letter.
+# html_split_index = False
+
+# If true, links to the reST sources are added to the pages.
+html_show_sourcelink = False
+
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
+# html_show_sphinx = True
+
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
+# html_show_copyright = True
+
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a <link> tag referring to it.  The value of this option must be the
+# base URL from which the finished HTML is served.
+# html_use_opensearch = ''
+
+# This is the file name suffix for HTML files (e.g. ".xhtml").
+# html_file_suffix = None
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = target_name + '-docs'
+
+# If true, publish source files
+html_copy_source = False
+
+# -- Options for LaTeX output ---------------------------------------------
+
+latex_elements = {
+    # The paper size ('letterpaper' or 'a4paper').
+    # 'papersize': 'letterpaper',
+
+    # The font size ('10pt', '11pt' or '12pt').
+    # 'pointsize': '10pt',
+
+    # Additional stuff for the LaTeX preamble.
+    # 'preamble': '',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+#  author, documentclass [howto, manual, or own class]).
+latex_documents = [
+    (master_doc, target_name + '.tex',
+     title, author, 'manual'),
+]
+
+# The name of an image file (relative to this directory) to place at the top of
+# the title page.
+# latex_logo = None
+
+# For "manual" documents, if this is true, then toplevel headings are parts,
+# not chapters.
+# latex_use_parts = False
+
+# If true, show page references after internal links.
+# latex_show_pagerefs = False
+
+# If true, show URL addresses after external links.
+# latex_show_urls = False
+
+# Documents to append as an appendix to all manuals.
+# latex_appendices = []
+
+# If false, no module index is generated.
+# latex_domain_indices = True
+
+
+# -- Options for manual page output ---------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    (master_doc, target_name,
+     title, [author], 1)
+]
+
+# If true, show URL addresses after external links.
+# man_show_urls = False
+
+
+# -- Options for Texinfo output -------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+    (master_doc, target_name,
+     title, author, project,
+     description, category),
+]
+
+# Documents to append as an appendix to all manuals.
+# texinfo_appendices = []
+
+# If false, no module index is generated.
+# texinfo_domain_indices = True
+
+# How to display URL addresses: 'footnote', 'no', or 'inline'.
+# texinfo_show_urls = 'footnote'
+
+# If true, do not generate a @detailmenu in the "Top" node's menu.
+# texinfo_no_detailmenu = False
+
+# -- Options for PDF output --------------------------------------------------
+
+pdf_documents = [
+    (master_doc, target_name,
+     title, author)
+]
+
+latest_tag = os.popen('git describe --abbrev=0 --tags').read().strip('\n')
+
+previous_release_branch_name='newton'
+current_release_branch_name='ocata'
+
+previous_release_capital_name=previous_release_branch_name.upper()
+previous_release_formal_name=previous_release_branch_name.capitalize()
+current_release_capital_name=current_release_branch_name.upper()
+current_release_formal_name=current_release_branch_name.capitalize()
+upgrade_backup_dir="``/etc/openstack_deploy."+previous_release_capital_name+"``"
+
+rst_epilog = """
+.. |previous_release_branch_name| replace:: %s
+.. |current_release_branch_name| replace:: %s
+.. |previous_release_capital_name| replace:: %s
+.. |previous_release_formal_name| replace:: %s
+.. |current_release_capital_name| replace:: %s
+.. |current_release_formal_name| replace:: %s
+.. |upgrade_backup_dir| replace:: %s
+.. |latest_tag| replace:: %s
+""" % (previous_release_branch_name,
+       current_release_branch_name,
+       previous_release_capital_name,
+       previous_release_formal_name,
+       current_release_capital_name,
+       current_release_formal_name,
+       upgrade_backup_dir,
+       latest_tag)
+
+watermark = os.popen("git branch --contains $(git rev-parse HEAD) | awk -F/ '/stable/ {print $2}'").read().strip(' \n\t').capitalize()
+if watermark == "":
+  watermark = "Pre-release"
+
+# -- Options for sphinxmark -----------------------------------------------
+sphinxmark_enable = True
+sphinxmark_div = 'docs-body'
+sphinxmark_image = 'text'
+sphinxmark_text = watermark
+sphinxmark_text_color = (128, 128, 128)
+sphinxmark_text_size = 70

deploy-guide/source/configure.rst

@@ -53,7 +53,8 @@ For examples, please see :ref:`test-environment-config` and
 :ref:`production-environment-config`.
 
 For details about how the inventory is generated from the environment
-configuration, see :ref:`developer-inventory`.
+configuration, see
+`developer-inventory <http://docs.openstack.org/developer/openstack-ansible/developer-docs/inventory.html>`_.
 
 Configuring additional services
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

deploy-guide/source/deploymenthost.rst

@@ -73,7 +73,7 @@ of failure caused by connectivity issues.
 
 The following network information is used as an example:
 
-.. code-block::
+.. code-block:: ini
 
    Container management: 172.29.236.0/22 (VLAN 10)
 

deploy-guide/source/index.rst

@@ -1,6 +1,6 @@
-==================
-Installation Guide
-==================
+==================================
+OpenStack-Ansible Deployment Guide
+==================================
 
 This guide provides instructions for performing an OpenStack-Ansible
 installation in a test environment and a production environment, and is

doc/source/index.rst

@@ -19,7 +19,7 @@ review.
 .. toctree::
    :maxdepth: 1
 
-   install-guide/index
+   .. TODO: Add deploy guide once asettle has live link
    upgrade-guide/index
    developer-docs/index
 

doc/source/install-guide/figures/README.rst

@@ -1,5 +0,0 @@
-Figures
-#######
-
-Figures in this directory are created using `Omnigraffle <https://www.omnigroup.com/omnigraffle>`_.
-For each image, the source .graffle file, svg, and png formats are provided.

tox.ini

@@ -33,6 +33,8 @@ commands=
     doc8 doc
     python setup.py build_sphinx
 
+[testenv:deploy-guide]
+commands = sphinx-build -a -E -W -d deploy-guide/build/doctrees -b html deploy-guide/source deploy-guide/build/html
 
 [doc8]
 # Settings for doc8: