openstack/openstack-manuals
Code Issues Proposed changes

Merge "Use the parameter tag according to the markup conventions"

Browse Source
This commit is contained in:
Jenkins 2015-03-03 19:06:32 +00:00 committed by Gerrit Code Review
commit 2aad4e5286
35 changed files with 147 additions and 147 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/admin-guide-cloud/blockstorage/section_backup-block-storage-disks.xml
View File

@ -77,7 +77,7 @@
<filename>/dev/cinder-volumes/<replaceable>VOLUME_NAME</replaceable></filename>.</para>
<para>The size does not have to be the same as the
volume of the snapshot. The
<parameter>size</parameter> parameter
<parameter>--size</parameter> parameter
defines the space that LVM reserves for the
snapshot volume. As a precaution, the size
should be the same as that of the original

2
doc/admin-guide-cloud/blockstorage/section_increase-api-throughput.xml
View File

@ -20,7 +20,7 @@
<literal>cinder-api</literal>.</para>
</note>
<para>To do so, use the Block Storage API service option
<parameter>osapi_volume_workers</parameter>. This option allows
<option>osapi_volume_workers</option>. This option allows
you to specify the number of API service workers (or OS processes)
to launch for the Block Storage API service.</para>
<para>To configure this option, open the

8
doc/admin-guide-cloud/ch_compute.xml
View File

@ -162,7 +162,7 @@
but you can configure them by editing the
<filename>policy.json</filename> file for user roles.
For example, a rule can be defined so that a user must
have the <parameter>admin</parameter> role in order to be
have the <literal>admin</literal> role in order to be
able to allocate a public IP address.</para>
<para>A tenant limits users' access to particular images. Each
user is assigned a user name and password. Keypairs
@ -210,8 +210,8 @@
different operating systems as Ext4 for Linux distributions,
VFAT for non-Linux and non-Windows operating systems, and
NTFS for Windows. However, it is possible to specify
any other filesystem type by using <parameter>virt_mkfs</parameter> or
<parameter>default_ephemeral_format</parameter> configuration options.</para>
any other filesystem type by using <option>virt_mkfs</option> or
<option>default_ephemeral_format</option> configuration options.</para>
<note>
<para>For example, the <systemitem class="service">cloud-init</systemitem> package
included into an Ubuntu's stock cloud image, by default,
@ -396,7 +396,7 @@
provides five flavors. By default, these are configurable
by admin users, however that behavior can be changed by
redefining the access controls for
<parameter>compute_extension:flavormanage</parameter>
<literal>compute_extension:flavormanage</literal>
in <filename>/etc/nova/policy.json</filename> on the
<filename>compute-api</filename> server.</para>
<para>For a list of flavors that are available on your

2
doc/admin-guide-cloud/compute/section_compute-configure-migrations.xml
View File

@ -413,7 +413,7 @@ HostA: 921515008 101921792 772783104 12% /var/lib/nova/instances
<itemizedlist>
<listitem>
<para>To use block migration, you must use the <!--CHANGE THIS ==-->
<parameter>==block-migrate</parameter> parameter with the live migration
<parameter>--block-migrate</parameter> parameter with the live migration
command.</para>
<!--Made the CHANGE THIS note a comment. Please revert if incorrect. LKB-->
</listitem>

2
doc/admin-guide-cloud/compute/section_compute-instance-building-blocks.xml
View File

@ -69,7 +69,7 @@
+-----+-----------+-----------+------+-----------+------+-------+-------------+-----------+</computeroutput></screen>
<para>By default, administrative users can configure the flavors. You
can change this behavior by redefining the access controls for
<parameter>compute_extension:flavormanage</parameter> in
<literal>compute_extension:flavormanage</literal> in
<filename>/etc/nova/policy.json</filename> on the
<filename>compute-api</filename> server.</para>
</section>

2
doc/admin-guide-cloud/compute/section_compute-networking-nova.xml
View File

@ -621,7 +621,7 @@ echo 'Extra user data here'</computeroutput></screen>
<section xml:id="using-multiple-nics-usage">
<title>Using multinic</title>
<para>In order to use multinic, create two networks, and attach them
to the tenant (named <parameter>project</parameter> on the command
to the tenant (named <literal>project</literal> on the command
line):</para>
<screen><prompt>$</prompt> <userinput>nova network-create first-net --fixed-range-v4 20.20.0.0/24 --project-id $your-project</userinput>
<prompt>$</prompt> <userinput>nova network-create second-net --fixed-range-v4 20.20.10.0/24 --project-id $your-project</userinput></screen>

14
doc/admin-guide-cloud/compute/section_compute-recover-nodes.xml
View File

@ -105,17 +105,17 @@ task_state: NULL
</note>
</step>
<step>
<para>Set the <parameter>libvirt-qemu</parameter> UID in
<para>Set the <literal>libvirt-qemu</literal> UID in
<filename>/etc/passwd</filename> to the same number on all hosts
(for example, 119).</para>
</step>
<step>
<para>Set the <parameter>nova group</parameter> in
<para>Set the <literal>nova</literal> group in
<filename>/etc/group</filename> file to the same number on all
hosts (for example, 120).</para>
</step>
<step>
<para>Set the <parameter>libvirtd</parameter> group in
<para>Set the <literal>libvirtd</literal> group in
<filename>/etc/group</filename> file to the same number on all
hosts (for example, 119).</para>
</step>
@ -129,7 +129,7 @@ task_state: NULL
<prompt>#</prompt> <userinput>find / -gid 120 -exec chgrp nova {} \;</userinput></screen>
</step>
<step performance="optional">
<para>Repeat all steps for the <parameter>libvirt-qemu</parameter>
<para>Repeat all steps for the <literal>libvirt-qemu</literal>
files, if required.</para>
</step>
<step>
@ -172,7 +172,7 @@ task_state: NULL
<itemizedlist>
<listitem>
<para>Create an active iSCSI session from the SAN to the cloud
controller (used for the <parameter>cinder-volumes</parameter>
controller (used for the <literal>cinder-volumes</literal>
LVM's VG).</para>
</listitem>
<listitem>
@ -259,7 +259,7 @@ task_state: NULL
<para>Instance state at this stage depends on whether you added
an <filename>/etc/fstab</filename> entry for that volume.
Images built with the <package>cloud-init</package> package
remain in a <parameter>pending</parameter> state, while others
remain in a <literal>pending</literal> state, while others
skip the missing volume and start. This step is performed in
order to ask Compute to reboot every instance, so that the
stored state is preserved. It does not matter if not all
@ -302,7 +302,7 @@ done &lt; $volumes_tmp_file</programlisting>
follow these tips:</para>
<itemizedlist>
<listitem>
<para>Use the <parameter>errors=remount</parameter> parameter in
<para>Use the <literal>errors=remount</literal> parameter in
the <filename>fstab</filename> file to prevent data
corruption.</para>
<para>This parameter will cause the system to disable the ability

4
doc/admin-guide-cloud/compute/section_compute-rootwrap.xml
View File

@ -39,7 +39,7 @@
file. Because it's in the trusted security path, it must be owned and
writable by only the root user. The file's location is specified in both
the sudoers entry and in the <filename>nova.conf</filename> configuration
file with the <parameter>rootwrap_config=entry</parameter> parameter.</para>
file with the <literal>rootwrap_config=entry</literal> parameter.</para>
<para>The <filename>rootwrap.conf</filename> file uses an INI file format
with these sections and parameters:</para>
<table rules="all" frame="border" xml:id="rootwrap-conf-table-filter-path" width="100%">
@ -70,7 +70,7 @@
Their location is specified in the <filename>rootwrap.conf</filename>
file.</para>
<para>Filter definition files use an INI file format with a
<parameter>[Filters]</parameter> section and several lines, each with a
<literal>[Filters]</literal> section and several lines, each with a
unique parameter name, which should be different for each filter you
define:</para>
<table rules="all" frame="border" xml:id="rootwrap-conf-table-filter-name" width="100%">

20
doc/admin-guide-cloud/compute/section_compute-system-admin.xml
View File

@ -238,13 +238,13 @@ inject_password=true</programlisting>
<filename>/etc/nova/nova.conf</filename> file:</para>
<programlisting language="ini">log-config=/etc/nova/logging.conf</programlisting>
<para>
To change the logging level, add <parameter>DEBUG</parameter>,
<parameter>INFO</parameter>, <parameter>WARNING</parameter>, or
<parameter>ERROR</parameter> as a parameter.
To change the logging level, add <literal>DEBUG</literal>,
<literal>INFO</literal>, <literal>WARNING</literal>, or
<literal>ERROR</literal> as a parameter.
</para>
<para>The logging configuration file is an INI-style configuration
file, which must contain a section called
<parameter>logger_nova</parameter>. This controls the behavior of
<literal>logger_nova</literal>. This controls the behavior of
the logging facility in the <literal>nova-*</literal> services. For
example:</para>
<programlisting language="ini">[logger_nova]
@ -255,7 +255,7 @@ qualname = nova</programlisting>
(which is less verbose than the default <literal>DEBUG</literal>
setting).</para>
<para>For more about the logging configuration syntax, including the
<parameter>handlers</parameter> and <parameter>quaname</parameter>
<literal>handlers</literal> and <literal>quaname</literal>
variables, see the
<link xlink:href="http://docs.python.org/release/2.7/library/logging.html#configuration-file-format">
Python documentation</link> on logging configuration files.</para>
@ -362,14 +362,14 @@ local0.error @@172.20.1.43:1024</programlisting>
<para>On a compute node, edit the
<filename>/etc/nova/nova.conf</filename> file:</para>
<step>
<para>In the <parameter>[serial_console]</parameter> section,
<para>In the <literal>[serial_console]</literal> section,
enable the serial console:</para>
<programlisting language="ini">[serial_console]
...
enabled = true</programlisting>
</step>
<step>
<para>In the <parameter>[serial_console]</parameter> section,
<para>In the <literal>[serial_console]</literal> section,
configure the serial console proxy similar to graphical
console proxies:</para>
<programlisting language="ini">[serial_console]
@ -525,14 +525,14 @@ ws = websocket.create_connection(
+-----------+------------+-----+-----------+---------+</computeroutput></screen>
<itemizedlist>
<listitem>
<para><parameter>cpu:</parameter> Number of CPUs</para>
<para><literal>cpu</literal>: Number of CPUs</para>
</listitem>
<listitem>
<para><parameter>memory_mb:</parameter> Total amount of memory,
<para><literal>memory_mb</literal>: Total amount of memory,
in MB</para>
</listitem>
<listitem>
<para><parameter>disk_gb:</parameter> Total amount of space for
<para><literal>disk_gb</literal>: Total amount of space for
NOVA-INST-DIR/instances, in GB</para>
</listitem>
</itemizedlist>

2
doc/admin-guide-cloud/networking/section_networking-adv-config.xml
View File

@ -17,7 +17,7 @@
<para>The neutron configuration file contains the common neutron configuration options.</para>
<para>The plug-in configuration file contains the plug-in specific options.</para>
<para>The plug-in that runs on the service is loaded through the
<parameter>core_plugin</parameter> configuration option. In some cases, a plug-in
<literal>core_plugin</literal> configuration option. In some cases, a plug-in
might have an agent that performs the actual networking.</para>
<para>Most plug-ins require an SQL database. After you install and start the database
server, set a password for the root account and delete the anonymous accounts:</para>

2
doc/admin-guide-cloud/networking/section_networking-scenarios.xml
View File

@ -691,7 +691,7 @@ physical_interface_mappings = physnet2:eth1</programlisting>
used simultaneously. This section describes different <emphasis>ML2</emphasis> plug-in
and agent configurations with different type drivers and mechanism drivers.</para>
<note>
<para>Currently, there is no need to define <parameter>SEGMENTATION_ID</parameter>
<para>Currently, there is no need to define <literal>SEGMENTATION_ID</literal>
network provider attribute for GRE and VXLAN network types. The choice can be
delegated to Networking, in such case ML2 plug-in tries to find a network
in tenant network pools which respects specified provider network attributes.

2
doc/admin-guide-cloud/networking/section_networking_adv_features.xml
View File

@ -1459,7 +1459,7 @@
<option>state_sync_interval</option> configuration option to a non-zero
value exclusively on a node designated for back-end status
synchronization.</para>
<para>The <parameter>fields=status</parameter> parameter in Networking API requests
<para>The <literal>fields=status</literal> parameter in Networking API requests
always triggers an explicit query to the NSX back end, even when you enable
asynchronous state synchronization. For example, <code>GET
/v2.0/networks/<replaceable>NET_ID</replaceable>?fields=status&amp;fields=name</code>.</para>

2
doc/admin-guide-cloud/networking/section_networking_config-agents.xml
View File

@ -505,7 +505,7 @@ interface_driver = neutron.agent.linux.interface.OVSInterfaceDriver</programlist
<guimenu>Project</guimenu> section of the
dashboard.</para>
<para>Change the <option>enable_lb</option> option
to <parameter>True</parameter> in the
to <literal>True</literal> in the
<filename>local_settings</filename> file
(on Fedora, RHEL, and CentOS:
<filename>/etc/openstack-dashboard/local_settings</filename>,

24
doc/admin-guide-cloud/telemetry/section_telemetry-data-collection.xml
View File

@ -464,7 +464,7 @@
<para>Pipeline configuration by default, is stored in a separate configuration
file, called <filename>pipeline.yaml</filename>, next to the
<filename>ceilometer.conf</filename> file. The pipeline
configuration file can be set in the <parameter>pipeline_cfg_file</parameter>
configuration file can be set in the <option>pipeline_cfg_file</option>
parameter listed in the <link xlink:href=
"http://docs.openstack.org/juno/config-reference/content/ch_configuring-openstack-telemetry.html"
>Description of configuration options for api table</link> section in the
@ -652,7 +652,7 @@ sinks:
name: "disk.kilobytes"
unit: "KB"
scale: "1.0 / 1024.0"</programlisting>
<para>With the <parameter>map_from</parameter> and <parameter>map_to</parameter>
<para>With the <option>map_from</option> and <option>map_to</option>
:</para>
<programlisting>transformers:
- name: "unit_conversion"
@ -670,27 +670,27 @@ sinks:
<title>Aggregator transformer</title>
<para>A transformer that sums up the incoming samples until enough samples have
come in or a timeout has been reached.</para>
<para>Timeout can be specified with the <parameter>retention_time</parameter> parameter.
<para>Timeout can be specified with the <option>retention_time</option> parameter.
If we want to flush the aggregation after a set number of samples have been
aggregated, we can specify the size parameter.</para>
<para>The volume of the created sample is the sum of the volumes of samples that came
into the transformer. Samples can be aggregated by the attributes <parameter>project_id
</parameter>, <parameter>user_id</parameter> and <parameter>resource_metadata</parameter>.
into the transformer. Samples can be aggregated by the attributes <option>project_id
</option>, <option>user_id</option> and <option>resource_metadata</option>.
To aggregate by the chosen attributes, specify them in the configuration and set
which value of the attribute to take for the new sample (first to take the first
sample's attribute, last to take the last sample's attribute, and drop to discard
the attribute).</para>
<para>To aggregate 60s worth of samples by <parameter>resource_metadata</parameter>
and keep the <parameter>resource_metadata</parameter> of the latest received
<para>To aggregate 60s worth of samples by <option>resource_metadata</option>
and keep the <option>resource_metadata</option> of the latest received
sample:</para>
<programlisting>transformers:
- name: "aggregator"
parameters:
retention_time: 60
resource_metadata: last</programlisting>
<para>To aggregate each 15 samples by <parameter>user_id</parameter> and <parameter>resource_metadata
</parameter> and keep the <parameter>user_id</parameter> of the first received sample and
drop the <parameter>resource_metadata</parameter>:</para>
<para>To aggregate each 15 samples by <option>user_id</option> and <option>resource_metadata
</option> and keep the <option>user_id</option> of the first received sample and
drop the <option>resource_metadata</option>:</para>
<programlisting>transformers:
- name: "aggregator"
parameters:
@ -782,7 +782,7 @@ sinks:
</note>
<para>Multiple <systemitem class="service">ceilometer-collector</systemitem> process can be
run at a time. It is also supported to start multiple worker threads per collector process.
The <parameter>collector_workers</parameter> configuration option has to be modified in the
The <option>collector_workers</option> configuration option has to be modified in the
<link xlink:href=
"http://docs.openstack.org/juno/config-reference/content/ch_configuring-openstack-telemetry.html">
collector section</link> of the <filename>ceilometer.conf</filename>
@ -794,7 +794,7 @@ sinks:
<simplesect>
<title>Database dispatcher</title>
<para>When the database dispatcher is configured as data store, you have the option to set
a <parameter>time_to_live</parameter> parameter (ttl) for samples. By default the time to
a <option>time_to_live</option> parameter (ttl) for samples. By default the time to
live value for samples is set to -1, which means that they are kept in the database forever.
</para>
<para>The time to live value is specified in seconds. Each sample has a time stamp, and the

36
doc/admin-guide-cloud/telemetry/section_telemetry-data-retrieval.xml
View File

@ -47,16 +47,16 @@
following items:
<itemizedlist>
<listitem>
<para><parameter>field</parameter></para>
<para><literal>field</literal></para>
</listitem>
<listitem>
<para><parameter>op</parameter></para>
<para><literal>op</literal></para>
</listitem>
<listitem>
<para><parameter>value</parameter></para>
<para><literal>value</literal></para>
</listitem>
<listitem>
<para><parameter>type</parameter></para>
<para><literal>type</literal></para>
</listitem>
</itemizedlist></para>
<para>Regardless of the endpoint on which the filter is applied on, it will
@ -134,16 +134,16 @@
operation.</para>
</note>
<para>Complex query supports specifying a list of
<parameter>orderby</parameter> expressions. This means that the result
<literal>orderby</literal> expressions. This means that the result
of the query can be ordered based on the field names provided in this
list. When multiple keys are defined for the ordering, these will be applied
sequentially in the order of the specification. The second expression will
be applied on the groups for which the values of the first expression
are the same. The ordering can be ascending or descending.</para>
<para>The number of returned items can be bounded using the
<parameter>limit</parameter> option.</para>
<para>The <parameter>filter</parameter>, <parameter>orderby</parameter>
and <parameter>limit</parameter> fields are optional.</para>
<option>limit</option> option.</para>
<para>The <literal>filter</literal>, <literal>orderby</literal>
and <literal>limit</literal> fields are optional.</para>
<note>
<para>As opposed to the simple query, complex query is available via
a separate API endpoint. For more information see the
@ -188,7 +188,7 @@
</itemizedlist>
</para>
<note>
<para>The <parameter>aggregate.param</parameter> parameter is
<para>The <option>aggregate.param</option> parameter is
required.</para>
</note>
</listitem>
@ -247,7 +247,7 @@
</note>
<para>Similarly to other OpenStack command line clients, the <command>ceilometer</command>
client uses OpenStack Identity for authentication. The proper credentials and
<parameter>auth_url</parameter> parameter have to be defined via command line
<parameter>--auth_url</parameter> parameter have to be defined via command line
parameters or environment variables.</para>
<para>This section provides some examples without the aim of completeness. These commands
can be used for instance for validating an installation of Telemetry.</para>
@ -277,7 +277,7 @@
in an ascending order based on the name of the meter.</para>
<para>Samples are collected for each meter that is present in the list of meters,
except in case of instances that are not running or deleted from the OpenStack Compute
database. If an instance is no more existing and there is <parameter>time_to_live</parameter>
database. If an instance is no more existing and there is <option>time_to_live</option>
value is set in the <filename>ceilometer.conf</filename> configuration file, then a
group of samples are deleted in each expiration cycle. When the last sample is
deleted for a meter, the database can be cleaned up by running
@ -362,7 +362,7 @@
<varlistentry>
<term><parameter>--orderby</parameter></term>
<listitem>
<para>Contains the list of <parameter>orderby</parameter> expressions
<para>Contains the list of <literal>orderby</literal> expressions
in the form of:
<literal>[{field_name: direction}, {field_name: direction}]</literal>.</para>
</listitem>
@ -403,7 +403,7 @@
instance with the proper credentials:
<programlisting>&gt;&gt;&gt; import ceilometerclient.client
&gt;&gt;&gt; cclient = ceilometerclient.client.get_client(<replaceable>VERSION</replaceable>, username=<replaceable>USERNAME</replaceable>, password=<replaceable>PASSWORD</replaceable>, tenant_name=<replaceable>PROJECT_NAME</replaceable>, auth_url=<replaceable>AUTH_URL</replaceable>)</programlisting>
The <parameter>VERSION</parameter> parameter can be <literal>1</literal> or
The <literal>VERSION</literal> parameter can be <literal>1</literal> or
<literal>2</literal>, specifying the API version to be used.</para>
<para>The method calls look like the following:
<programlisting>&gt;&gt;&gt; cclient.meters.list()
@ -483,7 +483,7 @@
<literal>notifier</literal>:
<variablelist>
<varlistentry>
<term><parameter>per_meter_topic</parameter></term>
<term><option>per_meter_topic</option></term>
<listitem>
<para>The value of it is 1. It is used for publishing the samples on
additional <literal>metering_topic.sample_name</literal> topic queue
@ -491,7 +491,7 @@
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>policy</parameter></term>
<term><option>policy</option></term>
<listitem>
<para>It is used for configuring the behavior for the case, when the
publisher fails to send the samples, where the possible predefined
@ -514,7 +514,7 @@
<listitem>
<para>Used for creating an in-memory queue and retrying to send the samples
on the queue on the next samples publishing period (the queue length
can be configured with <parameter>max_queue_length</parameter>, where
can be configured with <option>max_queue_length</option>, where
1024 is the default value).</para>
</listitem>
</varlistentry>
@ -525,7 +525,7 @@
<para>The following options are available for the <literal>file</literal> publisher:
<variablelist>
<varlistentry>
<term><parameter>max_bytes</parameter></term>
<term><option>max_bytes</option></term>
<listitem>
<para>When this option is greater than zero, it will cause a rollover. When the
size is about to be exceeded, the file is closed and a new file is silently
@ -533,7 +533,7 @@
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>backup_count</parameter></term>
<term><option>backup_count</option></term>
<listitem>
<para>If this value is non-zero, an extension will be appended to the filename
of the old log, as '.1', '.2', and so forth until the specified value is reached.

2
doc/admin-guide-cloud/telemetry/section_telemetry-troubleshooting-guide.xml
View File

@ -76,7 +76,7 @@
Python API</link> reference of Telemetry.</para>
<para>The service catalog provided by OpenStack Identity contains the
available URLs that are available for authentication.
The URLs contain different <parameter>port</parameter>s, based on
The URLs contain different <literal>port</literal>s, based on
that the type of the given URL is <literal>public</literal>,
<literal>internal</literal> or <literal>admin</literal>.</para>
<para>OpenStack Identity is about to change API version from v2 to v3.

2
doc/common/section_cli_cinder_manage_volumes.xml
View File

@ -287,7 +287,7 @@
parameter.</para>
</note>
<note>
<para>While the <parameter>auth_key</parameter> property is
<para>While the <literal>auth_key</literal> property is
visible in the output of
<command>cinder transfer-create <replaceable>VOLUME_ID</replaceable></command>,
it will not be available in subsequent

10
doc/common/section_cli_nova_customize_flavors.xml
View File

@ -134,7 +134,7 @@
and a quota for maximum allowed bandwidth:</para>
<itemizedlist>
<listitem>
<para><parameter>cpu_shares</parameter>. Specifies the proportional weighted share
<para><option>cpu_shares</option>. Specifies the proportional weighted share
for the domain. If this element is
omitted, the service defaults to the OS
provided defaults. There is no unit for
@ -145,7 +145,7 @@
value 1024.</para>
</listitem>
<listitem>
<para><parameter>cpu_period</parameter>. Specifies the enforcement interval (unit:
<para><option>cpu_period</option>. Specifies the enforcement interval (unit:
microseconds) for QEMU and LXC
hypervisors. Within a period, each VCPU of
the domain is not allowed to consume more
@ -155,17 +155,17 @@
value 0 means no value.</para>
</listitem>
<listitem>
<para><parameter>cpu_limit</parameter>. Specifies the upper limit for VMware machine CPU allocation in MHz.
<para><option>cpu_limit</option>. Specifies the upper limit for VMware machine CPU allocation in MHz.
This parameter ensures that a machine never uses more than the defined amount of CPU time. It can be used to enforce a limit on the machine's CPU performance.
</para>
</listitem>
<listitem>
<para><parameter>cpu_reservation</parameter>. Specifies the guaranteed minimum CPU reservation in MHz for VMware.
<para><option>cpu_reservation</option>. Specifies the guaranteed minimum CPU reservation in MHz for VMware.
This means that if needed, the machine will definitely get allocated the reserved amount of CPU cycles.
</para>
</listitem>
<listitem>
<para><parameter>cpu_quota</parameter>. Specifies the maximum allowed bandwidth
<para><option>cpu_quota</option>. Specifies the maximum allowed bandwidth
(unit: microseconds). A domain with a
negative-value quota indicates that the
domain has infinite bandwidth, which means

2
doc/common/section_cli_nova_manage_images.xml
View File

@ -150,7 +150,7 @@
name or ID of a source instance, and the name of the resulting
back-up image, it requires the <literal>backup-type</literal>
argument with the possible values <literal>daily</literal> or
<literal>weekly</literal>, and the <parameter>rotation</parameter>
<literal>weekly</literal>, and the <literal>rotation</literal>
argument. The rotation number is an integer standing for the number
of back-up images (associated with a single instance) to keep
around. If this number exceeds the rotation threshold, the excess

4
doc/common/section_keystone-keyring-support.xml
View File

@ -11,7 +11,7 @@
<note>
<para>Keyring is used only if <parameter>--os-use-keyring</parameter>
is specified or if the environment variable
<parameter>OS_USE_KEYRING=true</parameter> is defined.</para>
<option>OS_USE_KEYRING=true</option> is defined.</para>
</note>
<para>A user specifies their username and password credentials to interact
with OpenStack, using any client command. These credentials can be specified
@ -19,7 +19,7 @@
It is not safe to specify the password using either of these methods.</para>
<para>For example, when you specify your password using the command-line client
with the <parameter>--os-password</parameter> argument, anyone with access
to your computer can view it in plain text with the <parameter>ps</parameter>
to your computer can view it in plain text with the <literal>ps</literal>
field.</para>
<para>To avoid storing the password in plain text, you can prompt for the
OpenStack password interactively. Then, the keyring can store the password

6
doc/common/section_keystone_config_ldap-hardening.xml
View File

@ -51,21 +51,21 @@
<literal>allow</literal>, or <literal>never</literal>:
</para>
<itemizedlist>
<listitem><para><parameter>demand</parameter>: a
<listitem><para><literal>demand</literal>: a
certificate will always be requested from the LDAP server.
The session will be terminated if no certificate is
provided, or if the certificate provided cannot be
verified against the existing certificate authorities
file.
</para></listitem>
<listitem><para><parameter>allow</parameter>: a
<listitem><para><literal>allow</literal>: a
certificate will always be requested from the LDAP server.
The session will proceed as normal even if a certificate
is not provided. If a certificate is provided but it
cannot be verified against the existing certificate
authorities file, the certificate will be ignored and the
session will proceed as normal.</para></listitem>
<listitem><para><parameter>never</parameter>: a
<listitem><para><literal>never</literal>: a
certificate will never be requested.</para></listitem>
</itemizedlist>
</step>

8
doc/config-reference/block-storage/drivers/dell-equallogic-driver.xml
View File

@ -73,14 +73,14 @@ ssh_max_pool_conn = 5</programlisting>
<term>SAN_UNAME</term>
<listitem>
<para>The user name to login to the Group manager via SSH at
the <parameter>san_ip</parameter>. Default user name is <literal>grpadmin</literal>.</para>
the <literal>san_ip</literal>. Default user name is <literal>grpadmin</literal>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>SAN_PW</term>
<listitem>
<para>The corresponding password of <replaceable>SAN_UNAME</replaceable>.
Not used when <parameter>san_private_key</parameter> is set. Default
Not used when <literal>san_private_key</literal> is set. Default
password is <literal>password</literal>.</para>
</listitem>
</varlistentry>
@ -104,7 +104,7 @@ ssh_max_pool_conn = 5</programlisting>
<term>EQLX_UNAME</term>
<listitem>
<para>The CHAP login account for each
volume in a pool, if <parameter>eqlx_use_chap</parameter> is set
volume in a pool, if <literal>eqlx_use_chap</literal> is set
to <literal>true</literal>. Default account name is <literal>chapadmin</literal>.</para>
</listitem>
</varlistentry>
@ -121,7 +121,7 @@ ssh_max_pool_conn = 5</programlisting>
<listitem>
<para>The filename of the private key used
for SSH authentication. This provides password-less login to the
EqualLogic Group. Not used when <parameter>san_password</parameter>
EqualLogic Group. Not used when <literal>san_password</literal>
is set. There is no default value.</para>
</listitem>
</varlistentry>

30
doc/config-reference/block-storage/drivers/hp-lefthand-driver.xml
View File

@ -158,43 +158,43 @@
set for a volume type, the following defaults are used:</para>
<variablelist>
<varlistentry><term>hplh:provisioning</term>
<listitem><para>Defaults to <parameter>thin</parameter> provisioning, the valid values are,
<parameter>thin</parameter>
<listitem><para>Defaults to <literal>thin</literal> provisioning, the valid values are,
<literal>thin</literal>
and
<parameter>full</parameter></para></listitem>
<literal>full</literal></para></listitem>
</varlistentry>
<varlistentry><term>hplh:ao</term>
<listitem><para>Defaults to <parameter>true</parameter>, the valid values are,
<parameter>true</parameter>
<listitem><para>Defaults to <literal>true</literal>, the valid values are,
<literal>true</literal>
and
<parameter>false</parameter>.</para></listitem>
<literal>false</literal>.</para></listitem>
</varlistentry>
<varlistentry><term>hplh:data_pl</term>
<listitem><para>Defaults to
<parameter>r-0</parameter>,
<literal>r-0</literal>,
Network RAID-0 (None), the valid values are,</para>
<para>
<parameter>r-0</parameter>,
<literal>r-0</literal>,
Network RAID-0 (None)
</para>
<para>
<parameter>r-5</parameter>,
<literal>r-5</literal>,
Network RAID-5 (Single Parity)
</para>
<para>
<parameter>r-10-2</parameter>,
<literal>r-10-2</literal>,
Network RAID-10 (2-Way Mirror)
</para>
<para>
<parameter>r-10-3</parameter>,
<literal>r-10-3</literal>,
Network RAID-10 (3-Way Mirror)
</para>
<para>
<parameter>r-10-4</parameter>,
<literal>r-10-4</literal>,
Network RAID-10 (4-Way Mirror)
</para>
<para>
<parameter>r-6</parameter>,
<literal>r-6</literal>,
Network RAID-6 (Dual Parity),
</para>
</listitem>
@ -413,9 +413,9 @@ san_is_local=False
Add server associations on the VSA with the associated
CHAPS and initiator information. The name should
correspond to the
<parameter>hostname</parameter>
<literal>hostname</literal>
of the
<parameter>nova-compute</parameter>
<literal>nova-compute</literal>
node. For Xen, this is the hypervisor host name. To do
this, use either CLIQ or the Centralized Management
Console.

2
doc/config-reference/block-storage/drivers/vmware-vmdk-driver.xml
View File

@ -198,7 +198,7 @@
</step>
<step>
<para>Optionally, for the
<parameter>vmware_host_version</parameter>
<option>vmware_host_version</option>
parameter, enter the version number of your
vSphere platform. For example,
<userinput>5.5</userinput>.</para>

2
doc/config-reference/compute/section_compute-scheduler.xml
View File

@ -27,7 +27,7 @@ scheduler_driver_task_period = 60
scheduler_driver = nova.scheduler.filter_scheduler.FilterScheduler
scheduler_available_filters = nova.scheduler.filters.all_filters
scheduler_default_filters = RetryFilter, AvailabilityZoneFilter, RamFilter, ComputeFilter, ComputeCapabilitiesFilter, ImagePropertiesFilter, ServerGroupAntiAffinityFilter, ServerGroupAffinityFilter</programlisting>
<para>By default, the <parameter>scheduler_driver</parameter> is
<para>By default, the <option>scheduler_driver</option> is
configured as a filter scheduler, as described in the next
section. In the default configuration, this scheduler
considers hosts that meet all the following criteria:</para>

12
doc/config-reference/compute/section_hypervisor_vmware.xml
View File

@ -747,7 +747,7 @@ trusty-server-cloudimg-amd64-disk1.vmdk</userinput></screen>
IDE controller. Therefore, as the previous examples show, it
is important to set the <option>vmware_adaptertype</option>
property correctly. The default adapter type is lsiLogic, which
is SCSI, so you can omit the <parameter>vmware_adaptertype</parameter>
is SCSI, so you can omit the <option>vmware_adaptertype</option>
property if you are certain that the image adapter type is
lsiLogic.</para>
</section>
@ -855,7 +855,7 @@ trusty-server-cloudimg-amd64-disk1.vmdk</userinput></screen>
<para>If multiple compute nodes are running on the same host,
or have a shared file system, you can enable them to use the
same cache folder on the back-end data store. To configure
this action, set the <parameter>cache_prefix</parameter> option
this action, set the <option>cache_prefix</option> option
in the <filename>nova.conf</filename> file. Its value stands for
the name prefix of the folder where cached images are stored.</para>
<note><para>This can take effect only if compute nodes are running
@ -865,15 +865,15 @@ trusty-server-cloudimg-amd64-disk1.vmdk</userinput></screen>
options in the <literal>DEFAULT</literal> section in the
<filename>nova.conf</filename> file:</para>
<variablelist><varlistentry>
<term><parameter>remove_unused_base_images</parameter></term>
<term><option>remove_unused_base_images</option></term>
<listitem>
<para>Set this parameter to <userinput>True</userinput> to
<para>Set this option to <userinput>True</userinput> to
specify that unused images should be removed after the
duration specified in the <parameter>remove_unused_original_minimum_age_seconds</parameter> parameter.
duration specified in the <option>remove_unused_original_minimum_age_seconds</option> option.
The default is <userinput>True</userinput>.</para></listitem>
</varlistentry>
<varlistentry>
<term><parameter>remove_unused_original_minimum_age_seconds</parameter></term>
<term><option>remove_unused_original_minimum_age_seconds</option></term>
<listitem><para>Specifies the duration in seconds after which an unused
image is purged from the cache. The default is
<userinput>86400</userinput> (24 hours).</para></listitem>

16
doc/config-reference/image-service/section_image-service-backend-vmware.xml
View File

@ -31,7 +31,7 @@
back end, use the SPBM feature.</para>
</note></para>
<para>In the <literal>glance_store</literal> section, set the
<parameter>default_store</parameter> parameter to
<option>default_store</option> parameter to
<userinput>vsphere</userinput>, as shown in this code
sample:</para>
<programlisting language="ini">[glance_store]
@ -90,7 +90,7 @@ vmware_api_insecure = <replaceable>False</replaceable></programlisting>
<section xml:id="glance-backend-DS">
<title>Configure vCenter data stores for the back end</title>
<para>You can specify a vCenter data store for the back end by
setting the <parameter>vmware_datastore_name</parameter>
setting the <option>vmware_datastore_name</option>
parameter value to the vCenter name of the data store.
This configuration limits the back end to a single data
store.</para>
@ -104,13 +104,13 @@ vmware_api_insecure = <replaceable>False</replaceable></programlisting>
<title>To configure a single data store</title>
<step>
<para>If present, comment or delete the
<parameter>vmware_pbm_wsdl_location</parameter>
and <parameter>vmware_pbm_policy</parameter>
<option>vmware_pbm_wsdl_location</option>
and <option>vmware_pbm_policy</option>
parameters.</para>
</step>
<step>
<para>Uncomment and define the
<parameter>vmware_datastore_name</parameter>
<option>vmware_datastore_name</option>
parameter with the name of the vCenter data
store.</para>
</step>
@ -157,19 +157,19 @@ vmware_api_insecure = <replaceable>False</replaceable></programlisting>
</step>
<step>
<para>Comment or delete the
<parameter>vmware_datastore_name</parameter>
<option>vmware_datastore_name</option>
parameter.</para>
</step>
<step>
<para>Uncomment and define the
<parameter>vmware_pbm_policy</parameter>
<option>vmware_pbm_policy</option>
parameter by entering the same value as the tag
you defined and applied to the data stores in
vCenter.</para>
</step>
<step>
<para>Uncomment and define the
<parameter>vmware_pbm_wsdl_location</parameter>
<option>vmware_pbm_wsdl_location</option>
parameter by entering the location of the PBM
service WSDL file. For example,
<filename>file:///opt/SDK/spbm/wsdl/pbmService.wsdl</filename>.</para>

6
doc/config-reference/object-storage/section_object-storage-features.xml
View File

@ -503,16 +503,16 @@ Sample represents 1.00% of the object partition space
</section>
<section xml:id="object-storage-account-quotas">
<title>Account quotas</title>
<para>The <parameter>x-account-meta-quota-bytes</parameter>
<para>The <literal>x-account-meta-quota-bytes</literal>
metadata entry must be requests (PUT, POST) if a given
account quota (in bytes) is exceeded while DELETE requests
are still allowed.</para>
<para>The <parameter>x-account-meta-quota-bytes</parameter>
<para>The <literal>x-account-meta-quota-bytes</literal>
metadata entry must be
set to store and enable the quota. Write requests to this
metadata entry are only permitted for resellers. There is
no account quota limitation on a reseller account even if
<parameter>x-account-meta-quota-bytes</parameter> is set.
<literal>x-account-meta-quota-bytes</literal> is set.
</para>
<para>Any object PUT operations that exceed the quota return a
413 response (request entity too large) with a descriptive

2
doc/networking-guide/section_networking_adv_agent.xml
View File

@ -14,7 +14,7 @@
<para>The neutron configuration file contains the common neutron configuration options.</para>
<para>The plug-in configuration file contains the plug-in specific options.</para>
<para>The plug-in that runs on the service is loaded through the
<parameter>core_plugin</parameter> configuration option. In some cases, a plug-in
<option>core_plugin</option> configuration option. In some cases, a plug-in
might have an agent that performs the actual networking.</para>
<para>Most plug-ins require an SQL database. After you install and start the database
server, set a password for the root account and delete the anonymous accounts:</para>

2
doc/networking-guide/section_networking_adv_features.xml
View File

@ -1461,7 +1461,7 @@
<option>state_sync_interval</option> configuration option to a non-zero
value exclusively on a node designated for back-end status
synchronization.</para>
<para>The <parameter>fields=status</parameter> parameter in Networking API requests
<para>The <literal>fields=status</literal> parameter in Networking API requests
always triggers an explicit query to the NSX back end, even when you enable
asynchronous state synchronization. For example, <code>GET
/v2.0/networks/<replaceable>NET_ID</replaceable>?fields=status&amp;fields=name</code>.</para>

4
doc/user-guide/section_object-api-archive-auto-extract.xml
View File

@ -16,7 +16,7 @@
<section xml:id="archive-auto-extract-put">
<title>Auto-extract archive request</title>
<para>To upload an archive file, make a &PUT; request. Add the
<parameter>extract-archive=<replaceable>format</replaceable></parameter>
<literal>extract-archive=<replaceable>format</replaceable></literal>
query parameter to indicate that you are uploading a tar
archive file instead of normal content.</para>
<para>Valid values for the <replaceable>format</replaceable>
@ -70,7 +70,7 @@
<para>The POSIX.1-2001 pax format.</para>
<para>Use gzip or bzip2 to compress the
archive.</para>
<para>Use the <parameter>extract-archive</parameter>
<para>Use the <literal>extract-archive</literal>
query parameter to specify the format. Valid
values for this parameter are
<literal>tar</literal>,

2
doc/user-guide/section_object-api-bulk-delete.xml
View File

@ -14,7 +14,7 @@
<section xml:id="bulk-delete-request">
<title>Bulk delete request</title>
<para>To perform a bulk delete operation, add the
<parameter>bulk-delete</parameter> query parameter to
<literal>bulk-delete</literal> query parameter to
the path of a &POST; or &DELETE; operation.</para>
<note>
<para>The &DELETE; operation is supported for backwards

12
doc/user-guide/section_object-api-create-large-objects.xml
View File

@ -95,7 +95,7 @@
<para>List the name of each segment object along with its size
and MD5 checksum in order.</para>
<para>Create a manifest object. Include the
<parameter>?multipart-manifest=put</parameter> query
<literal>?multipart-manifest=put</literal> query
string at the end of the manifest object name to indicate
that this is a manifest object.</para>
<para>The body of the &PUT; request on the manifest object
@ -150,7 +150,7 @@
You can also set the <literal>Content-Type</literal>
request header and custom object metadata.</para>
<para>When the &PUT; operation sees the
<parameter>?multipart-manifest=put</parameter> query
<literal>?multipart-manifest=put</literal> query
parameter, it reads the request body and verifies that
each segment object exists and that the sizes and ETags
match. If there is a mismatch, the &PUT;operation
@ -163,19 +163,19 @@
manifest object, the response body contains the
concatenated content of the segment objects. To download
the manifest list, use the
<parameter>?multipart-manifest=get</parameter> query
<literal>?multipart-manifest=get</literal> query
parameter. The resulting list is not formatted the same as
the manifest you originally used in the &PUT;
operation.</para>
<para>If you use the &DELETE; operation on a manifest object,
the manifest object is deleted. The segment objects are
not affected. However, if you add the
<parameter>?multipart-manifest=delete</parameter>
<literal>?multipart-manifest=delete</literal>
query parameter, the segment objects are deleted and if
all are successfully deleted, the manifest object is also
deleted.</para>
<para>To change the manifest, use a &PUT; operation with the
<parameter>?multipart-manifest=put</parameter> query
<literal>?multipart-manifest=put</literal> query
parameter. This request creates a manifest object. You can
also update the object metadata in the usual way.</para>
</section>
@ -356,7 +356,7 @@
<tr>
<th>Copying the manifest object</th>
<td><para>Include the
<parameter>?multipart-manifest=get</parameter>
<literal>?multipart-manifest=get</literal>
query string in the &COPY; request. The
new object contains the same manifest as
the original. The segment objects are not

42
doc/user-guide/section_object-api-large-lists.xml
View File

@ -6,50 +6,50 @@
xml:id="large-lists">
<title>Page through large lists of containers or objects</title>
<para>If you have a large number of containers or objects, you can
use the <parameter>marker</parameter>,
<parameter>limit</parameter>, and
<parameter>end_marker</parameter> parameters to control
use the <literal>marker</literal>,
<literal>limit</literal>, and
<literal>end_marker</literal> parameters to control
how many items are returned in a list and where the list
starts or ends.</para>
<variablelist>
<varlistentry>
<term><parameter>marker</parameter></term>
<term><literal>marker</literal></term>
<listitem>
<para>When you request a list of containers or
objects, Object Storage returns a maximum of
10,000 names for each request. To get subsequent
names, you must make another request with the
<parameter>marker</parameter> parameter. Set
<literal>marker</literal> parameter. Set
the <literal>marker</literal> parameter to the
name of the last item returned in the previous
list. You must URL-encode the
<parameter>marker</parameter> value before you
<literal>marker</literal> value before you
send the HTTP request. Object Storage returns a
maximum of 10,000 names starting after the last
item returned.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>limit</parameter></term>
<term><literal>limit</literal></term>
<listitem>
<para>To return fewer than 10,000 names, use the
<parameter>limit</parameter> parameter. If the
<literal>limit</literal> parameter. If the
number of names returned equals the specified
<parameter>limit</parameter> (or 10,000 if you
omit the <parameter>limit</parameter> parameter),
<literal>limit</literal> (or 10,000 if you
omit the <literal>limit</literal> parameter),
you can assume there are more names to list. If
the number of names in the list is exactly
divisible by the <parameter>limit</parameter>
divisible by the <literal>limit</literal>
value, the last request has no content.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>end_marker</parameter></term>
<term><literal>end_marker</literal></term>
<listitem>
<para>Limits the result set to names that are less
than the <parameter>end_marker</parameter>
than the <literal>end_marker</literal>
parameter value. You must URL-encode the
<parameter>end_marker</parameter> value before
<literal>end_marker</literal> value before
you send the HTTP request.</para>
</listitem>
</varlistentry>
@ -63,7 +63,7 @@ kiwis
oranges
pears</literallayout>
<step>
<para>Use a <parameter>limit</parameter> of two:</para>
<para>Use a <literal>limit</literal> of two:</para>
<screen><userinput># curl -i $publicURL/?limit=2 -X GET -H "X-Auth-Token: $token"</userinput></screen>
<screen><computeroutput>apples
bananas</computeroutput></screen>
@ -72,7 +72,7 @@ bananas</computeroutput></screen>
</step>
<step>
<para>Make another request with a
<parameter>marker</parameter> parameter set to the
<literal>marker</literal> parameter set to the
name of the last item returned:</para>
<screen><userinput># curl -i $publicURL/?limit=2&amp;amp;marker=bananas -X GET -H "X-Auth-Token: $token"</userinput></screen>
<screen><computeroutput>kiwis
@ -82,25 +82,25 @@ oranges</computeroutput></screen>
</step>
<step>
<para>Make another request with a
<parameter>marker</parameter> of the last item
<literal>marker</literal> of the last item
returned:</para>
<screen><userinput># curl -i $publicURL/?limit=2&amp;amp;marker=oranges -X GET -H "X-Auth-Token: $token"</userinput></screen>
<screen><computeroutput>pears</computeroutput></screen>
<para>You receive a one-item response, which is fewer than
the <parameter>limit</parameter> number of names. This
the <literal>limit</literal> number of names. This
indicates that this is the end of the list.</para>
</step>
<step>
<para>Use the <parameter>end_marker</parameter> parameter
<para>Use the <literal>end_marker</literal> parameter
to limit the result set to object names that are less
than the <parameter>end_marker</parameter> parameter
than the <literal>end_marker</literal> parameter
value:</para>
<screen><userinput># curl -i $publicURL/?end_marker=oranges -X GET -H "X-Auth-Token: $token"</userinput></screen>
<screen><computeroutput>apples
bananas
kiwis</computeroutput></screen>
<para>You receive a result set of all container names
before the <parameter>end-marker</parameter>
before the <literal>end-marker</literal>
value.</para>
</step>
</procedure>

4
doc/user-guide/section_object-api-response-formats.xml
View File

@ -75,7 +75,7 @@
<example>
<title>JSON example with format query parameter</title>
<para>For example, this request uses the
<parameter>format</parameter> query parameter to ask
<literal>format</literal> query parameter to ask
for a JSON response:</para>
<screen><prompt>$</prompt> <userinput>curl -i $publicURL?format=json -X GET -H "X-Auth-Token: $token"</userinput></screen>
<screen><computeroutput>HTTP/1.1 200 OK
@ -138,7 +138,7 @@ Date: Wed, 22 Jan 2014 21:12:00 GMT</computeroutput></screen>
<para>The remainder of the examples in this guide use
standard, non-serialized responses. However, all &GET;
requests that perform list operations accept the
<parameter>format</parameter> query parameter or
<literal>format</literal> query parameter or
<literal>Accept</literal> request header.</para>
</example>
</section>