openstack/openstack-manuals
Code Issues Proposed changes

Fix whitespace

Browse Source 
Fix issues noted by validate.py

Change-Id: I788bc6173f153375245a982974ace5b59af49219
This commit is contained in:
Andreas Jaeger 2013-09-21 19:14:40 +02:00
parent 6f7eafebff
commit 5dd25f4d6e
10 changed files with 49 additions and 48 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
doc/admin-guide-cloud/ch_networking.xml
View File

@ -515,7 +515,7 @@
connectivity on behalf of tenants.</para> connectivity on behalf of tenants.</para>
</listitem> </listitem>
</itemizedlist></para> </itemizedlist></para>
<para> A tenant or cloud administrator can both perform the <para>A tenant or cloud administrator can both perform the
following procedures.</para> following procedures.</para>
<section xml:id="api_features"> <section xml:id="api_features">
<title>Core Networking API features</title> <title>Core Networking API features</title>
@ -620,7 +620,7 @@
<td>string</td> <td>string</td>
<td>None</td> <td>None</td>
<td>Human-readable name for this network; <td>Human-readable name for this network;
is not required to be unique. </td> is not required to be unique.</td>
</tr> </tr>
<tr> <tr>
<td><systemitem>shared</systemitem></td> <td><systemitem>shared</systemitem></td>
@ -630,7 +630,7 @@
resource can be accessed by any resource can be accessed by any
tenant. The default policy setting tenant. The default policy setting
restricts usage of this attribute to restricts usage of this attribute to
administrative users only. </td> administrative users only.</td>
</tr> </tr>
<tr> <tr>
<td><systemitem>status</systemitem></td> <td><systemitem>status</systemitem></td>
@ -644,7 +644,7 @@
<td>list(uuid-str)</td> <td>list(uuid-str)</td>
<td>Empty list</td> <td>Empty list</td>
<td>List of subnets associated with this <td>List of subnets associated with this
network. </td> network.</td>
</tr> </tr>
<tr> <tr>
<td><systemitem>tenant_id</systemitem></td> <td><systemitem>tenant_id</systemitem></td>
@ -680,7 +680,7 @@
<systemitem>cidr</systemitem>, <systemitem>cidr</systemitem>,
excluding excluding
<systemitem>gateway_ip</systemitem> <systemitem>gateway_ip</systemitem>
(if configured). </td> (if configured).</td>
<td><para>List of cidr sub-ranges that are <td><para>List of cidr sub-ranges that are
available for dynamic allocation to available for dynamic allocation to
ports. Syntax:</para> ports. Syntax:</para>
@ -743,7 +743,7 @@
<td>string</td> <td>string</td>
<td>None</td> <td>None</td>
<td>Human-readable name for this subnet <td>Human-readable name for this subnet
(might not be unique). </td> (might not be unique).</td>
</tr> </tr>
<tr> <tr>
<td><systemitem>network_id</systemitem></td> <td><systemitem>network_id</systemitem></td>
@ -759,7 +759,7 @@
<td>Owner of network. Only administrative <td>Owner of network. Only administrative
users can set the tenant identifier; users can set the tenant identifier;
this cannot be changed using this cannot be changed using
authorization policies. </td> authorization policies.</td>
</tr> </tr>
</tbody> </tbody>
</table> </table>
@ -784,7 +784,7 @@
<td>true</td> <td>true</td>
<td>Administrative state of this port. If <td>Administrative state of this port. If
specified as False (down), this port specified as False (down), this port
does not forward packets. </td> does not forward packets.</td>
</tr> </tr>
<tr> <tr>
<td><systemitem>device_id</systemitem></td> <td><systemitem>device_id</systemitem></td>
@ -827,21 +827,21 @@
<td>string</td> <td>string</td>
<td>None</td> <td>None</td>
<td>Human-readable name for this port <td>Human-readable name for this port
(might not be unique). </td> (might not be unique).</td>
</tr> </tr>
<tr> <tr>
<td><systemitem>network_id</systemitem></td> <td><systemitem>network_id</systemitem></td>
<td>uuid-string</td> <td>uuid-string</td>
<td>N/A</td> <td>N/A</td>
<td>Network with which this port is <td>Network with which this port is
associated. </td> associated.</td>
</tr> </tr>
<tr> <tr>
<td><systemitem>status</systemitem></td> <td><systemitem>status</systemitem></td>
<td>string</td> <td>string</td>
<td>N/A</td> <td>N/A</td>
<td>Indicates whether the network is <td>Indicates whether the network is
currently operational. </td> currently operational.</td>
</tr> </tr>
<tr> <tr>
<td><systemitem>tenant_id</systemitem></td> <td><systemitem>tenant_id</systemitem></td>
@ -1116,7 +1116,7 @@
tenant who submits the request tenant who submits the request
(without the (without the
<systemitem>--nic</systemitem> <systemitem>--nic</systemitem>
option). </td> option).</td>
<td><screen><prompt>$</prompt> <userinput>nova boot --image <replaceable>img</replaceable> --flavor <replaceable>flavor</replaceable> <replaceable>vm-name</replaceable></userinput></screen> <td><screen><prompt>$</prompt> <userinput>nova boot --image <replaceable>img</replaceable> --flavor <replaceable>flavor</replaceable> <replaceable>vm-name</replaceable></userinput></screen>
</td> </td>
</tr> </tr>
@ -1569,7 +1569,7 @@
<td>N/A</td> <td>N/A</td>
<td>Owner of the router. Only admin users <td>Owner of the router. Only admin users
can specify a tenant_id other than its can specify a tenant_id other than its
own. </td> own.</td>
</tr> </tr>
<tr> <tr>
<td>external_gateway_info</td> <td>external_gateway_info</td>
@ -2508,7 +2508,7 @@ default_notification_level = INFO
# Defined in rpc_notifier for rpc way, can be comma separated values. # Defined in rpc_notifier for rpc way, can be comma separated values.
# The actual topic names will be %s.%(default_notification_level)s # The actual topic names will be %s.%(default_notification_level)s
notification_topics = notifications </programlisting> notification_topics = notifications</programlisting>
</section> </section>
<section <section
xml:id="ch_adv_notification_cases_multi_rpc_topics"> xml:id="ch_adv_notification_cases_multi_rpc_topics">

4
doc/admin-guide-cloud/section_object-storage-admin.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?> <?xml version="1.0" encoding="UTF-8"?>
<section <section
xmlns="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xlink="http://www.w3.org/1999/xlink"
@ -14,4 +14,4 @@
<para>Refer to the <citetitle>OpenStack Configuration Reference</citetitle> <para>Refer to the <citetitle>OpenStack Configuration Reference</citetitle>
for a listing of all configuration options for OpenStack Object for a listing of all configuration options for OpenStack Object
Storage.</para> Storage.</para>
</section> </section>

4
doc/common/section_about-object-storage.xml
View File

@ -1,8 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?> <?xml version="1.0" encoding="UTF-8"?>
<section xmlns="http://docbook.org/ns/docbook" <section xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xlink="http://www.w3.org/1999/xlink"
version="5.0" version="5.0"
xml:id="ch_introduction-to-openstack-object-storage"> xml:id="ch_introduction-to-openstack-object-storage">
<title>Introduction to OpenStack Object Storage</title> <title>Introduction to OpenStack Object Storage</title>
<para>OpenStack Object Storage is a scalable object storage system - it is not a file system in the <para>OpenStack Object Storage is a scalable object storage system - it is not a file system in the

2
doc/common/section_baremetal.xml
View File

@ -17,7 +17,7 @@ xml:id="baremetal">
APIs and tools, such as Heat or salt-cloud. However, due to this unique APIs and tools, such as Heat or salt-cloud. However, due to this unique
situation, using the baremetal driver requires some additional situation, using the baremetal driver requires some additional
preparation of its environment, the details of which are beyond the preparation of its environment, the details of which are beyond the
scope of this guide. </para> scope of this guide.</para>
<note><para> <note><para>
Some OpenStack Compute features are not implemented by Some OpenStack Compute features are not implemented by
the baremetal hypervisor driver. See the <link the baremetal hypervisor driver. See the <link

4
doc/common/section_docker.xml
View File

@ -4,7 +4,7 @@ xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"
xml:id="docker"> xml:id="docker">
<title>Docker Driver</title> <title>Docker Driver</title>
<para> The Docker driver is a hypervisor driver for OpenStack Compute, <para>The Docker driver is a hypervisor driver for OpenStack Compute,
introduced with the Havana release. Docker is an open-source engine which introduced with the Havana release. Docker is an open-source engine which
automates the deployment of applications as highly portable, self-sufficient automates the deployment of applications as highly portable, self-sufficient
containers which are independent of hardware, language, framework, packaging containers which are independent of hardware, language, framework, packaging
@ -23,7 +23,7 @@ xml:id="docker">
sense that they are better for specific use cases. Compute's support for VMs sense that they are better for specific use cases. Compute's support for VMs
is currently advanced thanks to the variety of hypervisors running VMs. is currently advanced thanks to the variety of hypervisors running VMs.
However it's not the case for containers even though libvirt/LXC is a good However it's not the case for containers even though libvirt/LXC is a good
starting point. Docker aims to go the second level of integration. </para> starting point. Docker aims to go the second level of integration.</para>
<note><para> <note><para>
Some OpenStack Compute features are not implemented by Some OpenStack Compute features are not implemented by
the docker driver. See the <link the docker driver. See the <link

22
doc/config-reference/block-storage/drivers/ibm-gpfs-volume-driver.xml
View File

@ -12,14 +12,14 @@
<para>This driver enables the use of GPFS in a similar fashion as the NFS driver. With the <para>This driver enables the use of GPFS in a similar fashion as the NFS driver. With the
GPFS driver, instances do not actually access a storage device at the block level. GPFS driver, instances do not actually access a storage device at the block level.
Instead, volume backing files are created in a GPFS file system and mapped to instances, Instead, volume backing files are created in a GPFS file system and mapped to instances,
which emulate a block device. </para> which emulate a block device.</para>
<para> <para>
<note> <note>
<para>GPFS software must be installed and running on nodes where Cinder volume and <para>GPFS software must be installed and running on nodes where Cinder volume and
Nova compute services are running in the OpenStack environment. A GPFS file Nova compute services are running in the OpenStack environment. A GPFS file
system must also be created and mounted on these nodes before starting the system must also be created and mounted on these nodes before starting the
<literal>cinder-volume</literal> service. The details of these GPFS specific <literal>cinder-volume</literal> service. The details of these GPFS specific
steps are covered in GPFS Administration documentation. </para> steps are covered in GPFS Administration documentation.</para>
</note> </note>
</para> </para>
<para>Optionally, Glance can be configured to store images on a GPFS file system. When <para>Optionally, Glance can be configured to store images on a GPFS file system. When
@ -28,7 +28,7 @@
volumes using copy on write optimization strategy.</para> volumes using copy on write optimization strategy.</para>
</section> </section>
<section xml:id="GPFS-driver-options"> <section xml:id="GPFS-driver-options">
<title>Enabling the GPFS Driver </title> <title>Enabling the GPFS Driver</title>
<para>To use Cinder with the GPFS driver, first set the <literal>volume_driver</literal> in <para>To use Cinder with the GPFS driver, first set the <literal>volume_driver</literal> in
<filename>cinder.conf</filename>:</para> <filename>cinder.conf</filename>:</para>
<programlisting>volume_driver = cinder.volume.drivers.gpfs.GPFSDriver</programlisting> <programlisting>volume_driver = cinder.volume.drivers.gpfs.GPFSDriver</programlisting>
@ -36,11 +36,11 @@
driver.</para> driver.</para>
<xi:include href="../../../common/tables/cinder-gpfs_volume.xml"/> <xi:include href="../../../common/tables/cinder-gpfs_volume.xml"/>
<note> <note>
<para>The flag <literal>gpfs_images_share_mode</literal> is only valid if the Image service <para>The flag <literal>gpfs_images_share_mode</literal> is only valid if the Image service
is configured to use GPFS with <literal>gpfs_images_dir</literal> flag. Also note, is configured to use GPFS with <literal>gpfs_images_dir</literal> flag. Also note,
when the value of this flag is <literal>copy_on_write</literal>, the paths when the value of this flag is <literal>copy_on_write</literal>, the paths
specified by the flags <literal>gpfs_mount_point_base</literal> and specified by the flags <literal>gpfs_mount_point_base</literal> and
<literal>gpfs_images_dir</literal> must both reside in the same GPFS file system <literal>gpfs_images_dir</literal> must both reside in the same GPFS file system
and in the same GPFS fileset. and in the same GPFS fileset.
</para> </para>
</note> </note>
@ -105,7 +105,7 @@
<entry> <entry>
<para>Specify the allocation policy to be used for the volume file. Note <para>Specify the allocation policy to be used for the volume file. Note
that this option only works if "allow-write-affinity" is set for the that this option only works if "allow-write-affinity" is set for the
GPFS data pool. </para> GPFS data pool.</para>
</entry> </entry>
</row> </row>
<row> <row>
@ -113,7 +113,7 @@
<entry> <entry>
<para>Specify how many blocks are laid out sequentially in the volume <para>Specify how many blocks are laid out sequentially in the volume
file to behave like a single large block. This option only works if file to behave like a single large block. This option only works if
"allow-write-affinity" is set for the GPFS data pool. </para> "allow-write-affinity" is set for the GPFS data pool.</para>
</entry> </entry>
</row> </row>
<row> <row>
@ -142,7 +142,7 @@
<para>Volume snapshots are implemented using the GPFS file clone feature. Whenever a new <para>Volume snapshots are implemented using the GPFS file clone feature. Whenever a new
snapshot is created, the snapshot file is efficiently created as a read-only clone snapshot is created, the snapshot file is efficiently created as a read-only clone
parent of the volume, and the volume file uses copy on write optimization strategy parent of the volume, and the volume file uses copy on write optimization strategy
to minimize data movement. </para> to minimize data movement.</para>
<para>Similarly when a new volume is created from a snapshot or from an existing volume, <para>Similarly when a new volume is created from a snapshot or from an existing volume,
the same approach is taken. The same approach is also used when a new volume is the same approach is taken. The same approach is also used when a new volume is
created from a Glance image, if the source image is in raw format, and created from a Glance image, if the source image is in raw format, and

2
doc/user-guide-admin/section_dashboard_admin_manage_images.xml
View File

@ -140,7 +140,7 @@
<step> <step>
<para>In the <guilabel>Confirm Delete Image</guilabel> window, <para>In the <guilabel>Confirm Delete Image</guilabel> window,
click <guibutton>Delete Images</guibutton> to confirm the click <guibutton>Delete Images</guibutton> to confirm the
deletion. </para> deletion.</para>
<para>You cannot undo this action.</para> <para>You cannot undo this action.</para>
</step> </step>
</procedure> </procedure>

2
doc/user-guide-admin/section_dashboard_admin_manage_volumes.xml
View File

@ -23,7 +23,7 @@
Guide</citetitle></link>.</para> Guide</citetitle></link>.</para>
<para>As an administrative user, you can manage volumes and volume <para>As an administrative user, you can manage volumes and volume
types for users in various projects. You can create and delete types for users in various projects. You can create and delete
volumes types, and you can view and delete volumes. </para> volumes types, and you can view and delete volumes.</para>
<section xml:id="dashboard_create_volume_types"> <section xml:id="dashboard_create_volume_types">
<title>Create a volume type</title> <title>Create a volume type</title>
<procedure> <procedure>

2
doc/user-guide-admin/section_nova_specify_host.xml
View File

@ -16,7 +16,7 @@
within <filename>policy.json</filename> on the desired roles. By default, only the admin within <filename>policy.json</filename> on the desired roles. By default, only the admin
role has this setting enabled.</para> role has this setting enabled.</para>
<para>You can view the list of valid compute hosts by using the <command>nova <para>You can view the list of valid compute hosts by using the <command>nova
hypervisor-list </command>command, for hypervisor-list</command> command, for
example:<screen><prompt>$</prompt> <userinput>nova hypervisor-list</userinput> example:<screen><prompt>$</prompt> <userinput>nova hypervisor-list</userinput>
<computeroutput>+----+---------------------+ <computeroutput>+----+---------------------+
| ID | Hypervisor hostname | | ID | Hypervisor hostname |

27
doc/user-guide-admin/section_swift_cli_analyze_log_files.xml
View File

@ -5,8 +5,8 @@
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"
xml:id="analyzing-log-files-with-swift-cli"> xml:id="analyzing-log-files-with-swift-cli">
<title>Analyze log files</title> <title>Analyze log files</title>
<para>Use the swift command-line client to analyze log files. </para> <para>Use the swift command-line client to analyze log files.</para>
<para>The swift client is simple to use, scalable, and flexible. </para><para>Use the swift client <option>-o</option> or <para>The swift client is simple to use, scalable, and flexible.</para><para>Use the swift client <option>-o</option> or
<option>-output</option> option to get short answers to <option>-output</option> option to get short answers to
questions about logs,</para> questions about logs,</para>
<para>You can use the <option>-o —output</option> option with a <para>You can use the <option>-o —output</option> option with a
@ -14,7 +14,7 @@
specific file or to STDOUT (<literal>-</literal>). The ability specific file or to STDOUT (<literal>-</literal>). The ability
to redirect the output to STDOUT enables you to pipe to redirect the output to STDOUT enables you to pipe
(<literal>|</literal>) data without saving it to disk (<literal>|</literal>) data without saving it to disk
first. </para> first.</para>
<section xml:id="swift_file_analysis"><title>Upload and analyze log files</title><procedure> <section xml:id="swift_file_analysis"><title>Upload and analyze log files</title><procedure>
<step> <step>
<para>This example assumes that <para>This example assumes that
@ -27,7 +27,7 @@
<para>Each file uses the following line format:</para> <para>Each file uses the following line format:</para>
<example><title>Log line format</title><screen><computeroutput>Nov 15 21:53:52 lucid64 proxy-server - 127.0.0.1 15/Nov/2010/22/53/52 DELETE /v1/AUTH_cd4f57824deb4248a533f2c28bf156d3/2eefc05599d44df38a7f18b0b42ffedd HTTP/1.0 204 - \ <example><title>Log line format</title><screen><computeroutput>Nov 15 21:53:52 lucid64 proxy-server - 127.0.0.1 15/Nov/2010/22/53/52 DELETE /v1/AUTH_cd4f57824deb4248a533f2c28bf156d3/2eefc05599d44df38a7f18b0b42ffedd HTTP/1.0 204 - \
- test%3Atester%2CAUTH_tkcdab3c6296e249d7b7e2454ee57266ff - - - txaba5984c-aac7-460e-b04b-afc43f0c6571 - 0.0432</computeroutput></screen></example> - test%3Atester%2CAUTH_tkcdab3c6296e249d7b7e2454ee57266ff - - - txaba5984c-aac7-460e-b04b-afc43f0c6571 - 0.0432</computeroutput></screen></example>
</step><step> </step><step>
<para>Change into the <filename class="directory" <para>Change into the <filename class="directory"
>logtest</filename> directory:</para> >logtest</filename> directory:</para>
<screen><prompt>$</prompt> <userinput>cd logtest</userinput></screen></step> <screen><prompt>$</prompt> <userinput>cd logtest</userinput></screen></step>
@ -53,23 +53,24 @@ Objects: 4
Bytes: 5864468 Bytes: 5864468
Read ACL: Read ACL:
Write ACL:</computeroutput></screen></step> Write ACL:</computeroutput></screen></step>
<step><para> List all objects in the logtest container:</para> <step><para>List all objects in the logtest container:</para>
<screen><prompt>$</prompt> <userinput>swift -A http:///swift-auth.com:11000/v1.0 -U test:tester -K testing list logtest</userinput></screen> <screen><prompt>$</prompt> <userinput>swift -A http:///swift-auth.com:11000/v1.0 -U test:tester -K testing list logtest</userinput></screen>
<screen><computeroutput>2010-11-15-21_access.log <screen><computeroutput>2010-11-15-21_access.log
2010-11-15-22_access.log 2010-11-15-22_access.log
2010-11-16-21_access.log 2010-11-16-21_access.log
2010-11-16-22_access.log</computeroutput></screen></step></procedure></section> 2010-11-16-22_access.log</computeroutput></screen></step></procedure></section>
<section xml:id="swift_upload_files"><title>Download and analyze an object</title> <procedure> <section xml:id="swift_upload_files"><title>Download and analyze an object</title>
<procedure>
<para>This example uses the <option>-o —output</option> <para>This example uses the <option>-o —output</option>
option and a hyphen (<literal>-</literal>) to get option and a hyphen (<literal>-</literal>) to get
information about an object. </para> information about an object.</para>
<para>Use the swift <command>download</command> command to <para>Use the swift <command>download</command> command to
download the object. On this command, stream the download the object. On this command, stream the
output to <command>awk</command> to break down output to <command>awk</command> to break down
requests by return code and the date <literal>2200 on requests by return code and the date <literal>2200 on
November 16th, 2010</literal>. </para> November 16th, 2010</literal>.</para>
<para>Using the log line format, find the request type in <para>Using the log line format, find the request type in
column 9 and the return code in column 12. </para> column 9 and the return code in column 12.</para>
<para>After <command>awk</command> processes the output, <para>After <command>awk</command> processes the output,
it pipes it to <command>sort</command> and it pipes it to <command>sort</command> and
<command>uniq -c</command> to sum up the number of <command>uniq -c</command> to sum up the number of
@ -113,7 +114,7 @@ Write ACL:</computeroutput></screen></step>
<para>Use a bash for loop with awk and swift with <para>Use a bash for loop with awk and swift with
the <option>-o —output</option> option and a the <option>-o —output</option> option and a
hyphen (<literal>-</literal>) to discover how many hyphen (<literal>-</literal>) to discover how many
PUT requests are in each log file. </para> PUT requests are in each log file.</para>
<para>Run the swift <command>list</command> command to <para>Run the swift <command>list</command> command to
list objects in the logtest container. Then, for list objects in the logtest container. Then, for
@ -135,14 +136,14 @@ Write ACL:</computeroutput></screen></step>
<para>Run the swift <command>list -p 2010-11-15</command> <para>Run the swift <command>list -p 2010-11-15</command>
command to list objects in the logtest container command to list objects in the logtest container
that begin with the <literal>2010-11-15</literal> that begin with the <literal>2010-11-15</literal>
string. </para> string.</para>
<para>For each item in the list, run the swift <para>For each item in the list, run the swift
<command>download -o -</command> command. </para> <command>download -o -</command> command.</para>
<para>Pipe the output to <command>grep</command> and <para>Pipe the output to <command>grep</command> and
<command>wc</command>. Use the <command>wc</command>. Use the
<command>echo</command> command to display the <command>echo</command> command to display the
object name.</para> object name.</para>
<screen><prompt>$</prompt> <userinput>for f in `swift -A http://swift-auth.com:11000/v1.0 -U test:tester -K testing list -p 2010-11-15 logtest` ; \ <screen><prompt>$</prompt> <userinput>for f in `swift -A http://swift-auth.com:11000/v1.0 -U test:tester -K testing list -p 2010-11-15 logtest` ; \
do echo -ne “$f - PUTS - ” ; swift -A http://127.0.0.1:11000/v1.0 -U test:tester \ do echo -ne “$f - PUTS - ” ; swift -A http://127.0.0.1:11000/v1.0 -U test:tester \
-K testing download -o - logtest $f | grep PUT | wc -l ; \ -K testing download -o - logtest $f | grep PUT | wc -l ; \