openstack/python-openstackclient
Code Issues Proposed changes

Use Block Storage instead of Volume

Browse Source 
Volume is better to be replaced by Block Storage in the
doc.

Change-Id: I736669ee01c7385b6e701cb20f4334eff1c49286
This commit is contained in:
Xi Yang 2015-11-08 22:05:15 +08:00
parent 8d523266fc
commit 54b0ef3358
16 changed files with 28 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.rst
View File

@ -11,8 +11,8 @@ OpenStackClient
:alt: Downloads
OpenStackClient (aka OSC) is a command-line client for OpenStack that brings
the command set for Compute, Identity, Image, Object Store and Volume APIs
together in a single shell with a uniform command structure.
the command set for Compute, Identity, Image, Object Store and Block Storage
APIs together in a single shell with a uniform command structure.
The primary goal is to provide a unified shell command structure and a common
language to describe operations in OpenStack.

2
doc/source/command-objects/backup.rst
View File

@ -2,7 +2,7 @@
backup
======
Volume v1
Block Storage v1
backup create
-------------

2
doc/source/command-objects/extension.rst
View File

@ -34,7 +34,7 @@ List API extensions
.. option:: --volume
List extensions for the Volume API
List extensions for the Block Storage API
.. option:: --long

6
doc/source/command-objects/limits.rst
View File

@ -2,14 +2,14 @@
limits
======
The Compute and Volume APIs have resource usage limits.
The Compute and Block Storage APIs have resource usage limits.
Compute v2, Volume v1
Compute v2, Block Storage v1
limits show
-----------
Show compute and volume limits
Show compute and block storage limits
.. program:: limits show
.. code:: bash

8
doc/source/command-objects/quota.rst
View File

@ -4,7 +4,7 @@ quota
Resource quotas appear in multiple APIs, OpenStackClient presents them as a single object with multiple properties.
Compute v2, Volume v1
Compute v2, Block Storage v1
quota set
---------
@ -26,7 +26,7 @@ Set quotas for project
[--properties <num-properties>]
[--ram <ram-mb>]
# Volume settings
# Block Storage settings
[--gigabytes <new-gigabytes>]
[--snapshots <new-snapshots>]
[--volumes <new-volumes>]
@ -51,7 +51,7 @@ Set quotas for class
[--properties <num-properties>]
[--ram <ram-mb>]
# Volume settings
# Block Storage settings
[--gigabytes <new-gigabytes>]
[--snapshots <new-snapshots>]
[--volumes <new-volumes>]
@ -161,4 +161,4 @@ Show quotas for project
.. _quota_show-class:
.. describe:: <class>
Class to show
Class to show

2
doc/source/command-objects/snapshot.rst
View File

@ -2,7 +2,7 @@
snapshot
========
Volume v1
Block Storage v1
snapshot create
---------------

2
doc/source/command-objects/volume-qos.rst
View File

@ -2,7 +2,7 @@
volume qos
==========
volume v1, v2
Block Storage v1, v2
volume qos associate
--------------------

2
doc/source/command-objects/volume-type.rst
View File

@ -2,7 +2,7 @@
volume type
===========
Volume v1, v2
Block Storage v1, v2
volume type create
------------------

2
doc/source/command-objects/volume.rst
View File

@ -2,7 +2,7 @@
volume
======
Volume v1, v2
Block Storage v1, v2
volume create
-------------

2
doc/source/commands.rst
View File

@ -70,7 +70,7 @@ the API resources will be merged, as in the ``quota`` object that has options
referring to both Compute and Volume quotas.
* ``access token``: (**Identity**) long-lived OAuth-based token
* ``availability zone``: (**Compute**) a logical partition of hosts or volume services
* ``availability zone``: (**Compute**) a logical partition of hosts or block storage services
* ``aggregate``: (**Compute**) a grouping of servers
* ``backup``: (**Volume**) a volume copy
* ``catalog``: (**Identity**) service catalog

5
doc/source/index.rst
View File

@ -3,8 +3,9 @@ OpenStackClient
===============
OpenStackClient (aka OSC) is a command-line client for OpenStack that
brings the command set for Compute, Identity, Image, Object Storage and Volume
APIs together in a single shell with a uniform command structure.
brings the command set for Compute, Identity, Image, Object Storage and
Block Storage APIs together in a single shell with a uniform command
structure.
User Documentation
------------------

2
doc/source/man/openstack.rst
View File

@ -171,7 +171,7 @@ project support. The object names may consist of multiple words to compose a
unique name. Occasionally when multiple APIs have a common name with common
overlapping purposes there will be options to select which object to use, or
the API resources will be merged, as in the ``quota`` object that has options
referring to both Compute and Volume quotas.
referring to both Compute and Block Storage quotas.
Command Actions
---------------

5
doc/source/plugins.rst
View File

@ -11,8 +11,9 @@ Adoption
========
OpenStackClient promises to provide first class support for the following
OpenStack services: Compute, Identity, Image, Storage, Volume and Network.
These services are considered essential to any OpenStack deployment.
OpenStack services: Compute, Identity, Image, Object Storage, Block Storage
and Network. These services are considered essential to any OpenStack
deployment.
Other OpenStack services, such as Orchestration or Telemetry may create an
OpenStackClient plugin. The source code will not be hosted by

4
doc/source/releases.rst
View File

@ -133,12 +133,12 @@ Release Notes
* Add ``--log-file`` option support
* Set default Volume API version to ``2``
* Set default Block Storage API version to ``2``
1.6.0 (10 Aug 2015)
===================
* Added support for Volume v2 APIs
* Added support for Block Storage v2 APIs
Blueprint `volume-v2 <https://blueprints.launchpad.net/python-openstackclient/+spec/volume-v2>`_
* Backup

4
openstackclient/common/extension.py
View File

@ -49,7 +49,7 @@ class ListExtension(lister.Lister):
'--volume',
action='store_true',
default=False,
help='List extensions for the Volume API')
help='List extensions for the Block Storage API')
parser.add_argument(
'--long',
action='store_true',
@ -95,7 +95,7 @@ class ListExtension(lister.Lister):
try:
data += volume_client.list_extensions.show_all()
except Exception:
message = "Extensions list not supported by Volume API"
message = "Extensions list not supported by Block Storage API"
self.log.warning(message)
# Resource classes for the above

2
openstackclient/common/limits.py
View File

@ -25,7 +25,7 @@ from openstackclient.identity import common as identity_common
class ShowLimits(lister.Lister):
"""Show compute and volume limits"""
"""Show compute and block storage limits"""
log = logging.getLogger(__name__ + '.ShowLimits')