Merge "[arch-design] Update overview chapter"

doc/arch-design-draft/source/arch-guide-draft-mitaka/introduction.rst

@@ -1,67 +0,0 @@
-============
-Introduction
-============
-
-.. toctree::
-   :maxdepth: 2
-
-:term:`OpenStack` is a fully-featured, self-service cloud. This book takes you
-through some of the considerations you have to make when designing your
-cloud.
-
-Intended audience
-~~~~~~~~~~~~~~~~~
-
-This book has been written for architects and designers of OpenStack
-clouds. For a guide on deploying and operating OpenStack, please refer
-to the
-`OpenStack Operations Guide <http://docs.openstack.org/ops-guide/>`_.
-
-Before reading this book, we recommend:
-
-* Prior knowledge of cloud architecture and principles.
-* Experience in enterprise system design.
-* Linux and virtualization experience.
-* A basic understanding of networking principles and protocols.
-
-How this book is organized
-~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-This book follows a structure similar to what system architects would use in
-developing cloud architecture design documents. The sections covered are:
-
-*  :doc:`Identifying stakeholders <identifying-stakeholders>`: Discover
-   different business requirements and architecture design based on different
-   internal and external stakeholders.
-
-*  :doc:`Technical requirements <technical-requirements>`:
-   Information for SMEs on deployment methods and how they will affect
-   deployment cost.
-
-*  :doc:`Customer requirements <customer-requirements>`: Information for SMEs
-   on business and technical requirements.
-
-*  :doc:`Operator requirements <operator-requirements>`: Information on
-   :term:`Service Level Agreement (SLA)` considerations, selecting the right
-   hardware for servers and switches, and integration with external
-   :term:`identity provider`.
-
-*  :doc:`Capacity planning and scaling <capacity-planning-scaling>`:
-   Information on storage and networking.
-
-*  :doc:`High Availability <high-availability>`: Separation of data plane and
-   control plane, and how to eliminate single points of failure.
-
-*  :doc:`Security requirements <security-requirements>`: The security
-   requirements you will need to consider for the different OpenStack
-   scenarios.
-
-*  :doc:`Legal requirements <legal-requirements>`: The legal requirements you
-   will need to consider for the different OpenStack scenarios.
-
-.. TODO(jaegerandi): Use below :doc:`Example
-   architectures<example-architectures>`
-
-*  Example architectures: An examination of some
-   of the most common uses for OpenStack clouds, and explanations of the
-   considerations for each use case.

doc/arch-design-draft/source/capacity-planning-scaling.rst

@@ -1,3 +1,5 @@
+.. _capacity-planning-scaling:
+
 =============================
 Capacity planning and scaling
 =============================

doc/arch-design-draft/source/design.rst

@@ -1,3 +1,5 @@
+.. _design:
+
 ======
 Design
 ======

doc/arch-design-draft/source/high-availability.rst

@@ -1,3 +1,5 @@
+.. _high-availability:
+
 =================
 High Availability
 =================

doc/arch-design-draft/source/overview.rst

@@ -1,3 +1,50 @@
 ========
 Overview
 ========
+
+:term:`OpenStack` is a fully-featured, self-service cloud. This book takes you
+through some of the considerations you have to make when designing your
+cloud.
+
+Intended audience
+~~~~~~~~~~~~~~~~~
+
+This book has been written for architects and designers of OpenStack
+clouds. For information about deploying and operating OpenStack, see the
+`OpenStack Operations Guide <http://docs.openstack.org/ops-guide/>`_.
+
+Before reading this book, we recommend:
+
+* Prior knowledge of cloud architecture and principles.
+* Experience in enterprise system design.
+* Linux and virtualization experience.
+* A basic understanding of networking principles and protocols.
+
+How this book is organized
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+This book examines some of the most common uses for OpenStack clouds, explains
+the considerations for each use case, and design criteria for each of the
+major OpenStack components. Cloud architects may use this book as a
+comprehensive guide by reading all of the use cases, but it is also possible
+to read only the chapters which pertain to a specific use case. The sections
+covered include:
+
+*  :doc:`Cloud Architecture Use Cases <use-cases>`: An examination of some
+   of the most common OpenStack cloud use cases. It covers stakeholder
+   requirements, user stories, an explanation of the design models, and
+   component block diagrams.
+
+*  :doc:`High availability <high-availability>`: Separation of data plane and
+   control plane, and how to eliminate single points of failure.
+
+*  :doc:`Capacity planning and scaling <capacity-planning-scaling>`:
+   Information on how to design your cloud architecture for high network
+   traffic and scalability.
+
+*  :doc:`Cloud architecture design <design>`: A detailed breakdown of the
+   major cloud architecture components, and considerations when designing a
+   cloud. This includes storage choices, networking design choices,
+   implementing keystone, image creation and management, implementation of
+   control plane components, and using Dashboard or cloud management platform
+   tools.

doc/arch-design-draft/source/use-cases.rst

@@ -1,3 +1,5 @@
+.. _use-cases:
+
 =========
 Use Cases
 =========