openstack/openstack-manuals
Code Issues Proposed changes

Clarify use of cinder manage-snapshot command

Browse Source 
The snapshot in the 'cinder mansage-snapshot' command refers
to a snapshot of a volume, but the documentation mentions
"A snapshot is an image created from a running instance". This is
misleading since that indicates that it is a Nova snapshot.
Also, it should be explicit that the volume refered to in the command
is the parent of the snapshot.

Change-Id: Ia958b571cbb59d5046661ff85f8545f4f56a140b
This commit is contained in:
scottda 2016-05-26 10:58:01 -06:00
parent 4481383d7c
commit 0b9ae2b39b
1 changed files with 5 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
doc/common/cli_manage_volumes.rst
View File

@ -574,7 +574,7 @@ Delete a volume transfer
Manage and unmanage a snapshot
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
A snapshot is an image created from a running instance. As an administrator,
A snapshot is a point in time version of a volume. As an administrator,
you can manage and unmanage snapshots.
Manage a snapshot
@ -589,7 +589,8 @@ Manage a snapshot with the :command:`cinder snapshot-manage` command:
The arguments to be passed are:
``VOLUME_ID``
The ID of an already existent volume.
The ID of a volume that is the parent of the snapshot, and managed by the
Block Storage service.
``IDENTIFIER``
Name, ID, or other identifier for an existing snapshot.
@ -607,8 +608,8 @@ The arguments to be passed are:
:option:`--metadata`
Metadata key-value pairs. Defaults to ``None``.
The following example manages the ``my-snapshot-id`` image in the
``my-volume-id`` volume:
The following example manages the ``my-snapshot-id`` snapshot with the
``my-volume-id`` parent volume:
.. code-block:: console