From 0043fb7a7ca0b36e40912c9ca32c4de115925e8d Mon Sep 17 00:00:00 2001 From: Andreas Jaeger Date: Wed, 13 Aug 2014 19:51:21 +0200 Subject: [PATCH] Arch Design edits Many minor edits: Improve markup, follow conventions, add glossary items, fix capitalization,... Change-Id: I85693ef2d2c617327c707d13ffd5f05b4d97d1d7 --- doc/arch-design/ch_hybrid.xml | 3 +- .../section_architecture_compute_focus.xml | 2 +- ...tion_tech_considerations_compute_focus.xml | 3 +- .../section_architecture_general_purpose.xml | 3 +- ...n_prescriptive_example_general_purpose.xml | 4 +- ...on_tech_considerations_general_purpose.xml | 69 ++++++++++++------- ...tion_user_requirements_general_purpose.xml | 5 +- .../section_how_this_book_is_organized.xml | 3 +- 8 files changed, 59 insertions(+), 33 deletions(-) diff --git a/doc/arch-design/ch_hybrid.xml b/doc/arch-design/ch_hybrid.xml index d74f7b252c..45557b04d4 100644 --- a/doc/arch-design/ch_hybrid.xml +++ b/doc/arch-design/ch_hybrid.xml @@ -60,7 +60,8 @@ launches a public cloud instance. There are commercially available options, such as Rightscale, and open source options, such as ManageIQ - (http://manageiq.org/), but there is no single CMP that can + (http://manageiq.org), + but there is no single CMP that can address all needs in all scenarios. Whereas most of the sections of this book talk about the aspects of OpenStack, an architect needs to consider when designing an OpenStack diff --git a/doc/arch-design/compute_focus/section_architecture_compute_focus.xml b/doc/arch-design/compute_focus/section_architecture_compute_focus.xml index 92ca2d4929..45db6554b6 100644 --- a/doc/arch-design/compute_focus/section_architecture_compute_focus.xml +++ b/doc/arch-design/compute_focus/section_architecture_compute_focus.xml @@ -442,7 +442,7 @@ Ensure that the design can accommodate the regular periodic installation of application security patches while maintaining the required workloads. The frequency of security - patches for the proposed OS - hypervisor combination will have an + patches for the proposed OS-hypervisor combination will have an impact on performance and the patch installation process could affect maintenance windows. diff --git a/doc/arch-design/compute_focus/section_tech_considerations_compute_focus.xml b/doc/arch-design/compute_focus/section_tech_considerations_compute_focus.xml index 4d6a32ee9f..093674be57 100644 --- a/doc/arch-design/compute_focus/section_tech_considerations_compute_focus.xml +++ b/doc/arch-design/compute_focus/section_tech_considerations_compute_focus.xml @@ -376,7 +376,8 @@ Also consider several specialized components: - Orchestration module (heat) + Orchestration module + (heat) It is safe to assume that, given the nature of the diff --git a/doc/arch-design/generalpurpose/section_architecture_general_purpose.xml b/doc/arch-design/generalpurpose/section_architecture_general_purpose.xml index 447a400b54..5e3617aa28 100644 --- a/doc/arch-design/generalpurpose/section_architecture_general_purpose.xml +++ b/doc/arch-design/generalpurpose/section_architecture_general_purpose.xml @@ -730,7 +730,8 @@ certain components that will always be present, (Compute and Image Service, for example) there are other services that may not be required. As an example, a certain design might not need - Orchestration. Omitting Orchestration would not have a significant + Orchestration. Omitting + Orchestration would not have a significant impact on the overall design of a cloud; however, if the architecture uses a replacement for OpenStack Object Storage for its storage component, it could potentially have significant diff --git a/doc/arch-design/generalpurpose/section_prescriptive_example_general_purpose.xml b/doc/arch-design/generalpurpose/section_prescriptive_example_general_purpose.xml index d467cd2b03..ea4227eead 100644 --- a/doc/arch-design/generalpurpose/section_prescriptive_example_general_purpose.xml +++ b/doc/arch-design/generalpurpose/section_prescriptive_example_general_purpose.xml @@ -89,7 +89,9 @@ There is also a potential to leverage the Orchestration and Telemetry modules to provide an auto-scaling, orchestrated web application environment. Defining the web - applications in Heat Orchestration Templates (HOT) would + applications in Heat Orchestration Templates (HOT) + would negate the reliance on the scripted Puppet solution currently employed. OpenStack Networking can be used to control hardware load diff --git a/doc/arch-design/generalpurpose/section_tech_considerations_general_purpose.xml b/doc/arch-design/generalpurpose/section_tech_considerations_general_purpose.xml index 8bbb39b1f9..c842070549 100644 --- a/doc/arch-design/generalpurpose/section_tech_considerations_general_purpose.xml +++ b/doc/arch-design/generalpurpose/section_tech_considerations_general_purpose.xml @@ -131,7 +131,7 @@ cloud, the next design choice which will affect your design is the choice of network service which will be used to service instances in the cloud. The choice between legacy networking (nova-network), as a - part of OpenStack Compute Service, and OpenStack Networking + part of OpenStack Compute, and OpenStack Networking (neutron), has tremendous implications and will have a huge impact on the architecture and design of the cloud network infrastructure. @@ -313,7 +313,7 @@ the distribution vendor's OpenStack packages might be a requirement for support). OS selection also directly influences hypervisor selection. - A cloud architect who selects Ubuntu or RHEL has some + A cloud architect who selects Ubuntu, RHEL, or SLES has some flexibility in hypervisor; KVM, Xen, and LXC are supported virtualization methods available under OpenStack Compute (nova) on these Linux distributions. A cloud architect who @@ -321,25 +321,35 @@ Server. Similarly, a cloud architect who selects XenServer is limited to the CentOS-based dom0 operating system provided with XenServer. - The primary factors that play into OS/hypervisor selection + The primary factors that play into OS-hypervisor selection include: - - - User requirements: The selection of OS/hypervisor + + + User requirements + + The selection of OS-hypervisor combination first and foremost needs to support the user requirements. - - - Support: The selected OS/hypervisor combination + + + + Support + + The selected OS-hypervisor combination needs to be supported by OpenStack. - - - Interoperability: The OS/hypervisor needs to be + + + + Interoperability + + The OS-hypervisor needs to be interoperable with other features and services in the OpenStack design in order to meet the user requirements. - - + + + +
Hypervisor OpenStack supports a wide variety of hypervisors, one or @@ -347,7 +357,7 @@ include: - KVM (and Qemu) + KVM (and QEMU) XCP/XenServer @@ -408,29 +418,38 @@ in a general purpose cloud are: - OpenStack Compute (nova) + OpenStack Compute + (nova) - OpenStack Networking (neutron) + OpenStack Networking + (neutron) - OpenStack Image Service (glance) + OpenStack Image Service + (glance) - OpenStack Identity (keystone) + OpenStack Identity + (keystone) - OpenStack dashboard (horizon) + OpenStack dashboard + (horizon) - Telemetry module (ceilometer) + Telemetry module + (ceilometer) - A general purpose cloud may also include OpenStack Object - Storage (swift). OpenStack Block Storage (cinder) may be + A general purpose cloud may also include OpenStack + Object Storage (swift). + OpenStack Block Storage + (cinder) may be selected to provide persistent storage to applications and instances although, depending on the use case, this could be - optional.
+ optional. +
Supplemental software A general purpose OpenStack deployment consists of more than @@ -455,7 +474,7 @@ implementations are also made highly available. This high availability can be achieved by using software such as Keepalived or Pacemaker with Corosync. Pacemaker and Corosync - can provide Active-Active or Active-Passive highly available + can provide active-active or active-passive highly available configuration depending on the specific service in the OpenStack environment. Using this software can affect the design as it assumes at least a 2-node controller diff --git a/doc/arch-design/generalpurpose/section_user_requirements_general_purpose.xml b/doc/arch-design/generalpurpose/section_user_requirements_general_purpose.xml index ac91bef5dd..498c53756c 100644 --- a/doc/arch-design/generalpurpose/section_user_requirements_general_purpose.xml +++ b/doc/arch-design/generalpurpose/section_user_requirements_general_purpose.xml @@ -7,12 +7,13 @@ User requirements The general purpose cloud is built following the - Infrastructure-as-a-Service (IaaS) model; as a platform best + Infrastructure-as-a-Service (IaaS) + model; as a platform best suited for use cases with simple requirements. The general purpose cloud user requirements themselves are typically not complex. However, it is still important to capture them even if the project has minimum business and technical requirements - such as a Proof of Concept (PoC) or a small lab + such as a proof of concept (PoC) or a small lab platform. These user considerations are written from the perspective of the organization that is building the cloud, not from the diff --git a/doc/arch-design/introduction/section_how_this_book_is_organized.xml b/doc/arch-design/introduction/section_how_this_book_is_organized.xml index a827722612..217ad20aef 100644 --- a/doc/arch-design/introduction/section_how_this_book_is_organized.xml +++ b/doc/arch-design/introduction/section_how_this_book_is_organized.xml @@ -7,7 +7,8 @@ How this book is organized This book has been organized into various chapters that help define the use cases associated with making architectural - choices related to an OpenStack cloud installation. Each + choices related to an OpenStack cloud + installation. Each chapter is intended to stand alone to encourage individual chapter readability, however each chapter is designed to contain useful information that may be applicable in