64b6c9261e
Current folder name New folder name Book title ---------------------------------------------------------- basic-install DELETE cli-guide DELETE common common NEW admin-guide-cloud Cloud Administrators Guide docbkx-example DELETE openstack-block-storage-admin DELETE openstack-compute-admin DELETE openstack-config config-reference OpenStack Configuration Reference openstack-ha high-availability-guide OpenStack High Availabilty Guide openstack-image image-guide OpenStack Virtual Machine Image Guide openstack-install install-guide OpenStack Installation Guide openstack-network-connectivity-admin admin-guide-network OpenStack Networking Administration Guide openstack-object-storage-admin DELETE openstack-security security-guide OpenStack Security Guide openstack-training training-guide OpenStack Training Guide openstack-user user-guide OpenStack End User Guide openstack-user-admin user-guide-admin OpenStack Admin User Guide glossary NEW OpenStack Glossary bug: #1220407 Change-Id: Id5ffc774b966ba7b9a591743a877aa10ab3094c7 author: diane fleming
163 lines
8.5 KiB
XML
163 lines
8.5 KiB
XML
<?xml version= "1.0" encoding= "UTF-8"?>
|
|
<section xml:id="compute-options"
|
|
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>File format for nova.conf</title>
|
|
<simplesect>
|
|
<title>Overview</title>
|
|
<para>The Compute service supports a large number of configuration options. These options
|
|
are specified in a configuration file whose default location in
|
|
<filename>/etc/nova/nova.conf</filename>.</para>
|
|
<para>The configuration file is in <link xlink:href="https://en.wikipedia.org/wiki/INI_file"
|
|
>INI file format</link>, with options specified as <literal>key=value</literal>
|
|
pairs, grouped into sections. Almost all of the configuration options are in the
|
|
<literal>DEFAULT</literal> section. Here's a brief
|
|
example:<programlisting language="ini">[DEFAULT]
|
|
debug=true
|
|
verbose=true
|
|
|
|
[trusted_computing]
|
|
server=10.3.4.2</programlisting></para>
|
|
|
|
</simplesect>
|
|
<simplesect>
|
|
<title>Types of configuration options</title>
|
|
<para>Each configuration option has an associated type that indicates what values can be
|
|
set. The supported option types are as follows:<variablelist>
|
|
<varlistentry>
|
|
<term>BoolOpt</term>
|
|
<listitem>
|
|
<para>Boolean option. Value must be either <literal>true</literal> or
|
|
<literal>false</literal> .
|
|
Example:<programlisting language="ini">debug=false</programlisting></para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>StrOpt</term>
|
|
<listitem>
|
|
<para>String option. Value is an arbitrary string.
|
|
Example:<programlisting language="ini">my_ip=10.0.0.1</programlisting></para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>IntOption</term>
|
|
<listitem>
|
|
<para>Integer option. Value must be an integer. Example:
|
|
<programlisting language="ini">glance_port=9292</programlisting></para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>MultiStrOpt</term>
|
|
<listitem>
|
|
<para>String option. Same as StrOpt, except that it can be declared multiple
|
|
times to indicate multiple values.
|
|
Example:<programlisting language="ini">ldap_dns_servers=dns1.example.org
|
|
ldap_dns_servers=dns2.example.org</programlisting></para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>ListOpt</term>
|
|
<listitem>
|
|
<para>List option. Value is a list of arbitrary strings separated by commas.
|
|
Example:<programlisting language="ini">enabled_apis=ec2,osapi_compute,metadata</programlisting></para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>FloatOpt</term>
|
|
<listitem>
|
|
<para>Floating-point option. Value must be a floating-point number.
|
|
Example:<programlisting language="ini">ram_allocation_ratio=1.5</programlisting></para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
|
|
<important>
|
|
<para>Nova options should <emphasis>not</emphasis>
|
|
be quoted.</para>
|
|
</important>
|
|
</simplesect>
|
|
<simplesect>
|
|
<title>Sections</title>
|
|
<para>Configuration options are grouped by section. The Compute config file supports the
|
|
following sections.<variablelist>
|
|
<varlistentry>
|
|
<term><literal>[DEFAULT]</literal></term>
|
|
<listitem>
|
|
<para>Almost all of the configuration options are organized into this
|
|
section. If the documentation for a configuration option does not
|
|
specify its section, assume that it should be placed in this one.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><literal>[cells]</literal></term>
|
|
<listitem>
|
|
<para>The <literal>cells</literal> section is
|
|
used for options for configuring cells
|
|
functionality. See the <link
|
|
xlink:href="../openstack-compute/admin/content/ch_cells.html">Cells</link>
|
|
section of the OpenStack Compute Admin
|
|
Manual for more details.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><literal>[baremetal]</literal></term>
|
|
<listitem>
|
|
<para>This section is used for options that relate to the baremetal
|
|
hypervisor driver.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><literal>[conductor]</literal></term>
|
|
<listitem>
|
|
<para>The <literal>conductor</literal> section is used for options for
|
|
configuring the <systemitem class="service">nova-conductor</systemitem> service.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><literal>[trusted_computing]</literal></term>
|
|
<listitem>
|
|
<para>The <literal>trusted_computing</literal> section is used for options
|
|
that relate to the trusted computing pools functionality. Options in
|
|
this section describe how to connect to a remote attestation
|
|
service.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist></para>
|
|
</simplesect>
|
|
<simplesect>
|
|
<title>Variable substitution</title>
|
|
<para>The configuration file supports variable substitution. Once a configuration option is
|
|
set, it can be referenced in later configuration values when preceded by
|
|
<literal>$</literal>. Consider the following example where <literal>my_ip</literal>
|
|
is defined and then <literal>$my_ip</literal> is used as a
|
|
variable.<programlisting language="ini">my_ip=10.2.3.4
|
|
glance_host=$my_ip
|
|
metadata_host=$my_ip</programlisting></para>
|
|
<para>If you need a value to contain the <literal>$</literal> symbol, escape it by doing
|
|
<literal>$$</literal>. For example, if your LDAP DNS password was
|
|
<literal>$xkj432</literal>, you would
|
|
do:<programlisting language="ini">ldap_dns_password=$$xkj432</programlisting></para>
|
|
<para>The Compute code uses Python's <literal>string.Template.safe_substitute()</literal>
|
|
method to implement variable substitution. For more details on how variable substitution
|
|
is resolved, see <link
|
|
xlink:href="http://docs.python.org/2/library/string.html#template-strings">Python
|
|
documentation on template strings</link> and <link
|
|
xlink:href="http://www.python.org/dev/peps/pep-0292/">PEP 292</link>.</para>
|
|
</simplesect>
|
|
<simplesect>
|
|
<title>Whitespace</title>
|
|
<para>To include whitespace in a configuration value, use a quoted string. For
|
|
example:<programlisting language="ini">ldap_dns_passsword='a password with spaces'</programlisting></para>
|
|
</simplesect>
|
|
<simplesect>
|
|
<title>Specifying an alternate location for nova.conf</title>
|
|
<para>The configuration file is loaded by all of the nova-* services, as well as the
|
|
<command>nova-manage</command> command-line tool. To specify an alternate location
|
|
for the configuration file, pass the <literal>--config-file
|
|
<replaceable>/path/to/nova.conf</replaceable></literal> argument when starting a
|
|
nova-* service or calling <command>nova-manage</command>.</para>
|
|
</simplesect>
|
|
</section>
|