summaryrefslogtreecommitdiff
path: root/doc/source/command-objects/volume.rst
Commit message (Collapse)AuthorAgeFilesLines
* reorganize existing documentation according to the new standard layoutDoug Hellmann2017-06-231-403/+0
| | | | | | | | | | | | | Move existing content around based on the doc-migration specification. Replace :doc: markup with :ref: to have sphinx keep track of where the files move and generate valid hyperlinks. Add a few toctrees and index pages for the new directories. Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454 Change-Id: I253ee8f89d3ec40e39310c18bb87ed1d3d5de330 Signed-off-by: Doug Hellmann <doug@doughellmann.com>
* Help/docs cleanups: marker, limit, ip-address metavarsDean Troyer2017-04-041-4/+4
| | | | | | | | | | | | Cleanup help strings and docs for clarity and to keep things consistent: * --limit metavar should be <num-resource> to indicate what is being counted * --marker metavar should be <resource> or <resource-id> to indicate the type of value being specified * <*-ip-address> metavars should be just <ip-address> as there is no difference in format between fixed and floating IPs * Move all occurances of '(name or ID)' to end of help text Change-Id: I2c31746ed6ded3845244e03e57d809f8bc0e6b9d
* doc: Correct Sphinx warningsStephen Finucane2017-03-281-8/+8
| | | | | | | | | | | | | | | - Fix option-describe typos - Correct option and envvar markup, for commands that are using the reference form instead of the definition form or are marking up option arguments as options - Avoid duplicate commands - Fix some invalid docstrings - Fix some invalid indentation - Disable the murano plugin, which has invalid docs - Correct issues with- and track the network-topology spec - Include API modules in docs Change-Id: I3d5ed5e872540fe13f3e4bd5e9335829dc9a5226
* Support --no-property in "volume set" commandzhiyong.dai2017-02-231-1/+8
| | | | | | | Add "--no-property" option to "volume set" command in v1 and v2 and update the test cases. Change-Id: Id5660f23b3b2d9aa72f4c16b19ce83f3f7ed2fa4
* change os in command example to openstack(3)Kevin_Zheng2016-12-201-7/+7
| | | | | | | | | In the current doc, the command examples are like "os server create" but the acutal command should be started with "openstack" instead of "os", it is misleading to first time users. Change-Id: Ie67c0152d8ff8b7c456f91dc8b9a9164437ee9d1
* Add some options to "volume create" commandjiahui.qiang2016-12-061-0/+18
| | | | | | | | Add "--bootable", "--non-bootable", "--read-only" and "--read-write" options to "volume create" command for setting some attributes at the time of crration. Change-Id: I71b4e9fccb4ee0ab1a90e7179d6d2d34dbbae909 Implements: bp cinder-command-support
* Add "--type" and "--retype-policy" options to "volume set" commandHuanxuan Ao2016-11-231-0/+16
| | | | | | | | | Add "--type" and "--retype-policy" options to "volume set" command in volume v2 (v2 only) to support changing the volume type for a volume Change-Id: I0153abdb967aee790586a57cef31930e32005c1b Implements: bp cinder-command-support
* Merge "Add "--read-only" and "--read-write" options in "volume set""Jenkins2016-11-101-0/+9
|\
| * Add "--read-only" and "--read-write" options in "volume set"Huanxuan Ao2016-10-181-0/+9
| | | | | | | | | | | | | | | | Add "--read-only" and "--read-write" options in "volume set" command to set volume access mode. Implements: bp cinder-command-support Change-Id: I76ba85c7d3ff0eb026a9cbd794368d8b2b0d17fe
* | Add "volume migrate" commandHuanxuan Ao2016-10-181-0/+42
|/ | | | | | | | Add "volume migrate" command in volume v1 and v2 to support migrating volume to a new host Change-Id: Ie4e6037171a31a872006a13f9fd1e15eaa627c26 Implements: bp cinder-command-support
* Add and modify options for "volume create" commandHuanxuan Ao2016-09-281-6/+25
| | | | | | | | | | | | | | 1.Add mutually exclusive options into a mutually exclusive group. 2.Add "--source-replicated", "--consistency-group", "--hint" and "multi-attach" options 3.Make --size option to be optional under some cases Closes-Bug: #1568005 Closes-Bug: #1627913 Implements: bp implement-cinder-features Co-Authored-By: Roman Vasilets <rvasilets@mirantis.com> Change-Id: I2c4c3073195d33774e477f4d7f22e383b14b41dd
* Add warning message for --state option of set command in volumeHuanxuan Ao2016-09-261-1/+3
| | | | | | | | | There are some set commands can set object state, it maybe a danger behavor for users, so add explanation and warning in the help message of the "--state" option to talk users be caution when using (cinderclient have done this too) Change-Id: I6a902887ea98879999c9972f36b1b7ef332173c3
* Support mark volume as bootable in volume setqtang2016-09-141-0/+9
| | | | | | | | Add --bootable | --non-bootable option in volume set to mark or unmark volume as bootable. Change-Id: Ifa6c2dd1642202f55b6d50e3b8614d3513d488f6 Closes-Bug:#1535704
* Add "--limit" and "--marker" options to "volume list" commandHuanxuan Ao2016-09-111-0/+12
| | | | | | | | | Add ``--limit`` option to ``volume list`` command in volume v1, add ``--limit`` and ``--marker`` options to ``volume list`` command in volume v2. Change-Id: I327a252aa83ed84166da99cf6aa80334e0e6dd44 Partial-Bug: #1612484
* Add support of setting volume's stateXi Yang2016-08-031-0/+9
| | | | | | | | | OSC does not support to set volume's state, this patch is going to add this functionality. Closes-Bug:#1535213 Change-Id: I5bc1c7e81b8ba61c37f4bfd209fc86c5857fb050 Co-Authored-By: Huanxuan Ao <huanxuan.ao@easystack.cn>
* Add support for deleting volumes with associated snapshotswuyuting2016-07-271-1/+7
| | | | | | | | | | OSC doesn't support deleting volumes with associated snapshots. This patch provides support for deleting volumes with associated snapshots by adding an optional argument. Change-Id: I7e74f251574993ff13a38e508fd2f9debeda8d0a Closes-Bug: #1589332 Co-Authored-By: Rui Chen <chenrui.momo@gmail.com>
* Docs cleanup: volume command helpDean Troyer2016-03-281-32/+50
| | | | | | | | | This formats the volume command help text consistent with the rest of OSC, adds some reference targets and some explanation text to some commands. No functional changes have been made, only cosmetic/help output. Change-Id: Ib86ec3ca58bdea5f33078ced3ec3583b2be0e89a
* Add support for deleting Image-propertyroot2016-03-161-0/+6
| | | | | | | | | | OSC does not support to delete volume's image property. This patch will provide support for deleting image property to existing volume. Closes-Bug:#1554879 Change-Id: I9256913948fae9e9a03fed173b826dfa918f78e9 Implements: bp cinder-command-support
* Add support for setting Image-propertyroot2016-03-161-0/+8
| | | | | | | | | | | | OSC does not support to set volume's image property. This patch will provide support for adding image property to existing volume. Closes-Bug:#1554877 Implements: bp cinder-command-support Change-Id: I4ff5532c228f010789b81c7587dd4a2838a90f20
* Use Block Storage instead of VolumeXi Yang2015-11-271-1/+1
| | | | | | | Volume is better to be replaced by Block Storage in the doc. Change-Id: I736669ee01c7385b6e701cb20f4334eff1c49286
* Follow-on for volume list - add tests, clean helpDean Troyer2015-10-161-3/+13
| | | | | | | | | | * Add volume list tests for v1 (a copy of the v2 tests) * Converts volume v2 tests to use Identity v3 so domains can be tested * Add volume list (v2) tests for new options * Re-orders volume list options (both v1 and v2) to match * MArks the new volume list (v2) options as v2-only in doc Change-Id: I2181b2c48cfde2147d7d0ef135322df8a81e7ce8
* Add filtering by project/user for 'openstack volume list'kafka2015-10-151-6/+24
| | | | | | | | | | added project, user and domain options for filtering results, also cleaned up the order to match the docs. Co-Authored-By: Steve Martinelli <stevemar@ca.ibm.com> Closed-bug: #1483976 Change-Id: I9d955094d31d4a28e215d24f7521a11c62bee8db
* Add list feature to volume v2heha2015-08-061-1/+1
| | | | | | | | | | "volume list" is not in the v2. Co-Authored-By: Lin Hua Cheng <os.lcheng@gmail.com> implements bp: volume-v2 Change-Id: I9f4585202f5f9ec5f4c091278fc6c4036efb1290
* Change volume create --snapshot-id to --snapshotlin-hua-cheng2015-02-061-3/+3
| | | | | | | Keeping the option --snapshot-id hidden for backward compatibility. Change-Id: Iefa0aed9be255a5626a9bbb7db77911ef5ca8595 Closes-Bug: #1418742
* Add the ability to extend volumes in `osc volume set`Steve Martinelli2015-01-271-0/+5
| | | | | | | | Create a --size option for volume set, so the user may extend a volume's size. Change-Id: Ic8d3396d788a14ea1e10bf1da73edfd7f5d85070 Closes-Bug: #1413954
* Command docs: volumeSteve Martinelli2015-01-071-0/+189
Change-Id: Id1e500d5fb19ffdeb0d1bde9e22c3143c0873d0c
View Lorry Controller Status