From ca1e4cccd922568d00ca8f2efa37778afac746a2 Mon Sep 17 00:00:00 2001 From: Alexandra Settle Date: Fri, 28 Oct 2016 14:56:47 +0100 Subject: [PATCH] [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 | 1 + .../source}/app-advanced-config-affinity.rst | 0 .../source}/app-advanced-config-options.rst | 0 .../source}/app-advanced-config-override.rst | 0 .../source}/app-advanced-config-security.rst | 0 .../app-advanced-config-sslcertificates.rst | 0 .../source}/app-advanced-role-docs.rst | 0 .../source}/app-config-prod.rst | 8 +- .../source}/app-config-test.rst | 4 +- .../source}/app-custom-layouts.rst | 0 .../source}/app-networking.rst | 0 .../source}/app-resources.rst | 0 .../source}/app-security.rst | 0 .../source}/app.rst | 0 deploy-guide/source/conf.py | 341 ++++++++++++++++++ .../source}/configure.rst | 3 +- .../source}/deploymenthost.rst | 2 +- .../figures/arch-layout-production.png | Bin .../figures/arch-layout-production.svg | 0 .../source}/figures/arch-layout-test.png | Bin .../source}/figures/arch-layout-test.svg | 0 .../source}/figures/arch-layout.graffle | Bin ...allation-workflow-configure-deployment.png | Bin .../installation-workflow-deploymenthost.png | Bin .../installation-workflow-overview.png | Bin .../installation-workflow-run-playbooks.png | Bin .../installation-workflow-targethosts.png | Bin ...installation-workflow-verify-openstack.png | Bin .../figures/installation-workflow.graffle | Bin .../networkarch-bare-external-example.png | Bin .../figures/networkarch-bare-external.png | Bin ...networkarch-container-external-example.png | Bin .../networkarch-container-external.png | Bin .../source}/figures/networkcomponents.png | Bin .../source}/figures/networking-compute.png | Bin .../figures/networking-neutronagents.png | Bin .../figures/production-storage-cinder.png | Bin .../production-storage-cinder.svg/image3.wmf | Bin .../production-storage-cinder.svg | 0 .../figures/production-storage-glance.png | Bin .../production-storage-glance.svg/image3.wmf | Bin .../production-storage-glance.svg | 0 .../figures/production-storage-nova.png | Bin .../production-storage-nova.svg/image3.wmf | Bin .../production-storage-nova.svg | 0 .../figures/production-storage-swift.png | Bin .../figures/production-storage-swift.svg | 0 .../production-storage.graffle/data.plist | Bin .../production-storage.graffle/image3.wmf | Bin .../source}/figures/production-storage.svg | 0 .../source}/index.rst | 6 +- .../source}/navigation.txt | 0 .../source}/overview-network-arch.rst | 0 .../source}/overview-osa.rst | 0 .../source}/overview-requirements.rst | 0 .../source}/overview-service-architecture.rst | 0 .../source}/overview-storage-arch.rst | 0 .../source}/overview.rst | 0 .../source}/run-playbooks.rst | 0 .../source}/targethosts-networkconfig.rst | 0 .../source}/targethosts-prepare.rst | 0 .../source}/targethosts.rst | 0 .../source}/verify-operation.rst | 0 doc/source/index.rst | 2 +- doc/source/install-guide/figures/README.rst | 5 - tox.ini | 2 + 66 files changed, 357 insertions(+), 17 deletions(-) rename {doc/source/install-guide => deploy-guide/source}/app-advanced-config-affinity.rst (100%) rename {doc/source/install-guide => deploy-guide/source}/app-advanced-config-options.rst (100%) rename {doc/source/install-guide => deploy-guide/source}/app-advanced-config-override.rst (100%) rename {doc/source/install-guide => deploy-guide/source}/app-advanced-config-security.rst (100%) rename {doc/source/install-guide => deploy-guide/source}/app-advanced-config-sslcertificates.rst (100%) rename {doc/source/install-guide => deploy-guide/source}/app-advanced-role-docs.rst (100%) rename {doc/source/install-guide => deploy-guide/source}/app-config-prod.rst (92%) rename {doc/source/install-guide => deploy-guide/source}/app-config-test.rst (95%) rename {doc/source/install-guide => deploy-guide/source}/app-custom-layouts.rst (100%) rename {doc/source/install-guide => deploy-guide/source}/app-networking.rst (100%) rename {doc/source/install-guide => deploy-guide/source}/app-resources.rst (100%) rename {doc/source/install-guide => deploy-guide/source}/app-security.rst (100%) rename {doc/source/install-guide => deploy-guide/source}/app.rst (100%) create mode 100644 deploy-guide/source/conf.py rename {doc/source/install-guide => deploy-guide/source}/configure.rst (96%) rename {doc/source/install-guide => deploy-guide/source}/deploymenthost.rst (99%) rename {doc/source/install-guide => deploy-guide/source}/figures/arch-layout-production.png (100%) rename {doc/source/install-guide => deploy-guide/source}/figures/arch-layout-production.svg (100%) rename {doc/source/install-guide => deploy-guide/source}/figures/arch-layout-test.png (100%) rename {doc/source/install-guide => deploy-guide/source}/figures/arch-layout-test.svg (100%) rename {doc/source/install-guide => deploy-guide/source}/figures/arch-layout.graffle (100%) rename {doc/source/install-guide => deploy-guide/source}/figures/installation-workflow-configure-deployment.png (100%) rename {doc/source/install-guide => deploy-guide/source}/figures/installation-workflow-deploymenthost.png (100%) rename {doc/source/install-guide => deploy-guide/source}/figures/installation-workflow-overview.png (100%) rename {doc/source/install-guide => deploy-guide/source}/figures/installation-workflow-run-playbooks.png (100%) rename {doc/source/install-guide => deploy-guide/source}/figures/installation-workflow-targethosts.png (100%) rename {doc/source/install-guide => deploy-guide/source}/figures/installation-workflow-verify-openstack.png (100%) rename {doc/source/install-guide => deploy-guide/source}/figures/installation-workflow.graffle (100%) rename {doc/source/install-guide => deploy-guide/source}/figures/networkarch-bare-external-example.png (100%) rename {doc/source/install-guide => deploy-guide/source}/figures/networkarch-bare-external.png (100%) rename {doc/source/install-guide => deploy-guide/source}/figures/networkarch-container-external-example.png (100%) rename {doc/source/install-guide => deploy-guide/source}/figures/networkarch-container-external.png (100%) rename {doc/source/install-guide => deploy-guide/source}/figures/networkcomponents.png (100%) rename {doc/source/install-guide => deploy-guide/source}/figures/networking-compute.png (100%) rename {doc/source/install-guide => deploy-guide/source}/figures/networking-neutronagents.png (100%) rename {doc/source/install-guide => deploy-guide/source}/figures/production-storage-cinder.png (100%) rename {doc/source/install-guide => deploy-guide/source}/figures/production-storage-cinder.svg/image3.wmf (100%) rename {doc/source/install-guide => deploy-guide/source}/figures/production-storage-cinder.svg/production-storage-cinder.svg (100%) rename {doc/source/install-guide => deploy-guide/source}/figures/production-storage-glance.png (100%) rename {doc/source/install-guide => deploy-guide/source}/figures/production-storage-glance.svg/image3.wmf (100%) rename {doc/source/install-guide => deploy-guide/source}/figures/production-storage-glance.svg/production-storage-glance.svg (100%) rename {doc/source/install-guide => deploy-guide/source}/figures/production-storage-nova.png (100%) rename {doc/source/install-guide => deploy-guide/source}/figures/production-storage-nova.svg/image3.wmf (100%) rename {doc/source/install-guide => deploy-guide/source}/figures/production-storage-nova.svg/production-storage-nova.svg (100%) rename {doc/source/install-guide => deploy-guide/source}/figures/production-storage-swift.png (100%) rename {doc/source/install-guide => deploy-guide/source}/figures/production-storage-swift.svg (100%) rename {doc/source/install-guide => deploy-guide/source}/figures/production-storage.graffle/data.plist (100%) rename {doc/source/install-guide => deploy-guide/source}/figures/production-storage.graffle/image3.wmf (100%) rename {doc/source/install-guide => deploy-guide/source}/figures/production-storage.svg (100%) rename {doc/source/install-guide => deploy-guide/source}/index.rst (87%) rename {doc/source/install-guide => deploy-guide/source}/navigation.txt (100%) rename {doc/source/install-guide => deploy-guide/source}/overview-network-arch.rst (100%) rename {doc/source/install-guide => deploy-guide/source}/overview-osa.rst (100%) rename {doc/source/install-guide => deploy-guide/source}/overview-requirements.rst (100%) rename {doc/source/install-guide => deploy-guide/source}/overview-service-architecture.rst (100%) rename {doc/source/install-guide => deploy-guide/source}/overview-storage-arch.rst (100%) rename {doc/source/install-guide => deploy-guide/source}/overview.rst (100%) rename {doc/source/install-guide => deploy-guide/source}/run-playbooks.rst (100%) rename {doc/source/install-guide => deploy-guide/source}/targethosts-networkconfig.rst (100%) rename {doc/source/install-guide => deploy-guide/source}/targethosts-prepare.rst (100%) rename {doc/source/install-guide => deploy-guide/source}/targethosts.rst (100%) rename {doc/source/install-guide => deploy-guide/source}/verify-operation.rst (100%) delete mode 100644 doc/source/install-guide/figures/README.rst diff --git a/.gitignore b/.gitignore index 99b0ceeb3a..20c2e7b331 100644 --- a/.gitignore +++ b/.gitignore @@ -10,6 +10,7 @@ build/ dist/ doc/build/ +deploy-guide/build/ # Packages # ############ diff --git a/doc/source/install-guide/app-advanced-config-affinity.rst b/deploy-guide/source/app-advanced-config-affinity.rst similarity index 100% rename from doc/source/install-guide/app-advanced-config-affinity.rst rename to deploy-guide/source/app-advanced-config-affinity.rst diff --git a/doc/source/install-guide/app-advanced-config-options.rst b/deploy-guide/source/app-advanced-config-options.rst similarity index 100% rename from doc/source/install-guide/app-advanced-config-options.rst rename to deploy-guide/source/app-advanced-config-options.rst diff --git a/doc/source/install-guide/app-advanced-config-override.rst b/deploy-guide/source/app-advanced-config-override.rst similarity index 100% rename from doc/source/install-guide/app-advanced-config-override.rst rename to deploy-guide/source/app-advanced-config-override.rst diff --git a/doc/source/install-guide/app-advanced-config-security.rst b/deploy-guide/source/app-advanced-config-security.rst similarity index 100% rename from doc/source/install-guide/app-advanced-config-security.rst rename to deploy-guide/source/app-advanced-config-security.rst diff --git a/doc/source/install-guide/app-advanced-config-sslcertificates.rst b/deploy-guide/source/app-advanced-config-sslcertificates.rst similarity index 100% rename from doc/source/install-guide/app-advanced-config-sslcertificates.rst rename to deploy-guide/source/app-advanced-config-sslcertificates.rst diff --git a/doc/source/install-guide/app-advanced-role-docs.rst b/deploy-guide/source/app-advanced-role-docs.rst similarity index 100% rename from doc/source/install-guide/app-advanced-role-docs.rst rename to deploy-guide/source/app-advanced-role-docs.rst diff --git a/doc/source/install-guide/app-config-prod.rst b/deploy-guide/source/app-config-prod.rst similarity index 92% rename from doc/source/install-guide/app-config-prod.rst rename to deploy-guide/source/app-config-prod.rst index 2ed1518609..a60059a53b 100644 --- a/doc/source/install-guide/app-config-prod.rst +++ b/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 diff --git a/doc/source/install-guide/app-config-test.rst b/deploy-guide/source/app-config-test.rst similarity index 95% rename from doc/source/install-guide/app-config-test.rst rename to deploy-guide/source/app-config-test.rst index 961093529b..e9ff5a3e43 100644 --- a/doc/source/install-guide/app-config-test.rst +++ b/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 -------------------------- diff --git a/doc/source/install-guide/app-custom-layouts.rst b/deploy-guide/source/app-custom-layouts.rst similarity index 100% rename from doc/source/install-guide/app-custom-layouts.rst rename to deploy-guide/source/app-custom-layouts.rst diff --git a/doc/source/install-guide/app-networking.rst b/deploy-guide/source/app-networking.rst similarity index 100% rename from doc/source/install-guide/app-networking.rst rename to deploy-guide/source/app-networking.rst diff --git a/doc/source/install-guide/app-resources.rst b/deploy-guide/source/app-resources.rst similarity index 100% rename from doc/source/install-guide/app-resources.rst rename to deploy-guide/source/app-resources.rst diff --git a/doc/source/install-guide/app-security.rst b/deploy-guide/source/app-security.rst similarity index 100% rename from doc/source/install-guide/app-security.rst rename to deploy-guide/source/app-security.rst diff --git a/doc/source/install-guide/app.rst b/deploy-guide/source/app.rst similarity index 100% rename from doc/source/install-guide/app.rst rename to deploy-guide/source/app.rst diff --git a/deploy-guide/source/conf.py b/deploy-guide/source/conf.py new file mode 100644 index 0000000000..d6e7b671be --- /dev/null +++ b/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 +# " v 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 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 diff --git a/doc/source/install-guide/configure.rst b/deploy-guide/source/configure.rst similarity index 96% rename from doc/source/install-guide/configure.rst rename to deploy-guide/source/configure.rst index b5a5bf252c..13bc0e00f3 100644 --- a/doc/source/install-guide/configure.rst +++ b/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 `_. Configuring additional services ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/doc/source/install-guide/deploymenthost.rst b/deploy-guide/source/deploymenthost.rst similarity index 99% rename from doc/source/install-guide/deploymenthost.rst rename to deploy-guide/source/deploymenthost.rst index 580eed821b..fc9db4b8a9 100644 --- a/doc/source/install-guide/deploymenthost.rst +++ b/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) diff --git a/doc/source/install-guide/figures/arch-layout-production.png b/deploy-guide/source/figures/arch-layout-production.png similarity index 100% rename from doc/source/install-guide/figures/arch-layout-production.png rename to deploy-guide/source/figures/arch-layout-production.png diff --git a/doc/source/install-guide/figures/arch-layout-production.svg b/deploy-guide/source/figures/arch-layout-production.svg similarity index 100% rename from doc/source/install-guide/figures/arch-layout-production.svg rename to deploy-guide/source/figures/arch-layout-production.svg diff --git a/doc/source/install-guide/figures/arch-layout-test.png b/deploy-guide/source/figures/arch-layout-test.png similarity index 100% rename from doc/source/install-guide/figures/arch-layout-test.png rename to deploy-guide/source/figures/arch-layout-test.png diff --git a/doc/source/install-guide/figures/arch-layout-test.svg b/deploy-guide/source/figures/arch-layout-test.svg similarity index 100% rename from doc/source/install-guide/figures/arch-layout-test.svg rename to deploy-guide/source/figures/arch-layout-test.svg diff --git a/doc/source/install-guide/figures/arch-layout.graffle b/deploy-guide/source/figures/arch-layout.graffle similarity index 100% rename from doc/source/install-guide/figures/arch-layout.graffle rename to deploy-guide/source/figures/arch-layout.graffle diff --git a/doc/source/install-guide/figures/installation-workflow-configure-deployment.png b/deploy-guide/source/figures/installation-workflow-configure-deployment.png similarity index 100% rename from doc/source/install-guide/figures/installation-workflow-configure-deployment.png rename to deploy-guide/source/figures/installation-workflow-configure-deployment.png diff --git a/doc/source/install-guide/figures/installation-workflow-deploymenthost.png b/deploy-guide/source/figures/installation-workflow-deploymenthost.png similarity index 100% rename from doc/source/install-guide/figures/installation-workflow-deploymenthost.png rename to deploy-guide/source/figures/installation-workflow-deploymenthost.png diff --git a/doc/source/install-guide/figures/installation-workflow-overview.png b/deploy-guide/source/figures/installation-workflow-overview.png similarity index 100% rename from doc/source/install-guide/figures/installation-workflow-overview.png rename to deploy-guide/source/figures/installation-workflow-overview.png diff --git a/doc/source/install-guide/figures/installation-workflow-run-playbooks.png b/deploy-guide/source/figures/installation-workflow-run-playbooks.png similarity index 100% rename from doc/source/install-guide/figures/installation-workflow-run-playbooks.png rename to deploy-guide/source/figures/installation-workflow-run-playbooks.png diff --git a/doc/source/install-guide/figures/installation-workflow-targethosts.png b/deploy-guide/source/figures/installation-workflow-targethosts.png similarity index 100% rename from doc/source/install-guide/figures/installation-workflow-targethosts.png rename to deploy-guide/source/figures/installation-workflow-targethosts.png diff --git a/doc/source/install-guide/figures/installation-workflow-verify-openstack.png b/deploy-guide/source/figures/installation-workflow-verify-openstack.png similarity index 100% rename from doc/source/install-guide/figures/installation-workflow-verify-openstack.png rename to deploy-guide/source/figures/installation-workflow-verify-openstack.png diff --git a/doc/source/install-guide/figures/installation-workflow.graffle b/deploy-guide/source/figures/installation-workflow.graffle similarity index 100% rename from doc/source/install-guide/figures/installation-workflow.graffle rename to deploy-guide/source/figures/installation-workflow.graffle diff --git a/doc/source/install-guide/figures/networkarch-bare-external-example.png b/deploy-guide/source/figures/networkarch-bare-external-example.png similarity index 100% rename from doc/source/install-guide/figures/networkarch-bare-external-example.png rename to deploy-guide/source/figures/networkarch-bare-external-example.png diff --git a/doc/source/install-guide/figures/networkarch-bare-external.png b/deploy-guide/source/figures/networkarch-bare-external.png similarity index 100% rename from doc/source/install-guide/figures/networkarch-bare-external.png rename to deploy-guide/source/figures/networkarch-bare-external.png diff --git a/doc/source/install-guide/figures/networkarch-container-external-example.png b/deploy-guide/source/figures/networkarch-container-external-example.png similarity index 100% rename from doc/source/install-guide/figures/networkarch-container-external-example.png rename to deploy-guide/source/figures/networkarch-container-external-example.png diff --git a/doc/source/install-guide/figures/networkarch-container-external.png b/deploy-guide/source/figures/networkarch-container-external.png similarity index 100% rename from doc/source/install-guide/figures/networkarch-container-external.png rename to deploy-guide/source/figures/networkarch-container-external.png diff --git a/doc/source/install-guide/figures/networkcomponents.png b/deploy-guide/source/figures/networkcomponents.png similarity index 100% rename from doc/source/install-guide/figures/networkcomponents.png rename to deploy-guide/source/figures/networkcomponents.png diff --git a/doc/source/install-guide/figures/networking-compute.png b/deploy-guide/source/figures/networking-compute.png similarity index 100% rename from doc/source/install-guide/figures/networking-compute.png rename to deploy-guide/source/figures/networking-compute.png diff --git a/doc/source/install-guide/figures/networking-neutronagents.png b/deploy-guide/source/figures/networking-neutronagents.png similarity index 100% rename from doc/source/install-guide/figures/networking-neutronagents.png rename to deploy-guide/source/figures/networking-neutronagents.png diff --git a/doc/source/install-guide/figures/production-storage-cinder.png b/deploy-guide/source/figures/production-storage-cinder.png similarity index 100% rename from doc/source/install-guide/figures/production-storage-cinder.png rename to deploy-guide/source/figures/production-storage-cinder.png diff --git a/doc/source/install-guide/figures/production-storage-cinder.svg/image3.wmf b/deploy-guide/source/figures/production-storage-cinder.svg/image3.wmf similarity index 100% rename from doc/source/install-guide/figures/production-storage-cinder.svg/image3.wmf rename to deploy-guide/source/figures/production-storage-cinder.svg/image3.wmf diff --git a/doc/source/install-guide/figures/production-storage-cinder.svg/production-storage-cinder.svg b/deploy-guide/source/figures/production-storage-cinder.svg/production-storage-cinder.svg similarity index 100% rename from doc/source/install-guide/figures/production-storage-cinder.svg/production-storage-cinder.svg rename to deploy-guide/source/figures/production-storage-cinder.svg/production-storage-cinder.svg diff --git a/doc/source/install-guide/figures/production-storage-glance.png b/deploy-guide/source/figures/production-storage-glance.png similarity index 100% rename from doc/source/install-guide/figures/production-storage-glance.png rename to deploy-guide/source/figures/production-storage-glance.png diff --git a/doc/source/install-guide/figures/production-storage-glance.svg/image3.wmf b/deploy-guide/source/figures/production-storage-glance.svg/image3.wmf similarity index 100% rename from doc/source/install-guide/figures/production-storage-glance.svg/image3.wmf rename to deploy-guide/source/figures/production-storage-glance.svg/image3.wmf diff --git a/doc/source/install-guide/figures/production-storage-glance.svg/production-storage-glance.svg b/deploy-guide/source/figures/production-storage-glance.svg/production-storage-glance.svg similarity index 100% rename from doc/source/install-guide/figures/production-storage-glance.svg/production-storage-glance.svg rename to deploy-guide/source/figures/production-storage-glance.svg/production-storage-glance.svg diff --git a/doc/source/install-guide/figures/production-storage-nova.png b/deploy-guide/source/figures/production-storage-nova.png similarity index 100% rename from doc/source/install-guide/figures/production-storage-nova.png rename to deploy-guide/source/figures/production-storage-nova.png diff --git a/doc/source/install-guide/figures/production-storage-nova.svg/image3.wmf b/deploy-guide/source/figures/production-storage-nova.svg/image3.wmf similarity index 100% rename from doc/source/install-guide/figures/production-storage-nova.svg/image3.wmf rename to deploy-guide/source/figures/production-storage-nova.svg/image3.wmf diff --git a/doc/source/install-guide/figures/production-storage-nova.svg/production-storage-nova.svg b/deploy-guide/source/figures/production-storage-nova.svg/production-storage-nova.svg similarity index 100% rename from doc/source/install-guide/figures/production-storage-nova.svg/production-storage-nova.svg rename to deploy-guide/source/figures/production-storage-nova.svg/production-storage-nova.svg diff --git a/doc/source/install-guide/figures/production-storage-swift.png b/deploy-guide/source/figures/production-storage-swift.png similarity index 100% rename from doc/source/install-guide/figures/production-storage-swift.png rename to deploy-guide/source/figures/production-storage-swift.png diff --git a/doc/source/install-guide/figures/production-storage-swift.svg b/deploy-guide/source/figures/production-storage-swift.svg similarity index 100% rename from doc/source/install-guide/figures/production-storage-swift.svg rename to deploy-guide/source/figures/production-storage-swift.svg diff --git a/doc/source/install-guide/figures/production-storage.graffle/data.plist b/deploy-guide/source/figures/production-storage.graffle/data.plist similarity index 100% rename from doc/source/install-guide/figures/production-storage.graffle/data.plist rename to deploy-guide/source/figures/production-storage.graffle/data.plist diff --git a/doc/source/install-guide/figures/production-storage.graffle/image3.wmf b/deploy-guide/source/figures/production-storage.graffle/image3.wmf similarity index 100% rename from doc/source/install-guide/figures/production-storage.graffle/image3.wmf rename to deploy-guide/source/figures/production-storage.graffle/image3.wmf diff --git a/doc/source/install-guide/figures/production-storage.svg b/deploy-guide/source/figures/production-storage.svg similarity index 100% rename from doc/source/install-guide/figures/production-storage.svg rename to deploy-guide/source/figures/production-storage.svg diff --git a/doc/source/install-guide/index.rst b/deploy-guide/source/index.rst similarity index 87% rename from doc/source/install-guide/index.rst rename to deploy-guide/source/index.rst index 7562880817..1422096353 100644 --- a/doc/source/install-guide/index.rst +++ b/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 diff --git a/doc/source/install-guide/navigation.txt b/deploy-guide/source/navigation.txt similarity index 100% rename from doc/source/install-guide/navigation.txt rename to deploy-guide/source/navigation.txt diff --git a/doc/source/install-guide/overview-network-arch.rst b/deploy-guide/source/overview-network-arch.rst similarity index 100% rename from doc/source/install-guide/overview-network-arch.rst rename to deploy-guide/source/overview-network-arch.rst diff --git a/doc/source/install-guide/overview-osa.rst b/deploy-guide/source/overview-osa.rst similarity index 100% rename from doc/source/install-guide/overview-osa.rst rename to deploy-guide/source/overview-osa.rst diff --git a/doc/source/install-guide/overview-requirements.rst b/deploy-guide/source/overview-requirements.rst similarity index 100% rename from doc/source/install-guide/overview-requirements.rst rename to deploy-guide/source/overview-requirements.rst diff --git a/doc/source/install-guide/overview-service-architecture.rst b/deploy-guide/source/overview-service-architecture.rst similarity index 100% rename from doc/source/install-guide/overview-service-architecture.rst rename to deploy-guide/source/overview-service-architecture.rst diff --git a/doc/source/install-guide/overview-storage-arch.rst b/deploy-guide/source/overview-storage-arch.rst similarity index 100% rename from doc/source/install-guide/overview-storage-arch.rst rename to deploy-guide/source/overview-storage-arch.rst diff --git a/doc/source/install-guide/overview.rst b/deploy-guide/source/overview.rst similarity index 100% rename from doc/source/install-guide/overview.rst rename to deploy-guide/source/overview.rst diff --git a/doc/source/install-guide/run-playbooks.rst b/deploy-guide/source/run-playbooks.rst similarity index 100% rename from doc/source/install-guide/run-playbooks.rst rename to deploy-guide/source/run-playbooks.rst diff --git a/doc/source/install-guide/targethosts-networkconfig.rst b/deploy-guide/source/targethosts-networkconfig.rst similarity index 100% rename from doc/source/install-guide/targethosts-networkconfig.rst rename to deploy-guide/source/targethosts-networkconfig.rst diff --git a/doc/source/install-guide/targethosts-prepare.rst b/deploy-guide/source/targethosts-prepare.rst similarity index 100% rename from doc/source/install-guide/targethosts-prepare.rst rename to deploy-guide/source/targethosts-prepare.rst diff --git a/doc/source/install-guide/targethosts.rst b/deploy-guide/source/targethosts.rst similarity index 100% rename from doc/source/install-guide/targethosts.rst rename to deploy-guide/source/targethosts.rst diff --git a/doc/source/install-guide/verify-operation.rst b/deploy-guide/source/verify-operation.rst similarity index 100% rename from doc/source/install-guide/verify-operation.rst rename to deploy-guide/source/verify-operation.rst diff --git a/doc/source/index.rst b/doc/source/index.rst index 55312da149..b53c09d426 100644 --- a/doc/source/index.rst +++ b/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 diff --git a/doc/source/install-guide/figures/README.rst b/doc/source/install-guide/figures/README.rst deleted file mode 100644 index 71043f103f..0000000000 --- a/doc/source/install-guide/figures/README.rst +++ /dev/null @@ -1,5 +0,0 @@ -Figures -####### - -Figures in this directory are created using `Omnigraffle `_. -For each image, the source .graffle file, svg, and png formats are provided. diff --git a/tox.ini b/tox.ini index 27d61544b9..909e2ee86f 100644 --- a/tox.ini +++ b/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: