openstack/openstack-manuals
Code Issues Proposed changes

bp:restructure-documentation Restructure of Configuration Reference

Browse Source 
Initial re-structure of guide (more is definitely needed, including
 edits, but can now work per component). Ensured all sections are
 consolidated under one of the services. Minor edits to work with
 structure flow. Redid guide intro to list all components. Added
 subdirectories for networking and compute (to match existing
 for block-storage and object-storage).

Change-Id: I7cf3ddbb48c201ac89b037daff786dfb7a22dd34
This commit is contained in:
Summer Long
2013-09-02 17:06:38 +10:00
parent f8a32a7a5a
commit 624d62a1a3
31 changed files with 490 additions and 475 deletions
Download Patch File Download Diff File Expand all files Collapse all files

194
doc/src/docbkx/common/section_identity-configure.xml
View File

@@ -3,98 +3,104 @@
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"
xml:id="keystone-configuration-file">
<title>Configuration Files</title>
<para>The Identity Service
<filename>/etc/keystone/keystone.conf</filename> configuration
file is an INI-format file with sections.</para>
<para>The <literal>[DEFAULT]</literal> section configures general
configuration values.</para>
<para>Specific sections, such as the <literal>[sql]</literal> and
<literal>[ec2]</literal> sections, configure individual
services.</para>
<table rules="all">
<caption>Identity Service configuration file sections</caption>
<col width="30%"/>
<col width="70%"/>
<thead>
<tr>
<td>Section</td>
<td>Description</td>
</tr>
</thead>
<tbody>
<tr>
<td><literal>[DEFAULT]</literal></td>
<td>General configuration.</td>
</tr>
<tr>
<td><literal>[sql]</literal></td>
<td>Optional storage backend configuration.</td>
</tr>
<tr>
<td><literal>[ec2]</literal></td>
<td>Amazon EC2 authentication driver configuration.</td>
</tr>
<tr>
<td><literal>[s3]</literal></td>
<td>Amazon S3 authentication driver configuration.</td>
</tr>
<tr>
<td><literal>[identity]</literal></td>
<td>Identity Service system driver configuration.</td>
</tr>
<tr>
<td><literal>[catalog]</literal></td>
<td>Service catalog driver configuration.</td>
</tr>
<tr>
<td><literal>[token]</literal></td>
<td>Token driver configuration.</td>
</tr>
<tr>
<td><literal>[policy]</literal></td>
<td>Policy system driver configuration for RBAC.</td>
</tr>
<tr>
<td><literal>[signing]</literal></td>
<td>Cryptographic signatures for PKI based tokens.</td>
</tr>
<tr>
<td><literal>[ssl]</literal></td>
<td>SSL configuration.</td>
</tr>
</tbody>
</table>
<para>When you start the Identity Service, you can use the
<literal>--config-file</literal> parameter to specify a
configuration file.</para>
<para>If you do not specify a configuration file, the Identity
Service looks for the <filename>keystone.conf</filename>
configuration file in the following directories in the following
order:</para>
<orderedlist>
<listitem>
<para>
<literal>~/.keystone</literal>
</para>
</listitem>
<listitem>
<para>
<literal>~/</literal>
</para>
</listitem>
<listitem>
<para>
<literal>/etc/keystone</literal>
</para>
</listitem>
<listitem>
<para>
<literal>/etc</literal>
</para>
</listitem>
</orderedlist>
<para>The <filename>/etc/keystone/keystone-paste.ini</filename> file
configures the Identity Service WSGI middleware pipeline.</para>
<title>Identity Configuration Files</title>
<variablelist>
<varlistentry><term>keystone.conf</term>
<listitem><para>The Identity Service
<filename>/etc/keystone/keystone.conf</filename> configuration
file is an INI-format file with sections.</para>
<para>The <literal>[DEFAULT]</literal> section configures general
configuration values.</para>
<para>Specific sections, such as the <literal>[sql]</literal> and
<literal>[ec2]</literal> sections, configure individual
services.</para>
<table rules="all">
<caption>keystone.conf file sections</caption>
<col width="30%"/>
<col width="70%"/>
<thead>
<tr>
<td>Section</td>
<td>Description</td>
</tr>
</thead>
<tbody>
<tr>
<td><literal>[DEFAULT]</literal></td>
<td>General configuration.</td>
</tr>
<tr>
<td><literal>[sql]</literal></td>
<td>Optional storage backend configuration.</td>
</tr>
<tr>
<td><literal>[ec2]</literal></td>
<td>Amazon EC2 authentication driver configuration.</td>
</tr>
<tr>
<td><literal>[s3]</literal></td>
<td>Amazon S3 authentication driver configuration.</td>
</tr>
<tr>
<td><literal>[identity]</literal></td>
<td>Identity Service system driver configuration.</td>
</tr>
<tr>
<td><literal>[catalog]</literal></td>
<td>Service catalog driver configuration.</td>
</tr>
<tr>
<td><literal>[token]</literal></td>
<td>Token driver configuration.</td>
</tr>
<tr>
<td><literal>[policy]</literal></td>
<td>Policy system driver configuration for RBAC.</td>
</tr>
<tr>
<td><literal>[signing]</literal></td>
<td>Cryptographic signatures for PKI based tokens.</td>
</tr>
<tr>
<td><literal>[ssl]</literal></td>
<td>SSL configuration.</td>
</tr>
</tbody>
</table>
<para>When you start the Identity Service, you can use the
<literal>--config-file</literal> parameter to specify a
configuration file.</para>
<para>If you do not specify a configuration file, the Identity
Service looks for the <filename>keystone.conf</filename>
configuration file in the following directories in the following
order:</para>
<orderedlist>
<listitem>
<para>
<literal>~/.keystone</literal>
</para>
</listitem>
<listitem>
<para>
<literal>~/</literal>
</para>
</listitem>
<listitem>
<para>
<literal>/etc/keystone</literal>
</para>
</listitem>
<listitem>
<para>
<literal>/etc</literal>
</para>
</listitem>
</orderedlist>
</listitem>
</varlistentry>
<varlistentry><term>keystone-paste.ini</term>
<listitem><para>The <filename>/etc/keystone/keystone-paste.ini</filename> file
configures the Identity Service WSGI middleware pipeline.</para></listitem>
</varlistentry>
</variablelist>
</section>

2
doc/src/docbkx/common/section_introduction-to-xen.xml
View File

@@ -250,5 +250,5 @@
</itemizedlist></para>
</section>
<xi:include href="section_xen-install.xml"/>
<xi:include href="../openstack-config/compute-configure-xen.xml"/>
<xi:include href="../openstack-config/compute/section_compute-configure-xen.xml"/>
</section>

2
doc/src/docbkx/common/section_keystone-sample-conf-files.xml
View File

@@ -5,7 +5,7 @@
xmlns:xlink="http://www.w3.org/1999/xlink"
version="5.0"
xml:id="sample-configuration-files">
<title>Sample Configuration Files</title>
<title>Identity Sample Configuration Files</title>
<itemizedlist>
<listitem>
<para>

20
doc/src/docbkx/openstack-config/bk-config-ref.xml
View File

@@ -44,7 +44,9 @@
<revdescription>
<itemizedlist>
<listitem>
<para>Moves Block Storage driver configuration information from the <citetitle>Block Storage Administration Guide</citetitle> to this reference.</para>
<para>Moves Block Storage driver configuration information
from the <citetitle>Block Storage Administration Guide</citetitle>
to this reference.</para>
</listitem>
</itemizedlist>
</revdescription>
@@ -54,8 +56,7 @@
<revdescription>
<itemizedlist>
<listitem>
<para>Initial creation of Configuration
Reference.</para>
<para>Initial creation of Configuration Reference.</para>
</listitem>
</itemizedlist>
</revdescription>
@@ -67,22 +68,15 @@
<xi:include href="ch_identityconfigure.xml"/>
<!-- Compute -->
<xi:include href="ch_computeconfigure.xml"/>
<xi:include href="ch_computehypervisors.xml"/>
<xi:include href="ch_computescheduler.xml"/>
<xi:include href="ch_computecells.xml"/>
<xi:include href="ch_compute-conductor.xml"/>
<xi:include href="ch_computesecurity.xml"/>
<!-- Image -->
<xi:include href="ch_imageservice.xml"/>
<!-- Networking -->
<xi:include href="ch_networkingconfigure.xml"/>
<!-- Dashboard -->
<xi:include href="ch_dashboardconfigure.xml"/>
<!-- Object Storage -->
<xi:include href="ch_objectstorageconfigure.xml"/>
<!-- Block Storage -->
<xi:include href="ch_blockstorageconfigure.xml"/>
<xi:include href="block-storage/ch-block-storage-overview.xml"/>
<xi:include href="block-storage/ch-storage-drivers.xml"/>
<!-- Long listings of reference tables -->
<xi:include href="ch_compute-options-reference.xml"/>
<xi:include href="ch_networking-options-reference.xml"/>
</book>

6
doc/src/docbkx/openstack-config/block-storage/ch-block-storage-overview.xml → doc/src/docbkx/openstack-config/block-storage/section_block-storage-overview.xml
View File

@@ -1,8 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<chapter xmlns="http://docbook.org/ns/docbook"
<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="block_storage_overview">
xml:id="section_block-storage-overview">
<title>Introduction to the OpenStack Block Storage Service</title>
<para>The OpenStack Block Storage service provides persistent
block storage resources that OpenStack Compute instances can
@@ -128,4 +128,4 @@
</itemizedlist>
</listitem>
</itemizedlist>
</chapter>
</section>

7
doc/src/docbkx/openstack-config/block-storage/ch-storage-drivers.xml → doc/src/docbkx/openstack-config/block-storage/section_volume-drivers.xml
View File

@@ -1,9 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<chapter xmlns="http://docbook.org/ns/docbook"
<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="ch-volume-drivers">
xml:id="section_volume-drivers">
<title>Volume Drivers</title>
<para>To use different volume drivers for the <systemitem
class="service">cinder-volume</systemitem> service, use
@@ -29,4 +28,4 @@ iscsi_helper=tgtadm</programlisting>
<xi:include href="drivers/solidfire-volume-driver.xml"/>
<xi:include href="drivers/xenapi-nfs.xml"/>
<xi:include href="drivers/xen-sm-driver.xml"/>
</chapter>
</section>

4
doc/src/docbkx/openstack-config/ch_blockstorageconfigure.xml
View File

@@ -7,10 +7,11 @@
xmlns:ns4="http://www.w3.org/2000/svg"
xmlns:ns3="http://www.w3.org/1998/Math/MathML"
xmlns:ns="http://docbook.org/ns/docbook">
<title>Configuring OpenStack Block Storage</title>
<title>OpenStack Block Storage</title>
<?dbhtml stop-chunking?>
<para>The Block Storage project works with many different storage drivers. You can
configure those following the instructions.</para>
<xi:include href="block-storage/section_block-storage-overview.xml"/>
<section xml:id="setting-flags-in-cinder-conf-file">
<title>Setting Configuration Options in the <filename>cinder.conf</filename> File</title>
<para>The configuration file <filename>cinder.conf</filename> is installed in
@@ -21,5 +22,6 @@
<para>You can also provide shared storage for the instances
directory with MooseFS instead of NFS.</para>
<xi:include href="../common/section_moosefs.xml"/>
<xi:include href="block-storage/section_volume-drivers.xml"/>
</section>
</chapter>

63
doc/src/docbkx/openstack-config/ch_compute-options-reference.xml
View File

@@ -1,63 +0,0 @@
<?xml version= "1.0" encoding= "UTF-8"?>
<chapter xml:id= "compute-options-reference"
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">
<title>Configuration: nova.conf</title>
<xi:include href="../common/section_compute-options.xml" />
<section xml:id="list-of-compute-config-options">
<title>List of configuration options</title>
<para>For a complete list of all available configuration options for each OpenStack Compute service, run bin/nova-&lt;servicename&gt; --help.</para>
<xi:include href="../common/tables/nova-api.xml"/>
<xi:include href="../common/tables/nova-authentication.xml"/>
<xi:include href="../common/tables/nova-availabilityzones.xml"/>
<xi:include href="../common/tables/nova-baremetal.xml"/>
<xi:include href="../common/tables/nova-ca.xml"/>
<xi:include href="../common/tables/nova-cells.xml"/>
<xi:include href="../common/tables/nova-common.xml"/>
<xi:include href="../common/tables/nova-compute.xml"/>
<xi:include href="../common/tables/nova-conductor.xml"/>
<xi:include href="../common/tables/nova-configdrive.xml"/>
<xi:include href="../common/tables/nova-console.xml"/>
<xi:include href="../common/tables/nova-db.xml"/>
<xi:include href="../common/tables/nova-ec2.xml"/>
<xi:include href="../common/tables/nova-fping.xml"/>
<xi:include href="../common/tables/nova-glance.xml"/>
<xi:include href="../common/tables/nova-hyperv.xml"/>
<xi:include href="../common/tables/nova-hypervisor.xml"/>
<xi:include href="../common/tables/nova-ipv6.xml"/>
<xi:include href="../common/tables/nova-kombu.xml"/>
<xi:include href="../common/tables/nova-ldap.xml"/>
<xi:include href="../common/tables/nova-livemigration.xml"/>
<xi:include href="../common/tables/nova-logging.xml"/>
<xi:include href="../common/tables/nova-metadata.xml"/>
<xi:include href="../common/tables/nova-network.xml"/>
<xi:include href="../common/tables/nova-periodic.xml"/>
<xi:include href="../common/tables/nova-policy.xml"/>
<xi:include href="../common/tables/nova-powervm.xml"/>
<xi:include href="../common/tables/nova-qpid.xml"/>
<xi:include href="../common/tables/nova-neutron.xml"/>
<xi:include href="../common/tables/nova-quota.xml"/>
<xi:include href="../common/tables/nova-rabbitmq.xml"/>
<xi:include href="../common/tables/nova-rpc.xml"/>
<xi:include href="../common/tables/nova-s3.xml"/>
<xi:include href="../common/tables/nova-scheduling.xml"/>
<xi:include href="../common/tables/nova-spice.xml"/>
<xi:include href="../common/tables/nova-testing.xml"/>
<xi:include href="../common/tables/nova-tilera.xml"/>
<xi:include href="../common/tables/nova-trustedcomputing.xml"/>
<xi:include href="../common/tables/nova-vmware.xml"/>
<xi:include href="../common/tables/nova-vnc.xml"/>
<xi:include href="../common/tables/nova-volumes.xml"/>
<xi:include href="../common/tables/nova-vpn.xml"/>
<xi:include href="../common/tables/nova-wsgi.xml"/>
<xi:include href="../common/tables/nova-xen.xml"/>
<xi:include href="../common/tables/nova-xvpnvncproxy.xml"/>
<xi:include href="../common/tables/nova-zeromq.xml"/>
<xi:include href="../common/tables/nova-zookeeper.xml"/>
</section>
</chapter>

195
doc/src/docbkx/openstack-config/ch_computeconfigure.xml
View File

@@ -1,27 +1,23 @@
<?xml version="1.0" encoding="UTF-8"?>
<chapter version="5.0" xml:id="ch_configuring-openstack-compute"
xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink"
<chapter xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:ns5="http://www.w3.org/1999/xhtml"
xmlns:ns4="http://www.w3.org/2000/svg"
xmlns:ns3="http://www.w3.org/1998/Math/MathML"
xmlns:ns="http://docbook.org/ns/docbook">
<title>Configuring OpenStack Compute</title>
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"
xml:id="ch_configuring-openstack-compute">
<title>OpenStack Compute</title>
<para>The OpenStack system has several key projects that are separate installations but can work
together depending on your cloud needs: OpenStack Compute, OpenStack Object Storage, and
OpenStack Image Store. There are basic configuration decisions to make, and the <link
xlink:href="http://docs.openstack.org/trunk/openstack-compute/install/content/">OpenStack
Install Guide</link> covers a few different architectures for certain use cases.</para>
<para>The OpenStack system has several components that are installed separately but which can work
together depending on your cloud needs. Key components include: OpenStack Compute, OpenStack
Object Storage, and OpenStack Image Store. There are basic configuration decisions to make, and
the <link xlink:href="http://docs.openstack.org/trunk/openstack-compute/install/content/"
>OpenStack Install Guide</link> covers a few different architectures for certain use
cases.</para>
<!--status: right place-->
<section xml:id="configuring-openstack-compute-basics">
<?dbhtml stop-chunking?>
<title>Post-Installation Configuration for OpenStack
Compute</title>
<title>Post-Installation Configuration</title>
<para>Configuring your Compute installation involves many
configuration files - the <filename>nova.conf</filename> file,
configuration files: the <filename>nova.conf</filename> file,
the <filename>api-paste.ini</filename> file, and related Image
and Identity management configuration files. This section
contains the basics for a simple multi-node installation, but
@@ -39,30 +35,7 @@
default set of options are already configured in
<filename>nova.conf</filename> when you install
manually.</para>
<para>Starting with the default file, you must define the
following required items in
<filename>/etc/nova/nova.conf</filename>. The options are
described below. You can place comments in the
<filename>nova.conf</filename> file by entering a new line
with a <literal>#</literal> sign at the beginning of the line.
To see a listing of all possible configuration options, refer
to the tables this guide.</para>
<para>Here is a simple example <filename>nova.conf</filename>
file for a small private cloud, with all the cloud controller
services, database server, and messaging server on the same
server. In this case, CONTROLLER_IP represents the IP address
of a central server, BRIDGE_INTERFACE represents the bridge
such as br100, the NETWORK_INTERFACE represents an interface
to your VLAN setup, and passwords are represented as
DB_PASSWORD_COMPUTE for your Compute (nova) database password,
and RABBIT PASSWORD represents the password to your message
queue installation.</para>
<programlisting language="ini"><xi:include parse="text" href="../common/samples/nova.conf"/></programlisting>
<para>Create a <literal>nova</literal> group, so you can set
<para>Create a <literal>nova</literal> group, so you can set
permissions on the configuration file:</para>
<screen><prompt>$</prompt> <userinput>sudo addgroup nova</userinput></screen>
@@ -77,111 +50,8 @@
<prompt>$</prompt> <userinput>chown -R <option>username</option>:nova /etc/nova</userinput>
<prompt>$</prompt> <userinput>chmod 640 /etc/nova/nova.conf</userinput></screen>
</section>
<section
xml:id="setting-up-openstack-compute-environment-on-the-compute-node">
<title>Setting Up OpenStack Compute Environment on the Compute
Node</title>
<para>These are the commands you run to ensure the database
schema is current:</para>
<screen><prompt>$</prompt> <userinput>nova-manage db sync</userinput></screen>
</section>
<!--status: good, right place-->
<section xml:id="general-compute-configuration-overview">
<title>General Compute Configuration Overview</title>
<para>Most configuration information is available in the
<filename>nova.conf</filename> configuration option file. Here
are some general purpose configuration options that you can use
to learn more about the configuration option file and the node.
The configuration file nova.conf is typically stored in
<filename>/etc/nova/nova.conf</filename>.</para>
<para>You can use a particular configuration option file by using
the <literal>option</literal> (<filename>nova.conf</filename>)
parameter when running one of the <literal>nova-*</literal>
services. This inserts configuration option definitions from the
given configuration file name, which may be useful for debugging
or performance tuning. Here are some general purpose
configuration options.</para>
<para>If you want to maintain the state of all the services, you
can use the <literal>state_path</literal> configuration option
to indicate a top-level directory for storing data related to
the state of Compute including images if you are using the
Compute object store.</para>
<xi:include href="../common/tables/nova-common.xml"/>
</section>
<!--status: good, right place-->
<section xml:id="sample-nova-configuration-files">
<title>Example <filename>nova.conf</filename> Configuration
Files</title>
<para>The following sections describe many of the configuration
option settings that can go into the
<filename>nova.conf</filename> files. Copies of each
<filename>nova.conf</filename> file need to be copied to each
compute node. Here are some sample
<filename>nova.conf</filename> files that offer examples of
specific configurations.</para>
<simplesect>
<title>KVM, Flat, MySQL, and Glance, OpenStack or EC2
API</title>
<para>This example <filename>nova.conf</filename> file is from
an internal Rackspace test system used for
demonstrations.</para>
<programlisting language="ini"><xi:include parse="text" href="../common/samples/nova.conf"/></programlisting>
<figure xml:id="Nova_conf_KVM_Flat">
<title>KVM, Flat, MySQL, and Glance, OpenStack or EC2
API</title>
<mediaobject>
<imageobject>
<imagedata
fileref="../common/figures/SCH_5004_V00_NUAC-Network_mode_KVM_Flat_OpenStack.png"
contentwidth="6in"/>
</imageobject>
</mediaobject>
</figure>
</simplesect>
<simplesect>
<title>XenServer, Flat networking, MySQL, and Glance, OpenStack
API</title>
<para>This example <filename>nova.conf</filename> file is from
an internal Rackspace test system.</para>
<programlisting language="ini">verbose
nodaemon
sql_connection=mysql://root:&lt;password&gt;@127.0.0.1/nova
network_manager=nova.network.manager.FlatManager
image_service=nova.image.glance.GlanceImageService
flat_network_bridge=xenbr0
compute_driver=xenapi.XenAPIDriver
xenapi_connection_url=https://&lt;XenServer IP&gt;
xenapi_connection_username=root
xenapi_connection_password=supersecret
xenapi_image_upload_handler=nova.virt.xenapi.imageupload.glance.GlanceStore
rescue_timeout=86400
use_ipv6=true
# To enable flat_injected, currently only works on Debian-based systems
flat_injected=true
ipv6_backend=account_identifier
ca_path=./nova/CA
# Add the following to your conf file if you're running on Ubuntu Maverick
xenapi_remap_vbd_dev=true</programlisting>
<figure xml:id="Nova_conf_XEN_Flat">
<title>KVM, Flat, MySQL, and Glance, OpenStack or EC2
API</title>
<mediaobject>
<imageobject>
<imagedata
fileref="../common/figures/SCH_5005_V00_NUAC-Network_mode_XEN_Flat_OpenStack.png"
scale="60"/>
</imageobject>
</mediaobject>
</figure>
</simplesect>
</section>
<!--status: good, right place-->
<xi:include href="compute/section_compute-config-overview.xml"/>
<section xml:id="configuring-logging">
<title>Configuring Logging</title>
<para>You can use <filename>nova.conf</filename> configuration
@@ -193,7 +63,7 @@ xenapi_remap_vbd_dev=true</programlisting>
</section>
<section xml:id="configuring-hypervisors">
<title>Configuring Hypervisors</title>
<para>See <xref linkend="ch_hypervisors"/> for details.</para>
<para>See <xref linkend="section_compute-hypervisors"/> for details.</para>
</section>
<!--status: good, right place-->
<section xml:id="configuring-authentication-authorization">
@@ -214,8 +84,8 @@ xenapi_remap_vbd_dev=true</programlisting>
<filename>nova.conf</filename>.</para>
<xi:include href="../common/tables/nova-ldap.xml"/>
</section>
<xi:include href="compute-configure-ipv6.xml"/>
<xi:include href="compute-configure-migrations.xml"/>
<xi:include href="compute/section_compute-configure-ipv6.xml"/>
<xi:include href="compute/section_compute-configure-migrations.xml"/>
<section xml:id="configuring-resize">
<?dbhtml stop-chunking?>
<title>Configuring Resize</title>
@@ -234,17 +104,24 @@ xenapi_remap_vbd_dev=true</programlisting>
<!-- End of XenServer/Resize -->
</section>
</section>
<!-- End of configuring resize -->
<xi:include href="compute-configure-db.xml"/>
<xi:include href="compute/section_compute-configure-db.xml"/>
<!-- Oslo rpc mechanism (such as, Rabbit, Qpid, ZeroMQ) -->
<xi:include href="../common/section_rpc.xml"/>
<xi:include href="../common/section_compute_config-api.xml"></xi:include>
<xi:include href="../common/section_compute-configure-ec2.xml"/>
<xi:include href="../common/section_compute-configure-quotas.xml"/>
<xi:include href="../common/section_compute-configure-console.xml"/>
<xi:include href="section_compute-configure-service-groups.xml"/>
<xi:include href="../common/section_fibrechannel.xml"/>
<xi:include href="../common/section_multiple-compute-nodes.xml"/>
<section xml:id="section_compute-components">
<title>Components Configuration</title>
<xi:include href="../common/section_rpc.xml"/>
<xi:include href="../common/section_compute_config-api.xml"></xi:include>
<xi:include href="../common/section_compute-configure-ec2.xml"/>
<xi:include href="../common/section_compute-configure-quotas.xml"/>
<xi:include href="../common/section_compute-configure-console.xml"/>
<xi:include href="compute/section_compute-configure-service-groups.xml"/>
<xi:include href="../common/section_fibrechannel.xml"/>
<xi:include href="../common/section_multiple-compute-nodes.xml"/>
<xi:include href="compute/section_compute-hypervisors.xml"/>
<xi:include href="compute/section_compute-scheduler.xml"/>
<xi:include href="compute/section_compute-cells.xml"/>
<xi:include href="compute/section_compute-conductor.xml"/>
<xi:include href="compute/section_compute-security.xml"/>
</section>
<xi:include href="compute/section_compute-options-reference.xml"/>
</chapter>

42
doc/src/docbkx/openstack-config/ch_config-overview.xml
View File

@@ -4,34 +4,22 @@
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"
xml:id="config_overview">
<title>OpenStack Configuration Overview</title>
<para>OpenStack is a collection of open source project to enable
setting up cloud services. Each project uses similar
<para>OpenStack is a collection of open source project components
that enable setting up cloud services. Each component uses similar
configuration techniques and a common framework for INI file
options. This guide pulls together multiple references for
each type of configuration.</para>
<para>.conf files</para>
<para>.ini files</para>
<para><emphasis role="bold">Compute</emphasis></para>
<para>API options</para>
<para>Authentication options</para>
<para>Database backends</para>
<para>Scheduling backends</para>
<para>Messaging backends</para>
<para>Virtualization options</para>
<para>Storage driver options</para>
<para>Networking driver options</para>
<para><emphasis role="bold">Block Storage</emphasis></para>
<para>Database backends</para>
<para>Scheduling backends</para>
<para>Storage driver options</para>
<para><emphasis role="bold">Object Storage</emphasis></para>
<para>.conf files</para>
<para>Authentication options</para>
<para><emphasis role="bold">Image</emphasis>
options.
</para>
<para/>
<para><emphasis role="bold">Identity</emphasis></para>
<para/>
<para>This guide pulls together multiple references and configuration options for
the following OpenStack components:
</para>
<itemizedlist>
<listitem><para>OpenStack Identity</para></listitem>
<listitem><para>OpenStack Compute</para></listitem>
<listitem><para>OpenStack Image Service</para></listitem>
<listitem><para>OpenStack Networking</para></listitem>
<listitem><para>OpenStack Dashboard</para></listitem>
<listitem><para>OpenStack Object Storage</para></listitem>
<listitem><para>OpenStack Block Storage</para></listitem>
</itemizedlist>
<xi:include href="../common/section_dochistory.xml"/>
</preface>

2
doc/src/docbkx/openstack-config/ch_dashboardconfigure.xml
View File

@@ -3,7 +3,7 @@
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"
xml:id="ch_configuring-dashboard">
<title>Configuring the OpenStack Dashboard</title>
<title>OpenStack Dashboard</title>
<para>This chapter describes how to configure the OpenStack
Dashboard with Apache web server.</para>
<xi:include href="../common/section_dashboard-configure.xml"/>

24
doc/src/docbkx/openstack-config/ch_identityconfigure.xml
View File

@@ -7,23 +7,11 @@
xmlns:ns4="http://www.w3.org/2000/svg"
xmlns:ns3="http://www.w3.org/1998/Math/MathML"
xmlns:ns="http://docbook.org/ns/docbook">
<title>Configuring OpenStack Identity</title>
<title>OpenStack Identity</title>
<?dbhtml stop-chunking?>
<para>The Identity project has several configuration
options.</para>
<section xml:id="setting-flags-in-keystone-conf-file">
<title>Setting Configuration Options in the
<filename>keystone.conf</filename> File</title>
<para>The configuration file <filename>keystone.conf</filename>
is installed in <filename>/etc/keystone</filename> by default. A
default set of options are already configured in
<filename>keystone.conf</filename> when you install manually.</para>
<para>Here is a simple example
<filename>keystone.conf</filename> file.</para>
<programlisting language="ini"><xi:include parse="text" href="../common/samples/keystone.conf"/></programlisting>
</section>
<xi:include href="../common/section_identity-configure.xml"/>
<xi:include href="../common/section_keystone-sample-conf-files.xml"/>
<xi:include href="../common/section_keystone_certificates-for-pki.xml"/>
<xi:include href="../common/section_keystone-ssl-config.xml"/>
<para>The Identity service has several configuration options.</para>
<xi:include href="../common/section_identity-configure.xml"/>
<xi:include href="../common/section_keystone_certificates-for-pki.xml"/>
<xi:include href="../common/section_keystone-ssl-config.xml"/>
<xi:include href="../common/section_keystone-sample-conf-files.xml"/>
</chapter>

2
doc/src/docbkx/openstack-config/ch_imageservice.xml
View File

@@ -7,7 +7,7 @@
xmlns:ns4="http://www.w3.org/2000/svg"
xmlns:ns3="http://www.w3.org/1998/Math/MathML"
xmlns:ns="http://docbook.org/ns/docbook">
<title>Configuring OpenStack Image Service</title>
<title>OpenStack Image Service</title>
<para>Compute relies on an external image service to store virtual

12
doc/src/docbkx/openstack-config/ch_networkingconfigure.xml Normal file
View File

@@ -0,0 +1,12 @@
<?xml version="1.0" encoding="UTF-8"?>
<chapter version="5.0" xml:id="ch_configuring-openstack-networking"
xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:ns5="http://www.w3.org/1999/xhtml"
xmlns:ns4="http://www.w3.org/2000/svg"
xmlns:ns3="http://www.w3.org/1998/Math/MathML"
xmlns:ns="http://docbook.org/ns/docbook">
<title>OpenStack Networking</title>
<xi:include href="networking/section_networking-options-reference.xml"/>
</chapter>

27
doc/src/docbkx/openstack-config/ch_objectstorageconfigure.xml
View File

@@ -3,10 +3,31 @@
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"
xml:id="ch_configuring-object-storage">
<title>Configuring OpenStack Object Storage</title>
<para>OpenStack Object Storage uses multiple configuration files for
multiple services and background daemons.</para>
<title>OpenStack Object Storage</title>
<para>OpenStack Object Storage uses multiple configuration files for multiple services and
background daemons, and paste.deploy to manage server configurations. Default configuration
options are set in the <code>[DEFAULT]</code> section, and any options specified there can
be overridden in any of the other sections.</para>
<xi:include href="object-storage/section_object-storage-general-service-conf.xml"/>
<!--these need to be placed under appropriate sections
<section xml:id="memcache-conf">
<title>Sample Memcache configuration file</title>
<programlisting language="ini"><xi:include parse="text" href="https://raw.github.com/openstack/swift/master/etc/memcache.conf-sample"/></programlisting></section>
<section xml:id="mime-types-conf">
<title>Sample Mime.Types configuration file</title>
<programlisting language="ini"><xi:include parse="text" href="https://raw.github.com/openstack/swift/master/etc/mime.types-sample"/></programlisting></section>
<section xml:id="object-expirer-conf">
<title>Sample Object Expirer configuration file</title>
<programlisting><xi:include parse="text" href="https://raw.github.com/openstack/swift/master/etc/object-expirer.conf-sample"/></programlisting></section>
<section xml:id="rsyncd-conf">
<title>Sample Rsyncd configuration file</title>
<programlisting language="ini"><xi:include parse="text" href="https://raw.github.com/openstack/swift/master/etc/rsyncd.conf-sample"/></programlisting></section>
<section xml:id="swift-bench-conf">
<title>Sample Swift bench configuration file</title>
<programlisting language="ini"><xi:include parse="text" href="https://raw.github.com/openstack/swift/master/etc/swift-bench.conf-sample"/></programlisting></section>
<section xml:id="swift-conf">
<title>Sample Swift configuration file</title>
<programlisting><xi:include parse="text" href="https://raw.github.com/openstack/swift/master/etc/swift.conf-sample"/></programlisting></section>-->
<section xml:id="object-server-configuration">
<title>Object Server Configuration</title>
<para>An example Object Server configuration can be found at

16
doc/src/docbkx/openstack-config/ch_computecells.xml → doc/src/docbkx/openstack-config/compute/section_compute-cells.xml
View File

@@ -1,8 +1,12 @@
<?xml version="1.0" encoding="UTF-8"?>
<chapter xmlns="http://docbook.org/ns/docbook"
<section xml:id="section_compute-cells"
xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"
xml:id="ch_cells">
xmlns:ns5="http://www.w3.org/1999/xhtml"
xmlns:ns4="http://www.w3.org/2000/svg"
xmlns:ns3="http://www.w3.org/1998/Math/MathML"
xmlns:ns="http://docbook.org/ns/docbook"
version="5.0">
<title>Cells</title>
<?dbhtml stop-chunking?>
<para><emphasis role="italic">Cells</emphasis> functionality allows you to scale an OpenStack
@@ -141,7 +145,7 @@ rabbit_virtual_host=cell1_vhost</programlisting></para>
<para>In the child cell, we would run the following, as
root:<screen><prompt>#</prompt> <userinput>nova-manage cell create --name=api --cell_type=parent --username=api1_user --password=api1_passwd --hostname=10.0.0.10 --port=5672 --virtual_host=api_vhost --woffset=1.0 --wscale=1.0
</userinput></screen></para>
<xi:include href="../common/tables/nova-cells.xml"/>
<xi:include href="../../common/tables/nova-cells.xml"/>
</section>
<section xml:id="cell-config-optional-json">
<title>Optional cell configuration</title>
@@ -177,4 +181,4 @@ rabbit://&lt;username>:&lt;password>@&lt;hostname>:&lt;port>/&lt;virtual_host>
}]
</programlisting>
</section>
</chapter>
</section>

14
doc/src/docbkx/openstack-config/ch_compute-conductor.xml → doc/src/docbkx/openstack-config/compute/section_compute-conductor.xml
View File

@@ -1,8 +1,9 @@
<?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_conductor">
<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="section_conductor">
<title>Conductor</title>
<para>
The <systemitem class="service">nova-conductor</systemitem> service is key to allowing OpenStack to function
@@ -27,5 +28,6 @@ ensuring forward progress and graceful error handling.
This will be especially beneficial for operations that cross multiple
compute nodes, such as migrations or resizes
</para>
<xi:include href="../common/tables/nova-conductor.xml"/>
</chapter>
<xi:include href="../../common/tables/nova-conductor.xml"/>
</section>

113
doc/src/docbkx/openstack-config/compute/section_compute-config-overview.xml Normal file
View File

@@ -0,0 +1,113 @@
<section xml:id="section_compute-config-overview"
xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:ns5="http://www.w3.org/1999/xhtml"
xmlns:ns4="http://www.w3.org/2000/svg"
xmlns:ns3="http://www.w3.org/1998/Math/MathML"
xmlns:ns="http://docbook.org/ns/docbook"
version="5.0">
<title>General Compute Configuration Overview</title>
<para>Most configuration information is available in the <filename>nova.conf</filename>
configuration option file, which is in the <filename>/etc/nova</filename> directory.</para>
<para>You can use a particular configuration option file by using the <literal>option</literal>
(<filename>nova.conf</filename>) parameter when running one of the
<literal>nova-*</literal> services. This inserts configuration option definitions from
the given configuration file name, which may be useful for debugging or performance
tuning.</para>
<para>If you want to maintain the state of all the services, you can use the
<literal>state_path</literal> configuration option to indicate a top-level directory for
storing data related to the state of Compute including images if you are using the Compute
object store.</para>
<para>You can place comments in the <filename>nova.conf</filename> file by entering a new line
with a <literal>#</literal> sign at the beginning of the line. To see a listing of all
possible configuration options, refer to the tables in this guide. Here are some general
purpose configuration options that you can use to learn more about the configuration option
file and the node.</para>
<para/>
<xi:include href="../../common/tables/nova-common.xml"/>
<!--status: good, right place-->
<section xml:id="sample-nova-configuration-files">
<title>Example <filename>nova.conf</filename> Configuration
Files</title>
<para>The following sections describe many of the configuration
option settings that can go into the
<filename>nova.conf</filename> files. Copies of each
<filename>nova.conf</filename> file need to be copied to each
compute node. Here are some sample
<filename>nova.conf</filename> files that offer examples of
specific configurations.</para>
<simplesect>
<title>Small, private cloud</title>
<para>Here is a simple example <filename>nova.conf</filename>
file for a small private cloud, with all the cloud controller
services, database server, and messaging server on the same
server. In this case, CONTROLLER_IP represents the IP address
of a central server, BRIDGE_INTERFACE represents the bridge
such as br100, the NETWORK_INTERFACE represents an interface
to your VLAN setup, and passwords are represented as
DB_PASSWORD_COMPUTE for your Compute (nova) database password,
and RABBIT PASSWORD represents the password to your message
queue installation.</para>
<programlisting language="ini"><xi:include parse="text" href="../../common/samples/nova.conf"/></programlisting>
</simplesect>
<simplesect>
<title>KVM, Flat, MySQL, and Glance, OpenStack or EC2
API</title>
<para>This example <filename>nova.conf</filename> file is from
an internal Rackspace test system used for
demonstrations.</para>
<programlisting language="ini"><xi:include parse="text" href="../../common/samples/nova.conf"/></programlisting>
<figure xml:id="Nova_conf_KVM_Flat">
<title>KVM, Flat, MySQL, and Glance, OpenStack or EC2
API</title>
<mediaobject>
<imageobject>
<imagedata
fileref="../../common/figures/SCH_5004_V00_NUAC-Network_mode_KVM_Flat_OpenStack.png"
contentwidth="6in"/>
</imageobject>
</mediaobject>
</figure>
</simplesect>
<simplesect>
<title>XenServer, Flat networking, MySQL, and Glance, OpenStack
API</title>
<para>This example <filename>nova.conf</filename> file is from
an internal Rackspace test system.</para>
<programlisting language="ini">verbose
nodaemon
sql_connection=mysql://root:&lt;password&gt;@127.0.0.1/nova
network_manager=nova.network.manager.FlatManager
image_service=nova.image.glance.GlanceImageService
flat_network_bridge=xenbr0
compute_driver=xenapi.XenAPIDriver
xenapi_connection_url=https://&lt;XenServer IP&gt;
xenapi_connection_username=root
xenapi_connection_password=supersecret
xenapi_image_upload_handler=nova.virt.xenapi.imageupload.glance.GlanceStore
rescue_timeout=86400
use_ipv6=true
# To enable flat_injected, currently only works on Debian-based systems
flat_injected=true
ipv6_backend=account_identifier
ca_path=./nova/CA
# Add the following to your conf file if you're running on Ubuntu Maverick
xenapi_remap_vbd_dev=true</programlisting>
<figure xml:id="Nova_conf_XEN_Flat">
<title>KVM, Flat, MySQL, and Glance, OpenStack or EC2
API</title>
<mediaobject>
<imageobject>
<imagedata
fileref="../../common/figures/SCH_5005_V00_NUAC-Network_mode_XEN_Flat_OpenStack.png"
scale="60"/>
</imageobject>
</mediaobject>
</figure>
</simplesect>
</section>
</section>

3
doc/src/docbkx/openstack-config/compute-configure-backing-storage.xml → doc/src/docbkx/openstack-config/compute/section_compute-configure-backing-storage.xml
View File

@@ -1,4 +1,5 @@
<section xml:id="configuring-backing-storage"
<section xml:id="section_configure-backing-storage"
version="5.0"
xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:xi="http://www.w3.org/2001/XInclude"

9
doc/src/docbkx/openstack-config/compute-configure-console.xml → doc/src/docbkx/openstack-config/compute/section_compute-configure-console.xml
View File

@@ -3,7 +3,7 @@
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink"
version="5.0"
xml:id="remote-console-access">
xml:id="section_compute-configure-console">
<title>Configure remote console access</title>
<!--<?dbhtml stop-chunking?>-->
<para>OpenStack has two main methods for providing a remote
@@ -12,9 +12,8 @@
either through the OpenStack dashboard and the command
line. Best practice is to select one or the other to
run.</para>
<xi:include href="compute-configure-vnc.xml"/>
<section
<xi:include href="../../common/section_compute-configure-vnc.xml"/>
<section
xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink"
@@ -35,7 +34,7 @@
service communicates directly with the hypervisor process using
SPICE.</para>
<para>Options for configuring SPICE as the console for OpenStack Compute can be found below.</para>
<xi:include href="../common/tables/nova-spice.xml"/>
<xi:include href="../../common/tables/nova-spice.xml"/>
<!--<note><para>If you intend to support <link linkend="configuring-migrations">live migration</link>,
you cannot specify a specific IP address for <literal>server_listen</literal>,
because that IP address will not exist on the destination host.</para></note>-->

15
doc/src/docbkx/openstack-config/compute-configure-db.xml → doc/src/docbkx/openstack-config/compute/section_compute-configure-db.xml
View File

@@ -1,4 +1,4 @@
<section xml:id="configuring-database-connections"
<section xml:id="section_configuring-database-connections"
xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:xi="http://www.w3.org/2001/XInclude"
@@ -6,16 +6,18 @@
xmlns:ns4="http://www.w3.org/2000/svg"
xmlns:ns3="http://www.w3.org/1998/Math/MathML"
xmlns:ns="http://docbook.org/ns/docbook" version="5.0">
<title>Configuring Database Connections</title>
<title>Database Configuration</title>
<para>You can configure OpenStack Compute to use any
SQLAlchemy-compatible database. The database name is
<literal>nova</literal>. If you are using <systemitem
<literal>nova</literal>. If you use <systemitem
class="service">nova-conductor</systemitem>, it will be the
only service writing to the database, the other Compute
services will access the database through <systemitem
only service writing to the database; the other Compute
services access the database through <systemitem
class="service">nova-conductor</systemitem>.
</para>
<para>Use the following command to ensure the database schema is current:</para>
<screen><prompt>$</prompt> <userinput>nova-manage db sync</userinput></screen>
<para>If <systemitem class="service">nova-conductor</systemitem>
is not used, entries to the database are mostly written by the
<systemitem class="service">nova-scheduler</systemitem>
@@ -24,6 +26,5 @@
</para>
<para>In either case, use these settings to configure the connection
string for the nova database.</para>
<xi:include href="../common/tables/nova-db.xml"/>
<xi:include href="../../common/tables/nova-db.xml"/>
</section>

4
doc/src/docbkx/openstack-config/compute-configure-ipv6.xml → doc/src/docbkx/openstack-config/compute/section_compute-configure-ipv6.xml
View File

@@ -1,4 +1,4 @@
<section xml:id="configuring-compute-to-use-ipv6-addresses"
<section xml:id="section_configuring-compute-to-use-ipv6-addresses"
xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:xi="http://www.w3.org/2001/XInclude"
@@ -58,5 +58,5 @@
<screen><prompt>$</prompt> <userinput>nova network-create public --fixed-range-v4 10.0.2.0/24 --fixed-range-v6 fd00:1::/48</userinput></screen>
<xi:include href="../common/tables/nova-ipv6.xml"/>
<xi:include href="../../common/tables/nova-ipv6.xml"/>
</section>

4
doc/src/docbkx/openstack-config/compute-configure-migrations.xml → doc/src/docbkx/openstack-config/compute/section_compute-configure-migrations.xml
View File

@@ -1,4 +1,4 @@
<section xml:id="configuring-compute-migrations"
<section xml:id="section_configuring-compute-migrations"
xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:xi="http://www.w3.org/2001/XInclude"
@@ -234,7 +234,7 @@ after :libvirtd_opts=" -d -l"</programlisting>
following chart is for advanced usage only.</para>
</listitem>
</orderedlist></para>
<xi:include href="../common/tables/nova-livemigration.xml"/>
<xi:include href="../../common/tables/nova-livemigration.xml"/>
<section xml:id="true-live-migration-kvm-libvirt">
<title>Enabling true live migration</title>

2
doc/src/docbkx/openstack-config/section_compute-configure-service-groups.xml → doc/src/docbkx/openstack-config/compute/section_compute-configure-service-groups.xml
View File

@@ -86,6 +86,6 @@
[zookeeper]
address="192.168.2.1:2181,192.168.2.2:2181,192.168.2.3:2181"</programlisting>
</para>
<xi:include href="../common/tables/nova-zookeeper.xml"/>
<xi:include href="../../common/tables/nova-zookeeper.xml"/>
</section>
</section>

7
doc/src/docbkx/openstack-config/compute-configure-xen.xml → doc/src/docbkx/openstack-config/compute/section_compute-configure-xen.xml
View File

@@ -1,11 +1,12 @@
<section xml:id="configuring-compute-to-xen"
<section xml:id="section_compute-configure-xen"
xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:ns5="http://www.w3.org/1999/xhtml"
xmlns:ns4="http://www.w3.org/2000/svg"
xmlns:ns3="http://www.w3.org/1998/Math/MathML"
xmlns:ns="http://docbook.org/ns/docbook">
xmlns:ns="http://docbook.org/ns/docbook"
version="5.0">
<title>Xen Configuration Reference</title>
<para>The following section discusses some commonly changed options in XenServer.
The table below provides a complete reference of all
@@ -72,6 +73,6 @@ by using the Host Aggregates feature.</para></note>
</para></section>
<section xml:id="xen-config-reference-table">
<title>Configuration Reference Table for Xen</title>
<xi:include href="../common/tables/nova-xen.xml"/>
<xi:include href="../../common/tables/nova-xen.xml"/>
</section>
</section>

32
doc/src/docbkx/openstack-config/ch_computehypervisors.xml → doc/src/docbkx/openstack-config/compute/section_compute-hypervisors.xml
View File

@@ -1,8 +1,12 @@
<?xml version="1.0" encoding="UTF-8"?>
<chapter xmlns="http://docbook.org/ns/docbook"
<section xml:id="section_compute-hypervisors"
xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"
xml:id="ch_hypervisors">
xmlns:ns5="http://www.w3.org/1999/xhtml"
xmlns:ns4="http://www.w3.org/2000/svg"
xmlns:ns3="http://www.w3.org/1998/Math/MathML"
xmlns:ns="http://docbook.org/ns/docbook"
version="5.0">
<title>Hypervisors</title>
<para>OpenStack Compute supports many hypervisors, which might
make it difficult for you to choose one. Most installations
@@ -99,14 +103,14 @@
options that are used to configure the compute node's
hypervisor. Specific options for particular hypervisors
can be found in following sections.</para>
<xi:include href="../common/tables/nova-hypervisor.xml"/>
<xi:include href="../../common/tables/nova-hypervisor.xml"/>
</section>
<xi:include href="../common/section_kvm.xml"/>
<xi:include href="../common/section_qemu.xml"/>
<xi:include href="../common/section_introduction-to-xen.xml"/>
<xi:include href="../common/section_lxc.xml"/>
<xi:include href="../common/section_vmware.xml"/>
<xi:include href="../common/section_powervm.xml"/>
<xi:include href="../common/section_hyper-v.xml"/>
<xi:include href="../common/section_baremetal.xml"/>
</chapter>
<xi:include href="../../common/section_kvm.xml"/>
<xi:include href="../../common/section_qemu.xml"/>
<xi:include href="../../common/section_introduction-to-xen.xml"/>
<xi:include href="../../common/section_lxc.xml"/>
<xi:include href="../../common/section_vmware.xml"/>
<xi:include href="../../common/section_powervm.xml"/>
<xi:include href="../../common/section_hyper-v.xml"/>
<xi:include href="../../common/section_baremetal.xml"/>
</section>

62
doc/src/docbkx/openstack-config/compute/section_compute-options-reference.xml Normal file
View File

@@ -0,0 +1,62 @@
<?xml version= "1.0" encoding= "UTF-8"?>
<section xml:id= "section_compute-options-reference"
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">
<title>Compute Configuration Files: nova.conf</title>
<xi:include href="../../common/section_compute-options.xml" />
<section xml:id="list-of-compute-config-options">
<title>List of configuration options</title>
<para>For a complete list of all available configuration options for each OpenStack Compute service, run bin/nova-&lt;servicename&gt; --help.</para>
<xi:include href="../../common/tables/nova-api.xml"/>
<xi:include href="../../common/tables/nova-authentication.xml"/>
<xi:include href="../../common/tables/nova-availabilityzones.xml"/>
<xi:include href="../../common/tables/nova-baremetal.xml"/>
<xi:include href="../../common/tables/nova-ca.xml"/>
<xi:include href="../../common/tables/nova-cells.xml"/>
<xi:include href="../../common/tables/nova-common.xml"/>
<xi:include href="../../common/tables/nova-compute.xml"/>
<xi:include href="../../common/tables/nova-conductor.xml"/>
<xi:include href="../../common/tables/nova-configdrive.xml"/>
<xi:include href="../../common/tables/nova-console.xml"/>
<xi:include href="../../common/tables/nova-db.xml"/>
<xi:include href="../../common/tables/nova-ec2.xml"/>
<xi:include href="../../common/tables/nova-fping.xml"/>
<xi:include href="../../common/tables/nova-glance.xml"/>
<xi:include href="../../common/tables/nova-hyperv.xml"/>
<xi:include href="../../common/tables/nova-hypervisor.xml"/>
<xi:include href="../../common/tables/nova-ipv6.xml"/>
<xi:include href="../../common/tables/nova-kombu.xml"/>
<xi:include href="../../common/tables/nova-ldap.xml"/>
<xi:include href="../../common/tables/nova-livemigration.xml"/>
<xi:include href="../../common/tables/nova-logging.xml"/>
<xi:include href="../../common/tables/nova-metadata.xml"/>
<xi:include href="../../common/tables/nova-network.xml"/>
<xi:include href="../../common/tables/nova-periodic.xml"/>
<xi:include href="../../common/tables/nova-policy.xml"/>
<xi:include href="../../common/tables/nova-powervm.xml"/>
<xi:include href="../../common/tables/nova-qpid.xml"/>
<xi:include href="../../common/tables/nova-neutron.xml"/>
<xi:include href="../../common/tables/nova-quota.xml"/>
<xi:include href="../../common/tables/nova-rabbitmq.xml"/>
<xi:include href="../../common/tables/nova-rpc.xml"/>
<xi:include href="../../common/tables/nova-s3.xml"/>
<xi:include href="../../common/tables/nova-scheduling.xml"/>
<xi:include href="../../common/tables/nova-spice.xml"/>
<xi:include href="../../common/tables/nova-testing.xml"/>
<xi:include href="../../common/tables/nova-tilera.xml"/>
<xi:include href="../../common/tables/nova-trustedcomputing.xml"/>
<xi:include href="../../common/tables/nova-vmware.xml"/>
<xi:include href="../../common/tables/nova-vnc.xml"/>
<xi:include href="../../common/tables/nova-volumes.xml"/>
<xi:include href="../../common/tables/nova-vpn.xml"/>
<xi:include href="../../common/tables/nova-wsgi.xml"/>
<xi:include href="../../common/tables/nova-xen.xml"/>
<xi:include href="../../common/tables/nova-xvpnvncproxy.xml"/>
<xi:include href="../../common/tables/nova-zeromq.xml"/>
<xi:include href="../../common/tables/nova-zookeeper.xml"/>
</section>
</section>

20
doc/src/docbkx/openstack-config/ch_computescheduler.xml → doc/src/docbkx/openstack-config/compute/section_compute-scheduler.xml
View File

@@ -1,8 +1,12 @@
<?xml version="1.0" encoding="UTF-8"?>
<chapter xmlns="http://docbook.org/ns/docbook"
<section xml:id="section_compute-scheduler"
xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"
xml:id="ch_scheduling">
xmlns:ns5="http://www.w3.org/1999/xhtml"
xmlns:ns4="http://www.w3.org/2000/svg"
xmlns:ns3="http://www.w3.org/1998/Math/MathML"
xmlns:ns="http://docbook.org/ns/docbook"
version="5.0">
<title>Scheduling</title>
<para>Compute uses the <systemitem class="service">nova-scheduler</systemitem> service to
determine how to dispatch compute and volume requests. For example, the <systemitem
@@ -36,7 +40,7 @@ compute_fill_first_cost_fn_weight=-1.0</programlisting>
</listitem>
</itemizedlist>
<para>For information on the volume scheduler, refer to the <link
xlink:href="../openstack-block-storage-admin/admin/content/"><citetitle>OpenStack Block Storage
xlink:href="../../openstack-block-storage-admin/admin/content/"><citetitle>OpenStack Block Storage
Admin Guide</citetitle></link> for information.</para>
<section xml:id="filter-scheduler">
<title>Filter Scheduler</title>
@@ -521,9 +525,9 @@ ram_weight_multiplier=1.0</computeroutput></screen>
which randomly selects from lists of filtered hosts. It is
the default volume scheduler.</para>
</section>
<xi:include href="../common/section_host_aggregates.xml"/>
<xi:include href="../../common/section_host_aggregates.xml"/>
<section xml:id="compute-scheduler-config-ref">
<title>Configuration Reference</title>
<xi:include href="../common/tables/nova-scheduling.xml"/>
<xi:include href="../../common/tables/nova-scheduling.xml"/>
</section>
</chapter>
</section>

6
doc/src/docbkx/openstack-config/ch_computesecurity.xml → doc/src/docbkx/openstack-config/compute/section_compute-security.xml
View File

@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<chapter version="5.0" xml:id="ch_security"
<section version="5.0" xml:id="section-compute-security"
xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:xi="http://www.w3.org/2001/XInclude"
@@ -12,5 +12,5 @@
technologies to increase security. For more information, see the
<link xlink:href="http://docs.openstack.org/sec/">OpenStack
Security Guide</link>.</para>
<xi:include href="../common/section_trusted-compute-pools.xml"/>
</chapter>
<xi:include href="../../common/section_trusted-compute-pools.xml"/>
</section>

34
doc/src/docbkx/openstack-config/ch_networking-options-reference.xml → doc/src/docbkx/openstack-config/networking/section_networking-options-reference.xml
View File

@@ -1,98 +1,98 @@
<?xml version= "1.0" encoding= "UTF-8"?>
<chapter xml:id= "networking-options-reference"
<section xml:id= "section_networking-options-reference"
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">
<title>Configuration options for Networking</title>
<title>Networking Configuration Options</title>
<para>These options and descriptions were generated from the code in
the Networking service project which provides software defined networking
between VMs run in Compute. Below are common options, and the sections
following contain information about the various networking plugins and
less-commonly altered sections.</para>
<xi:include href="../common/tables/neutron-common.xml"/>
<xi:include href="../../common/tables/neutron-common.xml"/>
<xi:include href="section_networking-plugins.xml"/>
<xi:include href="../common/section_rpc-for-networking.xml"/>
<xi:include href="../../common/section_rpc-for-networking.xml"/>
<section xml:id="networking-options-agent">
<title>Agent</title>
<para>Use the following options to alter agent-related settings.</para>
<xi:include href="../common/tables/neutron-agent.xml"/>
<xi:include href="../../common/tables/neutron-agent.xml"/>
</section>
<section xml:id="networking-options-api">
<title>API</title>
<para>Use the following options to alter API-related settings.</para>
<xi:include href="../common/tables/neutron-api.xml"/>
<xi:include href="../../common/tables/neutron-api.xml"/>
</section>
<section xml:id="networking-options-db">
<title>Database</title>
<para>Use the following options to alter Database-related settings.</para>
<xi:include href="../common/tables/neutron-db.xml"/>
<xi:include href="../../common/tables/neutron-db.xml"/>
</section>
<section xml:id="networking-options-logging">
<title>Logging</title>
<para>Use the following options to alter logging settings.</para>
<xi:include href="../common/tables/neutron-logging.xml"/>
<xi:include href="../../common/tables/neutron-logging.xml"/>
</section>
<section xml:id="networking-options-metadata">
<title>Metadata Agent</title>
<para>Use the following options in the
<filename>metadata_agent.ini</filename> file for the Metadata agent.</para>
<xi:include href="../common/tables/neutron-metadata.xml"/>
<xi:include href="../../common/tables/neutron-metadata.xml"/>
</section>
<section xml:id="networking-options-policy">
<title>Policy</title>
<para>Use the following options in the
<filename>neutron.conf</filename> file to change policy settings.</para>
<xi:include href="../common/tables/neutron-policy.xml"/>
<xi:include href="../../common/tables/neutron-policy.xml"/>
</section>
<section xml:id="networking-options-quotas">
<title>Quotas</title>
<para>Use the following options in the
<filename>neutron.conf</filename> file for the quota system.</para>
<xi:include href="../common/tables/neutron-quotas.xml"/>
<xi:include href="../../common/tables/neutron-quotas.xml"/>
</section>
<section xml:id="networking-options-scheduler">
<title>Scheduler</title>
<para>Use the following options in the
<filename>neutron.conf</filename> file to change scheduler settings.</para>
<xi:include href="../common/tables/neutron-scheduler.xml"/>
<xi:include href="../../common/tables/neutron-scheduler.xml"/>
</section>
<section xml:id="networking-options-securitygroups">
<title>Security Groups</title>
<para>Use the following options in the configuration file
for your driver to change security group settings.</para>
<xi:include href="../common/tables/neutron-securitygroups.xml"/>
<xi:include href="../../common/tables/neutron-securitygroups.xml"/>
</section>
<section xml:id="networking-options-ssl">
<title>SSL</title>
<para>Use the following options in the
<filename>neutron.conf</filename> file to enable SSL.</para>
<xi:include href="../common/tables/neutron-ssl.xml"/>
<xi:include href="../../common/tables/neutron-ssl.xml"/>
</section>
<section xml:id="networking-options-testing">
<title>Testing</title>
<para>Use the following options to alter testing-related features.</para>
<xi:include href="../common/tables/neutron-testing.xml"/>
<xi:include href="../../common/tables/neutron-testing.xml"/>
</section>
<section xml:id="networking-options-wsgi">
<title>WSGI</title>
<para>Use the following options in the
<filename>neutron.conf</filename> file to configure the WSGI layer.</para>
<xi:include href="../common/tables/neutron-wsgi.xml"/>
<xi:include href="../../common/tables/neutron-wsgi.xml"/>
</section>
</chapter>
</section>

22
doc/src/docbkx/openstack-config/section_networking-plugins.xml → doc/src/docbkx/openstack-config/networking/section_networking-plugins.xml
View File

@@ -22,48 +22,48 @@ plugins available.
</para>
<section xml:id="networking-plugin-bigswitch">
<title>BigSwitch Configuration Options</title>
<xi:include href="../common/tables/neutron-bigswitch.xml"/>
<xi:include href="../../common/tables/neutron-bigswitch.xml"/>
</section>
<section xml:id="networking-plugin-cisco">
<title>CISCO Configuration Options</title>
<xi:include href="../common/tables/neutron-cisco.xml"/>
<xi:include href="../../common/tables/neutron-cisco.xml"/>
</section>
<section xml:id="networking-plugin-hyperv">
<title>CloudBase Hyper-V Configuration Options</title>
<xi:include href="../common/tables/neutron-hyperv.xml"/>
<xi:include href="../../common/tables/neutron-hyperv.xml"/>
</section>
<section xml:id="networking-plugin-linuxbridge">
<title>Linux Bridge Configuration Options</title>
<xi:include href="../common/tables/neutron-linuxbridge.xml"/>
<xi:include href="../../common/tables/neutron-linuxbridge.xml"/>
</section>
<section xml:id="networking-plugin-meta">
<title>Meta Plugin Configuration Options</title>
<para>The Meta Plugin allows you to use multiple plugins at the same time.</para>
<xi:include href="../common/tables/neutron-meta.xml"/>
<xi:include href="../../common/tables/neutron-meta.xml"/>
</section>
<section xml:id="networking-plugin-midonet">
<title>MidoNet Configuration Options</title>
<xi:include href="../common/tables/neutron-midonet.xml"/>
<xi:include href="../../common/tables/neutron-midonet.xml"/>
</section>
<section xml:id="networking-plugin-nec">
<title>NEC Configuration Options</title>
<xi:include href="../common/tables/neutron-nec.xml"/>
<xi:include href="../../common/tables/neutron-nec.xml"/>
</section>
<section xml:id="networking-plugin-nicira">
<title>Nicira NVP Configuration Options</title>
<xi:include href="../common/tables/neutron-nicira.xml"/>
<xi:include href="../../common/tables/neutron-nicira.xml"/>
</section>
<section xml:id="networking-plugin-openvswitch">
<title>Open vSwitch Configuration Options</title>
<xi:include href="../common/tables/neutron-openvswitch.xml"/>
<xi:include href="../../common/tables/neutron-openvswitch.xml"/>
</section>
<section xml:id="networking-plugin-plumgrid">
<title>PLUMgrid Configuration Options</title>
<xi:include href="../common/tables/neutron-plumgrid.xml"/>
<xi:include href="../../common/tables/neutron-plumgrid.xml"/>
</section>
<section xml:id="networking-plugin-ryu">
<title>Ryu Configuration Options</title>
<xi:include href="../common/tables/neutron-ryu.xml"/>
<xi:include href="../../common/tables/neutron-ryu.xml"/>
</section>
</section>