From 4b278ef71183d8d8a0e3ac9bd4fffb06d4827e4c Mon Sep 17 00:00:00 2001 From: Lana Brindley Date: Wed, 1 Mar 2017 15:27:24 +1000 Subject: [PATCH] [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 --- doc/install-guide/source/overview.rst | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/doc/install-guide/source/overview.rst b/doc/install-guide/source/overview.rst index 981f0f5a5a..2c2da621c1 100644 --- a/doc/install-guide/source/overview.rst +++ b/doc/install-guide/source/overview.rst @@ -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 ` 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 `_. + This example architecture differs from a minimal production architecture as follows: