openstack/openstack-manuals
Code Issues Proposed changes

Apply conventions for Swift and Ceilometer

Browse Source 
Use "swift" instead of "Swift".
Use "Telemetry" instead of "Ceilometer" where appropriate, lowercase
"ceilometer" as project name.
Reformat file common/section_objectstorage-features.xml.
Add some systemitem markup.

Partial-Bug: #1217503

Change-Id: Ia56a245a4993e4ea92fe19f38af443cf1bc411f5
This commit is contained in:
Andreas Jaeger
2014-05-11 21:21:32 +02:00
parent 41f9ff0834
commit c4aa170efa
12 changed files with 152 additions and 197 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
doc/common/section_cli_nova_usage_statistics.xml
View File

@@ -1,14 +1,17 @@
<?xml version="1.0" encoding="UTF-8"?>
<section xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0" xml:id="usage_statistics">
<title>Show usage statistics for hosts and instances</title><para xlink:href="http://graphite.wikidot.com">You can show basic
<section xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink"
version="5.0" xml:id="usage_statistics">
<title>Show usage statistics for hosts and instances</title>
<para xlink:href="http://graphite.wikidot.com">You can show basic
statistics on resource usage for hosts and instances.</para>
<note>
<para xlink:href="http://graphite.wikidot.com">For more sophisticated
monitoring, see the <link
xlink:href="https://launchpad.net/ceilometer"
>Ceilometer</link> project, which is under
development. You can also use tools, such as <link
>ceilometer</link> project.
You can also use tools, such as <link
xlink:href="http://ganglia.info/">Ganglia</link> or
<link xlink:href="http://graphite.wikidot.com/"
>Graphite</link>, to gather more detailed data.</para>

4
doc/common/section_keystone-concepts.xml
View File

@@ -91,8 +91,8 @@
<term><glossterm>Service</glossterm>
</term>
<listitem>
<para>An OpenStack service, such as Compute (Nova),
Object Storage (Swift), or Image Service (Glance).
<para>An OpenStack service, such as Compute (nova),
Object Storage (swift), or Image Service (glance).
Provides one or more endpoints through which users
can access resources and perform
operations.</para>

2
doc/common/section_objectstorage-arch.xml
View File

@@ -55,7 +55,7 @@
reapers. You can provision object stores provisioned with single gigabit or 10 gigabit
network interface depending on the expected workload and desired performance.</para>
<figure>
<title>Object Storage (Swift)</title>
<title>Object Storage (swift)</title>
<mediaobject>
<imageobject>
<imagedata fileref="../common/figures/objectstorage-nodes.png"/>

4
doc/common/section_objectstorage-characteristics.xml
View File

@@ -44,7 +44,7 @@
</listitem>
</itemizedlist>
<figure>
<title>Object Storage (Swift)</title>
<title>Object Storage (swift)</title>
<mediaobject>
<imageobject>
<imagedata fileref="../common/figures/objectstorage.png"/>
@@ -56,4 +56,4 @@
Ruby, and C#. Amazon S3 and RackSpace Cloud Files users should be very familiar with Object
Storage. Users new to object storage systems will have to adjust to a different approach and
mindset than those required for a traditional filesystem.</para>
</section>
</section>

288
doc/common/section_objectstorage-features.xml
View File

@@ -6,175 +6,121 @@
xml:id="section_objectstorage_features">
<!-- ... Old module003-ch002-features-benefits edited, renamed, and stored in doc/common for use by both Cloud Admin and Operator Training Guides... -->
<title>Features and benefits</title>
<para>
<informaltable class="c19">
<tbody>
<tr>
<th rowspan="1" colspan="1">Features</th>
<th rowspan="1" colspan="1">Benefits</th>
</tr>
<tr>
<td rowspan="1" colspan="1"><emphasis role="bold"
>Leverages commodity
hardware</emphasis></td>
<td rowspan="1" colspan="1"
>No
lock-in, lower
price/GB</td>
</tr>
<tr>
<td rowspan="1" colspan="1"><emphasis role="bold"
>HDD/node failure agnostic</emphasis></td>
<td rowspan="1" colspan="1">Self-healing, reliable, data redundancy protects
from failures</td>
</tr>
<tr>
<td rowspan="1" colspan="1"><emphasis role="bold"
>Unlimited storage</emphasis></td>
<td rowspan="1" colspan="1">Large and flat namespace, highly scalable read/write
access, able to serve content directly from storage system</td>
</tr>
<tr>
<td rowspan="1" colspan="1"><emphasis role="bold"
>Multi-dimensional scalability</emphasis>
</td>
<td rowspan="1" colspan="1">Scale-out architecture: Scale vertically and
horizontally-distributed storage Backs up and archives large amounts of data
with linear performance</td>
</tr>
<tr>
<td rowspan="1" colspan="1"><emphasis role="bold">Account/container/object
structure</emphasis></td>
<td rowspan="1" colspan="1">No nesting, not a traditional file
system: Optimized for scale, it scales to multiple petabytes and
billions of objects</td>
</tr>
<tr>
<td rowspan="1" colspan="1"><emphasis role="bold">Built-in replication 3&#10005;
+ data redundancy (compared with 2&#10005; on RAID)</emphasis></td>
<td rowspan="1" colspan="1">A configurable number of accounts, containers and
object copies for high availability</td>
</tr>
<tr>
<td rowspan="1" colspan="1"><emphasis role="bold"
>Easily add capacity (unlike
RAID resize)</emphasis></td>
<td rowspan="1" colspan="1"
>Elastic
data scaling with
ease</td>
</tr>
<tr>
<td rowspan="1" colspan="1"><emphasis role="bold"
>No central database</emphasis></td>
<td rowspan="1" colspan="1"
>Higher
performance, no
bottlenecks</td>
</tr>
<tr>
<td rowspan="1" colspan="1"><emphasis role="bold"
>RAID not required</emphasis></td>
<td rowspan="1" colspan="1">Handle many small, random reads and writes
efficiently</td>
</tr>
<tr>
<td rowspan="1" colspan="1"><emphasis role="bold"
>Built-in management
utilities</emphasis></td>
<td rowspan="1" colspan="1">Account management: Create, add, verify, and
delete users; Container management: Upload, download, and verify;
Monitoring: Capacity, host, network, log trawling, and cluster
health</td>
</tr>
<tr>
<td rowspan="1" colspan="1"><emphasis role="bold"
>Drive auditing</emphasis></td>
<td rowspan="1" colspan="1"
>Detect
drive failures preempting data
corruption</td>
</tr>
<tr>
<td rowspan="1" colspan="1"><emphasis role="bold"
>Expiring objects</emphasis></td>
<td rowspan="1" colspan="1"
>Users
can set an expiration time or a TTL on an
object to control
access</td>
</tr>
<tr>
<td rowspan="1" colspan="1"><emphasis role="bold"
>Direct object access</emphasis></td>
<td rowspan="1" colspan="1"
>Enable
direct browser access to content, such as for
a control
panel</td>
</tr>
<tr>
<td rowspan="1" colspan="1"><emphasis role="bold"
>Realtime visibility into client
requests</emphasis></td>
<td rowspan="1" colspan="1"
>Know
what users are
requesting</td>
</tr>
<tr>
<td rowspan="1" colspan="1"><emphasis role="bold"
>Supports S3 API</emphasis></td>
<td rowspan="1" colspan="1"
>Utilize
tools that were designed for the popular S3
API</td>
</tr>
<tr>
<td rowspan="1" colspan="1"><emphasis role="bold"
>Restrict containers per
account</emphasis></td>
<td rowspan="1" colspan="1"
>Limit
access to control usage by
user</td>
</tr>
<tr>
<td rowspan="1" colspan="1"><emphasis role="bold"
>Support for NetApp, Nexenta,
SolidFire</emphasis></td>
<td rowspan="1" colspan="1"
>Unified
support for block volumes using a variety of
storage
systems</td>
</tr>
<tr>
<td rowspan="1" colspan="1"><emphasis role="bold"
>Snapshot and backup API for block
volumes</emphasis></td>
<td rowspan="1" colspan="1"
>Data
protection and recovery for VM
data</td>
</tr>
<tr>
<td rowspan="1" colspan="1"><emphasis role="bold"
>Standalone volume API
available</emphasis></td>
<td rowspan="1" colspan="1"
>Separate
endpoint and API for integration with other
compute
systems</td>
</tr>
<tr>
<td rowspan="1" colspan="1"><emphasis role="bold"
>Integration with Compute</emphasis></td>
<td rowspan="1" colspan="1">Fully integrated with Compute for attaching block
volumes and reporting on usage</td>
</tr>
</tbody>
</informaltable>
</para>
<informaltable>
<thead>
<tr>
<th>Features</th>
<th>Benefits</th>
</tr>
</thead>
<tbody>
<tr>
<td><emphasis role="bold">Leverages commodity hardware</emphasis></td>
<td>No lock-in, lower price/GB.</td>
</tr>
<tr>
<td><emphasis role="bold">HDD/node failure agnostic</emphasis></td>
<td>Self-healing, reliable, data redundancy protects from
failures.</td>
</tr>
<tr>
<td><emphasis role="bold">Unlimited storage</emphasis></td>
<td>Large and flat namespace, highly scalable read/write
access, able to serve content directly from storage system.</td>
</tr>
<tr>
<td><emphasis role="bold">Multi-dimensional scalability</emphasis>
</td>
<td>Scale-out architecture: Scale vertically and
horizontally-distributed storage. Backs up and archives
large amounts of data with linear performance.</td>
</tr>
<tr>
<td><emphasis role="bold">Account/container/object structure</emphasis></td>
<td>No nesting, not a traditional file system: Optimized
for scale, it scales to multiple petabytes and billions of
objects.</td>
</tr>
<tr>
<td><emphasis role="bold">Built-in replication 3&#10005; +
data redundancy (compared with 2&#10005; on RAID)</emphasis>
</td>
<td>A configurable number of accounts, containers and
object copies for high availability.</td>
</tr>
<tr>
<td><emphasis role="bold">Easily add capacity (unlike
RAID resize)</emphasis></td>
<td>Elastic data scaling with ease</td>
</tr>
<tr>
<td><emphasis role="bold">No central database</emphasis></td>
<td>Higher performance, no bottlenecks</td>
</tr>
<tr>
<td><emphasis role="bold">RAID not required</emphasis></td>
<td>Handle many small, random reads and writes efficiently</td>
</tr>
<tr>
<td><emphasis role="bold">Built-in management utilities</emphasis></td>
<td>Account management: Create, add, verify, and delete
users; Container management: Upload, download, and verify;
Monitoring: Capacity, host, network, log trawling, and
cluster health.</td>
</tr>
<tr>
<td><emphasis role="bold">Drive auditing</emphasis></td>
<td>Detect drive failures preempting data corruption</td>
</tr>
<tr>
<td><emphasis role="bold">Expiring objects</emphasis></td>
<td>Users can set an expiration time or a TTL on an object
to control access</td>
</tr>
<tr>
<td><emphasis role="bold">Direct object access</emphasis></td>
<td>Enable direct browser access to content, such as for
a control panel</td>
</tr>
<tr>
<td><emphasis role="bold">Realtime visibility into client
requests</emphasis></td>
<td>Know what users are requesting.</td>
</tr>
<tr>
<td><emphasis role="bold">Supports S3 API</emphasis></td>
<td>Utilize tools that were designed for the popular S3
API.</td>
</tr>
<tr>
<td><emphasis role="bold">Restrict containers per
account</emphasis></td>
<td>Limit access to control usage by user.</td>
</tr>
<tr>
<td><emphasis role="bold">Support for NetApp, Nexenta,
SolidFire</emphasis></td>
<td>Unified support for block volumes using a variety of
storage systems.</td>
</tr>
<tr>
<td><emphasis role="bold">Snapshot and backup API for
block volumes</emphasis></td>
<td>Data protection and recovery for VM data.</td>
</tr>
<tr>
<td><emphasis role="bold">Standalone volume API
available</emphasis></td>
<td>Separate endpoint and API for integration with other
compute systems.</td>
</tr>
<tr>
<td><emphasis role="bold">Integration with
Compute</emphasis></td>
<td>Fully integrated with Compute for attaching block
volumes and reporting on usage.</td>
</tr>
</tbody>
</informaltable>
</section>

2
doc/common/section_objectstorage-intro.xml
View File

@@ -6,7 +6,7 @@
xml:id="section_objectstorage-intro">
<!-- ... Old module003-ch001-intro-objstore edited, renamed, and stored in doc/common for use by both Cloud Admin and Operator Training Guides... -->
<title>Introduction to Object Storage</title>
<para>OpenStack Object Storage (code-named Swift) is open source software for creating
<para>OpenStack Object Storage (code-named swift) is open source software for creating
redundant, scalable data storage using clusters of standardized servers to store petabytes
of accessible data. It is a long-term storage system for large amounts of static data that
can be retrieved, leveraged, and updated. Object Storage uses a distributed architecture

4
doc/common/section_objectstorage-troubleshoot.xml
View File

@@ -50,10 +50,10 @@
</section>
<section xml:id="recover-ring-builder-file">
<title>Emergency recovery of ring builder files</title>
<para>You should always keep a backup of Swift ring builder files. However, if an
<para>You should always keep a backup of swift ring builder files. However, if an
emergency occurs, this procedure may assist in returning your cluster to an
operational state.</para>
<para>Using existing Swift tools, there is no way to recover a builder file from a
<para>Using existing swift tools, there is no way to recover a builder file from a
<filename>ring.gz</filename> file. However, if you have a knowledge of Python, it is possible to
construct a builder file that is pretty close to the one you have lost. The
following is what you will need to do.</para>

4
doc/common/section_storage-concepts.xml
View File

@@ -17,8 +17,8 @@
<thead>
<tr>
<td>On-instance / ephemeral</td>
<td>Block storage (Cinder)</td>
<td>Object Storage (Swift)</td>
<td>Block storage (cinder)</td>
<td>Object Storage (swift)</td>
</tr>
</thead>
<tbody>

6
doc/config-reference/block-storage/section_block-storage-overview.xml
View File

@@ -34,8 +34,8 @@
</listitem>
<listitem>
<para><systemitem class="service">cinder-backup</systemitem>.
Provides a means to back up a Block Storage Volume
to OpenStack Object Store (SWIFT).</para>
Provides a means to back up a Block Storage volume
to OpenStack Object Storage (swift).</para>
</listitem>
</itemizedlist>
<para>The Block Storage service contains the following components:</para>
@@ -103,7 +103,7 @@
<listitem>
<para><emphasis role="bold">Backups</emphasis>. An
archived copy of a volume currently stored in
OpenStack Object Storage (Swift).</para>
OpenStack Object Storage (swift).</para>
</listitem>
</itemizedlist>
</listitem>

2
doc/install-guide/ch_ceilometer.xml
View File

@@ -5,7 +5,7 @@
xml:id="ch_ceilometer">
<title>Add the Telemetry module</title>
<para>Telemetry provides a framework for monitoring and metering
the OpenStack cloud. It is also known as the Ceilometer
the OpenStack cloud. It is also known as the ceilometer
project.</para>
<xi:include href="../common/section_getstart_telemetry.xml"/>
<xi:include href="section_ceilometer-install.xml"/>

18
doc/install-guide/object-storage/section_object-storage-install.xml
View File

@@ -35,16 +35,22 @@
following types of nodes:</para>
<itemizedlist>
<listitem>
<para>One proxy node which runs the swift-proxy-server
<para>One proxy node which runs the
<systemitem class="service">swift-proxy-server</systemitem>
processes. The proxy server proxies requests to the
appropriate storage nodes.</para>
</listitem>
<listitem>
<para>Five storage nodes that run the swift-account-server,
swift-container-server, and swift-object-server processes
which control storage of the account databases, the
container databases, as well as the actual stored
objects.</para>
<para>
Five storage nodes that run the <systemitem
class="service">swift-account-server</systemitem>,
<systemitem
class="service">swift-container-server</systemitem>,
and <systemitem
class="service">swift-object-server</systemitem>
processes which control storage of the account
databases, the container databases, as well as the
actual stored objects.</para>
</listitem>
</itemizedlist>
<note>

2
doc/install-guide/section_nova-compute.xml
View File

@@ -23,7 +23,7 @@
<note os="debian">
<para>To use the meta-packages and install other components on
your compute node, such as OpenStack Networking and Ceilometer
your compute node, such as OpenStack Networking and Telemetry
agents, run this command:</para>
<screen><prompt>#</prompt> <userinput>apt-get install openstack-compute-node</userinput></screen>
<para>The controller node has the