openstack/openstack-manuals
Code Issues Proposed changes

Apply service name conventions for Block Storage

Browse Source 
There are several instances of "Block Storage Service" in the
upstream documentation. As was recently clarified in the docs
mailing list, these should be "Block Storage service". This patch
applies the fix.

Change-Id: I591c100ab031b75f1c0d27d45f53e32401a26e30
Partial-Bug: #1217503
This commit is contained in:
Don Domingo 2014-03-19 13:07:11 +10:00
parent 21aa195468
commit 5fca287eb5
26 changed files with 100 additions and 101 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
doc/admin-guide-cloud/ch_blockstorage.xml
View File

@ -26,10 +26,10 @@
xlink:href="http://docs.openstack.org/trunk/openstack-ops/content/storage_decision.html" xlink:href="http://docs.openstack.org/trunk/openstack-ops/content/storage_decision.html"
>Storage Decisions</link> in the <citetitle>OpenStack >Storage Decisions</link> in the <citetitle>OpenStack
Operations Guide</citetitle>.</para> Operations Guide</citetitle>.</para>
<para>The OpenStack Block Storage Service enables you to add <para>OpenStack Block Storage enables you to add extra
extra block-level storage to your OpenStack Compute block-level storage to your OpenStack Compute instances.
instances. This service is similar to the Amazon EC2 This service is similar to the Amazon EC2 Elastic Block
Elastic Block Storage (EBS) offering.</para> Storage (EBS) offering.</para>
</section> </section>
<?hard-pagebreak?> <?hard-pagebreak?>
<section xml:id="section_manage-volumes"> <section xml:id="section_manage-volumes">
@ -129,7 +129,7 @@
<section xml:id="troubleshooting-cinder-install"> <section xml:id="troubleshooting-cinder-install">
<title>Troubleshoot your installation</title> <title>Troubleshoot your installation</title>
<para>This section provides useful tips to help troubleshoot <para>This section provides useful tips to help troubleshoot
your Block Storage Service installation.</para> your Block Storage installation.</para>
<xi:include href="section_ts_cinder_config.xml"/> <xi:include href="section_ts_cinder_config.xml"/>
<xi:include href="section_ts_multipath_warn.xml"/> <xi:include href="section_ts_multipath_warn.xml"/>
<xi:include href="section_ts_vol_attach_miss_sg_scan.xml"/> <xi:include href="section_ts_vol_attach_miss_sg_scan.xml"/>

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

@ -1657,7 +1657,7 @@ net.bridge.bridge-nf-call-ip6tables=0</programlisting>
</section> </section>
<section xml:id="section_block-storage-volumes"> <section xml:id="section_block-storage-volumes">
<title>Volumes</title> <title>Volumes</title>
<para>The Block Storage Service provides persistent block <para>OpenStack Block Storage provides persistent block
storage resources that OpenStack Compute instances can storage resources that OpenStack Compute instances can
consume.</para> consume.</para>
<para>See the <citetitle>OpenStack Configuration <para>See the <citetitle>OpenStack Configuration
@ -2018,10 +2018,10 @@ qualname = nova</programlisting></para>
send logging information to syslog. This is useful send logging information to syslog. This is useful
if you want to use rsyslog, which forwards the if you want to use rsyslog, which forwards the
logs to a remote machine. You need to separately logs to a remote machine. You need to separately
configure the Compute service (Nova), the Identity configure the Compute service (nova), the Identity
Service (Keystone), the Image Service (Glance), service (keystone), the Image Service (glance),
and, if you are using it, the Block Storage and, if you are using it, the Block Storage
Service (Cinder) to send log messages to syslog. service (cinder) to send log messages to syslog.
To do so, add these lines to:</para> To do so, add these lines to:</para>
<itemizedlist> <itemizedlist>
<listitem> <listitem>

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

@ -7,7 +7,7 @@
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" version="5.0"> xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0">
<title>Back up Block Storage Service disks</title> <title>Back up Block Storage service disks</title>
<para>While you can use the LVM snapshot to create snapshots, you <para>While you can use the LVM snapshot to create snapshots, you
can also use it to back up your volumes. By using LVM can also use it to back up your volumes. By using LVM
snapshot, you reduce the size of the backup; only existing snapshot, you reduce the size of the backup; only existing
@ -53,7 +53,7 @@
</itemizedlist> </itemizedlist>
<para>You can apply this process to volumes of any size.</para> <para>You can apply this process to volumes of any size.</para>
<procedure> <procedure>
<title>To back up Block Storage Service disks</title> <title>To back up Block Storage service disks</title>
<step> <step>
<title>Create a snapshot of a used volume</title> <title>Create a snapshot of a used volume</title>
<substeps> <substeps>
@ -131,7 +131,7 @@ Block device 251:14</programlisting>
<step> <step>
<para>To exploit the snapshot with the <para>To exploit the snapshot with the
<command>tar</command> command, mount your <command>tar</command> command, mount your
partition on the Block Storage Service partition on the Block Storage service
server.</para> server.</para>
<para>The <command>kpartx</command> utility <para>The <command>kpartx</command> utility
discovers and maps table partitions. You discovers and maps table partitions. You
@ -247,7 +247,7 @@ Block device 251:14</programlisting>
the <option>backups_retention_days</option> the <option>backups_retention_days</option>
setting.</para> setting.</para>
<para>Launch this script from the server that runs the <para>Launch this script from the server that runs the
Block Storage Service.</para> Block Storage service.</para>
<para>This example shows a mail report:</para> <para>This example shows a mail report:</para>
<programlisting>Backup Start Time - 07/10 at 01:00:01 <programlisting>Backup Start Time - 07/10 at 01:00:01
Current retention - 7 days Current retention - 7 days

34
doc/admin-guide-cloud/section_ts_cinder_config.xml
View File

@ -10,24 +10,24 @@
linkend="section_ts_cinder_config"> linkend="section_ts_cinder_config">
<title xml:id="ts_block_config">Troubleshoot the Block Storage <title xml:id="ts_block_config">Troubleshoot the Block Storage
configuration</title> configuration</title>
<para>This section helps you solve some basic and common errors <para>Most Block Storage errors are caused by incorrect volume
that you might encounter during setup and configuration of the configurations that result in volume creation failues. To resolve
Block Storage Service. The focus here is on failed these failures, review these logs:</para>
creation of volumes. The most important thing to know is where <itemizedlist>
to look in case of a failure.</para> <listitem><para><systemitem class="service">cinder-api</systemitem>
<para>Two log files are especially helpful for solving volume log (<filename>/var/log/cinder/api.log</filename>)</para></listitem>
creation failures, the <systemitem class="service" <listitem><para><systemitem class="service">cinder-volume</systemitem>
>cinder-api</systemitem> log and the <systemitem log (<filename>/var/log/cinder/volume.log</filename>)</para></listitem>
class="service">cinder-volume</systemitem> log. The </itemizedlist>
<systemitem class="service">cinder-api</systemitem> log is <para>The <systemitem class="service">cinder-api</systemitem> log
useful for determining if you have endpoint or connectivity is useful for determining if you have endpoint or connectivity
issues. If you send a request to create a volume and it fails, issues. If you send a request to create a volume and it fails,
review the <systemitem class="service" review the <systemitem class="service" >cinder-api</systemitem>
>cinder-api</systemitem> log to determine whether the request log to determine whether the request made it to the Block Storage
made it to the Block Storage service. If the request is logged service. If the request is logged and you see no errors or
and you see no errors or trace-backs, check the trace-backs, check the
<systemitem class="service">cinder-volume</systemitem> log <systemitem class="service">cinder-volume</systemitem> log for
for errors or trace-backs.</para> errors or trace-backs.</para>
<note> <note>
<para>Create commands are listed in the <systemitem <para>Create commands are listed in the <systemitem
class="service">cinder-api</systemitem> log.</para> class="service">cinder-api</systemitem> log.</para>

13
doc/admin-guide-cloud/section_volume-migration.xml
View File

@ -19,12 +19,11 @@
Block Storage driver to enable optimizations that the Block Storage driver to enable optimizations that the
storage might be able to perform. If the back-end is storage might be able to perform. If the back-end is
not able to perform the migration, the Block Storage not able to perform the migration, the Block Storage
Service uses one of two generic flows, as uses one of two generic flows, as follows.</para>
follows.</para>
</listitem> </listitem>
<listitem> <listitem>
<para>If the volume is not attached, the Block Storage <para>If the volume is not attached, the Block Storage
Service creates a volume and copies the data from the service creates a volume and copies the data from the
original to the new volume.</para> original to the new volume.</para>
<note> <note>
<para>While most back-ends support this function, not all do. <para>While most back-ends support this function, not all do.
@ -37,10 +36,10 @@
</listitem> </listitem>
<listitem> <listitem>
<para>If the volume is attached to a VM instance, the <para>If the volume is attached to a VM instance, the
Block Storage Service creates a volume, and calls Block Storage creates a volume, and calls Compute to
Compute to copy the data from the original to the new copy the data from the original to the new volume.
volume. Currently this is supported only by the Currently this is supported only by the Compute
Compute libvirt driver.</para> libvirt driver.</para>
</listitem> </listitem>
</orderedlist> </orderedlist>
<para>As an example, this scenario shows two LVM back-ends and <para>As an example, this scenario shows two LVM back-ends and

2
doc/common/section_cli_install.xml
View File

@ -181,7 +181,7 @@
</listitem> </listitem>
<listitem> <listitem>
<para><literal>cinder</literal> - Block Storage <para><literal>cinder</literal> - Block Storage
Service API and extensions.</para> API and extensions.</para>
</listitem> </listitem>
<listitem> <listitem>
<para><literal>glance</literal> - Image Service <para><literal>glance</literal> - Image Service

2
doc/common/section_cli_version.xml
View File

@ -15,7 +15,7 @@
</listitem> </listitem>
<listitem> <listitem>
<para><literal>cinder</literal> - Block Storage <para><literal>cinder</literal> - Block Storage
Service API and extensions.</para> API and extensions.</para>
</listitem> </listitem>
<listitem> <listitem>
<para><literal>glance</literal> - Image Service <para><literal>glance</literal> - Image Service

16
doc/common/section_getstart_block-storage.xml
View File

@ -2,20 +2,20 @@
xmlns:xi="http://www.w3.org/2001/XInclude" 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="block-storage-service"> xml:id="block-storage-service">
<title>Block Storage Service</title> <title>Block Storage</title>
<para>The Block Storage Service enables management of volumes, <para>The Block Storage service enables management of volumes,
volume snapshots, and volume types. It includes the following volume snapshots, and volume types. It includes the following
components:</para> components:</para>
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para><systemitem class="service">cinder-api</systemitem>. <para><systemitem class="service">cinder-api</systemitem>:
Accepts API requests and routes them to <systemitem Accepts API requests and routes them to <systemitem
class="service">cinder-volume</systemitem> for class="service">cinder-volume</systemitem> for
action.</para> action.</para>
</listitem> </listitem>
<listitem> <listitem>
<para><systemitem class="service" <para><systemitem class="service"
>cinder-volume</systemitem>. Responds to requests to read >cinder-volume</systemitem>: Responds to requests to read
from and write to the Block Storage database to maintain from and write to the Block Storage database to maintain
state, interacting with other processes (like <systemitem state, interacting with other processes (like <systemitem
class="service">cinder-scheduler</systemitem>) through a class="service">cinder-scheduler</systemitem>) through a
@ -25,16 +25,16 @@
</listitem> </listitem>
<listitem> <listitem>
<para><systemitem class="service" <para><systemitem class="service"
>cinder-scheduler</systemitem> daemon. Like the >cinder-scheduler</systemitem> daemon: Like the
<systemitem class="service">nova-scheduler</systemitem>, <systemitem class="service">nova-scheduler</systemitem>,
picks the optimal block storage provider node on which to picks the optimal block storage provider node on which to
create the volume.</para> create the volume.</para>
</listitem> </listitem>
<listitem> <listitem>
<para>Messaging queue. Routes information between the Block <para>Messaging queue: Routes information between the Block
Storage Service processes.</para> Storage service processes.</para>
</listitem> </listitem>
</itemizedlist> </itemizedlist>
<para>The Block Storage Service interacts with Compute to <para>The Block Storage service interacts with Compute to
provide volumes for instances.</para> provide volumes for instances.</para>
</section> </section>

2
doc/config-reference/block-storage/backup/ceph-backup-driver.xml
View File

@ -29,7 +29,7 @@
less time to restore a volume than to take a full less time to restore a volume than to take a full
copy.</para> copy.</para>
<note> <note>
<para>Block Storage Service enables you to:</para> <para>Block Storage enables you to:</para>
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para>Restore to a new volume, which <para>Restore to a new volume, which

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

@ -24,7 +24,7 @@
</listitem> </listitem>
</itemizedlist> </itemizedlist>
<para>This document describes how to configure the OpenStack Block <para>This document describes how to configure the OpenStack Block
Storage Service for use with Coraid storage appliances.</para> Storage service for use with Coraid storage appliances.</para>
<section xml:id="coraid_terminology"> <section xml:id="coraid_terminology">
<title>Terminology</title> <title>Terminology</title>
<para>These terms are used in this section:</para> <para>These terms are used in this section:</para>
@ -70,14 +70,14 @@
</section> </section>
<section xml:id="coraid_requirements"> <section xml:id="coraid_requirements">
<title>Requirements</title> <title>Requirements</title>
<para>To support the OpenStack Block Storage Service, your SAN <para>To support the OpenStack Block Storage service, your SAN
must include an SRX for physical storage, a VSX running at least must include an SRX for physical storage, a VSX running at least
CorOS v2.0.6 for snapshot support, and an ESM running at least CorOS v2.0.6 for snapshot support, and an ESM running at least
v2.1.1 for storage repository orchestration. Ensure that all v2.1.1 for storage repository orchestration. Ensure that all
storage appliances are installed and connected to your network storage appliances are installed and connected to your network
before you configure OpenStack volumes.</para> before you configure OpenStack volumes.</para>
<para>So that the node can communicate with the SAN, you must <para>In order for the node to communicate with the SAN, you must
install the Coraid AoE Linux driver on each compute node on the install the Coraid AoE Linux driver on each Compute node on the
network that runs an OpenStack instance.</para> network that runs an OpenStack instance.</para>
</section> </section>
<section xml:id="coraid_overview"> <section xml:id="coraid_overview">

8
doc/config-reference/block-storage/drivers/hp-3par-driver.xml
View File

@ -4,7 +4,7 @@
<title>HP 3PAR Fibre Channel and iSCSI drivers</title> <title>HP 3PAR Fibre Channel and iSCSI drivers</title>
<para>The <filename>HP3PARFCDriver</filename> and <para>The <filename>HP3PARFCDriver</filename> and
<filename>HP3PARISCSIDriver</filename> drivers, which are <filename>HP3PARISCSIDriver</filename> drivers, which are
based on the Block Storage Service (Cinder) plug-in based on the Block Storage service (Cinder) plug-in
architecture, run volume operations by communicating with the architecture, run volume operations by communicating with the
HP 3PAR storage system over HTTP, HTTPS, and SSH connections. HP 3PAR storage system over HTTP, HTTPS, and SSH connections.
The HTTP and HTTPS communications use The HTTP and HTTPS communications use
@ -33,7 +33,7 @@
<para>Additionally, you must install the <para>Additionally, you must install the
<package>hp3parclient</package> version 3.0 or <package>hp3parclient</package> version 3.0 or
newer from the Python standard library on the newer from the Python standard library on the
system with the enabled Block Storage Service system with the enabled Block Storage service
volume drivers.</para> volume drivers.</para>
</listitem> </listitem>
</itemizedlist> </itemizedlist>
@ -117,7 +117,7 @@
</note> </note>
<para>If volume types are not used or a particular key is not <para>If volume types are not used or a particular key is not
set for a volume type, the following defaults are set for a volume type, the following defaults are
used.</para> used:</para>
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para><literal>hp3par:cpg</literal> - Defaults to the <para><literal>hp3par:cpg</literal> - Defaults to the
@ -387,7 +387,7 @@ hp3par_snapshot_expiration=72</programlisting>
</procedure> </procedure>
<para>The HP 3PAR Fibre Channel and iSCSI drivers are now <para>The HP 3PAR Fibre Channel and iSCSI drivers are now
enabled on your OpenStack system. If you experience enabled on your OpenStack system. If you experience
problems, review the Block Storage Service log files for problems, review the Block Storage service log files for
errors.</para> errors.</para>
</section> </section>
</section> </section>

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

@ -6,7 +6,7 @@
The The
<filename>HPLeftHandISCSIDriver</filename> <filename>HPLeftHandISCSIDriver</filename>
is based on the is based on the
Block Storage Service (Cinder) plug-in architecture. Volume operations Block Storage service (Cinder) plug-in architecture. Volume operations
are run by communicating with the HP LeftHand/StoreVirtual system over are run by communicating with the HP LeftHand/StoreVirtual system over
HTTPS, or SSH connections. HTTPS communications use the HTTPS, or SSH connections. HTTPS communications use the
<package>hplefthandclient</package>, <package>hplefthandclient</package>,
@ -59,7 +59,7 @@
<para> <para>
Install the <package>hplefthandclient</package> version Install the <package>hplefthandclient</package> version
1.0.2 from the Python Package Index on the system with the 1.0.2 from the Python Package Index on the system with the
enabled Block Storage Service volume drivers. enabled Block Storage service volume drivers.
</para> </para>
</listitem> </listitem>
</itemizedlist> </itemizedlist>
@ -308,7 +308,7 @@ hplefthand_debug=false
</procedure> </procedure>
<para>The HP LeftHand/StoreVirtual driver is now enabled in <para>The HP LeftHand/StoreVirtual driver is now enabled in
standard mode on your OpenStack system. If you experience standard mode on your OpenStack system. If you experience
problems, review the Block Storage Service log files for errors. problems, review the Block Storage service log files for errors.
</para> </para>
</section> </section>
</section> </section>
@ -423,7 +423,7 @@ san_is_local=False
</procedure> </procedure>
<para>The HP LeftHand/StoreVirtual driver is now enabled in <para>The HP LeftHand/StoreVirtual driver is now enabled in
legacy mode on your OpenStack system. If you experience legacy mode on your OpenStack system. If you experience
problems, review the Block Storage Service log files for errors. problems, review the Block Storage service log files for errors.
</para> </para>
<para>To configure the VSA</para> <para>To configure the VSA</para>
<procedure> <procedure>

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

@ -41,7 +41,7 @@
</section> </section>
<section xml:id="GPFS-driver-options"> <section xml:id="GPFS-driver-options">
<title>Enable the GPFS driver</title> <title>Enable the GPFS driver</title>
<para>To use the Block Storage Service with the GPFS driver, first set the <para>To use the Block Storage service with the GPFS driver, first set the
<literal>volume_driver</literal> in <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>

4
doc/config-reference/ch_blockstorageconfigure.xml
View File

@ -8,14 +8,14 @@
xmlns:ns3="http://www.w3.org/1998/Math/MathML" xmlns:ns3="http://www.w3.org/1998/Math/MathML"
xmlns:ns="http://docbook.org/ns/docbook"> xmlns:ns="http://docbook.org/ns/docbook">
<title>Block Storage</title> <title>Block Storage</title>
<para>The OpenStack Block Storage Service works with many different <para>The OpenStack Block Storage service works with many different
storage drivers that you can configure by using these instructions.</para> storage drivers that you can configure by using these instructions.</para>
<xi:include href="block-storage/section_block-storage-overview.xml"/> <xi:include href="block-storage/section_block-storage-overview.xml"/>
<section xml:id="setting-flags-in-cinder-conf-file"> <section xml:id="setting-flags-in-cinder-conf-file">
<title><filename>cinder.conf</filename> configuration file</title> <title><filename>cinder.conf</filename> configuration file</title>
<para>The <filename>cinder.conf</filename> file is installed in <para>The <filename>cinder.conf</filename> file is installed in
<filename>/etc/cinder</filename> by default. When you manually <filename>/etc/cinder</filename> by default. When you manually
install the Block Storage Service, the options in the install the Block Storage service, the options in the
<filename>cinder.conf</filename> file are set to default values.</para> <filename>cinder.conf</filename> file are set to default values.</para>
<para>This example shows a typical <para>This example shows a typical
<filename>cinder.conf</filename> file:</para> <filename>cinder.conf</filename> file:</para>

8
doc/install-guide/bk_openstackinstallguide.xml
View File

@ -51,10 +51,10 @@
projects that you install separately but that work projects that you install separately but that work
together depending on your cloud needs. These projects together depending on your cloud needs. These projects
include Compute, Identity Service, Networking, Image include Compute, Identity Service, Networking, Image
Service, Block Storage Service, Object Storage, Service, Block Storage, Object Storage, Telemetry,
Telemetry, and Orchestration. You can install any of and Orchestration. You can install any of these
these projects separately and configure them projects separately and configure them stand-alone or
standalone or as connected entities. <phrase as connected entities. <phrase
os="debian">This guide walks through an os="debian">This guide walks through an
installation by using packages available through installation by using packages available through
Debian 7.0 (code name: Wheezy).</phrase> Debian 7.0 (code name: Wheezy).</phrase>

4
doc/install-guide/ch_basics.xml
View File

@ -325,11 +325,11 @@ iface eth1 inet static
</tr> </tr>
<tr> <tr>
<td><literal><replaceable>CINDER_DBPASS</replaceable></literal></td> <td><literal><replaceable>CINDER_DBPASS</replaceable></literal></td>
<td>Database password for the Block Storage Service</td> <td>Database password for the Block Storage service</td>
</tr> </tr>
<tr> <tr>
<td><literal><replaceable>CINDER_PASS</replaceable></literal></td> <td><literal><replaceable>CINDER_PASS</replaceable></literal></td>
<td>Password of Block Storage Service user <literal>cinder</literal></td> <td>Password of Block Storage service user <literal>cinder</literal></td>
</tr> </tr>
<tr> <tr>
<td><literal><replaceable>NEUTRON_DBPASS</replaceable></literal></td> <td><literal><replaceable>NEUTRON_DBPASS</replaceable></literal></td>

8
doc/install-guide/ch_cinder.xml
View File

@ -3,15 +3,15 @@
xmlns:xi="http://www.w3.org/2001/XInclude" 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="ch_cinder"> xml:id="ch_cinder">
<title>Add the Block Storage Service</title> <title>Add the Block Storage service</title>
<para>The OpenStack Block Storage Service works through the <para>The OpenStack Block Storage service works through the
interaction of a series of daemon processes named <systemitem interaction of a series of daemon processes named <systemitem
role="process">cinder-*</systemitem> that reside persistently on role="process">cinder-*</systemitem> that reside persistently on
the host machine or machines. You can run the binaries from a the host machine or machines. You can run the binaries from a
single node or across multiple nodes. You can also run them on the single node or across multiple nodes. You can also run them on the
same node as other OpenStack services. The following sections same node as other OpenStack services. The following sections
introduce Block Storage Service components and concepts and show introduce Block Storage service components and concepts and show
you how to configure and install the Block Storage Service.</para> you how to configure and install the Block Storage service.</para>
<xi:include href="../common/section_getstart_block-storage.xml"/> <xi:include href="../common/section_getstart_block-storage.xml"/>
<xi:include href="section_cinder-controller.xml"/> <xi:include href="section_cinder-controller.xml"/>
<xi:include href="section_cinder-node.xml"/> <xi:include href="section_cinder-node.xml"/>

4
doc/install-guide/section_ceilometer-cinder.xml
View File

@ -4,11 +4,11 @@
xmlns:xi="http://www.w3.org/2001/XInclude" 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">
<?dbhtml-stop-chunking?> <?dbhtml-stop-chunking?>
<title>Configure the Block Storage service for Telemetry</title> <title>Add the Block Storage service agent for Telemetry</title>
<procedure> <procedure>
<step> <step>
<para>To retrieve volume samples, you must configure the Block <para>To retrieve volume samples, you must configure the Block
Storage Service to send notifications to the bus.</para> Storage service to send notifications to the bus.</para>
<para os="debian;ubuntu">Edit <filename>/etc/cinder/cinder.conf</filename> <para os="debian;ubuntu">Edit <filename>/etc/cinder/cinder.conf</filename>
and add in the <literal>[DEFAULT]</literal> section:</para> and add in the <literal>[DEFAULT]</literal> section:</para>

18
doc/install-guide/section_cinder-controller.xml
View File

@ -2,7 +2,7 @@
xmlns:xi="http://www.w3.org/2001/XInclude" 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="cinder-controller"> xml:id="cinder-controller">
<title>Configure a Block Storage Service controller</title> <title>Configure a Block Storage service controller</title>
<note> <note>
<para>This section describes how to configure OpenStack Block Storage <para>This section describes how to configure OpenStack Block Storage
services on the <glossterm baseform="controller node">Controller node</glossterm> services on the <glossterm baseform="controller node">Controller node</glossterm>
@ -17,7 +17,7 @@
<procedure> <procedure>
<step> <step>
<para>Install the appropriate packages for the Block Storage <para>Install the appropriate packages for the Block Storage
Service:</para> service:</para>
<screen os="ubuntu;debian"><prompt>#</prompt> <userinput>apt-get install cinder-api cinder-scheduler</userinput></screen> <screen os="ubuntu;debian"><prompt>#</prompt> <userinput>apt-get install cinder-api cinder-scheduler</userinput></screen>
<screen os="centos;rhel;fedora"><prompt>#</prompt> <userinput>yum install openstack-cinder</userinput></screen> <screen os="centos;rhel;fedora"><prompt>#</prompt> <userinput>yum install openstack-cinder</userinput></screen>
<screen os="opensuse;sles"><prompt>#</prompt> <userinput>zypper install openstack-cinder-api openstack-cinder-scheduler</userinput></screen> <screen os="opensuse;sles"><prompt>#</prompt> <userinput>zypper install openstack-cinder-api openstack-cinder-scheduler</userinput></screen>
@ -50,7 +50,7 @@
connection = mysql://cinder:<replaceable>CINDER_DBPASS</replaceable>@<replaceable>controller</replaceable>/cinder</programlisting> connection = mysql://cinder:<replaceable>CINDER_DBPASS</replaceable>@<replaceable>controller</replaceable>/cinder</programlisting>
</step> </step>
<step os="rhel;centos;fedora;opensuse;sles"> <step os="rhel;centos;fedora;opensuse;sles">
<para>To create the Block Storage Service database and tables <para>To create the Block Storage service database and tables
and a <literal>cinder</literal> database user, run the and a <literal>cinder</literal> database user, run the
<command>openstack-db</command> command.</para> <command>openstack-db</command> command.</para>
<screen><prompt>#</prompt> <userinput>openstack-db --init --service cinder --password <replaceable>CINDER_DBPASS</replaceable></userinput></screen> <screen><prompt>#</prompt> <userinput>openstack-db --init --service cinder --password <replaceable>CINDER_DBPASS</replaceable></userinput></screen>
@ -67,13 +67,13 @@ IDENTIFIED BY '<replaceable>CINDER_DBPASS</replaceable>';</userinput></screen>
</step> </step>
<step os="ubuntu"> <step os="ubuntu">
<para>Create the database tables for the Block Storage <para>Create the database tables for the Block Storage
Service.</para> service.</para>
<screen><prompt>#</prompt> <userinput>cinder-manage db sync</userinput></screen> <screen><prompt>#</prompt> <userinput>cinder-manage db sync</userinput></screen>
</step> </step>
<step os="rhel;centos;fedora;opensuse;sles;ubuntu"> <step os="rhel;centos;fedora;opensuse;sles;ubuntu">
<para>Create a <literal>cinder</literal> user. The Block Storage <para>Create a <literal>cinder</literal> user. The Block Storage
Service uses this user to authenticate with the Identity service uses this user to authenticate with the Identity
Service. Use the <literal>service</literal> tenant and give service. Use the <literal>service</literal> tenant and give
the user the <literal>admin</literal> role.</para> the user the <literal>admin</literal> role.</para>
<screen><prompt>$</prompt> <userinput>keystone user-create --name=cinder --pass=<replaceable>CINDER_PASS</replaceable> --email=<replaceable>cinder@example.com</replaceable></userinput> <screen><prompt>$</prompt> <userinput>keystone user-create --name=cinder --pass=<replaceable>CINDER_PASS</replaceable> --email=<replaceable>cinder@example.com</replaceable></userinput>
<prompt>$</prompt> <userinput>keystone user-role-add --user=cinder --tenant=service --role=admin</userinput></screen> <prompt>$</prompt> <userinput>keystone user-role-add --user=cinder --tenant=service --role=admin</userinput></screen>
@ -132,7 +132,7 @@ rabbit_password = <replaceable>RABBIT_PASS</replaceable></programlisting>
</step> </step>
<step os="rhel;centos;fedora;opensuse;sles;ubuntu"> <step os="rhel;centos;fedora;opensuse;sles;ubuntu">
<para>Register the Block Storage Service with the Identity <para>Register the Block Storage service with the Identity
Service so that other OpenStack services can locate it. Service so that other OpenStack services can locate it.
Register the service and specify the endpoint using the Register the service and specify the endpoint using the
<command>keystone</command> command.</para> <command>keystone</command> command.</para>
@ -146,8 +146,8 @@ rabbit_password = <replaceable>RABBIT_PASS</replaceable></programlisting>
</step> </step>
<step os="rhel;centos;fedora;opensuse;sles;ubuntu"> <step os="rhel;centos;fedora;opensuse;sles;ubuntu">
<para>Also register a service and endpoint for version 2 of the <para>Also register a service and endpoint for version 2 of the
Block Storage Service API.</para> Block Storage service API.</para>
<screen><prompt>$</prompt> <userinput>keystone service-create --name=cinderv2 --type=volumev2 \ <screen><prompt>#</prompt> <userinput>keystone service-create --name=cinderv2 --type=volumev2 \
--description="OpenStack Block Storage v2"</userinput> --description="OpenStack Block Storage v2"</userinput>
<prompt>$</prompt> <userinput>keystone endpoint-create \ <prompt>$</prompt> <userinput>keystone endpoint-create \
--service-id=$(keystone service-list | awk '/ volumev2 / {print $2}') \ --service-id=$(keystone service-list | awk '/ volumev2 / {print $2}') \

10
doc/install-guide/section_cinder-node.xml
View File

@ -3,9 +3,9 @@
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"
xml:id="cinder-node"> xml:id="cinder-node">
<?dbhtml-stop-chunking?> <?dbhtml-stop-chunking?>
<title>Configure a Block Storage Service node</title> <title>Configure a Block Storage service node</title>
<para>After you configure the services on the controller node, <para>After you configure the services on the controller node,
configure a second system to be a Block Storage Service node. This configure a second system to be a Block Storage service node. This
node contains the disk that serves volumes.</para> node contains the disk that serves volumes.</para>
<para>You can configure OpenStack to use various storage systems. <para>You can configure OpenStack to use various storage systems.
The examples in this guide show you how to configure LVM.</para> The examples in this guide show you how to configure LVM.</para>
@ -68,7 +68,7 @@ filter = [ "a/sda1/", "a/sdb/", "r/.*/"]
</step> </step>
<step> <step>
<para>After you configure the operating system, install the <para>After you configure the operating system, install the
appropriate packages for the Block Storage Service:</para> appropriate packages for the Block Storage service:</para>
<screen os="ubuntu;debian"><prompt>#</prompt> <userinput>apt-get install cinder-volume</userinput></screen> <screen os="ubuntu;debian"><prompt>#</prompt> <userinput>apt-get install cinder-volume</userinput></screen>
<screen os="centos;rhel;fedora"><prompt>#</prompt> <userinput>yum install openstack-cinder</userinput></screen> <screen os="centos;rhel;fedora"><prompt>#</prompt> <userinput>yum install openstack-cinder</userinput></screen>
<screen os="opensuse;sles"><prompt>#</prompt> <userinput>zypper install openstack-cinder-volume</userinput></screen> <screen os="opensuse;sles"><prompt>#</prompt> <userinput>zypper install openstack-cinder-volume</userinput></screen>
@ -81,7 +81,7 @@ filter = [ "a/sda1/", "a/sdb/", "r/.*/"]
><literal>[keystone_authtoken]</literal> settings</link>, ><literal>[keystone_authtoken]</literal> settings</link>,
and <link linkend="debconf-rabbitqm">RabbitMQ and <link linkend="debconf-rabbitqm">RabbitMQ
credentials</link>. Make sure to enter the same details as credentials</link>. Make sure to enter the same details as
your Block Storage Service controller node.</para> your Block Storage service controller node.</para>
<para>Another screen prompts you for the <systemitem <para>Another screen prompts you for the <systemitem
class="library">volume-group</systemitem> to use. The Debian class="library">volume-group</systemitem> to use. The Debian
package configuration script detects every active volume package configuration script detects every active volume
@ -90,7 +90,7 @@ filter = [ "a/sda1/", "a/sdb/", "r/.*/"]
(this should be the case if you configured the volume group first, (this should be the case if you configured the volume group first,
as this guide recommends), and tries to use the first one it as this guide recommends), and tries to use the first one it
sees. If you have only one active volume group on your Block sees. If you have only one active volume group on your Block
Storage Service node, you do not need to manually enter its Storage service node, you do not need to manually enter its
name in when you install the <systemitem class="service" name in when you install the <systemitem class="service"
>cinder-volume</systemitem> package because it is detected >cinder-volume</systemitem> package because it is detected
automatically. If no <systemitem class="library" automatically. If no <systemitem class="library"

2
doc/security-guide/ch004_book-introduction.xml
View File

@ -161,7 +161,7 @@
<title>Block Storage</title> <title>Block Storage</title>
<para>The OpenStack Block Storage service (Cinder) provides <para>The OpenStack Block Storage service (Cinder) provides
persistent block storage for compute instances. The Block persistent block storage for compute instances. The Block
Storage Service is responsible for managing the life-cycle of Storage service is responsible for managing the life-cycle of
block devices, from the creation and attachment of volumes to block devices, from the creation and attachment of volumes to
instances, to their release.</para> instances, to their release.</para>
<para>Security considerations for block storage are similar to <para>Security considerations for block storage are similar to

2
doc/training-guides/bk001-ch004-associate-controller-node-quiz.xml
View File

@ -329,7 +329,7 @@
<listitem> <listitem>
<para>A, D, E - The following command-line clients are available for the respective services' APIs: <para>A, D, E - The following command-line clients are available for the respective services' APIs:
cinder(python-cinderclient) cinder(python-cinderclient)
Client for the Block Storage Service API. Use to create and manage volumes. Client for the Block Storage service API. Use to create and manage volumes.
glance(python-glanceclient) glance(python-glanceclient)
Client for the Image Service API. Use to create and manage images. Client for the Image Service API. Use to create and manage images.
keystone(python-keystoneclient) keystone(python-keystoneclient)

2
doc/training-guides/card040-cinder.xml
View File

@ -5,7 +5,7 @@
version="5.0" version="5.0"
xml:id="configure-block-storage"> xml:id="configure-block-storage">
<title>Install Cinder</title> <title>Install Cinder</title>
<!-- this maps to user story "Card040 - As an associate trainee I need to be able to install and configure OpenStack Block Storage Service in the Controller Node --> <!-- this maps to user story "Card040 - As an associate trainee I need to be able to install and configure OpenStack Block Storage service in the Controller Node -->
<!-- The basic install guide no longer exists. A new include needs to be found --> <!-- The basic install guide no longer exists. A new include needs to be found -->
<!-- <xi:include href="../install-guide/basic-install-files/basic-install_controller-cinder.xml" <!-- <xi:include href="../install-guide/basic-install-files/basic-install_controller-cinder.xml"

4
doc/training-guides/module001-ch006-overview-horizon-cli.xml
View File

@ -882,7 +882,7 @@
<para>The following command-line clients are available for the <para>The following command-line clients are available for the
respective services' APIs:</para> respective services' APIs:</para>
<para>cinder(python-cinderclient)</para> <para>cinder(python-cinderclient)</para>
<para>Client for the Block Storage Service API. Use to create <para>Client for the Block Storage service API. Use to create
and manage volumes.</para> and manage volumes.</para>
<para>glance(python-glanceclient)</para> <para>glance(python-glanceclient)</para>
<para>Client for the Image Service API. Use to create and manage <para>Client for the Image Service API. Use to create and manage
@ -949,7 +949,7 @@
<para>swift. Object Storage API.</para> <para>swift. Object Storage API.</para>
</listitem> </listitem>
<listitem> <listitem>
<para>cinder. Block Storage Service API.</para> <para>cinder. Block Storage service API.</para>
</listitem> </listitem>
<listitem> <listitem>
<para>heat. Orchestration API.</para> <para>heat. Orchestration API.</para>

2
doc/training-guides/sources/cinder/architecture.xml
View File

@ -25,7 +25,7 @@
<section xml:id="Cinder-System-Architecture"> <section xml:id="Cinder-System-Architecture">
<title>Block Storage System Architecture</title> <title>Block Storage System Architecture</title>
<para> <para>
The OpenStack Block Storage Service is intended to run on one or more nodes. The OpenStack Block Storage service is intended to run on one or more nodes.
Block Storage uses a SQL-based central database that is shared by all Block Storage services in the system. The amount and depth of the data fits into a SQL database quite well. For small deployments this seems like an optimal solution. For larger deployments, and especially if security is a concern, Block Storage will be moving towards multiple data stores with some kind of aggregation system. Block Storage uses a SQL-based central database that is shared by all Block Storage services in the system. The amount and depth of the data fits into a SQL database quite well. For small deployments this seems like an optimal solution. For larger deployments, and especially if security is a concern, Block Storage will be moving towards multiple data stores with some kind of aggregation system.
</para> </para>
</section> </section>

10
doc/user-guide-admin/section_cli_cinder_quotas.xml
View File

@ -5,7 +5,7 @@
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"> xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0">
<title>Manage Block Storage service quotas</title> <title>Manage Block Storage service quotas</title>
<para>As an administrative user, you can update the OpenStack Block <para>As an administrative user, you can update the OpenStack Block
Storage Service quotas for a project. You can also update the quota Storage service quotas for a project. You can also update the quota
defaults for a new project.</para> defaults for a new project.</para>
<para> <para>
<table rules="all"> <table rules="all">
@ -49,9 +49,9 @@
</table> </table>
</para> </para>
<section xml:id="cli_set_block_storage_quotas_procedure"> <section xml:id="cli_set_block_storage_quotas_procedure">
<title>View and update Block Storage Service quotas</title> <title>View and update Block Storage service quotas</title>
<para>As an administrative user, you can view and update Block <para>As an administrative user, you can view and update Block
Storage Service quotas.</para> Storage service quotas.</para>
<procedure> <procedure>
<step> <step>
<para>List the default quotas for all projects, as <para>List the default quotas for all projects, as
@ -74,7 +74,7 @@
<step> <step>
<para>View Block Storage Service quotas for a project, as <para>View Block Storage service quotas for a project, as
follows:</para> follows:</para>
<screen><prompt>$</prompt> <userinput>cinder quota-show <replaceable>TENANT_NAME</replaceable></userinput></screen> <screen><prompt>$</prompt> <userinput>cinder quota-show <replaceable>TENANT_NAME</replaceable></userinput></screen>
<para>For example:</para> <para>For example:</para>
@ -88,7 +88,7 @@
+-----------+-------+</computeroutput></screen> +-----------+-------+</computeroutput></screen>
</step> </step>
<step> <step>
<para>To update Block Storage Service quotas, place <para>To update Block Storage service quotas, place
the tenant ID in a usable variable, as the tenant ID in a usable variable, as
follows:</para> follows:</para>
<screen><prompt>$</prompt> <userinput>tenant=$(keystone tenant-list | awk '/<replaceable>tenantName</replaceable>/ {print $2}')</userinput></screen> <screen><prompt>$</prompt> <userinput>tenant=$(keystone tenant-list | awk '/<replaceable>tenantName</replaceable>/ {print $2}')</userinput></screen>