openstack
/
openstack-manuals
Code Issues Proposed changes

[install] Improve overview to make purpose of guide clear 

As per bug, making the purpose of the guide clearer, ensuring
readers understand it is a minimum architecture for PoC purposes,
and directing them to the arch guide for more complicated archictures.

Change-Id: Ibeea8a6e8fa279d75c656c8073d2a1197b177fe3
Closes-Bug: #1646249
This commit is contained in:
Lana Brindley 2017-03-01 15:27:24 +10:00
parent d35fabc2a0
commit 4b278ef711
1 changed files with 12 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
doc/install-guide/source/overview.rst
View File

@ -14,7 +14,9 @@ integration.
This guide covers step-by-step deployment of the major OpenStack
services using a functional example architecture suitable for
new users of OpenStack with sufficient Linux experience.
new users of OpenStack with sufficient Linux experience. This guide is not
intended to be used for production system installations, but to create a
minimum proof-of-concept for the purpose of learning about OpenStack.
After becoming familiar with basic installation, configuration, operation,
and troubleshooting of these OpenStack services, you should consider the
@ -38,6 +40,15 @@ The example architecture requires at least two nodes (hosts) to launch a basic
:term:`virtual machine <virtual machine (VM)>` or instance. Optional
services such as Block Storage and Object Storage require additional nodes.
.. important::
The example architecture used in this guide is a minimum configuration,
and is not intended for production system installations. It is designed to
provide a minimum proof-of-concept for the purpose of learning about
OpenStack. For information on creating architectures for specific
use cases, or how to determine which architecture is required, see the
`Architecture Design Guide <https://docs.openstack.org/arch-design/>`_.
This example architecture differs from a minimal production architecture as
follows: