From 5fca287eb58d87419ff0d179b81df702c9cf33b4 Mon Sep 17 00:00:00 2001 From: Don Domingo Date: Wed, 19 Mar 2014 13:07:11 +1000 Subject: [PATCH] Apply service name conventions for Block Storage 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 --- doc/admin-guide-cloud/ch_blockstorage.xml | 10 +++--- doc/admin-guide-cloud/ch_compute.xml | 8 ++--- .../section_backup-block-storage-disks.xml | 8 ++--- .../section_ts_cinder_config.xml | 36 +++++++++---------- .../section_volume-migration.xml | 13 ++++--- doc/common/section_cli_install.xml | 2 +- doc/common/section_cli_version.xml | 2 +- doc/common/section_getstart_block-storage.xml | 16 ++++----- .../backup/ceph-backup-driver.xml | 2 +- .../block-storage/drivers/coraid-driver.xml | 8 ++--- .../block-storage/drivers/hp-3par-driver.xml | 8 ++--- .../drivers/hp-lefthand-driver.xml | 8 ++--- .../drivers/ibm-gpfs-volume-driver.xml | 2 +- .../ch_blockstorageconfigure.xml | 4 +-- .../bk_openstackinstallguide.xml | 8 ++--- doc/install-guide/ch_basics.xml | 4 +-- doc/install-guide/ch_cinder.xml | 8 ++--- .../section_ceilometer-cinder.xml | 4 +-- .../section_cinder-controller.xml | 18 +++++----- doc/install-guide/section_cinder-node.xml | 10 +++--- .../ch004_book-introduction.xml | 2 +- ...1-ch004-associate-controller-node-quiz.xml | 2 +- doc/training-guides/card040-cinder.xml | 2 +- .../module001-ch006-overview-horizon-cli.xml | 4 +-- .../sources/cinder/architecture.xml | 2 +- .../section_cli_cinder_quotas.xml | 10 +++--- 26 files changed, 100 insertions(+), 101 deletions(-) diff --git a/doc/admin-guide-cloud/ch_blockstorage.xml b/doc/admin-guide-cloud/ch_blockstorage.xml index 9822c6e5b9..bd946549e9 100644 --- a/doc/admin-guide-cloud/ch_blockstorage.xml +++ b/doc/admin-guide-cloud/ch_blockstorage.xml @@ -26,10 +26,10 @@ xlink:href="http://docs.openstack.org/trunk/openstack-ops/content/storage_decision.html" >Storage Decisions in the OpenStack Operations Guide. - The OpenStack Block Storage Service enables you to add - extra block-level storage to your OpenStack Compute - instances. This service is similar to the Amazon EC2 - Elastic Block Storage (EBS) offering. + OpenStack Block Storage enables you to add extra + block-level storage to your OpenStack Compute instances. + This service is similar to the Amazon EC2 Elastic Block + Storage (EBS) offering.
@@ -129,7 +129,7 @@
Troubleshoot your installation This section provides useful tips to help troubleshoot - your Block Storage Service installation. + your Block Storage installation. diff --git a/doc/admin-guide-cloud/ch_compute.xml b/doc/admin-guide-cloud/ch_compute.xml index 1059c6676e..7fcb64a4dc 100644 --- a/doc/admin-guide-cloud/ch_compute.xml +++ b/doc/admin-guide-cloud/ch_compute.xml @@ -1657,7 +1657,7 @@ net.bridge.bridge-nf-call-ip6tables=0
Volumes - The Block Storage Service provides persistent block + OpenStack Block Storage provides persistent block storage resources that OpenStack Compute instances can consume. See the OpenStack Configuration @@ -2018,10 +2018,10 @@ qualname = nova send logging information to syslog. This is useful if you want to use rsyslog, which forwards the logs to a remote machine. You need to separately - configure the Compute service (Nova), the Identity - Service (Keystone), the Image Service (Glance), + configure the Compute service (nova), the Identity + service (keystone), the Image Service (glance), 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: diff --git a/doc/admin-guide-cloud/section_backup-block-storage-disks.xml b/doc/admin-guide-cloud/section_backup-block-storage-disks.xml index bff73cc3f9..0f720e6110 100644 --- a/doc/admin-guide-cloud/section_backup-block-storage-disks.xml +++ b/doc/admin-guide-cloud/section_backup-block-storage-disks.xml @@ -7,7 +7,7 @@ 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"> - Back up Block Storage Service disks + Back up Block Storage service disks While you can use the LVM snapshot to create snapshots, you can also use it to back up your volumes. By using LVM snapshot, you reduce the size of the backup; only existing @@ -53,7 +53,7 @@ You can apply this process to volumes of any size. - To back up Block Storage Service disks + To back up Block Storage service disks Create a snapshot of a used volume @@ -131,7 +131,7 @@ Block device 251:14 To exploit the snapshot with the tar command, mount your - partition on the Block Storage Service + partition on the Block Storage service server. The kpartx utility discovers and maps table partitions. You @@ -247,7 +247,7 @@ Block device 251:14 the setting. Launch this script from the server that runs the - Block Storage Service. + Block Storage service. This example shows a mail report: Backup Start Time - 07/10 at 01:00:01 Current retention - 7 days diff --git a/doc/admin-guide-cloud/section_ts_cinder_config.xml b/doc/admin-guide-cloud/section_ts_cinder_config.xml index 8a69d579fd..73a4ebb6e6 100644 --- a/doc/admin-guide-cloud/section_ts_cinder_config.xml +++ b/doc/admin-guide-cloud/section_ts_cinder_config.xml @@ -10,24 +10,24 @@ linkend="section_ts_cinder_config"> Troubleshoot the Block Storage configuration - This section helps you solve some basic and common errors - that you might encounter during setup and configuration of the - Block Storage Service. The focus here is on failed - creation of volumes. The most important thing to know is where - to look in case of a failure. - Two log files are especially helpful for solving volume - creation failures, the cinder-api log and the cinder-volume log. The - cinder-api log is - useful for determining if you have endpoint or connectivity - issues. If you send a request to create a volume and it fails, - review the cinder-api log to determine whether the request - made it to the Block Storage service. If the request is logged - and you see no errors or trace-backs, check the - cinder-volume log - for errors or trace-backs. + Most Block Storage errors are caused by incorrect volume + configurations that result in volume creation failues. To resolve + these failures, review these logs: + + cinder-api + log (/var/log/cinder/api.log) + cinder-volume + log (/var/log/cinder/volume.log) + + The cinder-api log + is useful for determining if you have endpoint or connectivity + issues. If you send a request to create a volume and it fails, + review the cinder-api + log to determine whether the request made it to the Block Storage + service. If the request is logged and you see no errors or + trace-backs, check the + cinder-volume log for + errors or trace-backs. Create commands are listed in the cinder-api log. diff --git a/doc/admin-guide-cloud/section_volume-migration.xml b/doc/admin-guide-cloud/section_volume-migration.xml index 85bfb3254b..a13a13d03a 100644 --- a/doc/admin-guide-cloud/section_volume-migration.xml +++ b/doc/admin-guide-cloud/section_volume-migration.xml @@ -19,12 +19,11 @@ Block Storage driver to enable optimizations that the storage might be able to perform. If the back-end is not able to perform the migration, the Block Storage - Service uses one of two generic flows, as - follows. + uses one of two generic flows, as follows. 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. While most back-ends support this function, not all do. @@ -37,10 +36,10 @@ If the volume is attached to a VM instance, the - Block Storage Service creates a volume, and calls - Compute to copy the data from the original to the new - volume. Currently this is supported only by the - Compute libvirt driver. + Block Storage creates a volume, and calls Compute to + copy the data from the original to the new volume. + Currently this is supported only by the Compute + libvirt driver. As an example, this scenario shows two LVM back-ends and diff --git a/doc/common/section_cli_install.xml b/doc/common/section_cli_install.xml index 6145fa68f7..2709361ecf 100644 --- a/doc/common/section_cli_install.xml +++ b/doc/common/section_cli_install.xml @@ -181,7 +181,7 @@ cinder - Block Storage - Service API and extensions. + API and extensions. glance - Image Service diff --git a/doc/common/section_cli_version.xml b/doc/common/section_cli_version.xml index 9bac2dfb5e..a48a015609 100644 --- a/doc/common/section_cli_version.xml +++ b/doc/common/section_cli_version.xml @@ -15,7 +15,7 @@ cinder - Block Storage - Service API and extensions. + API and extensions. glance - Image Service diff --git a/doc/common/section_getstart_block-storage.xml b/doc/common/section_getstart_block-storage.xml index 17909f9ac7..6036cd41a8 100644 --- a/doc/common/section_getstart_block-storage.xml +++ b/doc/common/section_getstart_block-storage.xml @@ -2,20 +2,20 @@ xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0" xml:id="block-storage-service"> - Block Storage Service - The Block Storage Service enables management of volumes, + Block Storage + The Block Storage service enables management of volumes, volume snapshots, and volume types. It includes the following components: - cinder-api. + cinder-api: Accepts API requests and routes them to cinder-volume for action. cinder-volume. Responds to requests to read + >cinder-volume: Responds to requests to read from and write to the Block Storage database to maintain state, interacting with other processes (like cinder-scheduler) through a @@ -25,16 +25,16 @@ cinder-scheduler daemon. Like the + >cinder-scheduler daemon: Like the nova-scheduler, picks the optimal block storage provider node on which to create the volume. - Messaging queue. Routes information between the Block - Storage Service processes. + Messaging queue: Routes information between the Block + Storage service processes. - The Block Storage Service interacts with Compute to + The Block Storage service interacts with Compute to provide volumes for instances.
diff --git a/doc/config-reference/block-storage/backup/ceph-backup-driver.xml b/doc/config-reference/block-storage/backup/ceph-backup-driver.xml index fdd9476198..b79956123f 100644 --- a/doc/config-reference/block-storage/backup/ceph-backup-driver.xml +++ b/doc/config-reference/block-storage/backup/ceph-backup-driver.xml @@ -29,7 +29,7 @@ less time to restore a volume than to take a full copy. - Block Storage Service enables you to: + Block Storage enables you to: Restore to a new volume, which diff --git a/doc/config-reference/block-storage/drivers/coraid-driver.xml b/doc/config-reference/block-storage/drivers/coraid-driver.xml index 60af381974..bc162f1e06 100644 --- a/doc/config-reference/block-storage/drivers/coraid-driver.xml +++ b/doc/config-reference/block-storage/drivers/coraid-driver.xml @@ -24,7 +24,7 @@ This document describes how to configure the OpenStack Block - Storage Service for use with Coraid storage appliances. + Storage service for use with Coraid storage appliances.
Terminology These terms are used in this section: @@ -70,14 +70,14 @@
Requirements - To support the OpenStack Block Storage Service, your SAN + To support the OpenStack Block Storage service, your SAN 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 v2.1.1 for storage repository orchestration. Ensure that all storage appliances are installed and connected to your network before you configure OpenStack volumes. - So that the node can communicate with the SAN, you must - install the Coraid AoE Linux driver on each compute node on the + In order for the node to communicate with the SAN, you must + install the Coraid AoE Linux driver on each Compute node on the network that runs an OpenStack instance.
diff --git a/doc/config-reference/block-storage/drivers/hp-3par-driver.xml b/doc/config-reference/block-storage/drivers/hp-3par-driver.xml index 6d18adf740..d961c371b2 100644 --- a/doc/config-reference/block-storage/drivers/hp-3par-driver.xml +++ b/doc/config-reference/block-storage/drivers/hp-3par-driver.xml @@ -4,7 +4,7 @@ HP 3PAR Fibre Channel and iSCSI drivers The HP3PARFCDriver and HP3PARISCSIDriver 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 HP 3PAR storage system over HTTP, HTTPS, and SSH connections. The HTTP and HTTPS communications use @@ -33,7 +33,7 @@ Additionally, you must install the hp3parclient version 3.0 or newer from the Python standard library on the - system with the enabled Block Storage Service + system with the enabled Block Storage service volume drivers. @@ -117,7 +117,7 @@ If volume types are not used or a particular key is not set for a volume type, the following defaults are - used. + used: hp3par:cpg - Defaults to the @@ -387,7 +387,7 @@ hp3par_snapshot_expiration=72 The HP 3PAR Fibre Channel and iSCSI drivers are now 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.
diff --git a/doc/config-reference/block-storage/drivers/hp-lefthand-driver.xml b/doc/config-reference/block-storage/drivers/hp-lefthand-driver.xml index 73eada2d73..3272b340cd 100644 --- a/doc/config-reference/block-storage/drivers/hp-lefthand-driver.xml +++ b/doc/config-reference/block-storage/drivers/hp-lefthand-driver.xml @@ -6,7 +6,7 @@ The HPLeftHandISCSIDriver 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 HTTPS, or SSH connections. HTTPS communications use the hplefthandclient, @@ -59,7 +59,7 @@ Install the hplefthandclient version 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. @@ -308,7 +308,7 @@ hplefthand_debug=false The HP LeftHand/StoreVirtual driver is now enabled in 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. @@ -423,7 +423,7 @@ san_is_local=False The HP LeftHand/StoreVirtual driver is now enabled in 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. To configure the VSA diff --git a/doc/config-reference/block-storage/drivers/ibm-gpfs-volume-driver.xml b/doc/config-reference/block-storage/drivers/ibm-gpfs-volume-driver.xml index 944e0241dd..e97d07e939 100644 --- a/doc/config-reference/block-storage/drivers/ibm-gpfs-volume-driver.xml +++ b/doc/config-reference/block-storage/drivers/ibm-gpfs-volume-driver.xml @@ -41,7 +41,7 @@
Enable the GPFS driver - To use the Block Storage Service with the GPFS driver, first set the + To use the Block Storage service with the GPFS driver, first set the volume_driver in cinder.conf: volume_driver = cinder.volume.drivers.gpfs.GPFSDriver diff --git a/doc/config-reference/ch_blockstorageconfigure.xml b/doc/config-reference/ch_blockstorageconfigure.xml index 8718a3e54b..4c29d32e48 100644 --- a/doc/config-reference/ch_blockstorageconfigure.xml +++ b/doc/config-reference/ch_blockstorageconfigure.xml @@ -8,14 +8,14 @@ xmlns:ns3="http://www.w3.org/1998/Math/MathML" xmlns:ns="http://docbook.org/ns/docbook"> Block Storage - The OpenStack Block Storage Service works with many different + The OpenStack Block Storage service works with many different storage drivers that you can configure by using these instructions.
<filename>cinder.conf</filename> configuration file The cinder.conf file is installed in /etc/cinder by default. When you manually - install the Block Storage Service, the options in the + install the Block Storage service, the options in the cinder.conf file are set to default values. This example shows a typical cinder.conf file: diff --git a/doc/install-guide/bk_openstackinstallguide.xml b/doc/install-guide/bk_openstackinstallguide.xml index 53f06b173b..2838cd9389 100644 --- a/doc/install-guide/bk_openstackinstallguide.xml +++ b/doc/install-guide/bk_openstackinstallguide.xml @@ -51,10 +51,10 @@ projects that you install separately but that work together depending on your cloud needs. These projects include Compute, Identity Service, Networking, Image - Service, Block Storage Service, Object Storage, - Telemetry, and Orchestration. You can install any of - these projects separately and configure them - standalone or as connected entities. This guide walks through an installation by using packages available through Debian 7.0 (code name: Wheezy). diff --git a/doc/install-guide/ch_basics.xml b/doc/install-guide/ch_basics.xml index 2d5767fdab..67de6fa6b2 100644 --- a/doc/install-guide/ch_basics.xml +++ b/doc/install-guide/ch_basics.xml @@ -325,11 +325,11 @@ iface eth1 inet static CINDER_DBPASS - Database password for the Block Storage Service + Database password for the Block Storage service CINDER_PASS - Password of Block Storage Service user cinder + Password of Block Storage service user cinder NEUTRON_DBPASS diff --git a/doc/install-guide/ch_cinder.xml b/doc/install-guide/ch_cinder.xml index 721bc55ed2..28c69f7fac 100644 --- a/doc/install-guide/ch_cinder.xml +++ b/doc/install-guide/ch_cinder.xml @@ -3,15 +3,15 @@ xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0" xml:id="ch_cinder"> - Add the Block Storage Service - The OpenStack Block Storage Service works through the + Add the Block Storage service + The OpenStack Block Storage service works through the interaction of a series of daemon processes named cinder-* that reside persistently on 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 same node as other OpenStack services. The following sections - introduce Block Storage Service components and concepts and show - you how to configure and install the Block Storage Service. + introduce Block Storage service components and concepts and show + you how to configure and install the Block Storage service. diff --git a/doc/install-guide/section_ceilometer-cinder.xml b/doc/install-guide/section_ceilometer-cinder.xml index 020e4a6702..6ad5693425 100644 --- a/doc/install-guide/section_ceilometer-cinder.xml +++ b/doc/install-guide/section_ceilometer-cinder.xml @@ -4,11 +4,11 @@ xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"> - Configure the Block Storage service for Telemetry + Add the Block Storage service agent for Telemetry To retrieve volume samples, you must configure the Block - Storage Service to send notifications to the bus. + Storage service to send notifications to the bus. Edit /etc/cinder/cinder.conf and add in the [DEFAULT] section: diff --git a/doc/install-guide/section_cinder-controller.xml b/doc/install-guide/section_cinder-controller.xml index bac83b63a2..6b5128d62d 100644 --- a/doc/install-guide/section_cinder-controller.xml +++ b/doc/install-guide/section_cinder-controller.xml @@ -2,7 +2,7 @@ xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0" xml:id="cinder-controller"> - Configure a Block Storage Service controller + Configure a Block Storage service controller This section describes how to configure OpenStack Block Storage services on the Controller node @@ -17,7 +17,7 @@ Install the appropriate packages for the Block Storage - Service: + service: # apt-get install cinder-api cinder-scheduler # yum install openstack-cinder # zypper install openstack-cinder-api openstack-cinder-scheduler @@ -50,7 +50,7 @@ connection = mysql://cinder:CINDER_DBPASS@controller/cinder - To create the Block Storage Service database and tables + To create the Block Storage service database and tables and a cinder database user, run the openstack-db command. # openstack-db --init --service cinder --password CINDER_DBPASS @@ -67,13 +67,13 @@ IDENTIFIED BY 'CINDER_DBPASS'; Create the database tables for the Block Storage - Service. + service. # cinder-manage db sync Create a cinder user. The Block Storage - Service uses this user to authenticate with the Identity - Service. Use the service tenant and give + service uses this user to authenticate with the Identity + service. Use the service tenant and give the user the admin role. $ keystone user-create --name=cinder --pass=CINDER_PASS --email=cinder@example.com $ keystone user-role-add --user=cinder --tenant=service --role=admin @@ -132,7 +132,7 @@ rabbit_password = RABBIT_PASS - Register the Block Storage Service with the Identity + Register the Block Storage service with the Identity Service so that other OpenStack services can locate it. Register the service and specify the endpoint using the keystone command. @@ -146,8 +146,8 @@ rabbit_password = RABBIT_PASS Also register a service and endpoint for version 2 of the - Block Storage Service API. - $ keystone service-create --name=cinderv2 --type=volumev2 \ + Block Storage service API. + # keystone service-create --name=cinderv2 --type=volumev2 \ --description="OpenStack Block Storage v2" $ keystone endpoint-create \ --service-id=$(keystone service-list | awk '/ volumev2 / {print $2}') \ diff --git a/doc/install-guide/section_cinder-node.xml b/doc/install-guide/section_cinder-node.xml index 395797d650..6ae506ecc4 100644 --- a/doc/install-guide/section_cinder-node.xml +++ b/doc/install-guide/section_cinder-node.xml @@ -3,9 +3,9 @@ xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0" xml:id="cinder-node"> - Configure a Block Storage Service node + Configure a Block Storage service node 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. You can configure OpenStack to use various storage systems. The examples in this guide show you how to configure LVM. @@ -68,7 +68,7 @@ filter = [ "a/sda1/", "a/sdb/", "r/.*/"] After you configure the operating system, install the - appropriate packages for the Block Storage Service: + appropriate packages for the Block Storage service: # apt-get install cinder-volume # yum install openstack-cinder # zypper install openstack-cinder-volume @@ -81,7 +81,7 @@ filter = [ "a/sda1/", "a/sdb/", "r/.*/"] >[keystone_authtoken] settings, and RabbitMQ credentials. Make sure to enter the same details as - your Block Storage Service controller node. + your Block Storage service controller node. Another screen prompts you for the volume-group to use. The Debian 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, as this guide recommends), and tries to use the first one it 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 cinder-volume package because it is detected automatically. If no Block Storage The OpenStack Block Storage service (Cinder) provides 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 instances, to their release. Security considerations for block storage are similar to diff --git a/doc/training-guides/bk001-ch004-associate-controller-node-quiz.xml b/doc/training-guides/bk001-ch004-associate-controller-node-quiz.xml index 3209557fc3..7d17c34474 100644 --- a/doc/training-guides/bk001-ch004-associate-controller-node-quiz.xml +++ b/doc/training-guides/bk001-ch004-associate-controller-node-quiz.xml @@ -329,7 +329,7 @@ A, D, E - The following command-line clients are available for the respective services' APIs: 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) Client for the Image Service API. Use to create and manage images. keystone(python-keystoneclient) diff --git a/doc/training-guides/card040-cinder.xml b/doc/training-guides/card040-cinder.xml index b6abe2dade..57a963ca70 100644 --- a/doc/training-guides/card040-cinder.xml +++ b/doc/training-guides/card040-cinder.xml @@ -5,7 +5,7 @@ version="5.0" xml:id="configure-block-storage"> Install Cinder - +