[arch-design] Publish draft Arch Guide to docs.openstack.org
1. Unpublish the current arch-design and temporarily relocate it to a "to archive" directory until the archiving structure is available 2. Publish the arch-design-draft to docs.openstack.org 3. Unpublish arch-design-draft from https://docs.openstack.org/draft/ Change-Id: Ida5f237d2edce7a83a24c376c355e2c220bc8c28 Implements: blueprint arch-design-pike
@ -55,6 +55,6 @@ declare -A SPECIAL_BOOKS=(
|
||||
["config-reference"]="skip"
|
||||
["contributor-guide"]="skip"
|
||||
["releasenotes"]="skip"
|
||||
# Skip arch design while its being revised
|
||||
["arch-design-draft"]="skip"
|
||||
# Skip old arch design, will be archived
|
||||
["arch-design-to-archive"]="skip"
|
||||
)
|
||||
|
@ -1,56 +0,0 @@
|
||||
.. meta::
|
||||
:description: This guide targets OpenStack Architects
|
||||
for architectural design
|
||||
:keywords: Architecture, OpenStack
|
||||
|
||||
===========================================
|
||||
OpenStack Architecture Design Guide - Draft
|
||||
===========================================
|
||||
|
||||
.. note::
|
||||
|
||||
Architecture Design Guide is under development at the moment.
|
||||
Contributions are welcome.
|
||||
|
||||
Abstract
|
||||
~~~~~~~~
|
||||
|
||||
This guide provides information on planning and designing an OpenStack
|
||||
cloud. It describes common use cases, high availability, and considerations
|
||||
when changing capacity and scaling your cloud environment. A breakdown of the
|
||||
major OpenStack components is also described in relation to cloud architecture
|
||||
design.
|
||||
|
||||
Contents
|
||||
~~~~~~~~
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
common/conventions.rst
|
||||
overview.rst
|
||||
use-cases.rst
|
||||
high-availability.rst
|
||||
capacity-planning-scaling.rst
|
||||
design.rst
|
||||
|
||||
Appendix
|
||||
~~~~~~~~
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
common/app-support.rst
|
||||
|
||||
Glossary
|
||||
~~~~~~~~
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
common/glossary.rst
|
||||
|
||||
Search in this guide
|
||||
~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
* :ref:`search`
|
@ -54,7 +54,7 @@ master_doc = 'index'
|
||||
|
||||
# General information about the project.
|
||||
project = u'Architecture Design Guide'
|
||||
bug_tag = u'arch-design-draft'
|
||||
bug_tag = u'arch-design-to-archive'
|
||||
copyright = u'2015-2016, OpenStack contributors'
|
||||
|
||||
# The version info for the project you're documenting, acts as replacement for
|
||||
@ -71,7 +71,7 @@ release = '0.9'
|
||||
# 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 = u'https://git.openstack.org/cgit/openstack/openstack-manuals/tree/doc/arch-design-draft/source'
|
||||
giturl = u'https://git.openstack.org/cgit/openstack/openstack-manuals/tree/doc/arch-design-rst/source'
|
||||
git_cmd = "/usr/bin/git log | head -n1 | cut -f2 -d' '"
|
||||
gitsha = os.popen(git_cmd).read().strip('\n')
|
||||
html_context = {"gitsha": gitsha, "bug_tag": bug_tag,
|
||||
@ -201,7 +201,7 @@ html_show_sourcelink = False
|
||||
# html_file_suffix = None
|
||||
|
||||
# Output file base name for HTML help builder.
|
||||
htmlhelp_basename = 'arch-design-draft'
|
||||
htmlhelp_basename = 'arch-design-to-archive'
|
||||
|
||||
# If true, publish source files
|
||||
html_copy_source = False
|
Before Width: | Height: | Size: 52 KiB After Width: | Height: | Size: 52 KiB |
Before Width: | Height: | Size: 39 KiB After Width: | Height: | Size: 39 KiB |
Before Width: | Height: | Size: 35 KiB After Width: | Height: | Size: 35 KiB |
Before Width: | Height: | Size: 79 KiB After Width: | Height: | Size: 79 KiB |
Before Width: | Height: | Size: 70 KiB After Width: | Height: | Size: 70 KiB |
Before Width: | Height: | Size: 24 KiB After Width: | Height: | Size: 24 KiB |
Before Width: | Height: | Size: 42 KiB After Width: | Height: | Size: 42 KiB |
Before Width: | Height: | Size: 59 KiB After Width: | Height: | Size: 59 KiB |
Before Width: | Height: | Size: 54 KiB After Width: | Height: | Size: 54 KiB |
Before Width: | Height: | Size: 54 KiB After Width: | Height: | Size: 54 KiB |
Before Width: | Height: | Size: 68 KiB After Width: | Height: | Size: 68 KiB |
Before Width: | Height: | Size: 50 KiB After Width: | Height: | Size: 50 KiB |
Before Width: | Height: | Size: 52 KiB After Width: | Height: | Size: 52 KiB |
Before Width: | Height: | Size: 75 KiB After Width: | Height: | Size: 75 KiB |
Before Width: | Height: | Size: 37 KiB After Width: | Height: | Size: 37 KiB |
Before Width: | Height: | Size: 56 KiB After Width: | Height: | Size: 56 KiB |
Before Width: | Height: | Size: 46 KiB After Width: | Height: | Size: 46 KiB |
Before Width: | Height: | Size: 56 KiB After Width: | Height: | Size: 56 KiB |
Before Width: | Height: | Size: 30 KiB After Width: | Height: | Size: 30 KiB |
Before Width: | Height: | Size: 22 KiB After Width: | Height: | Size: 22 KiB |
Before Width: | Height: | Size: 25 KiB After Width: | Height: | Size: 25 KiB |
Before Width: | Height: | Size: 50 KiB After Width: | Height: | Size: 50 KiB |
Before Width: | Height: | Size: 50 KiB After Width: | Height: | Size: 50 KiB |
Before Width: | Height: | Size: 35 KiB After Width: | Height: | Size: 35 KiB |
56
doc/arch-design-to-archive/source/index.rst
Normal file
@ -0,0 +1,56 @@
|
||||
.. meta::
|
||||
:description: This guide targets OpenStack Architects
|
||||
for architectural design
|
||||
:keywords: Architecture, OpenStack
|
||||
|
||||
===================================
|
||||
OpenStack Architecture Design Guide
|
||||
===================================
|
||||
|
||||
Abstract
|
||||
~~~~~~~~
|
||||
|
||||
To reap the benefits of OpenStack, you should plan, design,
|
||||
and architect your cloud properly, taking user's needs into
|
||||
account and understanding the use cases.
|
||||
|
||||
Contents
|
||||
~~~~~~~~
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
common/conventions.rst
|
||||
introduction.rst
|
||||
legal-security-requirements.rst
|
||||
generalpurpose.rst
|
||||
compute-focus.rst
|
||||
storage-focus.rst
|
||||
network-focus.rst
|
||||
multi-site.rst
|
||||
hybrid.rst
|
||||
massively-scalable.rst
|
||||
specialized.rst
|
||||
references.rst
|
||||
|
||||
Appendix
|
||||
~~~~~~~~
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
common/app-support.rst
|
||||
|
||||
Glossary
|
||||
~~~~~~~~
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
common/glossary.rst
|
||||
|
||||
Search in this guide
|
||||
~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
* :ref:`search`
|
||||
|
@ -55,7 +55,7 @@ master_doc = 'index'
|
||||
# General information about the project.
|
||||
project = u'Architecture Design Guide'
|
||||
bug_tag = u'arch-design'
|
||||
copyright = u'2015-2016, OpenStack contributors'
|
||||
copyright = u'2015-2017, OpenStack contributors'
|
||||
|
||||
# The version info for the project you're documenting, acts as replacement for
|
||||
# |version| and |release|, also used in various other places throughout the
|
||||
@ -71,7 +71,7 @@ release = '0.9'
|
||||
# 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 = u'https://git.openstack.org/cgit/openstack/openstack-manuals/tree/doc/arch-design-rst/source'
|
||||
giturl = u'https://git.openstack.org/cgit/openstack/openstack-manuals/tree/doc/arch-design/source'
|
||||
git_cmd = "/usr/bin/git log | head -n1 | cut -f2 -d' '"
|
||||
gitsha = os.popen(git_cmd).read().strip('\n')
|
||||
html_context = {"gitsha": gitsha, "bug_tag": bug_tag,
|
||||
@ -201,7 +201,7 @@ html_show_sourcelink = False
|
||||
# html_file_suffix = None
|
||||
|
||||
# Output file base name for HTML help builder.
|
||||
htmlhelp_basename = 'arch-design-rst'
|
||||
htmlhelp_basename = 'arch-design'
|
||||
|
||||
# If true, publish source files
|
||||
html_copy_source = False
|
||||
|
@ -24,7 +24,7 @@ Elastic Stack consists of mainly three components: Elasticsearch (log search
|
||||
and analysis), Logstash (log intake, processing and output) and Kibana (log
|
||||
dashboard service).
|
||||
|
||||
.. image:: ../figures/ELKbasicArch.svg
|
||||
.. figure:: ../figures/ELKbasicArch.png
|
||||
:align: center
|
||||
:alt: Elastic Search Basic Architecture
|
||||
|