diff --git a/doc-tools-check-languages.conf b/doc-tools-check-languages.conf index abd119ca94..9a25534d4e 100644 --- a/doc-tools-check-languages.conf +++ b/doc-tools-check-languages.conf @@ -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" ) diff --git a/doc/arch-design-draft/source/index.rst b/doc/arch-design-draft/source/index.rst deleted file mode 100644 index c4701aa6b0..0000000000 --- a/doc/arch-design-draft/source/index.rst +++ /dev/null @@ -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` diff --git a/doc/arch-design-draft/setup.cfg b/doc/arch-design-to-archive/setup.cfg similarity index 100% rename from doc/arch-design-draft/setup.cfg rename to doc/arch-design-to-archive/setup.cfg diff --git a/doc/arch-design-draft/setup.py b/doc/arch-design-to-archive/setup.py similarity index 100% rename from doc/arch-design-draft/setup.py rename to doc/arch-design-to-archive/setup.py diff --git a/doc/arch-design-draft/source/common b/doc/arch-design-to-archive/source/common similarity index 100% rename from doc/arch-design-draft/source/common rename to doc/arch-design-to-archive/source/common diff --git a/doc/arch-design/source/compute-focus-architecture.rst b/doc/arch-design-to-archive/source/compute-focus-architecture.rst similarity index 100% rename from doc/arch-design/source/compute-focus-architecture.rst rename to doc/arch-design-to-archive/source/compute-focus-architecture.rst diff --git a/doc/arch-design/source/compute-focus-operational-considerations.rst b/doc/arch-design-to-archive/source/compute-focus-operational-considerations.rst similarity index 100% rename from doc/arch-design/source/compute-focus-operational-considerations.rst rename to doc/arch-design-to-archive/source/compute-focus-operational-considerations.rst diff --git a/doc/arch-design/source/compute-focus-prescriptive-examples.rst b/doc/arch-design-to-archive/source/compute-focus-prescriptive-examples.rst similarity index 100% rename from doc/arch-design/source/compute-focus-prescriptive-examples.rst rename to doc/arch-design-to-archive/source/compute-focus-prescriptive-examples.rst diff --git a/doc/arch-design/source/compute-focus-technical-considerations.rst b/doc/arch-design-to-archive/source/compute-focus-technical-considerations.rst similarity index 100% rename from doc/arch-design/source/compute-focus-technical-considerations.rst rename to doc/arch-design-to-archive/source/compute-focus-technical-considerations.rst diff --git a/doc/arch-design/source/compute-focus.rst b/doc/arch-design-to-archive/source/compute-focus.rst similarity index 100% rename from doc/arch-design/source/compute-focus.rst rename to doc/arch-design-to-archive/source/compute-focus.rst diff --git a/doc/arch-design-draft/source/conf.py b/doc/arch-design-to-archive/source/conf.py similarity index 98% rename from doc/arch-design-draft/source/conf.py rename to doc/arch-design-to-archive/source/conf.py index e2393c066f..5ccc3bf232 100644 --- a/doc/arch-design-draft/source/conf.py +++ b/doc/arch-design-to-archive/source/conf.py @@ -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 diff --git a/doc/arch-design-draft/source/figures/Compute_NSX.png b/doc/arch-design-to-archive/source/figures/Compute_NSX.png similarity index 100% rename from doc/arch-design-draft/source/figures/Compute_NSX.png rename to doc/arch-design-to-archive/source/figures/Compute_NSX.png diff --git a/doc/arch-design-draft/source/figures/Compute_Tech_Bin_Packing_CPU_optimized1.png b/doc/arch-design-to-archive/source/figures/Compute_Tech_Bin_Packing_CPU_optimized1.png similarity index 100% rename from doc/arch-design-draft/source/figures/Compute_Tech_Bin_Packing_CPU_optimized1.png rename to doc/arch-design-to-archive/source/figures/Compute_Tech_Bin_Packing_CPU_optimized1.png diff --git a/doc/arch-design-draft/source/figures/Compute_Tech_Bin_Packing_General1.png b/doc/arch-design-to-archive/source/figures/Compute_Tech_Bin_Packing_General1.png similarity index 100% rename from doc/arch-design-draft/source/figures/Compute_Tech_Bin_Packing_General1.png rename to doc/arch-design-to-archive/source/figures/Compute_Tech_Bin_Packing_General1.png diff --git a/doc/arch-design-draft/source/figures/General_Architecture3.png b/doc/arch-design-to-archive/source/figures/General_Architecture3.png similarity index 100% rename from doc/arch-design-draft/source/figures/General_Architecture3.png rename to doc/arch-design-to-archive/source/figures/General_Architecture3.png diff --git a/doc/arch-design-draft/source/figures/Generic_CERN_Architecture.png b/doc/arch-design-to-archive/source/figures/Generic_CERN_Architecture.png similarity index 100% rename from doc/arch-design-draft/source/figures/Generic_CERN_Architecture.png rename to doc/arch-design-to-archive/source/figures/Generic_CERN_Architecture.png diff --git a/doc/arch-design-draft/source/figures/Generic_CERN_Example.png b/doc/arch-design-to-archive/source/figures/Generic_CERN_Example.png similarity index 100% rename from doc/arch-design-draft/source/figures/Generic_CERN_Example.png rename to doc/arch-design-to-archive/source/figures/Generic_CERN_Example.png diff --git a/doc/arch-design-draft/source/figures/Massively_Scalable_Cells_regions_azs.png b/doc/arch-design-to-archive/source/figures/Massively_Scalable_Cells_regions_azs.png similarity index 100% rename from doc/arch-design-draft/source/figures/Massively_Scalable_Cells_regions_azs.png rename to doc/arch-design-to-archive/source/figures/Massively_Scalable_Cells_regions_azs.png diff --git a/doc/arch-design-draft/source/figures/Multi-Cloud_Priv-AWS4.png b/doc/arch-design-to-archive/source/figures/Multi-Cloud_Priv-AWS4.png similarity index 100% rename from doc/arch-design-draft/source/figures/Multi-Cloud_Priv-AWS4.png rename to doc/arch-design-to-archive/source/figures/Multi-Cloud_Priv-AWS4.png diff --git a/doc/arch-design-draft/source/figures/Multi-Cloud_Priv-Pub3.png b/doc/arch-design-to-archive/source/figures/Multi-Cloud_Priv-Pub3.png similarity index 100% rename from doc/arch-design-draft/source/figures/Multi-Cloud_Priv-Pub3.png rename to doc/arch-design-to-archive/source/figures/Multi-Cloud_Priv-Pub3.png diff --git a/doc/arch-design-draft/source/figures/Multi-Cloud_failover2.png b/doc/arch-design-to-archive/source/figures/Multi-Cloud_failover2.png similarity index 100% rename from doc/arch-design-draft/source/figures/Multi-Cloud_failover2.png rename to doc/arch-design-to-archive/source/figures/Multi-Cloud_failover2.png diff --git a/doc/arch-design-draft/source/figures/Multi-Site_Customer_Edge.png b/doc/arch-design-to-archive/source/figures/Multi-Site_Customer_Edge.png similarity index 100% rename from doc/arch-design-draft/source/figures/Multi-Site_Customer_Edge.png rename to doc/arch-design-to-archive/source/figures/Multi-Site_Customer_Edge.png diff --git a/doc/arch-design-draft/source/figures/Multi-Site_shared_keystone1.png b/doc/arch-design-to-archive/source/figures/Multi-Site_shared_keystone1.png similarity index 100% rename from doc/arch-design-draft/source/figures/Multi-Site_shared_keystone1.png rename to doc/arch-design-to-archive/source/figures/Multi-Site_shared_keystone1.png diff --git a/doc/arch-design-draft/source/figures/Multi-Site_shared_keystone_horizon_swift1.png b/doc/arch-design-to-archive/source/figures/Multi-Site_shared_keystone_horizon_swift1.png similarity index 100% rename from doc/arch-design-draft/source/figures/Multi-Site_shared_keystone_horizon_swift1.png rename to doc/arch-design-to-archive/source/figures/Multi-Site_shared_keystone_horizon_swift1.png diff --git a/doc/arch-design-draft/source/figures/Multi-site_Geo_Redundant_LB.png b/doc/arch-design-to-archive/source/figures/Multi-site_Geo_Redundant_LB.png similarity index 100% rename from doc/arch-design-draft/source/figures/Multi-site_Geo_Redundant_LB.png rename to doc/arch-design-to-archive/source/figures/Multi-site_Geo_Redundant_LB.png diff --git a/doc/arch-design-draft/source/figures/Network_Cloud_Storage2.png b/doc/arch-design-to-archive/source/figures/Network_Cloud_Storage2.png similarity index 100% rename from doc/arch-design-draft/source/figures/Network_Cloud_Storage2.png rename to doc/arch-design-to-archive/source/figures/Network_Cloud_Storage2.png diff --git a/doc/arch-design-draft/source/figures/Network_Web_Services1.png b/doc/arch-design-to-archive/source/figures/Network_Web_Services1.png similarity index 100% rename from doc/arch-design-draft/source/figures/Network_Web_Services1.png rename to doc/arch-design-to-archive/source/figures/Network_Web_Services1.png diff --git a/doc/arch-design-draft/source/figures/Specialized_Hardware2.png b/doc/arch-design-to-archive/source/figures/Specialized_Hardware2.png similarity index 100% rename from doc/arch-design-draft/source/figures/Specialized_Hardware2.png rename to doc/arch-design-to-archive/source/figures/Specialized_Hardware2.png diff --git a/doc/arch-design-draft/source/figures/Specialized_OOO.png b/doc/arch-design-to-archive/source/figures/Specialized_OOO.png similarity index 100% rename from doc/arch-design-draft/source/figures/Specialized_OOO.png rename to doc/arch-design-to-archive/source/figures/Specialized_OOO.png diff --git a/doc/arch-design-draft/source/figures/Specialized_SDN_external.png b/doc/arch-design-to-archive/source/figures/Specialized_SDN_external.png similarity index 100% rename from doc/arch-design-draft/source/figures/Specialized_SDN_external.png rename to doc/arch-design-to-archive/source/figures/Specialized_SDN_external.png diff --git a/doc/arch-design-draft/source/figures/Specialized_SDN_hosted.png b/doc/arch-design-to-archive/source/figures/Specialized_SDN_hosted.png similarity index 100% rename from doc/arch-design-draft/source/figures/Specialized_SDN_hosted.png rename to doc/arch-design-to-archive/source/figures/Specialized_SDN_hosted.png diff --git a/doc/arch-design-draft/source/figures/Specialized_VDI1.png b/doc/arch-design-to-archive/source/figures/Specialized_VDI1.png similarity index 100% rename from doc/arch-design-draft/source/figures/Specialized_VDI1.png rename to doc/arch-design-to-archive/source/figures/Specialized_VDI1.png diff --git a/doc/arch-design-draft/source/figures/Storage_Database_+_Object5.png b/doc/arch-design-to-archive/source/figures/Storage_Database_+_Object5.png similarity index 100% rename from doc/arch-design-draft/source/figures/Storage_Database_+_Object5.png rename to doc/arch-design-to-archive/source/figures/Storage_Database_+_Object5.png diff --git a/doc/arch-design-draft/source/figures/Storage_Hadoop3.png b/doc/arch-design-to-archive/source/figures/Storage_Hadoop3.png similarity index 100% rename from doc/arch-design-draft/source/figures/Storage_Hadoop3.png rename to doc/arch-design-to-archive/source/figures/Storage_Hadoop3.png diff --git a/doc/arch-design-draft/source/figures/Storage_Object.png b/doc/arch-design-to-archive/source/figures/Storage_Object.png similarity index 100% rename from doc/arch-design-draft/source/figures/Storage_Object.png rename to doc/arch-design-to-archive/source/figures/Storage_Object.png diff --git a/doc/arch-design/source/generalpurpose-architecture.rst b/doc/arch-design-to-archive/source/generalpurpose-architecture.rst similarity index 100% rename from doc/arch-design/source/generalpurpose-architecture.rst rename to doc/arch-design-to-archive/source/generalpurpose-architecture.rst diff --git a/doc/arch-design/source/generalpurpose-operational-considerations.rst b/doc/arch-design-to-archive/source/generalpurpose-operational-considerations.rst similarity index 100% rename from doc/arch-design/source/generalpurpose-operational-considerations.rst rename to doc/arch-design-to-archive/source/generalpurpose-operational-considerations.rst diff --git a/doc/arch-design/source/generalpurpose-prescriptive-example.rst b/doc/arch-design-to-archive/source/generalpurpose-prescriptive-example.rst similarity index 100% rename from doc/arch-design/source/generalpurpose-prescriptive-example.rst rename to doc/arch-design-to-archive/source/generalpurpose-prescriptive-example.rst diff --git a/doc/arch-design/source/generalpurpose-technical-considerations.rst b/doc/arch-design-to-archive/source/generalpurpose-technical-considerations.rst similarity index 100% rename from doc/arch-design/source/generalpurpose-technical-considerations.rst rename to doc/arch-design-to-archive/source/generalpurpose-technical-considerations.rst diff --git a/doc/arch-design/source/generalpurpose-user-requirements.rst b/doc/arch-design-to-archive/source/generalpurpose-user-requirements.rst similarity index 100% rename from doc/arch-design/source/generalpurpose-user-requirements.rst rename to doc/arch-design-to-archive/source/generalpurpose-user-requirements.rst diff --git a/doc/arch-design/source/generalpurpose.rst b/doc/arch-design-to-archive/source/generalpurpose.rst similarity index 100% rename from doc/arch-design/source/generalpurpose.rst rename to doc/arch-design-to-archive/source/generalpurpose.rst diff --git a/doc/arch-design/source/hybrid-architecture.rst b/doc/arch-design-to-archive/source/hybrid-architecture.rst similarity index 100% rename from doc/arch-design/source/hybrid-architecture.rst rename to doc/arch-design-to-archive/source/hybrid-architecture.rst diff --git a/doc/arch-design/source/hybrid-operational-considerations.rst b/doc/arch-design-to-archive/source/hybrid-operational-considerations.rst similarity index 100% rename from doc/arch-design/source/hybrid-operational-considerations.rst rename to doc/arch-design-to-archive/source/hybrid-operational-considerations.rst diff --git a/doc/arch-design/source/hybrid-prescriptive-examples.rst b/doc/arch-design-to-archive/source/hybrid-prescriptive-examples.rst similarity index 100% rename from doc/arch-design/source/hybrid-prescriptive-examples.rst rename to doc/arch-design-to-archive/source/hybrid-prescriptive-examples.rst diff --git a/doc/arch-design/source/hybrid-technical-considerations.rst b/doc/arch-design-to-archive/source/hybrid-technical-considerations.rst similarity index 100% rename from doc/arch-design/source/hybrid-technical-considerations.rst rename to doc/arch-design-to-archive/source/hybrid-technical-considerations.rst diff --git a/doc/arch-design/source/hybrid-user-requirements.rst b/doc/arch-design-to-archive/source/hybrid-user-requirements.rst similarity index 100% rename from doc/arch-design/source/hybrid-user-requirements.rst rename to doc/arch-design-to-archive/source/hybrid-user-requirements.rst diff --git a/doc/arch-design/source/hybrid.rst b/doc/arch-design-to-archive/source/hybrid.rst similarity index 100% rename from doc/arch-design/source/hybrid.rst rename to doc/arch-design-to-archive/source/hybrid.rst diff --git a/doc/arch-design-to-archive/source/index.rst b/doc/arch-design-to-archive/source/index.rst new file mode 100644 index 0000000000..c1dcb622bd --- /dev/null +++ b/doc/arch-design-to-archive/source/index.rst @@ -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` + diff --git a/doc/arch-design/source/introduction-how-this-book-is-organized.rst b/doc/arch-design-to-archive/source/introduction-how-this-book-is-organized.rst similarity index 100% rename from doc/arch-design/source/introduction-how-this-book-is-organized.rst rename to doc/arch-design-to-archive/source/introduction-how-this-book-is-organized.rst diff --git a/doc/arch-design/source/introduction-how-this-book-was-written.rst b/doc/arch-design-to-archive/source/introduction-how-this-book-was-written.rst similarity index 100% rename from doc/arch-design/source/introduction-how-this-book-was-written.rst rename to doc/arch-design-to-archive/source/introduction-how-this-book-was-written.rst diff --git a/doc/arch-design/source/introduction-intended-audience.rst b/doc/arch-design-to-archive/source/introduction-intended-audience.rst similarity index 100% rename from doc/arch-design/source/introduction-intended-audience.rst rename to doc/arch-design-to-archive/source/introduction-intended-audience.rst diff --git a/doc/arch-design/source/introduction-methodology.rst b/doc/arch-design-to-archive/source/introduction-methodology.rst similarity index 100% rename from doc/arch-design/source/introduction-methodology.rst rename to doc/arch-design-to-archive/source/introduction-methodology.rst diff --git a/doc/arch-design/source/introduction.rst b/doc/arch-design-to-archive/source/introduction.rst similarity index 100% rename from doc/arch-design/source/introduction.rst rename to doc/arch-design-to-archive/source/introduction.rst diff --git a/doc/arch-design/source/legal-security-requirements.rst b/doc/arch-design-to-archive/source/legal-security-requirements.rst similarity index 100% rename from doc/arch-design/source/legal-security-requirements.rst rename to doc/arch-design-to-archive/source/legal-security-requirements.rst diff --git a/doc/arch-design/source/massively-scalable-operational-considerations.rst b/doc/arch-design-to-archive/source/massively-scalable-operational-considerations.rst similarity index 100% rename from doc/arch-design/source/massively-scalable-operational-considerations.rst rename to doc/arch-design-to-archive/source/massively-scalable-operational-considerations.rst diff --git a/doc/arch-design/source/massively-scalable-technical-considerations.rst b/doc/arch-design-to-archive/source/massively-scalable-technical-considerations.rst similarity index 100% rename from doc/arch-design/source/massively-scalable-technical-considerations.rst rename to doc/arch-design-to-archive/source/massively-scalable-technical-considerations.rst diff --git a/doc/arch-design/source/massively-scalable-user-requirements.rst b/doc/arch-design-to-archive/source/massively-scalable-user-requirements.rst similarity index 100% rename from doc/arch-design/source/massively-scalable-user-requirements.rst rename to doc/arch-design-to-archive/source/massively-scalable-user-requirements.rst diff --git a/doc/arch-design/source/massively-scalable.rst b/doc/arch-design-to-archive/source/massively-scalable.rst similarity index 100% rename from doc/arch-design/source/massively-scalable.rst rename to doc/arch-design-to-archive/source/massively-scalable.rst diff --git a/doc/arch-design/source/multi-site-architecture.rst b/doc/arch-design-to-archive/source/multi-site-architecture.rst similarity index 100% rename from doc/arch-design/source/multi-site-architecture.rst rename to doc/arch-design-to-archive/source/multi-site-architecture.rst diff --git a/doc/arch-design/source/multi-site-operational-considerations.rst b/doc/arch-design-to-archive/source/multi-site-operational-considerations.rst similarity index 100% rename from doc/arch-design/source/multi-site-operational-considerations.rst rename to doc/arch-design-to-archive/source/multi-site-operational-considerations.rst diff --git a/doc/arch-design/source/multi-site-prescriptive-examples.rst b/doc/arch-design-to-archive/source/multi-site-prescriptive-examples.rst similarity index 100% rename from doc/arch-design/source/multi-site-prescriptive-examples.rst rename to doc/arch-design-to-archive/source/multi-site-prescriptive-examples.rst diff --git a/doc/arch-design/source/multi-site-technical-considerations.rst b/doc/arch-design-to-archive/source/multi-site-technical-considerations.rst similarity index 100% rename from doc/arch-design/source/multi-site-technical-considerations.rst rename to doc/arch-design-to-archive/source/multi-site-technical-considerations.rst diff --git a/doc/arch-design/source/multi-site-user-requirements.rst b/doc/arch-design-to-archive/source/multi-site-user-requirements.rst similarity index 100% rename from doc/arch-design/source/multi-site-user-requirements.rst rename to doc/arch-design-to-archive/source/multi-site-user-requirements.rst diff --git a/doc/arch-design/source/multi-site.rst b/doc/arch-design-to-archive/source/multi-site.rst similarity index 100% rename from doc/arch-design/source/multi-site.rst rename to doc/arch-design-to-archive/source/multi-site.rst diff --git a/doc/arch-design/source/network-focus-architecture.rst b/doc/arch-design-to-archive/source/network-focus-architecture.rst similarity index 100% rename from doc/arch-design/source/network-focus-architecture.rst rename to doc/arch-design-to-archive/source/network-focus-architecture.rst diff --git a/doc/arch-design/source/network-focus-operational-considerations.rst b/doc/arch-design-to-archive/source/network-focus-operational-considerations.rst similarity index 100% rename from doc/arch-design/source/network-focus-operational-considerations.rst rename to doc/arch-design-to-archive/source/network-focus-operational-considerations.rst diff --git a/doc/arch-design/source/network-focus-prescriptive-examples.rst b/doc/arch-design-to-archive/source/network-focus-prescriptive-examples.rst similarity index 100% rename from doc/arch-design/source/network-focus-prescriptive-examples.rst rename to doc/arch-design-to-archive/source/network-focus-prescriptive-examples.rst diff --git a/doc/arch-design/source/network-focus-technical-considerations.rst b/doc/arch-design-to-archive/source/network-focus-technical-considerations.rst similarity index 100% rename from doc/arch-design/source/network-focus-technical-considerations.rst rename to doc/arch-design-to-archive/source/network-focus-technical-considerations.rst diff --git a/doc/arch-design/source/network-focus-user-requirements.rst b/doc/arch-design-to-archive/source/network-focus-user-requirements.rst similarity index 100% rename from doc/arch-design/source/network-focus-user-requirements.rst rename to doc/arch-design-to-archive/source/network-focus-user-requirements.rst diff --git a/doc/arch-design/source/network-focus.rst b/doc/arch-design-to-archive/source/network-focus.rst similarity index 100% rename from doc/arch-design/source/network-focus.rst rename to doc/arch-design-to-archive/source/network-focus.rst diff --git a/doc/arch-design/source/references.rst b/doc/arch-design-to-archive/source/references.rst similarity index 100% rename from doc/arch-design/source/references.rst rename to doc/arch-design-to-archive/source/references.rst diff --git a/doc/arch-design/source/specialized-desktop-as-a-service.rst b/doc/arch-design-to-archive/source/specialized-desktop-as-a-service.rst similarity index 100% rename from doc/arch-design/source/specialized-desktop-as-a-service.rst rename to doc/arch-design-to-archive/source/specialized-desktop-as-a-service.rst diff --git a/doc/arch-design/source/specialized-hardware.rst b/doc/arch-design-to-archive/source/specialized-hardware.rst similarity index 100% rename from doc/arch-design/source/specialized-hardware.rst rename to doc/arch-design-to-archive/source/specialized-hardware.rst diff --git a/doc/arch-design/source/specialized-multi-hypervisor.rst b/doc/arch-design-to-archive/source/specialized-multi-hypervisor.rst similarity index 100% rename from doc/arch-design/source/specialized-multi-hypervisor.rst rename to doc/arch-design-to-archive/source/specialized-multi-hypervisor.rst diff --git a/doc/arch-design/source/specialized-networking.rst b/doc/arch-design-to-archive/source/specialized-networking.rst similarity index 100% rename from doc/arch-design/source/specialized-networking.rst rename to doc/arch-design-to-archive/source/specialized-networking.rst diff --git a/doc/arch-design/source/specialized-openstack-on-openstack.rst b/doc/arch-design-to-archive/source/specialized-openstack-on-openstack.rst similarity index 100% rename from doc/arch-design/source/specialized-openstack-on-openstack.rst rename to doc/arch-design-to-archive/source/specialized-openstack-on-openstack.rst diff --git a/doc/arch-design/source/specialized-software-defined-networking.rst b/doc/arch-design-to-archive/source/specialized-software-defined-networking.rst similarity index 100% rename from doc/arch-design/source/specialized-software-defined-networking.rst rename to doc/arch-design-to-archive/source/specialized-software-defined-networking.rst diff --git a/doc/arch-design/source/specialized.rst b/doc/arch-design-to-archive/source/specialized.rst similarity index 100% rename from doc/arch-design/source/specialized.rst rename to doc/arch-design-to-archive/source/specialized.rst diff --git a/doc/arch-design/source/storage-focus-architecture.rst b/doc/arch-design-to-archive/source/storage-focus-architecture.rst similarity index 100% rename from doc/arch-design/source/storage-focus-architecture.rst rename to doc/arch-design-to-archive/source/storage-focus-architecture.rst diff --git a/doc/arch-design/source/storage-focus-operational-considerations.rst b/doc/arch-design-to-archive/source/storage-focus-operational-considerations.rst similarity index 100% rename from doc/arch-design/source/storage-focus-operational-considerations.rst rename to doc/arch-design-to-archive/source/storage-focus-operational-considerations.rst diff --git a/doc/arch-design/source/storage-focus-prescriptive-examples.rst b/doc/arch-design-to-archive/source/storage-focus-prescriptive-examples.rst similarity index 100% rename from doc/arch-design/source/storage-focus-prescriptive-examples.rst rename to doc/arch-design-to-archive/source/storage-focus-prescriptive-examples.rst diff --git a/doc/arch-design/source/storage-focus-technical-considerations.rst b/doc/arch-design-to-archive/source/storage-focus-technical-considerations.rst similarity index 100% rename from doc/arch-design/source/storage-focus-technical-considerations.rst rename to doc/arch-design-to-archive/source/storage-focus-technical-considerations.rst diff --git a/doc/arch-design/source/storage-focus.rst b/doc/arch-design-to-archive/source/storage-focus.rst similarity index 100% rename from doc/arch-design/source/storage-focus.rst rename to doc/arch-design-to-archive/source/storage-focus.rst diff --git a/doc/arch-design-draft/source/capacity-planning-scaling.rst b/doc/arch-design/source/capacity-planning-scaling.rst similarity index 100% rename from doc/arch-design-draft/source/capacity-planning-scaling.rst rename to doc/arch-design/source/capacity-planning-scaling.rst diff --git a/doc/arch-design/source/conf.py b/doc/arch-design/source/conf.py index 256300a6d2..4a8a677cb2 100644 --- a/doc/arch-design/source/conf.py +++ b/doc/arch-design/source/conf.py @@ -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 diff --git a/doc/arch-design-draft/source/design-cmp-tools.rst b/doc/arch-design/source/design-cmp-tools.rst similarity index 100% rename from doc/arch-design-draft/source/design-cmp-tools.rst rename to doc/arch-design/source/design-cmp-tools.rst diff --git a/doc/arch-design-draft/source/design-compute.rst b/doc/arch-design/source/design-compute.rst similarity index 100% rename from doc/arch-design-draft/source/design-compute.rst rename to doc/arch-design/source/design-compute.rst diff --git a/doc/arch-design-draft/source/design-compute/design-compute-concepts.rst b/doc/arch-design/source/design-compute/design-compute-concepts.rst similarity index 100% rename from doc/arch-design-draft/source/design-compute/design-compute-concepts.rst rename to doc/arch-design/source/design-compute/design-compute-concepts.rst diff --git a/doc/arch-design-draft/source/design-compute/design-compute-cpu.rst b/doc/arch-design/source/design-compute/design-compute-cpu.rst similarity index 100% rename from doc/arch-design-draft/source/design-compute/design-compute-cpu.rst rename to doc/arch-design/source/design-compute/design-compute-cpu.rst diff --git a/doc/arch-design-draft/source/design-compute/design-compute-hardware.rst b/doc/arch-design/source/design-compute/design-compute-hardware.rst similarity index 100% rename from doc/arch-design-draft/source/design-compute/design-compute-hardware.rst rename to doc/arch-design/source/design-compute/design-compute-hardware.rst diff --git a/doc/arch-design-draft/source/design-compute/design-compute-hypervisor.rst b/doc/arch-design/source/design-compute/design-compute-hypervisor.rst similarity index 100% rename from doc/arch-design-draft/source/design-compute/design-compute-hypervisor.rst rename to doc/arch-design/source/design-compute/design-compute-hypervisor.rst diff --git a/doc/arch-design-draft/source/design-compute/design-compute-logging.rst b/doc/arch-design/source/design-compute/design-compute-logging.rst similarity index 99% rename from doc/arch-design-draft/source/design-compute/design-compute-logging.rst rename to doc/arch-design/source/design-compute/design-compute-logging.rst index 635ea5fbb6..2c8e7d0f03 100644 --- a/doc/arch-design-draft/source/design-compute/design-compute-logging.rst +++ b/doc/arch-design/source/design-compute/design-compute-logging.rst @@ -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 diff --git a/doc/arch-design-draft/source/design-compute/design-compute-networking.rst b/doc/arch-design/source/design-compute/design-compute-networking.rst similarity index 100% rename from doc/arch-design-draft/source/design-compute/design-compute-networking.rst rename to doc/arch-design/source/design-compute/design-compute-networking.rst diff --git a/doc/arch-design-draft/source/design-compute/design-compute-overcommit.rst b/doc/arch-design/source/design-compute/design-compute-overcommit.rst similarity index 100% rename from doc/arch-design-draft/source/design-compute/design-compute-overcommit.rst rename to doc/arch-design/source/design-compute/design-compute-overcommit.rst diff --git a/doc/arch-design-draft/source/design-compute/design-compute-storage.rst b/doc/arch-design/source/design-compute/design-compute-storage.rst similarity index 100% rename from doc/arch-design-draft/source/design-compute/design-compute-storage.rst rename to doc/arch-design/source/design-compute/design-compute-storage.rst diff --git a/doc/arch-design-draft/source/design-control-plane.rst b/doc/arch-design/source/design-control-plane.rst similarity index 100% rename from doc/arch-design-draft/source/design-control-plane.rst rename to doc/arch-design/source/design-control-plane.rst diff --git a/doc/arch-design-draft/source/design-identity.rst b/doc/arch-design/source/design-identity.rst similarity index 100% rename from doc/arch-design-draft/source/design-identity.rst rename to doc/arch-design/source/design-identity.rst diff --git a/doc/arch-design-draft/source/design-images.rst b/doc/arch-design/source/design-images.rst similarity index 100% rename from doc/arch-design-draft/source/design-images.rst rename to doc/arch-design/source/design-images.rst diff --git a/doc/arch-design-draft/source/design-networking.rst b/doc/arch-design/source/design-networking.rst similarity index 100% rename from doc/arch-design-draft/source/design-networking.rst rename to doc/arch-design/source/design-networking.rst diff --git a/doc/arch-design-draft/source/design-networking/design-networking-concepts.rst b/doc/arch-design/source/design-networking/design-networking-concepts.rst similarity index 100% rename from doc/arch-design-draft/source/design-networking/design-networking-concepts.rst rename to doc/arch-design/source/design-networking/design-networking-concepts.rst diff --git a/doc/arch-design-draft/source/design-networking/design-networking-design.rst b/doc/arch-design/source/design-networking/design-networking-design.rst similarity index 100% rename from doc/arch-design-draft/source/design-networking/design-networking-design.rst rename to doc/arch-design/source/design-networking/design-networking-design.rst diff --git a/doc/arch-design-draft/source/design-networking/design-networking-layer2.rst b/doc/arch-design/source/design-networking/design-networking-layer2.rst similarity index 100% rename from doc/arch-design-draft/source/design-networking/design-networking-layer2.rst rename to doc/arch-design/source/design-networking/design-networking-layer2.rst diff --git a/doc/arch-design-draft/source/design-networking/design-networking-layer3.rst b/doc/arch-design/source/design-networking/design-networking-layer3.rst similarity index 100% rename from doc/arch-design-draft/source/design-networking/design-networking-layer3.rst rename to doc/arch-design/source/design-networking/design-networking-layer3.rst diff --git a/doc/arch-design-draft/source/design-networking/design-networking-services.rst b/doc/arch-design/source/design-networking/design-networking-services.rst similarity index 100% rename from doc/arch-design-draft/source/design-networking/design-networking-services.rst rename to doc/arch-design/source/design-networking/design-networking-services.rst diff --git a/doc/arch-design-draft/source/design-storage.rst b/doc/arch-design/source/design-storage.rst similarity index 100% rename from doc/arch-design-draft/source/design-storage.rst rename to doc/arch-design/source/design-storage.rst diff --git a/doc/arch-design-draft/source/design-storage/design-storage-block.rst b/doc/arch-design/source/design-storage/design-storage-block.rst similarity index 100% rename from doc/arch-design-draft/source/design-storage/design-storage-block.rst rename to doc/arch-design/source/design-storage/design-storage-block.rst diff --git a/doc/arch-design-draft/source/design-storage/design-storage-commodity.rst b/doc/arch-design/source/design-storage/design-storage-commodity.rst similarity index 100% rename from doc/arch-design-draft/source/design-storage/design-storage-commodity.rst rename to doc/arch-design/source/design-storage/design-storage-commodity.rst diff --git a/doc/arch-design-draft/source/design-storage/design-storage-concepts.rst b/doc/arch-design/source/design-storage/design-storage-concepts.rst similarity index 100% rename from doc/arch-design-draft/source/design-storage/design-storage-concepts.rst rename to doc/arch-design/source/design-storage/design-storage-concepts.rst diff --git a/doc/arch-design-draft/source/design-storage/design-storage-file.rst b/doc/arch-design/source/design-storage/design-storage-file.rst similarity index 100% rename from doc/arch-design-draft/source/design-storage/design-storage-file.rst rename to doc/arch-design/source/design-storage/design-storage-file.rst diff --git a/doc/arch-design-draft/source/design-storage/design-storage-object.rst b/doc/arch-design/source/design-storage/design-storage-object.rst similarity index 100% rename from doc/arch-design-draft/source/design-storage/design-storage-object.rst rename to doc/arch-design/source/design-storage/design-storage-object.rst diff --git a/doc/arch-design-draft/source/design-storage/design-storage-planning-scaling.rst b/doc/arch-design/source/design-storage/design-storage-planning-scaling.rst similarity index 100% rename from doc/arch-design-draft/source/design-storage/design-storage-planning-scaling.rst rename to doc/arch-design/source/design-storage/design-storage-planning-scaling.rst diff --git a/doc/arch-design-draft/source/design.rst b/doc/arch-design/source/design.rst similarity index 100% rename from doc/arch-design-draft/source/design.rst rename to doc/arch-design/source/design.rst diff --git a/doc/arch-design-draft/source/figures/Check_mark_23x20_02.png b/doc/arch-design/source/figures/Check_mark_23x20_02.png similarity index 100% rename from doc/arch-design-draft/source/figures/Check_mark_23x20_02.png rename to doc/arch-design/source/figures/Check_mark_23x20_02.png diff --git a/doc/arch-design/source/figures/ELKbasicArch.png b/doc/arch-design/source/figures/ELKbasicArch.png new file mode 100644 index 0000000000..a6eb8f30a6 Binary files /dev/null and b/doc/arch-design/source/figures/ELKbasicArch.png differ diff --git a/doc/arch-design-draft/source/figures/ELKbasicArch.svg b/doc/arch-design/source/figures/ELKbasicArch.svg similarity index 100% rename from doc/arch-design-draft/source/figures/ELKbasicArch.svg rename to doc/arch-design/source/figures/ELKbasicArch.svg diff --git a/doc/arch-design-draft/source/figures/osog_0201.png b/doc/arch-design/source/figures/osog_0201.png similarity index 100% rename from doc/arch-design-draft/source/figures/osog_0201.png rename to doc/arch-design/source/figures/osog_0201.png diff --git a/doc/arch-design-draft/source/high-availability.rst b/doc/arch-design/source/high-availability.rst similarity index 100% rename from doc/arch-design-draft/source/high-availability.rst rename to doc/arch-design/source/high-availability.rst diff --git a/doc/arch-design/source/index.rst b/doc/arch-design/source/index.rst index c1dcb622bd..baba3c4c65 100644 --- a/doc/arch-design/source/index.rst +++ b/doc/arch-design/source/index.rst @@ -7,12 +7,18 @@ OpenStack Architecture Design Guide =================================== +.. note:: + + Parts of this guide is a work in progress. Contributions are welcome. + 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. +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 ~~~~~~~~ @@ -21,17 +27,11 @@ Contents :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 + overview.rst + use-cases.rst + high-availability.rst + capacity-planning-scaling.rst + design.rst Appendix ~~~~~~~~ @@ -53,4 +53,3 @@ Search in this guide ~~~~~~~~~~~~~~~~~~~~ * :ref:`search` - diff --git a/doc/arch-design-draft/source/overview-customer-requirements.rst b/doc/arch-design/source/overview-customer-requirements.rst similarity index 100% rename from doc/arch-design-draft/source/overview-customer-requirements.rst rename to doc/arch-design/source/overview-customer-requirements.rst diff --git a/doc/arch-design-draft/source/overview-legal-requirements.rst b/doc/arch-design/source/overview-legal-requirements.rst similarity index 100% rename from doc/arch-design-draft/source/overview-legal-requirements.rst rename to doc/arch-design/source/overview-legal-requirements.rst diff --git a/doc/arch-design-draft/source/overview-operator-requirements.rst b/doc/arch-design/source/overview-operator-requirements.rst similarity index 100% rename from doc/arch-design-draft/source/overview-operator-requirements.rst rename to doc/arch-design/source/overview-operator-requirements.rst diff --git a/doc/arch-design-draft/source/overview-planning.rst b/doc/arch-design/source/overview-planning.rst similarity index 100% rename from doc/arch-design-draft/source/overview-planning.rst rename to doc/arch-design/source/overview-planning.rst diff --git a/doc/arch-design-draft/source/overview-security-requirements.rst b/doc/arch-design/source/overview-security-requirements.rst similarity index 100% rename from doc/arch-design-draft/source/overview-security-requirements.rst rename to doc/arch-design/source/overview-security-requirements.rst diff --git a/doc/arch-design-draft/source/overview-software-licensing.rst b/doc/arch-design/source/overview-software-licensing.rst similarity index 100% rename from doc/arch-design-draft/source/overview-software-licensing.rst rename to doc/arch-design/source/overview-software-licensing.rst diff --git a/doc/arch-design-draft/source/overview.rst b/doc/arch-design/source/overview.rst similarity index 100% rename from doc/arch-design-draft/source/overview.rst rename to doc/arch-design/source/overview.rst diff --git a/doc/arch-design-draft/source/use-cases.rst b/doc/arch-design/source/use-cases.rst similarity index 100% rename from doc/arch-design-draft/source/use-cases.rst rename to doc/arch-design/source/use-cases.rst diff --git a/doc/arch-design-draft/source/use-cases/use-case-development.rst b/doc/arch-design/source/use-cases/use-case-development.rst similarity index 100% rename from doc/arch-design-draft/source/use-cases/use-case-development.rst rename to doc/arch-design/source/use-cases/use-case-development.rst diff --git a/doc/arch-design-draft/source/use-cases/use-case-general-compute.rst b/doc/arch-design/source/use-cases/use-case-general-compute.rst similarity index 100% rename from doc/arch-design-draft/source/use-cases/use-case-general-compute.rst rename to doc/arch-design/source/use-cases/use-case-general-compute.rst diff --git a/doc/arch-design-draft/source/use-cases/use-case-nfv.rst b/doc/arch-design/source/use-cases/use-case-nfv.rst similarity index 100% rename from doc/arch-design-draft/source/use-cases/use-case-nfv.rst rename to doc/arch-design/source/use-cases/use-case-nfv.rst diff --git a/doc/arch-design-draft/source/use-cases/use-case-storage.rst b/doc/arch-design/source/use-cases/use-case-storage.rst similarity index 100% rename from doc/arch-design-draft/source/use-cases/use-case-storage.rst rename to doc/arch-design/source/use-cases/use-case-storage.rst diff --git a/doc/arch-design-draft/source/use-cases/use-case-web-scale.rst b/doc/arch-design/source/use-cases/use-case-web-scale.rst similarity index 100% rename from doc/arch-design-draft/source/use-cases/use-case-web-scale.rst rename to doc/arch-design/source/use-cases/use-case-web-scale.rst diff --git a/tools/build-all-rst.sh b/tools/build-all-rst.sh index 421aed8023..beb747ac6e 100755 --- a/tools/build-all-rst.sh +++ b/tools/build-all-rst.sh @@ -46,7 +46,7 @@ done # Draft guides # This includes guides that we publish from stable branches # as versioned like the networking-guide. -for guide in networking-guide arch-design-draft config-reference; do +for guide in networking-guide config-reference; do if [[ ${PDF_TARGETS[*]} =~ $guide ]]; then tools/build-rst.sh doc/$guide --build build \ --target "draft/$guide" $LINKCHECK $PDF_OPTION diff --git a/tools/publishdocs.sh b/tools/publishdocs.sh index 9420d14a16..8cc140761e 100755 --- a/tools/publishdocs.sh +++ b/tools/publishdocs.sh @@ -32,7 +32,7 @@ function copy_to_branch { # We don't need this file rm -f publish-docs/$BRANCH/draft-index.html # We don't need these draft guides on the branch - rm -rf publish-docs/$BRANCH/arch-design-draft + rm -rf publish-docs/$BRANCH/arch-design-to-archive rm -rf publish-docs/$BRANCH/ops-guide for f in $(find publish-docs/$BRANCH -name "atom.xml"); do diff --git a/www/draft/draft-index.html b/www/draft/draft-index.html index 29ced1b131..30071f41f3 100644 --- a/www/draft/draft-index.html +++ b/www/draft/draft-index.html @@ -77,7 +77,6 @@