Edits to Overview/Architecture in Install Guide

Closes-Bug: #1238940

Change-Id: I200bd24315aaa3cd8b445cf36334375c89bf7838
author: Diane Fleming
This commit is contained in:
Diane Fleming 2013-10-11 16:08:18 -05:00 committed by annegentle
parent 2326e2d501
commit 549daf2e8b
13 changed files with 291 additions and 21361 deletions

View File

@ -1,46 +1,171 @@
<?xml version="1.0" encoding="utf-8"?>
<chapter xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"
xml:id="ch_getting-started-with-openstack">
<title>Get started with OpenStack</title>
<?dbhtml stop-chunking?>
<para>The OpenStack project is an open source cloud computing
platform for all types of clouds, which aims to be simple to
implement, massively scalable, and feature rich. Developers and
cloud computing technologists from around the world create the
OpenStack project.</para>
<para>OpenStack provides an Infrastructure as a Service (IaaS)
solution through a set of interrelated services. Each service
offers an application programming interface (API) that facilitates
this integration.</para>
<xi:include href="section_getstart_architecture.xml"/>
<?hard-pagebreak?>
<section xml:id="openstack-services">
<title>OpenStack services</title>
<para>This section describes OpenStack services in detail.</para>
<xi:include href="section_getstart_dashboard.xml"/>
<xi:include href="section_keystone-concepts.xml"/>
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"
xml:id="ch_getting-started-with-openstack">
<title>Get started with OpenStack</title>
<?dbhtml stop-chunking?>
<para xml:id="para1">The OpenStack project is an open source cloud
computing platform for all types of clouds, which aims to be
simple to implement, massively scalable, and feature
rich. Developers and cloud computing technologists
from around the world create the OpenStack project.</para>
<para xml:id="para2">OpenStack provides an Infrastructure as a
Service (IaaS) solution through a set of interrelated
services. Each service offers an application programming
interface (API) that facilitates this integration. Depending
on your needs, you can install some or all services.</para>
<para xml:id="para3">The following table describes the OpenStack
services that make up the OpenStack architecture:</para>
<table rules="all" xml:id="table1" width="85%">
<caption>OpenStack services</caption>
<col width="15%"/>
<col width="15%"/>
<col width="70%"/>
<thead>
<tr>
<th>Service</th>
<th>Project name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><link
xlink:href="http://www.openstack.org/software/openstack-dashboard/"
>Dashboard</link></td>
<td><link
xlink:href="http://docs.openstack.org/developer/horizon/"
>Horizon</link></td>
<td>Enables users to interact with OpenStack services
to launch an instance, assign IP addresses, set
access controls, and so on.</td>
</tr>
<tr>
<td><link
xlink:href="http://www.openstack.org/software/openstack-compute/"
>Compute</link></td>
<td><link
xlink:href="http://docs.openstack.org/developer/nova/"
>Nova</link></td>
<td>Provisions and manages large networks of virtual
machines on demand.</td>
</tr>
<tr>
<td><link
xlink:href="http://www.openstack.org/software/openstack-networking/"
>Networking</link></td>
<td><link
xlink:href="http://docs.openstack.org/developer/neutron/"
>Neutron</link></td>
<td>Enables network connectivity as a service among
interface devices managed by other OpenStack
services, usually Compute. Enables users to create
and attach interfaces to networks. Has a pluggable
architecture that supports many popular networking
vendors and technologies.</td>
</tr>
<tr><th colspan="3" align="center">Storage</th></tr>
<tr>
<td><link
xlink:href="http://www.openstack.org/software/openstack-storage/"
>Object Storage</link></td>
<td><link
xlink:href="http://docs.openstack.org/developer/swift/"
>Swift</link></td>
<td>Stores and gets files. Does not mount directories
like a file server.</td>
</tr>
<tr>
<td><link
xlink:href="http://www.openstack.org/software/openstack-storage/"
>Block Storage</link></td>
<td><link
xlink:href="http://docs.openstack.org/developer/cinder/"
>Cinder</link></td>
<td>Provides persistent block storage to guest virtual
machines.</td>
</tr>
<tr><th colspan="3" align="center">Shared services</th></tr>
<tr>
<td><link
xlink:href="http://www.openstack.org/software/openstack-shared-services/"
>Identity Service</link></td>
<td><link
xlink:href="http://docs.openstack.org/developer/keystone/"
>Keystone</link></td>
<td>Provides authentication and authorization for the
OpenStack services. Also provides a service
catalog within a particular OpenStack cloud.</td>
</tr>
<tr>
<td><link
xlink:href="http://www.openstack.org/software/openstack-shared-services/"
>Image Service</link></td>
<td><link
xlink:href="http://docs.openstack.org/developer/glance/"
>Glance</link></td>
<td>Provides a registry of virtual machine images.
Compute uses it to provision instances.</td>
</tr>
<tr>
<td><link
xlink:href="http://www.openstack.org/software/openstack-shared-services/"
>Metering/Monitoring Service</link></td>
<td><link
xlink:href="http://docs.openstack.org/developer/ceilometer/"
>Ceilometer</link></td>
<td>Monitors and meters the OpenStack cloud for
billing, benchmarking, scalability, and statistics
purposes.</td>
</tr>
<tr><th colspan="3" align="center">Higher-level services</th></tr>
<tr>
<td><link
xlink:href="http://www.openstack.org/software/openstack-shared-services/"
>Orchestration Service</link></td>
<td><link
xlink:href="http://docs.openstack.org/developer/heat/"
>Heat</link></td>
<td>Orchestrates multiple composite cloud applications by using
either the native HOT template format or the AWS
CloudFormation template format, through both an
OpenStack-native REST API and a CloudFormation-compatible
Query API.</td>
</tr>
</tbody>
</table>
<xi:include href="section_getstart_conceptual_arch.xml"/>
<xi:include href="section_getstart_logical_arch.xml"/>
<?hard-pagebreak?>
<xi:include href="section_getstart_compute.xml"/>
<?hard-pagebreak?>
<xi:include href="section_storage-concepts.xml"/>
<xi:include href="section_getstart_object-storage.xml"/>
<xi:include href="section_getstart_block-storage.xml"/>
<xi:include href="section_getstart_image.xml"/>
<xi:include href="section_getstart_networking.xml"/>
<?hard-pagebreak?>
<xi:include href="section_getstart_metering.xml"/>
<xi:include href="section_getstart_orchestration.xml"/>
</section>
<section xml:id="feedback">
<title>Feedback</title>
<para>To provide feedback on documentation, join and use the
<email>openstack-docs@lists.openstack.org</email> mailing list
at <link
xlink:href="http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs"
>OpenStack Documentation Mailing List</link>, or <link
xlink:href="https://bugs.launchpad.net/openstack-manuals/+filebug"
>report a bug</link>.</para>
</section>
<section xml:id="openstack-services">
<title>OpenStack services</title>
<para>This section describes OpenStack services in
detail.</para>
<xi:include href="section_getstart_compute.xml"/>
<?hard-pagebreak?>
<xi:include href="section_storage-concepts.xml"/>
<xi:include href="section_getstart_object-storage.xml"/>
<xi:include href="section_getstart_block-storage.xml"/>
<?hard-pagebreak?>
<xi:include href="section_getstart_networking.xml"/>
<?hard-pagebreak?>
<xi:include href="section_getstart_dashboard.xml"/>
<xi:include href="section_keystone-concepts.xml"/>
<?hard-pagebreak?>
<xi:include href="section_getstart_image.xml"/>
<xi:include href="section_getstart_metering.xml"/>
<xi:include href="section_getstart_orchestration.xml"/>
</section>
<section xml:id="feedback">
<title>Feedback</title>
<para>To provide feedback on documentation, join and use the
<email>openstack-docs@lists.openstack.org</email>
mailing list at <link
xlink:href="http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs"
>OpenStack Documentation Mailing List</link>, or <link
xlink:href="https://bugs.launchpad.net/openstack-manuals/+filebug"
>report a bug</link>.</para>
</section>
</chapter>

Binary file not shown.

Before

Width:  |  Height:  |  Size: 56 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 164 KiB

File diff suppressed because it is too large Load Diff

Binary file not shown.

Before

Width:  |  Height:  |  Size: 5.0 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 17 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 280 KiB

View File

@ -1,181 +0,0 @@
<section xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"
xml:id="openstack-architecture">
<title>OpenStack architecture</title>
<para>The following table describes the OpenStack services that
make up the OpenStack architecture. You may only install some
of these, depending on your needs.</para>
<table rules="all">
<caption>OpenStack services</caption>
<col width="20%"/>
<col width="10%"/>
<col width="70%"/>
<thead>
<tr>
<th>Service</th>
<th>Project name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><link
xlink:href="http://www.openstack.org/software/openstack-dashboard/"
>Dashboard</link></td>
<td><link
xlink:href="http://docs.openstack.org/developer/horizon/"
>Horizon</link></td>
<td>Enables users to interact with all OpenStack services to
launch an instance, assign IP addresses, set access
controls, and so on.</td>
</tr>
<tr>
<td><link
xlink:href="http://www.openstack.org/software/openstack-shared-services/"
>Identity Service</link></td>
<td><link
xlink:href="http://docs.openstack.org/developer/keystone/"
>Keystone</link></td>
<td>Provides authentication and authorization for all the
OpenStack services. Also provides a service catalog within
a particular OpenStack cloud.</td>
</tr>
<tr>
<td><link
xlink:href="http://www.openstack.org/software/openstack-compute/"
>Compute Service</link></td>
<td><link
xlink:href="http://docs.openstack.org/developer/nova/"
>Nova</link></td>
<td>Provisions and manages large networks of virtual
machines on demand.</td>
</tr>
<tr>
<td><link
xlink:href="http://www.openstack.org/software/openstack-storage/"
>Object Storage Service</link></td>
<td><link
xlink:href="http://docs.openstack.org/developer/swift/"
>Swift</link></td>
<td>Stores and retrieves files. Does not mount directories
like a file server.</td>
</tr>
<tr>
<td><link
xlink:href="http://www.openstack.org/software/openstack-storage/"
>Block Storage Service</link></td>
<td><link
xlink:href="http://docs.openstack.org/developer/cinder/"
>Cinder</link></td>
<td>Provides persistent block storage to guest virtual
machines.</td>
</tr>
<tr>
<td><link
xlink:href="http://www.openstack.org/software/openstack-shared-services/"
>Image Service</link></td>
<td><link
xlink:href="http://docs.openstack.org/developer/glance/"
>Glance</link></td>
<td>Provides a registry of virtual machine images. Compute
Service uses it to provision instances.</td>
</tr>
<tr>
<td><link
xlink:href="http://www.openstack.org/software/openstack-networking/"
>Networking Service</link></td>
<td><link
xlink:href="http://docs.openstack.org/developer/neutron/"
>Neutron</link></td>
<td>Enables network connectivity as a service among
interface devices managed by other OpenStack services,
usually Compute Service. Enables users to create and
attach interfaces to networks. Has a pluggable
architecture that supports many popular networking vendors
and technologies.</td>
</tr>
<tr>
<td><link
xlink:href="http://www.openstack.org/software/openstack-shared-services/"
>Metering/Monitoring Service</link></td>
<td><link
xlink:href="http://docs.openstack.org/developer/ceilometer/"
>Ceilometer</link></td>
<td>Monitors and meters the OpenStack cloud for billing,
benchmarking, scalability, and statistics purposes.</td>
</tr>
<tr>
<td><link
xlink:href="http://www.openstack.org/software/openstack-shared-services/"
>Orchestration Service</link></td>
<td><link
xlink:href="http://docs.openstack.org/developer/heat/"
>Heat</link></td>
<td>Orchestrates multiple composite cloud applications by
using the AWS CloudFormation template format, through both
an OpenStack-native REST API and a
CloudFormation-compatible Query API.</td>
</tr>
</tbody>
</table>
<?hard-pagebreak?>
<section xml:id="conceptual-architecture">
<title>Conceptual architecture</title>
<para>The following diagram shows the relationships among the
OpenStack services:</para>
<informalfigure xml:id="concept_arch">
<mediaobject>
<imageobject>
<imagedata
fileref="figures/openstack_havana_conceptual_arch.png"
contentwidth="6in"/>
</imageobject>
</mediaobject>
</informalfigure>
</section>
<?hard-pagebreak?>
<section xml:id="logical-architecture">
<title>Logical architecture</title>
<para>To design, install, and configure a cloud, cloud
administrators must understand the logical
architecture.</para>
<para>OpenStack modules are one of the following types:</para>
<itemizedlist>
<listitem>
<para>Daemon. Runs as a daemon. On Linux platforms, are
usually installed as a service.</para>
</listitem>
<listitem>
<para>Script. Runs installation and tests of a virtual
environment. For example, a script called
<code>run_tests.sh</code> installs a virtual environment
for a service and then may also run tests to verify that
virtual environment functions well.</para>
</listitem>
<listitem>
<para>Command-line interface (CLI). Enables users to submit
API calls to OpenStack services through easy-to-use
commands.</para>
</listitem>
</itemizedlist>
<para>The following diagram shows the most common, but not the
only, architecture for an OpenStack cloud:</para>
<!-- Source files in this repository in doc/src/docbkx/common/figures/openstack-arch-grizzly-v1.zip https://github.com/openstack/openstack-manuals/raw/master/doc/src/docbkx/common/figures/openstack-arch-grizzly-v1.zip -->
<figure xml:id="os-logical-arch">
<title>OpenStack logical architecture</title>
<mediaobject>
<imageobject>
<imagedata
fileref="figures/openstack-arch-grizzly-v1-logical.jpg"
contentwidth="6.5in"/>
</imageobject>
</mediaobject>
</figure>
<para>As in the conceptual architecture, end users can interact
through the dashboard, CLIs, and APIs. All services
authenticate through a common Identity Service and individual
services interact with each other through public APIs, except
where privileged administrator commands are necessary.</para>
</section>
</section>

View File

@ -0,0 +1,20 @@
<?xml version="1.0" encoding="UTF-8"?>
<section xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"
xml:id="conceptual-architecture">
<title>Conceptual architecture</title>
<para>The following diagram shows the relationships among the
OpenStack services:</para>
<!-- Source files in this repository in doc/src/docbkx/common/figures/openstack-arch-havana-v1.zip -->
<figure xml:id="concept_arch">
<title>OpenStack conceptual architecture</title>
<mediaobject>
<imageobject>
<imagedata
fileref="figures/openstack_havana_conceptual_arch.png"
contentwidth="6in"/>
</imageobject>
</mediaobject>
</figure>
</section>

View File

@ -0,0 +1,43 @@
<section xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"
xml:id="logical-architecture">
<title>Logical architecture</title>
<para>To design, install, and configure a cloud, cloud
administrators must understand the logical architecture.</para>
<para>OpenStack modules are one of the following types:</para>
<itemizedlist role="compact">
<listitem>
<para>Daemon. Runs as a daemon. On Linux platforms, a daemon is
usually installed as a service.</para>
</listitem>
<listitem>
<para>Script. Installs and tests of a virtual environment. For
example, the <code>run_tests.sh</code> script installs and
optionally tests a virtual environment for a service.</para>
</listitem>
<listitem>
<para>Command-line interface (CLI). Enables users to submit API
calls to OpenStack services through easy-to-use
commands.</para>
</listitem>
</itemizedlist>
<para>The following diagram shows the most common, but not the only,
architecture for an OpenStack cloud:</para>
<!-- Source files in this repository in doc/src/docbkx/common/figures/openstack-arch-havana-v1.zip -->
<figure xml:id="os-logical-arch">
<title>OpenStack logical architecture</title>
<mediaobject>
<imageobject>
<imagedata
fileref="figures/openstack-arch-havana-logical-v1.jpg"
contentwidth="6.5in"/>
</imageobject>
</mediaobject>
</figure>
<para>As in <xref linkend="concept_arch"/>, end users can interact
through the dashboard, CLIs, and APIs. All services authenticate
through a common Identity Service and individual services interact
with each other through public APIs, except where privileged
administrator commands are necessary.</para>
</section>

View File

@ -1,74 +1,77 @@
<chapter xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink"
version="5.0"
xml:id="ch_overview">
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"
xml:id="ch_overview">
<?dbhtml stop-chunking?>
<title>Overview and Architecture</title>
<section xml:id="overview-concepts">
<title>OpenStack Overview</title>
<para>The OpenStack project is an open source cloud computing
platform for all types of clouds, which aims to be simple to
implement, massively scalable, and feature rich. Developers and
cloud computing technologists from around the world create the
OpenStack project.</para>
<xi:include href="../common/section_getstart_architecture.xml"/>
</section>
<title>Architecture</title>
<para>This install guide offers a few of the many ways to install
OpenStack components and have them work together. It is meant as a
"choose your own adventure" guide, not a comprehensive guide. The
<citetitle>OpenStack Configuration Reference</citetitle> lists
every option in all OpenStack services. Before you begin an
installation adventure, here are some things you should know about
OpenStack concepts.</para>
<xi:include href="../common/ch_getstart.xml"
xpointer="element(para1)"/>
<xi:include href="../common/ch_getstart.xml"
xpointer="element(para2)"/>
<xi:include href="../common/ch_getstart.xml"
xpointer="element(para3)"/>
<xi:include href="../common/ch_getstart.xml"
xpointer="element(table1)"/>
<xi:include href="../common/section_getstart_conceptual_arch.xml"/>
<xi:include href="../common/section_getstart_logical_arch.xml"/>
<section xml:id="overview-architecture">
<title>Sample Architectures</title>
<para>This guide is written so that you can choose your own
OpenStack adventure. Because OpenStack is highly configurable to
meet different use cases, with many storage choices and
underlying software-defined networking scenarios, this guide
offers these main examples with the intention of expanding on
each:</para>
<title>Sample architectures</title>
<para>This guide enables you to choose your own OpenStack
adventure. OpenStack is highly configurable to meet different
needs with various storage and networking options.</para>
<para>This guide offers the following sample architecture
examples:</para>
<itemizedlist>
<listitem>
<para>Example architecture for simplicity: the most basic
architecture you can have: one node to run the "control" services, such
as database, message queue and API services for the Identity Service,
Image Service and Compute Service; and a second node to be our
Compute node that runs the hypervisor where our virtual machines will live.</para>
<figure xml:id="basic-architecture">
<title>Basic Architecture</title>
<mediaobject>
<imageobject>
<imagedata contentwidth="6in" fileref="figures/basic-architecture.svg"/>
</imageobject>
</mediaobject>
</figure>
<para os="fedora;rhel;centos">Technical details: Compute with KVM,
local ephemeral storage, nova-networks in multi-host flatDHCP,
MySQL, nova-api, default scheduler, Qpid for messaging,
Identity with SQL backend, Image with local storage,
Dashboard (optional extra). Use as many default options as possible.
</para>
<para os="ubuntu;debian;opensuse;sles">Technical details: Compute with KVM,
local ephemeral storage, nova-networks in multi-host flatDHCP,
MySQL, nova-api, default scheduler, RabbitMQ for messaging,
Identity with SQL backend, Image with local storage, Dashboard (optional extra).
Use as many default options as possible.
</para>
<para>Example basic architecture. This architecture has two
nodes. A cloud controller node runs the control services,
such as database, message queue and API services for the
Identity Service, Image Service and Compute. A compute node
runs the hypervisor where virtual machines live.</para>
<figure xml:id="basic-architecture">
<title>Basic architecture</title>
<mediaobject>
<imageobject>
<imagedata contentwidth="6in"
fileref="figures/basic-architecture.svg"/>
</imageobject>
</mediaobject>
</figure>
<para>Technical details: Compute with KVM, local ephemeral
storage, nova-network in multi-host flatDHCP mode, MySQL,
nova-api, default scheduler, <phrase os="fedora;rhel;centos"
>Qpid for messaging,</phrase><phrase
os="ubuntu;debian;opensuse">RabbitMQ for
messaging,</phrase> Identity with SQL back end, Image with
local storage, Dashboard (optional extra). Uses as many
default options as possible.</para>
</listitem>
<listitem>
<para>Example architecture from the OpenStack Operations
Guide: Same as above but with Block Storage backend
LVM/iSCSI, nova-network in multi-host with FlatDHCP, Live
Migration backend shared storage with NFS, and Object
Storage. One controller node and multiple compute
nodes.</para>
<para>Example architecture from the <link
xlink:href="http://docs.openstack.org/trunk/openstack-ops/content/"
><citetitle>OpenStack Operations
Guide</citetitle></link>. Same as the basic architecture
but with Block Storage LVM/iSCSI back end, nova-network in
multi-host with FlatDHCP, Live Migration back end shared
storage with NFS, and Object Storage. One controller node
and multiple compute nodes.</para>
</listitem>
<listitem>
<para>Example architecture with Identity and Object Storage
only (no Dashboard): Five node installation with Identity on
the proxy node and three replications of object servers.
<para>Example architecture with Identity Service and Object
Storage: Five node installation with Identity Service on the
proxy node and three replications of object servers.
Dashboard does not support this configuration so examples
are with CLI.</para>
</listitem>
<listitem>
<para>Example architecture with OpenStack Networking
(Neutron)</para>
<para>Example architecture with OpenStack Networking.</para>
</listitem>
</itemizedlist>
</section>