Remove DocBook XML files for Install Guide

Remove DocBook XML files and rename directory from install-guide-rst to
install-guide.

Adjust everything so that publishing works.
Update README to remove DocBook XML Install Guide specific instructions.

Implements: blueprint installguide-liberty
Change-Id: If723c44c3c0383dc8ab8e53798d82e7f0ee2cc57
This commit is contained in:
Andreas Jaeger 2015-08-19 09:18:49 +02:00
parent 1018c758c4
commit 25d1b7d617
269 changed files with 19 additions and 95090 deletions

8
.gitignore vendored
View File

@ -7,10 +7,10 @@ target/
/publish-docs/
/www/output/
/generated/
/doc/install-guide-rst/build-rdo/
/doc/install-guide-rst/build-obs/
/doc/install-guide-rst/build-ubuntu/
/doc/install-guide-rst/build-debian/
/doc/install-guide/build-rdo/
/doc/install-guide/build-obs/
/doc/install-guide/build-ubuntu/
/doc/install-guide/build-debian/
.doctrees
build/
/build-*.log.gz

View File

@ -44,9 +44,9 @@ source_lang = en
type = PO
[openstack-manuals-i18n.install-guide]
file_filter = doc/install-guide/locale/<lang>.po
file_filter = doc/install-guide/source/locale/<lang>/LC_MESSAGES/install-guide.po
minimum_perc = 75
source_file = doc/install-guide/locale/install-guide.pot
source_file = doc/install-guide/source/locale/install-guide.pot
source_lang = en
type = PO

View File

@ -48,7 +48,7 @@ The different manuals are in subdirectories of the
DocBook guides
--------------
* Normal guides
For example, the root directory of the *OpenStack Virtual Machine Image Guide*
is ``openstack-manuals/doc/image-guide``.
@ -66,22 +66,6 @@ The root of the generated HTML documentation is::
openstack-manuals/doc/image-guide/target/docbkx/webhelp/image-guide/content/index.html
* Installation guides
The root directory of the *OpenStack Install Guides*
is ``openstack-manuals/doc/install-guide``, you can get different operating system's guides::
cd openstack-manuals/doc/install-guide/
mvn clean generate-sources -Dprofile.os="ubuntu" -Doperating.system="apt"
mvn clean generate-sources -Dprofile.os="rhel;centos;fedora" -Doperating.system="yum"
mvn clean generate-sources -Dprofile.os="opensuse" -Doperating.system="zypper"
The generated PDF documentation file is::
openstack-manuals/doc/install-guide/target/docbkx/webhelp/local/install-guide/install/${operating.system}/openstack-install-guide-${operating.system}-local.pdf
The root of the generated HTML documentation is::
openstack-manuals/doc/install-guide/target/docbkx/webhelp/local/install-guide/install/${operating.system}/content/index.html
RST guides
----------

View File

@ -1,17 +1,15 @@
# directories to be set up
declare -A DIRECTORIES=(
["fr"]="common glossary image-guide"
["ja"]="common glossary image-guide install-guide"
["pt_BR"]="common install-guide"
["zh_CN"]="common glossary arch-design image-guide install-guide"
["ja"]="common glossary image-guide"
["zh_CN"]="common glossary arch-design image-guide"
)
# books to be built
declare -A BOOKS=(
["fr"]="image-guide"
["ja"]="image-guide install-guide user-guide user-guide-admin"
["pt_BR"]="install-guide"
["zh_CN"]="arch-design image-guide install-guide"
["ja"]="image-guide user-guide user-guide-admin"
["zh_CN"]="arch-design image-guide"
)
# draft books
@ -33,12 +31,12 @@ DOC_DIR="doc/"
# Values need to match content in
# project-config/jenkins/scripts/common_translation_update.sh
declare -A SPECIAL_BOOKS=(
["install-guide"]="RST"
["networking-guide"]="RST"
["user-guide"]="RST"
["user-guide-admin"]="RST"
["networking-guide"]="RST"
# In process of migration to RST
["admin-guide-cloud-rst"]="RST"
["install-guide-rst"]="RST"
# Skip guide while it's created
["contributor-guide"]="skip"
# This needs special handling, handle it with the RST tools.

View File

@ -1,93 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<appendix 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="reserved_user_ids">
<title>Reserved user IDs</title>
<para>
OpenStack reserves certain user IDs to run specific services and
own specific files. These user IDs are set up according to the
distribution packages. The following table gives an overview.
</para>
<note os="debian;opensuse;sles;ubuntu">
<para>Some OpenStack packages generate and assign user IDs
automatically during package installation. In these cases, the
user ID value is not important. The existence of the user ID is
what matters.
</para>
</note>
<table rules="all">
<caption>Reserved user IDs</caption>
<thead>
<tr>
<th>Name</th>
<th>Description</th>
<th>ID</th>
</tr>
</thead>
<tbody>
<!-- sorted by first column -->
<tr>
<td>ceilometer</td>
<td>OpenStack ceilometer daemons</td>
<td os="rhel;centos;fedora">166</td>
<td os="debian;opensuse;sles;ubuntu">Assigned during package installation</td>
</tr>
<tr>
<td>cinder</td>
<td>OpenStack cinder daemons</td>
<td os="rhel;centos;fedora">165</td>
<td os="debian;opensuse;sles;ubuntu">Assigned during package installation</td>
</tr>
<tr>
<td>glance</td>
<td>OpenStack glance daemons</td>
<td os="rhel;centos;fedora">161</td>
<td os="debian;opensuse;sles;ubuntu">Assigned during package installation</td>
</tr>
<tr>
<td>heat</td>
<td>OpenStack heat daemons</td>
<td os="rhel;centos;fedora">187</td>
<td os="debian;opensuse;sles;ubuntu">Assigned during package installation</td>
</tr>
<tr>
<td>keystone</td>
<td>OpenStack keystone daemons</td>
<td os="rhel;centos;fedora">163</td>
<td os="debian;opensuse;sles;ubuntu">Assigned during package installation</td>
</tr>
<tr>
<td>neutron</td>
<td>OpenStack neutron daemons</td>
<td os="rhel;centos;fedora">164</td>
<td os="debian;opensuse;sles;ubuntu">Assigned during package installation</td>
</tr>
<tr>
<td>nova</td>
<td>OpenStack nova daemons</td>
<td os="rhel;centos;fedora">162</td>
<td os="opensuse;sles">96</td>
<td os="debian;ubuntu">Assigned during package installation</td>
</tr>
<tr>
<td>swift</td>
<td>OpenStack swift daemons</td>
<td os="rhel;centos;fedora">160</td>
<td os="debian;opensuse;sles;ubuntu">Assigned during package installation</td>
</tr>
<tr>
<td>trove</td>
<td>OpenStack trove daemons</td>
<td os="debian;opensuse;sles;ubuntu;rhel;centos;fedora">Assigned during package installation</td>
</tr>
</tbody>
</table>
<para>Each user belongs to a user group with the same name as the
user.
</para>
</appendix>

View File

@ -1,105 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<book 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-install-manual"
status="draft">
<title>OpenStack Installation Guide for
<phrase os="rhel;centos;fedora">Red Hat Enterprise Linux 7, CentOS 7, and Fedora 21</phrase>
<phrase os="ubuntu">Ubuntu 14.04</phrase>
<phrase os="debian">Debian 7</phrase>
<phrase os="opensuse">openSUSE 13.2 and SUSE Linux Enterprise Server 12</phrase>
</title>
<?rax
status.bar.text.font.size="40px"
status.bar.text="Kilo"?>
<?rax subtitle.font.size="17px" title.font.size="32px"?>
<titleabbrev>OpenStack Installation Guide for
<phrase os="rhel;centos;fedora">Red Hat Enterprise Linux, CentOS, and Fedora</phrase>
<phrase os="ubuntu">Ubuntu 14.04</phrase>
<phrase os="opensuse">openSUSE and SUSE Linux Enterprise Server</phrase>
<phrase os="debian">Debian 7</phrase>
</titleabbrev>
<info>
<author>
<personname>
<firstname/>
<surname/>
</personname>
<affiliation>
<orgname>OpenStack</orgname>
</affiliation>
</author>
<copyright>
<year>2012</year>
<year>2013</year>
<year>2014</year>
<year>2015</year>
<holder>OpenStack Foundation</holder>
</copyright>
<releaseinfo>kilo</releaseinfo>
<productname>OpenStack Installation Guide</productname>
<pubdate/>
<legalnotice role="apache2">
<annotation>
<remark>Copyright details are filled in by the
template.</remark>
</annotation>
</legalnotice>
<abstract>
<para>The OpenStack® system consists of several key
projects that you install separately. These projects work
together depending on your cloud needs. These projects
include Compute, Identity Service, Networking, Image
Service, Block Storage, Object Storage, Telemetry,
Orchestration, and Database. You can install any of these
projects separately and configure them stand-alone or
as connected entities. <phrase
os="debian">This guide walks through an
installation by using packages available through
Debian 7 (code name: Wheezy).</phrase>
<phrase os="ubuntu">This guide walks through an
installation by using packages available through
Ubuntu 14.04.</phrase>
<phrase os="rhel;centos;fedora">This guide shows you
how to install OpenStack by using packages
available through Fedora 21 as well as on Red Hat
Enterprise Linux 7 and its derivatives through the
EPEL repository.</phrase>
<phrase os="opensuse;sles">This guide shows you how to
install OpenStack by using packages on openSUSE
13.2 and SUSE Linux Enterprise Server 12
through the Open Build Service Cloud
repository.</phrase> Explanations of configuration
options and sample configuration files are
included.</para>
</abstract>
</info>
<!-- Chapters are referred from the book file through these
include statements. You can add additional chapters using
these types of statements. -->
<xi:include href="../common/ch_preface.xml"/>
<xi:include href="ch_overview.xml"/>
<xi:include href="ch_basic_environment.xml"/>
<xi:include href="ch_debconf.xml"/>
<xi:include href="ch_keystone.xml"/>
<xi:include href="ch_glance.xml"/>
<xi:include href="ch_nova.xml"/>
<xi:include href="ch_networking.xml"/>
<xi:include href="ch_horizon.xml"/>
<xi:include href="ch_cinder.xml"/>
<xi:include href="ch_swift.xml"/>
<xi:include href="ch_heat.xml"/>
<xi:include href="ch_ceilometer.xml"/>
<!-- Chapter trove disabled on behalf. -->
<!-- <xi:include href="ch_trove.xml"/> -->
<!-- Chapter sahara disabled on behalf. -->
<!-- <xi:include href="ch_sahara.xml"/> -->
<xi:include href="ch_launch-instance.xml"/>
<xi:include href="app_reserved_uids.xml"/>
<xi:include href="../common/app_support.xml"/>
<glossary role="auto"/>
</book>

View File

@ -1,54 +0,0 @@
<?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_basic_environment">
<?dbhtml stop-chunking?>
<title>Basic environment</title>
<note>
<para>
The draft version of this guide focuses on the future Liberty
release and will not work for the current Kilo release. If
you want to install Kilo, you must use the <link
xlink:href="http://docs.openstack.org">Kilo version</link>
of this guide instead.
</para>
</note>
<para>This chapter explains how to configure each node in the
<link linkend="architecture_example-architectures">example architectures</link>
including the <link linkend="example-architecture-with-legacy-networking-hw">
two-node architecture with legacy networking</link> and
<link linkend="example-architecture-with-neutron-networking-hw">three-node
architecture with OpenStack Networking (neutron)</link>.</para>
<note>
<para>Although most environments include Identity, Image service,
Compute, at least one networking service, and the dashboard, the
Object Storage service can operate independently. If your use case
only involves Object Storage, you can skip to
<xref linkend="ch_swift"/> after configuring the appropriate nodes
for it. However, the dashboard requires at least
the Image service and Compute.</para>
</note>
<note>
<para>You must use an account with administrative privileges to configure
each node. Either run the commands as the <literal>root</literal> user
or configure the <literal>sudo</literal> utility.</para>
</note>
<note>
<para>
The <command>systemctl enable</command> call on openSUSE outputs
a warning message when the service uses SysV Init scripts
instead of native systemd files. This warning can be ignored.
</para>
</note>
<xi:include href="section_basics-prerequisites.xml"/>
<xi:include href="section_basics-security.xml"/>
<xi:include href="section_basics-networking.xml"/>
<xi:include href="section_basics-ntp.xml"/>
<xi:include href="section_basics-packages.xml"/>
<xi:include href="section_basics-database.xml"/>
<xi:include href="section_basics-queue.xml"/>
</chapter>

View File

@ -1,24 +0,0 @@
<?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_ceilometer">
<title>Add the Telemetry module</title>
<para>Telemetry provides a framework for monitoring and metering
the OpenStack cloud. It is also known as the ceilometer
project.</para>
<xi:include href="../common/section_getstart_telemetry.xml"/>
<xi:include href="section_ceilometer-controller.xml"/>
<xi:include href="section_ceilometer-nova.xml"/>
<xi:include href="section_ceilometer-glance.xml"/>
<xi:include href="section_ceilometer-cinder.xml"/>
<xi:include href="section_ceilometer-swift.xml"/>
<xi:include href="section_ceilometer-verify.xml"/>
<section xml:id="section_ceilometer_next_steps">
<title>Next steps</title>
<para>Your OpenStack environment now includes Telemetry. You can
<link linkend="launch-instance">launch an instance</link> or add more
services to your environment in the previous chapters.</para>
</section>
</chapter>

View File

@ -1,33 +0,0 @@
<?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_cinder">
<title>Add the Block Storage service</title>
<para>The OpenStack Block Storage service provides block storage devices
to guest instances. The method in which the storage is provisioned and
consumed is determined by the Block Storage driver, or drivers
in the case of a multi-backend configuration. There are a variety of
drivers that are available: NAS/SAN, NFS, iSCSI, Ceph, and more.
The Block Storage API and scheduler services typically run on the controller
nodes. Depending upon the drivers used, the volume service can run
on controllers, compute nodes, or standalone storage nodes.
For more information, see the
<link xlink:href="http://docs.openstack.org/kilo/config-reference/content/section_volume-drivers.html">
<citetitle>Configuration Reference</citetitle></link>.</para>
<note>
<para>This chapter omits the backup manager because it depends on the
Object Storage service.</para>
</note>
<xi:include href="../common/section_getstart_block-storage.xml"/>
<xi:include href="section_cinder-controller-node.xml"/>
<xi:include href="section_cinder-storage-node.xml"/>
<xi:include href="section_cinder-verify.xml"/>
<section xml:id="section_cinder_next_steps">
<title>Next steps</title>
<para>Your OpenStack environment now includes Block Storage. You can
<link linkend="launch-instance">launch an instance</link> or add more
services to your environment in the following chapters.</para>
</section>
</chapter>

View File

@ -1,14 +0,0 @@
<?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_debconf"
os="debian">
<title>Configure OpenStack with debconf</title>
<xi:include href="section_debconf-concepts.xml"/>
<xi:include href="section_debconf-dbconfig-common.xml"/>
<xi:include href="section_debconf-rabbitmq.xml"/>
<xi:include href="section_debconf-keystone_authtoken.xml"/>
<xi:include href="section_debconf-api-endpoints.xml"/>
</chapter>

View File

@ -1,31 +0,0 @@
<?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_glance">
<title>Add the Image service</title>
<para>The OpenStack Image service (glance) enables users to discover,
register, and retrieve virtual machine images. It offers a <glossterm
baseform="RESTful">REST</glossterm> API that enables you to
query virtual machine image metadata and retrieve an actual image.
You can store virtual machine images made available through the
Image service in a variety of locations, from simple file systems
to object-storage systems like OpenStack Object Storage.</para>
<important>
<para>For simplicity, this guide describes configuring the Image service to
use the <literal>file</literal> back end, which uploads and stores in a
directory on the controller node hosting the Image service. By
default, this directory is <filename>/var/lib/glance/images/</filename>.
</para>
<para>Before you proceed, ensure that the controller node has at least
several gigabytes of space available in this directory.</para>
<para>For information on requirements for other back ends, see <link
xlink:href="http://docs.openstack.org/trunk/config-reference/content/ch_configuring-openstack-image-service.html"
><citetitle>Configuration
Reference</citetitle></link>.</para>
</important>
<xi:include href="../common/section_getstart_image.xml"/>
<xi:include href="section_glance-install.xml"/>
<xi:include href="section_glance-verify.xml"/>
</chapter>

View File

@ -1,19 +0,0 @@
<?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_heat">
<title>Add the Orchestration module</title>
<para>The Orchestration module (heat) uses a heat orchestration template
(HOT) to create and manage cloud resources.</para>
<xi:include href="../common/section_getstart_orchestration.xml"/>
<xi:include href="section_heat-install.xml"/>
<xi:include href="section_heat-verify.xml"/>
<section xml:id="section_heat_next_steps">
<title>Next steps</title>
<para>Your OpenStack environment now includes Orchestration. You can
<link linkend="launch-instance">launch an instance</link> or add more
services to your environment in the following chapters.</para>
</section>
</chapter>

View File

@ -1,60 +0,0 @@
<?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_horizon">
<title>Add the dashboard</title>
<para>The OpenStack dashboard, also known as <link
xlink:href="https://git.openstack.org/cgit/openstack/horizon"
>Horizon</link>, is a Web interface that enables cloud
administrators and users to manage various OpenStack resources and
services.</para>
<para>The dashboard enables web-based interactions with the
OpenStack Compute cloud controller through the OpenStack
APIs.</para>
<para>Horizon enables you to customize the brand of the dashboard.</para>
<para>Horizon provides a set of core classes and reusable templates and tools.</para>
<para>This example deployment uses an Apache web server.</para>
<xi:include href="section_dashboard-install.xml"/>
<xi:include href="section_dashboard-verify.xml"/>
<section xml:id="section_horizon_next_steps">
<title>Next steps</title>
<para>Your OpenStack environment now includes the dashboard. You can
<link linkend="launch-instance">launch an instance</link> or add
more services to your environment in the following chapters.</para>
<para>After you install and configure the dashboard, you can
complete the following tasks:</para>
<itemizedlist>
<listitem>
<para>Provide users with a public IP address, a username, and a password
so they can access the dashboard through a web browser. In case of
any SSL certificate connection problems, point the server
IP address to a domain name, and give users access.</para>
</listitem>
<listitem>
<para>Customize your dashboard. See section <link xlink:href="http://docs.openstack.org/admin-guide-cloud/content/ch_install-dashboard.html#dashboard-custom-brand"
>Customize the dashboard</link> in the <link xlink:href="http://docs.openstack.org/admin-guide-cloud/content/"
><citetitle>OpenStack Cloud Administrator Guide</citetitle></link>
for information on setting up colors, logos, and site titles.</para>
</listitem>
<listitem>
<para>Set up session storage. See section <link xlink:href="http://docs.openstack.org/admin-guide-cloud/content/dashboard-sessions.html#dashboard-sessions">Set up session storage for the dashboard</link>
in the <link xlink:href="http://docs.openstack.org/admin-guide-cloud/content/"
><citetitle>OpenStack Cloud Administrator Guide</citetitle></link> for information on user
session data.</para>
</listitem>
<listitem>
<para>To use the VNC client with the dashboard, the browser
must support HTML5 Canvas and HTML5 WebSockets.</para>
<para>For details about browsers that support noVNC, see <link
xlink:href="https://github.com/kanaka/noVNC/blob/master/README.md">
https://github.com/kanaka/noVNC/blob/master/README.md</link>,
and <link xlink:href="https://github.com/kanaka/noVNC/wiki/Browser-support">
https://github.com/kanaka/noVNC/wiki/Browser-support</link>,
respectively.</para>
</listitem>
</itemizedlist>
</section>
</chapter>

View File

@ -1,14 +0,0 @@
<?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_keystone">
<title>Add the Identity service</title>
<xi:include href="../common/section_keystone-concepts.xml"/>
<xi:include href="section_keystone-install.xml"/>
<xi:include href="section_keystone-services.xml"/>
<xi:include href="section_keystone-users.xml"/>
<xi:include href="section_keystone-verify.xml"/>
<xi:include href="section_keystone-openrc.xml"/>
</chapter>

View File

@ -1,33 +0,0 @@
<?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="launch-instance">
<title>Launch an instance</title>
<para>An instance is a VM that OpenStack provisions on a compute node.
This guide shows you how to launch a minimal instance using the
<glossterm>CirrOS</glossterm> image that you added to your environment
in the <xref linkend="ch_glance"/> chapter. In these steps, you use the
command-line interface (CLI) on your controller node or any system with
the appropriate OpenStack client libraries. To use the dashboard, see the
<link
xlink:href="http://docs.openstack.org/user-guide/dashboard.html">
<citetitle>OpenStack User Guide</citetitle></link>.</para>
<para>Launch an instance using
<link linkend="launch-instance-neutron">OpenStack Networking (neutron)
</link> or
<link linkend="launch-instance-nova">legacy networking (nova-network)
</link>. For more
information, see the
<link
xlink:href="http://docs.openstack.org/user-guide/cli_launch_instances.html">
<citetitle>OpenStack User Guide</citetitle></link>.</para>
<note>
<para>These steps reference example components created in previous
chapters. You must adjust certain values such as IP addresses to
match your environment.</para>
</note>
<xi:include href="section_launch-instance-neutron.xml"/>
<xi:include href="section_launch-instance-nova.xml"/>
</chapter>

View File

@ -1,44 +0,0 @@
<?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_networking">
<title>Add a networking component</title>
<para>This chapter explains how to install and configure either
OpenStack Networking (neutron), or the legacy <systemitem
class="service">nova-network</systemitem> component.
The <systemitem class="service">nova-network</systemitem> service
enables you to deploy one network type per instance and is
suitable for basic network functionality. OpenStack Networking
enables you to deploy multiple network types per instance and
includes <glossterm baseform="plug-in">plug-ins</glossterm> for a
variety of products that support <glossterm>virtual
networking</glossterm>.</para>
<para>For more information, see the <link
xlink:href="http://docs.openstack.org/admin-guide-cloud/content/ch_networking.html"
>Networking</link> chapter of the <citetitle>OpenStack Cloud
Administrator Guide</citetitle>.</para>
<section xml:id="section_neutron-networking">
<title>OpenStack Networking (neutron)</title>
<xi:include parse="xml" href="../common/section_getstart_networking.xml"/>
<xi:include href="section_neutron-concepts.xml"/>
<xi:include href="section_neutron-controller-node.xml"/>
<xi:include href="section_neutron-network-node.xml"/>
<xi:include href="section_neutron-compute-node.xml"/>
<xi:include href="section_neutron-initial-networks.xml"/>
</section>
<section xml:id="section_nova-networking">
<title>Legacy networking (nova-network)</title>
<xi:include href="section_nova-networking-controller-node.xml"/>
<xi:include href="section_nova-networking-compute-node.xml"/>
<xi:include href="section_nova-networking-initial-network.xml"/>
</section>
<section xml:id="section_networking_next_steps">
<title>Next steps</title>
<para>Your OpenStack environment now includes the core components
necessary to launch a basic instance. You can <link
linkend="launch-instance">launch an instance</link> or add
more OpenStack services to your environment.</para>
</section>
</chapter>

View File

@ -1,13 +0,0 @@
<?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_nova">
<?dbhtml stop-chunking?>
<title>Add the Compute service</title>
<xi:include href="../common/section_getstart_compute.xml"/>
<xi:include href="section_nova-controller-install.xml"/>
<xi:include href="section_nova-compute-install.xml"/>
<xi:include href="section_nova-verify.xml"/>
</chapter>

View File

@ -1,258 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE chapter [
<!ENTITY % openstack SYSTEM "../common/entities/openstack.ent">
%openstack;
]>
<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">
<?dbhtml stop-chunking?>
<title>Architecture</title>
<section xml:id="architecture_overview">
<title>Overview</title>
<para>The <glossterm>OpenStack</glossterm> project is an open source cloud
computing platform that supports all types of cloud environments. The
project aims for simple implementation, massive scalability, and a rich
set of features. Cloud computing experts from around the world
contribute to the project.</para>
<para>OpenStack provides an Infrastructure-as-a-Service
(<glossterm>IaaS</glossterm>) solution through a variety of complemental
services. Each service offers an application programming interface
(<glossterm>API</glossterm>) that facilitates this integration. The
following table provides a list of OpenStack services:</para>
<xi:include href="../common/ch_getstart.xml"
xpointer="element(table1)"/>
<para>This guide describes how to deploy these services in a functional
test environment and, by example, teaches you how to build a production
environment. Realistically, you would use automation tools such as
Ansible, Chef, and Puppet to deploy and manage a production
environment.</para>
</section>
<section xml:id="architecture_conceptual-architecture">
<title>Conceptual architecture</title>
<para>Launching a virtual machine or instance involves many interactions
among several services. The following diagram provides the conceptual
architecture of a typical OpenStack environment.</para>
<figure xml:id="conceptual-architecture">
<title>Conceptual architecture</title>
<mediaobject>
<imageobject>
<imagedata contentwidth="6in"
fileref="../common/figures/openstack_kilo_conceptual_arch.png"/>
</imageobject>
</mediaobject>
</figure>
</section>
<section xml:id="architecture_example-architectures">
<title>Example architectures</title>
<para>OpenStack is highly configurable to meet different needs with various
compute, networking, and storage options. This guide enables you to
choose your own OpenStack adventure using a combination of core and
optional services. This guide uses the following example
architectures:</para>
<itemizedlist>
<listitem>
<para>Three-node architecture with OpenStack Networking
(neutron) and optional nodes for Block Storage and Object
Storage services.</para>
<itemizedlist>
<listitem>
<para>The
<glossterm baseform="cloud controller node"
>controller node</glossterm> runs the Identity service, Image
Service, management portions of Compute and Networking,
Networking plug-in, and the dashboard. It also includes
supporting services such as a SQL database,
<glossterm>message queue</glossterm>, and
<glossterm>Network Time Protocol (NTP)</glossterm>.</para>
<para>Optionally, the controller node runs portions of
Block Storage, Object Storage, Orchestration, Telemetry,
Database, and Data processing services. These
components provide additional features for your
environment.</para>
</listitem>
<listitem>
<para>The network node runs the Networking plug-in and
several agents that provision tenant networks and provide
switching, routing,
<glossterm baseform="Network Address Translation (NAT)"
>NAT</glossterm>, and <glossterm>DHCP</glossterm> services.
This node also handles external (Internet) connectivity for
tenant virtual machine instances.</para>
</listitem>
<listitem>
<para>The <glossterm>compute node</glossterm> runs the
<glossterm>hypervisor</glossterm> portion of Compute
that operates <glossterm>tenant</glossterm>
<glossterm baseform="virtual machine (VM)">virtual machines</glossterm>
or instances. By default, Compute uses
<glossterm baseform="kernel-based VM (KVM)">KVM</glossterm>
as the <glossterm>hypervisor</glossterm>. The compute node
also runs the Networking plug-in and an agent that connect
tenant networks to instances and provide firewalling
(<glossterm baseform="security group"
>security groups</glossterm>) services. You can run more
than one compute node.</para>
<para>Optionally, the compute node runs a Telemetry
agent to collect meters. Also, it can contain a third
network interface on a separate storage network to improve
performance of storage services.</para>
</listitem>
<listitem>
<para>The optional Block Storage node contains the disks that
the Block Storage service provisions for tenant virtual machine
instances. You can run more than one of these nodes.</para>
<para>Optionally, the Block Storage node runs a Telemetry
agent to collect meters. Also, it can contain a second
network interface on a separate storage network to improve
performance of storage services.</para>
</listitem>
<listitem>
<para>The optional Object Storage nodes contain the disks that
the Object Storage service uses for storing accounts,
containers, and objects. You can run more than two of these
nodes. However, the minimal architecture example requires
two nodes.</para>
<para>Optionally, these nodes can contain a second network
interface on a separate storage network to improve
performance of storage services.</para>
</listitem>
</itemizedlist>
<note>
<para>When you implement this architecture, skip
<xref linkend="section_nova-networking" /> in
<xref linkend="ch_networking" />. Optional services might
require additional nodes or additional resources on existing
nodes.</para>
</note>
<figure xml:id="example-architecture-with-neutron-networking-hw">
<title>Minimal architecture example with OpenStack Networking
(neutron)&mdash;Hardware requirements</title>
<mediaobject>
<imageobject>
<imagedata contentwidth="6in"
fileref="../common/figures/installguidearch-neutron-hw.png"/>
</imageobject>
</mediaobject>
</figure>
<figure xml:id="example-architecture-with-neutron-networking-networks">
<title>Minimal architecture example with OpenStack Networking
(neutron)&mdash;Network layout</title>
<mediaobject>
<imageobject>
<imagedata contentwidth="6in"
fileref="../common/figures/installguidearch-neutron-networks.png"/>
</imageobject>
</mediaobject>
</figure>
<figure xml:id="example-architecture-with-neutron-networking-services">
<title>Minimal architecture example with OpenStack Networking
(neutron)&mdash;Service layout</title>
<mediaobject>
<imageobject>
<imagedata contentwidth="6in"
fileref="../common/figures/installguidearch-neutron-services.png"/>
</imageobject>
</mediaobject>
</figure>
</listitem>
<listitem>
<para>Two-node architecture with legacy networking
(nova-network) and optional nodes for Block Storage and
Object Storage services.</para>
<itemizedlist>
<listitem>
<para>The
<glossterm baseform="cloud controller node"
>controller node</glossterm> runs the Identity service,
Image service, management portion of Compute, and the
dashboard. It also includes supporting services such as
a SQL database, <glossterm>message queue</glossterm>, and
<glossterm>Network Time Protocol (NTP)</glossterm>.</para>
<para>Optionally, the controller node runs portions of
Block Storage, Object Storage, Orchestration, Telemetry,
Database, and Data processing services. These
components provide additional features for your
environment.</para>
</listitem>
<listitem>
<para>The <glossterm>compute node</glossterm> runs the
<glossterm>hypervisor</glossterm> portion of Compute
that operates <glossterm>tenant</glossterm>
<glossterm baseform="virtual machine (VM)">virtual machines</glossterm>
or instances. By default, Compute uses
<glossterm baseform="kernel-based VM (KVM)">KVM</glossterm>
as the <glossterm>hypervisor</glossterm>. Compute also
provisions tenant networks and provides firewalling
(<glossterm baseform="security group"
>security groups</glossterm>) services. You can run more
than one compute node.</para>
<para>Optionally, the compute node runs a Telemetry
agent to collect meters. Also, it can contain a third
network interface on a separate storage network to improve
performance of storage services.</para>
</listitem>
<listitem>
<para>The optional Block Storage node contains the disks that
the Block Storage service provisions for tenant virtual machine
instances. You can run more than one of these nodes.</para>
<para>Optionally, the Block Storage node runs a Telemetry
agent to collect meters. Also, it can contain a second
network interface on a separate storage network to improve
performance of storage services.</para>
</listitem>
<listitem>
<para>The optional Object Storage nodes contain the disks that
the Object Storage service uses for storing accounts,
containers, and objects. You can run more than two of these
nodes. However, the minimal architecture example requires
two nodes.</para>
<para>Optionally, these nodes can contain a second network
interface on a separate storage network to improve
performance of storage services.</para>
</listitem>
</itemizedlist>
<note>
<para>When you implement this architecture, skip
<xref linkend="section_neutron-networking" /> in
<xref linkend="ch_networking" />. To use optional services, you
might need to build additional nodes, as described in
subsequent chapters.</para>
</note>
<figure xml:id="example-architecture-with-legacy-networking-hw">
<title>Minimal architecture example with legacy networking
(nova-network)&mdash;Hardware requirements</title>
<mediaobject>
<imageobject>
<imagedata contentwidth="6in"
fileref="../common/figures/installguidearch-nova-hw.png"/>
</imageobject>
</mediaobject>
</figure>
<figure xml:id="example-architecture-with-legacy-networking-networks">
<title>Minimal architecture example with legacy networking
(nova-network)&mdash;Network layout</title>
<mediaobject>
<imageobject>
<imagedata contentwidth="6in"
fileref="../common/figures/installguidearch-nova-networks.png"/>
</imageobject>
</mediaobject>
</figure>
<figure xml:id="example-architecture-with-legacy-networking-services">
<title>Minimal architecture example with legacy networking
(nova-network)&mdash;Service layout</title>
<mediaobject>
<imageobject>
<imagedata contentwidth="6in"
fileref="../common/figures/installguidearch-nova-services.png"/>
</imageobject>
</mediaobject>
</figure>
</listitem>
</itemizedlist>
</section>
</chapter>

View File

@ -1,19 +0,0 @@
<?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_sahara">
<title>Add the Data processing service</title>
<para>The Data processing service (sahara) enables users to provide a
scalable data processing stack and associated management interfaces.
This includes provisioning and operation of data processing clusters as
well as scheduling and operation of data processing jobs.
</para>
<warning><para>This chapter is a work in progress. It may contain
incorrect information, and will be updated frequently.</para></warning>
<xi:include href="../common/section_getstart_sahara.xml"/>
<xi:include href="section_sahara-install.xml" />
<xi:include href="section_sahara-verify.xml" />
</chapter>

View File

@ -1,25 +0,0 @@
<?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_swift">
<title>Add Object Storage</title>
<para>The OpenStack Object Storage services (swift) work together to
provide object storage and retrieval through a
<glossterm baseform="RESTful">REST</glossterm> API. Your environment
must at least include the Identity service (keystone) prior to
deploying Object Storage.</para>
<xi:include href="../common/section_getstart_object-storage.xml"/>
<xi:include href="section_swift-controller-node.xml"/>
<xi:include href="section_swift-storage-node.xml"/>
<xi:include href="section_swift-initial-rings.xml"/>
<xi:include href="section_swift-finalize-installation.xml"/>
<xi:include href="section_swift-verify.xml"/>
<section xml:id="section_swift_next_steps">
<title>Next steps</title>
<para>Your OpenStack environment now includes Object Storage. You can
<link linkend="launch-instance">launch an instance</link> or add more
services to your environment in the following chapters.</para>
</section>
</chapter>

View File

@ -1,16 +0,0 @@
<?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_trove">
<title>Add the Database service</title>
<para>Use the <glossterm baseform="Database service">Database
service</glossterm> to create cloud database resources. The
integrated project name is <glossterm>trove</glossterm>.</para>
<warning><para>This chapter is a work in progress. It may contain
incorrect information, and will be updated frequently.</para></warning>
<xi:include href="../common/section_getstart_trove.xml"/>
<xi:include href="section_trove-install.xml" />
<xi:include href="section_trove-verify.xml" />
</chapter>

Binary file not shown.

Before

Width:  |  Height:  |  Size: 504 KiB

File diff suppressed because it is too large Load Diff

Before

Width:  |  Height:  |  Size: 205 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 63 KiB

File diff suppressed because one or more lines are too long

Before

Width:  |  Height:  |  Size: 629 KiB

File diff suppressed because one or more lines are too long

Before

Width:  |  Height:  |  Size: 33 KiB

File diff suppressed because it is too large Load Diff

Before

Width:  |  Height:  |  Size: 42 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 28 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 13 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 10 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 20 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 16 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 28 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 35 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 14 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 15 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 6.4 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 42 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 37 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 38 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 10 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 14 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 9.8 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 11 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 10 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 11 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 17 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 49 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 24 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 11 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 16 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 18 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 19 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 8.2 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 8.3 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 18 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 8.1 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 58 KiB

View File

@ -1,995 +0,0 @@
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!-- Created with Inkscape (http://www.inkscape.org/) -->
<svg
xmlns:dc="http://purl.org/dc/elements/1.1/"
xmlns:cc="http://creativecommons.org/ns#"
xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
xmlns:svg="http://www.w3.org/2000/svg"
xmlns="http://www.w3.org/2000/svg"
xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
width="680"
height="530.00006"
id="svg4396"
version="1.1"
inkscape:version="0.48.4 r9939"
sodipodi:docname="installguide_arch-neutron.svg">
<defs
id="defs4398" />
<sodipodi:namedview
inkscape:document-units="mm"
pagecolor="#ffffff"
bordercolor="#666666"
borderopacity="1.0"
inkscape:pageopacity="0.0"
inkscape:pageshadow="2"
inkscape:zoom="1"
inkscape:cx="469.99999"
inkscape:cy="269.75908"
inkscape:current-layer="layer1"
id="namedview4400"
showgrid="true"
inkscape:snap-bbox="true"
inkscape:bbox-nodes="true"
units="mm"
fit-margin-top="0"
fit-margin-left="0"
fit-margin-right="0"
fit-margin-bottom="0"
inkscape:window-width="1366"
inkscape:window-height="746"
inkscape:window-x="-8"
inkscape:window-y="-8"
inkscape:window-maximized="1">
<inkscape:grid
type="xygrid"
id="grid4405"
empspacing="5"
visible="true"
enabled="true"
snapvisiblegridlinesonly="true"
originx="-20.000007px"
originy="-399.98715px"
dotted="false" />
</sodipodi:namedview>
<metadata
id="metadata4402">
<rdf:RDF>
<cc:Work
rdf:about="">
<dc:format>image/svg+xml</dc:format>
<dc:type
rdf:resource="http://purl.org/dc/dcmitype/StillImage" />
<dc:title />
</cc:Work>
</rdf:RDF>
</metadata>
<g
inkscape:label="Layer 1"
inkscape:groupmode="layer"
id="layer1"
transform="translate(-9.9999943,-14.09445)">
<g
transform="translate(1.2516975e-5,-308.26769)"
id="g3657">
<rect
ry="4.999999"
rx="5"
y="323.34317"
x="530.98096"
height="528.03802"
width="158.03801"
id="rect7705-0-8"
style="fill:#e0e0e0;fill-opacity:1;stroke:#000000;stroke-width:1.96199989;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" />
<text
sodipodi:linespacing="125%"
id="text7739-1-5"
y="342.36218"
x="610"
style="font-size:12px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans"
xml:space="preserve"><tspan
style="font-size:16px;text-align:center;text-anchor:middle"
y="342.36218"
x="610"
id="tspan7741-9-9"
sodipodi:role="line">Compute Node</tspan><tspan
style="font-size:14px;font-style:oblique;text-align:center;text-anchor:middle;-inkscape-font-specification:Sans Oblique"
id="tspan7743-5-4"
y="360.73312"
x="610"
sodipodi:role="line">compute1</tspan></text>
</g>
<g
transform="translate(1.2516975e-5,-308.26769)"
id="g3602">
<rect
ry="4.9999986"
rx="5"
y="323.34314"
x="350.98099"
height="528.03796"
width="158.03801"
id="rect7705-0"
style="fill:#e0e0e0;fill-opacity:1;stroke:#000000;stroke-width:1.96199977;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" />
<text
sodipodi:linespacing="125%"
id="text7739-1"
y="342.36215"
x="429.99997"
style="font-size:12px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans"
xml:space="preserve"><tspan
style="font-size:16px;text-align:center;text-anchor:middle"
y="342.36215"
x="429.99997"
id="tspan7741-9"
sodipodi:role="line">Network Node</tspan><tspan
style="font-size:14px;font-style:oblique;text-align:center;text-anchor:middle;-inkscape-font-specification:Sans Oblique"
id="tspan7743-5"
y="360.73309"
x="429.99997"
sodipodi:role="line">network</tspan></text>
</g>
<g
transform="translate(1.2516975e-5,-308.26769)"
id="g3548">
<rect
ry="4.9999995"
rx="5"
y="323.34317"
x="10.980982"
height="528.03802"
width="318.03802"
id="rect7705"
style="fill:#e0e0e0;fill-opacity:1;stroke:#000000;stroke-width:1.96200001;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" />
<text
sodipodi:linespacing="125%"
id="text7739"
y="342.36218"
x="170"
style="font-size:12px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans"
xml:space="preserve"><tspan
style="font-size:16px;text-align:center;text-anchor:middle"
y="342.36218"
x="170"
id="tspan7741"
sodipodi:role="line">Controller Node</tspan><tspan
style="font-size:14px;font-style:oblique;text-align:center;text-anchor:middle;-inkscape-font-specification:Sans Oblique"
id="tspan7743"
y="360.73312"
x="170"
sodipodi:role="line">controller</tspan></text>
</g>
<rect
style="fill:#606060;fill-opacity:1;stroke:#000000;stroke-width:1.96200013;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0"
id="rect7939-2"
width="138.03801"
height="268.03799"
x="182.146"
y="155.0755"
rx="5"
ry="4.999999" />
<g
transform="translate(1.2516975e-5,-308.26769)"
id="g3554">
<rect
ry="4.9999995"
rx="5.0000005"
y="373.34317"
x="20.980988"
height="68.025177"
width="298.03802"
id="rect9004"
style="fill:#606060;fill-opacity:1;fill-rule:nonzero;stroke:#000000;stroke-width:1.96200013;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" />