openstack/openstack-manuals
Code Issues Proposed changes

New consistency group APIs

Browse Source 
In Kilo, two new APIs were added to support consistency groups
in Cinder:
* Modify consistency groups.
* Create consistency group from a snapshot of a consistency group.
This patch adds documentation for the new APIs.

Closes-Bug: 1362882

Change-Id: Ibf9c5dcb5726cea470c5874542ea4df19933179c
This commit is contained in:
Xing Yang 2015-04-22 13:13:10 -04:00 committed by Tom Fifield
parent 0398ba26bb
commit 89be20126e
1 changed files with 34 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
doc/admin-guide-cloud/blockstorage/section_consistency_groups.xml
View File

@ -85,6 +85,13 @@
<listitem> <listitem>
<para>Delete a consistency group.</para> <para>Delete a consistency group.</para>
</listitem> </listitem>
<listitem>
<para>Modify a consistency group.</para>
</listitem>
<listitem>
<para>Create a consistency group from the snapshot of another
consistency group.</para>
</listitem>
</itemizedlist> </itemizedlist>
<para>The following operations are not allowed if a volume <para>The following operations are not allowed if a volume
is in a consistency group:</para> is in a consistency group:</para>
@ -220,4 +227,31 @@ volume-types</screen>
<note><para>The force flag is needed when there are volumes in the <note><para>The force flag is needed when there are volumes in the
consistency group.</para></note> consistency group.</para></note>
<screen><prompt>$</prompt> <userinput>cinder consisgroup-delete --force 1de80c27-3b2f-47a6-91a7-e867cbe36462</userinput></screen> <screen><prompt>$</prompt> <userinput>cinder consisgroup-delete --force 1de80c27-3b2f-47a6-91a7-e867cbe36462</userinput></screen>
<para>Modify a consistency group:</para>
<screen>cinder consisgroup-update
[--name <replaceable>NAME</replaceable>]
[--description <replaceable>DESCRIPTION</replaceable>]
[--add-volumes <replaceable>UUID1,UUID2,......</replaceable>]
[--remove-volumes <replaceable>UUID3,UUID4,......</replaceable>]
<replaceable>CG</replaceable></screen>
<para>The parameter <replaceable>CG</replaceable> is required.
It can be a name or UUID of a consistency group.
<replaceable>UUID1,UUID2,......</replaceable> are
UUIDs of one or more volumes to be added to the
consistency group, separated by commas. Default is None.
<replaceable>UUID3,UUId4,......</replaceable> are
UUIDs of one or more volumes to be removed from the
consistency group, separated by commas. Default is None.
</para>
<screen><prompt>$</prompt> <userinput>cinder consisgroup-update --name 'new name' --description 'new description' --add-volumes 0b3923f5-95a4-4596-a536-914c2c84e2db,1c02528b-3781-4e32-929c-618d81f52cf3 --remove-volumes 8c0f6ae4-efb1-458f-a8fc-9da2afcc5fb1,a245423f-bb99-4f94-8c8c-02806f9246d8 1de80c27-3b2f-47a6-91a7-e867cbe36462</userinput></screen>
<para>Create a consistency group from the snapshot of another consistency
group:
</para>
<screen>cinder consisgroup-create-from-src
[--cgsnapshot <replaceable>CGSNAPSHOT</replaceable>]
[--name <replaceable>NAME</replaceable>]
[--description <replaceable>DESCRIPTION</replaceable>]</screen>
<para>The parameter <replaceable>CGSNAPSHOT</replaceable> is a name
or UUID of a snapshot of a consistency group.</para>
<screen><prompt>$</prompt> <userinput>cinder consisgroup-create-from-src --cgsnapshot 6d9dfb7d-079a-471e-b75a-6e9185ba0c38 --name 'new cg' --description 'new cg from cgsnapshot'</userinput></screen>
</section> </section>