Update docbook element usage.

This patch updates this chapter will more docbook element usage.  Most
of the changes fall into these categories:

1) Use <filename> for filenames.

2) Use <literal> around a lot of things, such as configuraiton options
and values.

3) Remove the "default: " from the cells in the "Default" column of most
of the tables, as it seemed redundant.

Change-Id: I3749faf060bcfa9ec9236b2c9961839fd60b9ee0
This commit is contained in:
Russell Bryant 2012-03-03 11:32:43 -05:00
parent 47101ece43
commit 92de8ceee0

@ -18,19 +18,21 @@
<section xml:id="general-compute-configuration-overview">
<title>General Compute Configuration Overview</title>
<para>Most configuration information is available in the nova.conf flag
file. Here are some general purpose flags that you can use to learn more
about the flag file and the node. The configuration file nova.conf is
typically stored in /etc/nova/nova.conf.</para>
<para>Most configuration information is available in the
<filename>nova.conf</filename> flag file. Here are some general purpose
flags that you can use to learn more about the flag 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 flag file by using the --flagfile
(nova.conf) parameter when running one of the nova- services. This inserts
flag definitions from the given configuration file name, which may be
useful for debugging or performance tuning. Here are some general purpose
flags.</para>
<para>You can use a particular flag file by using the
<literal>--flagfile</literal> (<filename>nova.conf</filename>) parameter
when running one of the nova- services. This inserts flag definitions from
the given configuration file name, which may be useful for debugging or
performance tuning. Here are some general purpose flags.</para>
<table rules="all">
<caption>Description of general purpose nova.conf flags</caption>
<caption>Description of general purpose <filename>nova.conf</filename>
flags</caption>
<thead>
<tr>
@ -44,7 +46,7 @@
<tbody>
<tr>
<td>--my_ip</td>
<td><literal>--my_ip</literal></td>
<td>None</td>
@ -52,7 +54,7 @@
</tr>
<tr>
<td>--host</td>
<td><literal>--host</literal></td>
<td>None</td>
@ -61,7 +63,7 @@
</tr>
<tr>
<td>-?, --[no]help</td>
<td><literal>-?, --[no]help</literal></td>
<td>None</td>
@ -69,7 +71,7 @@
</tr>
<tr>
<td>--[no]helpshort</td>
<td><literal>--[no]helpshort</literal></td>
<td>None</td>
@ -77,7 +79,7 @@
</tr>
<tr>
<td>--[no]helpxml</td>
<td><literal>--[no]helpxml</literal></td>
<td>None</td>
@ -93,7 +95,8 @@
services.</para>
<table rules="all">
<caption>Description of nova.conf flags for all services</caption>
<caption>Description of <filename>nova.conf</filename> flags for all
services</caption>
<thead>
<tr>
@ -107,26 +110,26 @@
<tbody>
<tr>
<td>--state_path</td>
<td><literal>--state_path</literal></td>
<td>'/Users/username/p/nova/nova/../'</td>
<td><filename>/Users/username/p/nova/nova/../</filename></td>
<td>Directory path; Top-level directory for maintaining nova's
state.</td>
</tr>
<tr>
<td>--periodic_interval</td>
<td><literal>--periodic_interval</literal></td>
<td>default: '60'</td>
<td><literal>60</literal></td>
<td>Integer value; Seconds between running periodic tasks.</td>
</tr>
<tr>
<td>--report_interval</td>
<td><literal>--report_interval</literal></td>
<td>default: '10'</td>
<td><literal>10</literal></td>
<td>Integer value; Seconds between nodes reporting state to the data
store.</td>
@ -136,12 +139,12 @@
</section>
<section xml:id="sample-nova-configuration-files">
<title>Example nova.conf Configuration Files</title>
<title>Example <filename>nova.conf</filename> Configuration Files</title>
<para>The following sections describe many of the flag settings that can
go into the nova.conf files. These need to be copied to each compute node.
Here are some sample nova.conf files that offer examples of specific
configurations.</para>
go into the <filename>nova.conf</filename> files. These 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>Configuration using KVM, FlatDHCP, MySQL, Glance, LDAP, and
@ -206,8 +209,8 @@
<simplesect>
<title>KVM, Flat, MySQL, and Glance, OpenStack or EC2 API</title>
<para>This example nova.conf file is from an internal Rackspace test
system used for demonstrations.</para>
<para>This example <filename>nova.conf</filename> file is from an
internal Rackspace test system used for demonstrations.</para>
<programlisting>
# configured using KVM, Flat, MySQL, and Glance, API is OpenStack (or EC2)
@ -247,8 +250,8 @@
<title>XenServer 5.6, Flat networking, MySQL, and Glance, OpenStack
API</title>
<para>This example nova.conf file is from an internal Rackspace test
system.</para>
<para>This example <filename>nova.conf</filename> file is from an
internal Rackspace test system.</para>
<programlisting>
--verbose
@ -291,8 +294,9 @@
<section xml:id="configuring-logging">
<title>Configuring Logging</title>
<para>You can use nova.conf flags to indicate where Compute will log
events, the level of logging, and customize log formats.</para>
<para>You can use <filename>nova.conf</filename> flags to indicate where
Compute will log events, the level of logging, and customize log
formats.</para>
<table rules="all">
<caption>Description of nova.conf flags for logging</caption>
@ -309,44 +313,43 @@
<tbody>
<tr>
<td>--logdir</td>
<td><literal>--logdir</literal></td>
<td>'/var/logs/nova'</td>
<td><literal>/var/logs/nova</literal></td>
<td>Directory path; Output to a per-service log file in the named
directory.</td>
</tr>
<tr>
<td>--logfile</td>
<td><literal>--logfile</literal></td>
<td>default: ''</td>
<td>Based on service name.</td>
<td>File name; Output to named file.</td>
</tr>
<tr>
<td>--[no]use_syslog</td>
<td><literal>--[no]use_syslog</literal></td>
<td>default: 'false'</td>
<td><literal>False</literal></td>
<td>Output to syslog using their file naming system.</td>
</tr>
<tr>
<td>--default_log_levels</td>
<td><literal>--default_log_levels</literal></td>
<td>default:
'amqplib=WARN,sqlalchemy=WARN,eventlet.wsgi.server=WARN'</td>
<td><literal>amqplib=WARN,sqlalchemy=WARN,eventlet.wsgi.server=WARN</literal></td>
<td>Pair of named loggers and level of message to be logged; List of
logger=LEVEL pairs</td>
</tr>
<tr>
<td>--verbose</td>
<td><literal>--verbose</literal></td>
<td>default: 'false'</td>
<td><literal>False</literal></td>
<td>Set to 1 or true to turn on; Shows debug output - optional but
helpful during initial setup.</td>
@ -373,37 +376,37 @@
<tbody>
<tr>
<td>--logging_context_format_string</td>
<td><literal>--logging_context_format_string</literal></td>
<td>default: '%(asctime)s %(levelname)s %(name)s [%(request_id)s
%(user)s %(project)s] %(message)s'</td>
<td><literal>%(asctime)s %(levelname)s %(name)s [%(request_id)s
%(user)s %(project)s] %(message)s</literal></td>
<td>The format string to use for log messages with additional
context.</td>
</tr>
<tr>
<td>--logging_debug_format_suffix</td>
<td><literal>--logging_debug_format_suffix</literal></td>
<td>default: 'from %(processName)s (pid=%(process)d) %(funcName)s
%(pathname)s:%(lineno)d'</td>
<td><literal>from %(processName)s (pid=%(process)d) %(funcName)s
%(pathname)s:%(lineno)d</literal></td>
<td>The data to append to the log format when level is DEBUG</td>
</tr>
<tr>
<td>--logging_default_format_string</td>
<td><literal>--logging_default_format_string</literal></td>
<td>default: '%(asctime)s %(levelname)s %(name)s [-]
%(message)s'</td>
<td><literal>%(asctime)s %(levelname)s %(name)s [-]
%(message)s</literal></td>
<td>The format string to use for log messages without context.</td>
</tr>
<tr>
<td>--logging_exception_prefix</td>
<td><literal>--logging_exception_prefix</literal></td>
<td>default: '(%(name)s): TRACE: '</td>
<td><literal>(%(name)s): TRACE:</literal></td>
<td>String value; Prefix each line of exception output with this
format.</td>
@ -418,9 +421,9 @@
<para>OpenStack Compute requires a hypervisor and supports several
hypervisors and virtualization standards. Configuring and running
OpenStack Compute to use a particular hypervisor takes several
installation and configuration steps. The --libvirt_type flag indicates
which hypervisor will be used. Refer <xref
linkend="hypervisor-configuration-basics">
installation and configuration steps. The
<literal>--libvirt_type</literal> flag indicates which hypervisor will be
used. Refer <xref linkend="hypervisor-configuration-basics">
Hypervisor configuration basics
</xref> for more details.</para>
</section>
@ -429,16 +432,19 @@
<title>Configuring Authentication and Authorization</title>
<para>There are different methods of authentication for the OpenStack
Compute project. The default setting is to use the novarc file that
contains credentials. To do so, set the --use_deprecated-auth flag in your
nova.conf, which is True by default. For no auth, modify the paste.ini
that is included in the etc/nova directory. With additional configuration,
you can use the OpenStack Identity Service, code-named Keystone. In
Compute, the settings for using Keystone are commented lines in
etc/nova/api-paste.ini, and Keystone also provides an example file in
keystone/examples/paste/nova-api-paste.ini. Restart the nova-api service
for these settings to be configured. Refer to the Identity Service Starter
Guide for additional information.</para>
Compute project. The default setting is to use the
<filename>novarc</filename> file that contains credentials. To do so, set
the <literal>--use_deprecated_auth</literal> flag in your
<filename>nova.conf</filename>, which is <literal>True</literal> by
default. For no auth, modify the <filename>paste.ini</filename> that is
included in the <filename>etc/nova</filename> directory. With additional
configuration, you can use the OpenStack Identity Service, code-named
Keystone. In Compute, the settings for using Keystone are commented lines
in <filename>etc/nova/api-paste.ini</filename>, and Keystone also provides
an example file in
<filename>keystone/examples/paste/nova-api-paste.ini</filename>. Restart
the nova-api service for these settings to be configured. Refer to the
Identity Service Starter Guide for additional information.</para>
<para>OpenStack Compute uses an implementation of an authentication system
structured with an Active Directory or other federated LDAP user store
@ -450,11 +456,12 @@
<para>If you see errors such as "EC2ResponseError: 403 Forbidden" it is
likely you are trying to use euca commands without the auth system
properly configured. Either install and use the default auth setting, or
change out the default paste.ini file to use no auth, or configure the
Identity Service.</para>
change out the default <filename>paste.ini</filename> file to use no auth,
or configure the Identity Service.</para>
<table rules="all">
<caption>Description of nova.conf flags for Authentication</caption>
<caption>Description of <filename>nova.conf</filename> flags for
Authentication</caption>
<thead>
<tr>
@ -468,40 +475,42 @@
<tbody>
<tr>
<td>--auth_driver</td>
<td><literal>--auth_driver</literal></td>
<td>default:'nova.auth.dbdriver.DbDriver'</td>
<td><literal>nova.auth.dbdriver.DbDriver</literal></td>
<td><para>String value; Name of the driver for authentication</para>
<itemizedlist>
<listitem>
<para>nova.auth.dbdriver.DbDriver - Default setting, uses
credentials stored in zip file, one per project.</para>
<para><literal>nova.auth.dbdriver.DbDriver</literal> - Default
setting, uses credentials stored in zip file, one per
project.</para>
</listitem>
<listitem>
<para>nova.auth.ldapdriver.FakeLdapDriver - create a
replacement for this driver supporting other backends by
creating another class that exposes the same public
<para><literal>nova.auth.ldapdriver.FakeLdapDriver</literal> -
create a replacement for this driver supporting other backends
by creating another class that exposes the same public
methods.</para>
</listitem>
</itemizedlist></td>
</tr>
<tr>
<td>--use_deprecated_auth</td>
<td><literal>--use_deprecated_auth</literal></td>
<td>default:'False'</td>
<td><literal>False</literal></td>
<td><para>True or false; Sets the auth system to use the zip file
provided with the project files to store all credentials</para></td>
<td><para><literal>True</literal> or <literal>False</literal>; Sets
the auth system to use the zip file provided with the project files
to store all credentials</para></td>
</tr>
</tbody>
</table>
<table rules="all">
<caption>Description of nova.conf flags for customizing roles in
deprecated auth</caption>
<caption>Description of <filename>nova.conf</filename> flags for
customizing roles in deprecated auth</caption>
<thead>
<tr>
@ -515,25 +524,25 @@
<tbody>
<tr>
<td>--allowed_roles</td>
<td><literal>--allowed_roles</literal></td>
<td>default: 'cloudadmin,itsec,sysadmin,netadmin,developer')</td>
<td><literal>cloudadmin,itsec,sysadmin,netadmin,developer</literal></td>
<td>Comma separated list; Allowed roles for project</td>
</tr>
<tr>
<td>--global_roles</td>
<td><literal>--global_roles</literal></td>
<td>default: 'cloudadmin,itsec')</td>
<td><literal>cloudadmin,itsec</literal></td>
<td>Comma separated list; Roles that apply to all projects</td>
</tr>
<tr>
<td>--superuser_roles</td>
<td><literal>--superuser_roles</literal></td>
<td>default: 'cloudadmin')</td>
<td><literal>cloudadmin</literal></td>
<td>Comma separated list; Roles that ignore authorization checking
completely</td>
@ -542,8 +551,8 @@
</table>
<table rules="all">
<caption>Description of nova.conf flags for credentials in deprecated
auth</caption>
<caption>Description of <filename>nova.conf</filename> flags for
credentials in deprecated auth</caption>
<thead>
<tr>
@ -557,59 +566,60 @@
<tbody>
<tr>
<td>--credentials_template</td>
<td><literal>--credentials_template</literal></td>
<td>default: '')</td>
<td>None</td>
<td>Directory; Template for creating users' RC file</td>
</tr>
<tr>
<td>--credential_rc_file</td>
<td><literal>--credential_rc_file</literal></td>
<td>default: '%src')</td>
<td><literal>%src</literal></td>
<td>File name; File name of rc in credentials zip</td>
</tr>
<tr>
<td>--credential_cert_file</td>
<td><literal>--credential_cert_file</literal></td>
<td>default: 'cert.pem')</td>
<td><literal>cert.pem</literal></td>
<td>File name; File name of certificate in credentials zip</td>
</tr>
<tr>
<td>--credential_key_file</td>
<td><literal>--credential_key_file</literal></td>
<td>default: 'pk.pem')</td>
<td><literal>pk.pem</literal></td>
<td>File name; File name of rc in credentials zip</td>
</tr>
<tr>
<td>--vpn_client_template</td>
<td><literal>--vpn_client_template</literal></td>
<td>default: 'nova/cloudpipe/client/ovpn.template')</td>
<td><literal>nova/cloudpipe/client/ovpn.template</literal></td>
<td>Directory; Refers to where the template lives for creating users
vpn file</td>
</tr>
<tr>
<td>--credential_vpn_file</td>
<td><literal>--credential_vpn_file</literal></td>
<td>default: 'nova-vpn.conf')</td>
<td><literal>nova-vpn.conf</literal></td>
<td>File name; Filename of certificate in credentials.zip</td>
<td>File name; Filename of certificate in
<filename>credentials.zip</filename></td>
</tr>
</tbody>
</table>
<table rules="all">
<caption>Description of nova.conf flags for CA (Certificate
Authority)</caption>
<caption>Description of <filename>nova.conf</filename> flags for CA
(Certificate Authority)</caption>
<thead>
<tr>
@ -623,72 +633,69 @@
<tbody>
<tr>
<td>--keys_path</td>
<td><literal>--keys_path</literal></td>
<td>default: '$state_path/keys')</td>
<td><literal><replaceable>$state_path</replaceable>/keys</literal></td>
<td>Directory; Where Nova keeps the keys</td>
</tr>
<tr>
<td>--ca_file</td>
<td><literal>--ca_file</literal></td>
<td>default: 'cacert.pem')</td>
<td><literal>cacert.pem</literal></td>
<td>File name; File name of root CA</td>
</tr>
<tr>
<td>--crl_file</td>
<td><literal>--crl_file</literal></td>
<td>default: 'crl.pem')</td>
<td><literal>crl.pem</literal></td>
<td>File name; File name of Certificate Revocation List</td>
</tr>
<tr>
<td>--key_file</td>
<td><literal>--key_file</literal></td>
<td>default: 'private/cakey.pem')</td>
<td><literal>private/cakey.pem</literal></td>
<td>File name; File name of private key</td>
</tr>
<tr>
<td>--use_project_ca</td>
<td><literal>--use_project_ca</literal></td>
<td>default: 'false')</td>
<td><literal>false</literal></td>
<td>True or false; Indicates whether to use a CA for each project;
false means CA is not used for each project</td>
</tr>
<tr>
<td>--project_cert_subject</td>
<td><literal>--project_cert_subject</literal></td>
<td>default:
'/C=US/ST=California/L=MountainView/O=AnsoLabs/OU=NovaDev/CN=proje
ct-ca-%s-%s')</td>
<td><literal>/C=US/ST=California/L=MountainView/O=AnsoLabs/OU=NovaDev/CN=proje
ct-ca-%s-%s</literal></td>
<td>String; Subject for certificate for projects, %s for project,
timestamp</td>
</tr>
<tr>
<td>--user_cert_subject</td>
<td><literal>--user_cert_subject</literal></td>
<td>default:
'/C=US/ST=California/L=MountainView/O=AnsoLabs/OU=NovaDev/CN=%s-%s-%s')</td>
<td><literal>/C=US/ST=California/L=MountainView/O=AnsoLabs/OU=NovaDev/CN=%s-%s-%s</literal></td>
<td>String; Subject for certificate for users, %s for project,
users, timestamp</td>
</tr>
<tr>
<td>--vpn_cert_subject</td>
<td><literal>--vpn_cert_subject</literal></td>
<td>default:
'/C=US/ST=California/L=MountainView/O=AnsoLabs/OU=NovaDev/CN=project-vpn-%s-%s')</td>
<td><literal>/C=US/ST=California/L=MountainView/O=AnsoLabs/OU=NovaDev/CN=project-vpn-%s-%s</literal></td>
<td>String; Subject for certificate for vpns, %s for project,
timestamp</td>
@ -728,8 +735,8 @@
sudo bash -c "echo 1 &gt; /proc/sys/net/ipv6/conf/all/forwarding"
sudo bash -c "echo 0 &gt; /proc/sys/net/ipv6/conf/all/accept_ra"</literallayout>
<para>Edit the nova.conf file on all nodes to set the --use_ipv6 flag to
True. Restart all nova- services.</para>
<para>Edit the <filename>nova.conf</filename> file on all nodes to set the
--use_ipv6 flag to True. Restart all nova- services.</para>
<para>When using the command 'nova-manage network create' you can add a
fixed range for IPv6 addresses. You must specify public or private after
@ -756,7 +763,8 @@ sudo bash -c "echo 0 &gt; /proc/sys/net/ipv6/conf/all/accept_ra"</literallayout>
FlatDHCPManager.</para>
<table rules="all">
<caption>Description of nova.conf flags for configuring IPv6</caption>
<caption>Description of <filename>nova.conf</filename> flags for
configuring IPv6</caption>
<thead>
<tr>
@ -770,23 +778,23 @@ sudo bash -c "echo 0 &gt; /proc/sys/net/ipv6/conf/all/accept_ra"</literallayout>
<tbody>
<tr>
<td>--use_ipv6</td>
<td><literal>--use_ipv6</literal></td>
<td>default: 'false'</td>
<td><literal>false</literal></td>
<td>Set to 1 or true to turn on; Determines whether to use IPv6
network addresses</td>
</tr>
<tr>
<td>--flat_injected</td>
<td><literal>--flat_injected</literal></td>
<td>default: 'false'</td>
<td><literal>false</literal></td>
<td>Cactus only:Indicates whether Compute (Nova) should use attempt
to inject IPv6 network configuration information into the guest. It
attempts to modify /etc/network/interfaces and currently only works
on Debian-based systems.</td>
attempts to modify <filename>/etc/network/interfaces</filename> and
currently only works on Debian-based systems.</td>
</tr>
</tbody>
</table>
@ -795,16 +803,20 @@ sudo bash -c "echo 0 &gt; /proc/sys/net/ipv6/conf/all/accept_ra"</literallayout>
<section xml:id="configuring-compute-to-use-the-image-service">
<title>Configuring Image Service and Storage for Compute</title>
<para>Diablo uses Glance for storing and retrieving images. After you have
installed a Glance server, you can configure nova-compute to use Glance
for image storage and retrieval. You must ensure the --image_service flag
is defined with the Glance service :
'nova.image.glance.GlanceImageService' uses Glance to store and retrieve
images for OpenStack Compute.</para>
<para>Diablo uses <application>Glance</application> for storing and
retrieving images. After you have installed a
<application>Glance</application> server, you can configure
<command>nova-compute</command> to use <application>Glance</application>
for image storage and retrieval. You must ensure the
<literal>--image_service</literal> flag is defined with the
<application>Glance</application> service :
'<literal>nova.image.glance.GlanceImageService</literal>' uses
<application>Glance</application> to store and retrieve images for
OpenStack Compute.</para>
<table rules="all">
<caption>Description of nova.conf flags for the Glance image service and
storage</caption>
<caption>Description of <filename>nova.conf</filename> flags for the
Glance image service and storage</caption>
<thead>
<tr>
@ -818,22 +830,22 @@ sudo bash -c "echo 0 &gt; /proc/sys/net/ipv6/conf/all/accept_ra"</literallayout>
<tbody>
<tr>
<td>--image_service</td>
<td><literal>--image_service</literal></td>
<td>default: 'nova.image.local.GlanceImageService'</td>
<td><literal>nova.image.local.GlanceImageService</literal></td>
<td><para>The service to use for retrieving and searching for
images. Images must be registered using euca2ools. Options:
</para><itemizedlist>
<listitem>
<para>nova.image.s3.S3ImageService</para>
<para><literal>nova.image.s3.S3ImageService</literal></para>
<para>S3 backend for the Image Service.</para>
</listitem>
<listitem>
<para><emphasis
role="bold">nova.image.glance.GlanceImageService</emphasis></para>
role="bold"><literal>nova.image.glance.GlanceImageService</literal></emphasis></para>
<para>Glance back end for storing and retrieving images; See
<link
@ -844,9 +856,9 @@ sudo bash -c "echo 0 &gt; /proc/sys/net/ipv6/conf/all/accept_ra"</literallayout>
</tr>
<tr>
<td>--glance_api_servers</td>
<td><literal>--glance_api_servers</literal></td>
<td>default: '$my_ip:9292'</td>
<td><literal><replaceable>$my_ip</replaceable>:9292</literal></td>
<td>List of Glance API hosts. Each item may contain a host (or IP
address) and port of an OpenStack Compute Image Service server
@ -854,18 +866,18 @@ sudo bash -c "echo 0 &gt; /proc/sys/net/ipv6/conf/all/accept_ra"</literallayout>
</tr>
<tr>
<td>--s3_dmz</td>
<td><literal>--s3_dmz</literal></td>
<td>default: '$my_ip'</td>
<td><literal><replaceable>$my_ip</replaceable></literal></td>
<td>IP address; For instances internal IP (a DMZ is shorthand for a
demilitarized zone)</td>
</tr>
<tr>
<td>--s3_host</td>
<td><literal>--s3_host</literal></td>
<td>default: '$my_ip'</td>
<td><literal><replaceable>$my_ip</replaceable></literal></td>
<td>IP address: IP address of the S3 host for infrastructure.
Location where OpenStack Compute is hosting the objectstore service,
@ -873,17 +885,17 @@ sudo bash -c "echo 0 &gt; /proc/sys/net/ipv6/conf/all/accept_ra"</literallayout>
</tr>
<tr>
<td>--s3_port</td>
<td><literal>--s3_port</literal></td>
<td>default: '3333'</td>
<td><literal>3333</literal></td>
<td>Integer value; Port where S3 host is running</td>
</tr>
<tr>
<td>--use_s3</td>
<td><literal>--use_s3</literal></td>
<td>default: 'true'</td>
<td><literal>true</literal></td>
<td>Set to 1 or true to turn on; Determines whether to get images
from s3 or use a local copy</td>
@ -1022,16 +1034,16 @@ ping HostC
root 5952 5908 6 11:29 pts/5 00:00:00 python /opt/nova-2010.4//bin/nova-objectstore
... (snip) </programlisting>
<para>"NOVA-INST-DIR/instances/" directory can be seen at
HostA</para>
<para>"<filename><replaceable>NOVA-INST-DIR</replaceable>/instances/</filename>"
directory can be seen at HostA</para>
<literallayout class="monospaced">ls -ld NOVA-INST-DIR/instances/</literallayout>
<literallayout class="monospaced">ls -ld <filename><replaceable>NOVA-INST-DIR</replaceable>/instances/</filename></literallayout>
<programlisting>drwxr-xr-x 2 root root 4096 2010-12-07 14:34 nova-install-dir/instances/ </programlisting>
<para>Same check at HostB and HostC</para>
<literallayout>ls -ld NOVA-INST-DIR/instances/</literallayout>
<literallayout>ls -ld <filename><replaceable>NOVA-INST-DIR</replaceable>/instances/</filename></literallayout>
<programlisting>drwxr-xr-x 2 root root 4096 2010-12-07 14:34 nova-install-dir/instances/</programlisting>
@ -1050,7 +1062,7 @@ HostA: 921515008 101921792 772783104 12% /opt ( &lt;--- this line is im
<listitem>
<para>Libvirt configurations. Modify
/etc/libvirt/libvirt.conf:</para>
<filename>/etc/libvirt/libvirt.conf</filename>:</para>
<programlisting>
before : #listen_tls = 0
@ -1062,14 +1074,14 @@ after : listen_tcp = 1
add: auth_tcp = "none"
</programlisting>
<para>Modify /etc/init/libvirt-bin.conf</para>
<para>Modify <filename>/etc/init/libvirt-bin.conf</filename></para>
<programlisting>
before : exec /usr/sbin/libvirtd -d
after : exec /usr/sbin/libvirtd -d -l
</programlisting>
<para>Modify /etc/default/libvirt-bin</para>
<para>Modify <filename>/etc/default/libvirt-bin</filename></para>
<programlisting>
before :libvirtd_opts=" -d"
@ -1093,7 +1105,8 @@ ps -ef | grep libvirt</literallayout>
</orderedlist></para>
<table rules="all">
<caption>Description of nova.conf flags for live migration</caption>
<caption>Description of <filename>nova.conf</filename> flags for live
migration</caption>
<thead>
<tr>
@ -1107,37 +1120,37 @@ ps -ef | grep libvirt</literallayout>
<tbody>
<tr>
<td>--live_migration_retry_count</td>
<td><literal>--live_migration_retry_count</literal></td>
<td>default: 30</td>
<td><literal>30</literal></td>
<td>Retry count needed in live_migration. Sleep 1sec for each
retry</td>
</tr>
<tr>
<td>--live_migration_uri</td>
<td><literal>--live_migration_uri</literal></td>
<td>default: 'qemu+tcp://%s/system'</td>
<td><literal>qemu+tcp://%s/system</literal></td>
<td>Define protocol used by live_migration feature. If you would
like to use qemu+ssh, change this as described at
http://libvirt.org/.</td>
like to use qemu+ssh, change this as described at <link
xlink:href="http://libvirt.org">http://libvirt.org/</link>.</td>
</tr>
<tr>
<td>--live_migration_bandwidth</td>
<td><literal>--live_migration_bandwidth</literal></td>
<td>default: 0</td>
<td><literal>0</literal></td>
<td>Define bandwidth used by live migration.</td>
</tr>
<tr>
<td>--live_migration_flag</td>
<td><literal>--live_migration_flag</literal></td>
<td>default: 'VIR_MIGRATE_UNDEFINE_SOURCE,
VIR_MIGRATE_PEER2PEER'</td>
<td><literal>VIR_MIGRATE_UNDEFINE_SOURCE,
VIR_MIGRATE_PEER2PEER</literal></td>
<td>Define libvirt flag for live migration.</td>
</tr>
@ -1169,50 +1182,50 @@ ps -ef | grep libvirt</literallayout>
<tbody>
<tr>
<td>--sql_connection</td>
<td><literal>--sql_connection</literal></td>
<td>default: 'sqlite:///$state_path/nova.sqlite'</td>
<td><literal>sqlite:///<replaceable>$state_path</replaceable>/nova.sqlite</literal></td>
<td>IP address; Location of OpenStack Compute SQL database</td>
</tr>
<tr>
<td>--sql_idle_timeout</td>
<td><literal>--sql_idle_timeout</literal></td>
<td>default: '3600'</td>
<td><literal>3600</literal></td>
<td>Integer value; Number of seconds to wait for a database
connection</td>
</tr>
<tr>
<td>--sql_max_retries</td>
<td><literal>--sql_max_retries</literal></td>
<td>default: '12'</td>
<td><literal>12</literal></td>
<td>Integer value; Number of attempts on the SQL connection</td>
</tr>
<tr>
<td>--sql_retry_interval</td>
<td><literal>--sql_retry_interval</literal></td>
<td>default: '10'</td>
<td><literal>10</literal></td>
<td>Integer value; Retry interval for SQL connections</td>
</tr>
<tr>
<td>--db_backend</td>
<td><literal>--db_backend</literal></td>
<td>default: 'sqlalchemy'</td>
<td><literal>sqlalchemy</literal></td>
<td>The backend selected for the database connection</td>
</tr>
<tr>
<td>--db_driver</td>
<td><literal>--db_driver</literal></td>
<td>default: 'nova.db.api'</td>
<td><literal>nova.db.api</literal></td>
<td>The drive to use for database access</td>
</tr>
@ -1702,13 +1715,14 @@ ps -ef | grep libvirt</literallayout>
<title>Configuring and Changing Limits</title>
<para>The actual limits are specified in the file
etc/nova/api-paste.ini, as part of the WSGI pipeline.</para>
<filename>etc/nova/api-paste.ini</filename>, as part of the WSGI
pipeline.</para>
<para>To enable limits, ensure the 'ratelimit' filter is included in the
API pipeline specification. If the 'ratelimit' filter is removed from
the pipeline, limiting will be disabled. There should also be a
definition for the ratelimit filter. The lines will appear as
follows:</para>
<para>To enable limits, ensure the '<literal>ratelimit</literal>' filter
is included in the API pipeline specification. If the
'<literal>ratelimit</literal>' filter is removed from the pipeline,
limiting will be disabled. There should also be a definition for the
ratelimit filter. The lines will appear as follows:</para>
<programlisting>
@ -1723,10 +1737,11 @@ paste.filter_factory = nova.api.openstack.compute.limits:RateLimitingMiddleware.
</programlisting>
<para>To modify the limits, add a 'limits' specification to the
[filter:ratelimit] section of the file. The limits are specified in the
order HTTP method, friendly URI, regex, limit, and interval. The
following example specifies the default rate limiting values:</para>
<para>To modify the limits, add a '<literal>limits</literal>'
specification to the <literal>[filter:ratelimit]</literal> section of
the file. The limits are specified in the order HTTP method, friendly
URI, regex, limit, and interval. The following example specifies the
default rate limiting values:</para>
<programlisting>