summaryrefslogtreecommitdiff
path: root/doc/source/command-objects/volume-backup.rst
Commit message (Collapse)AuthorAgeFilesLines
* reorganize existing documentation according to the new standard layoutDoug Hellmann2017-06-231-201/+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
* Fix sphinx errorsAndreas Jaeger2017-01-261-5/+5
| | | | | | It's :option: instead of :options:, fix typo. Change-Id: I273d592f38db07fef7633fe833b1c0ab9e52e6a8
* Fix all missing "os to openstack" transformationHuanxuan Ao2016-12-211-1/+1
| | | | | | | | | Checked and fix all missing of the review: https://review.openstack.org/#/c/412669/ https://review.openstack.org/#/c/412673/ https://review.openstack.org/#/c/412678/ Change-Id: Ice85958874121eeb574d0b4cfa58e1590b014ed6
* change os in command example to openstack(3)Kevin_Zheng2016-12-201-5/+5
| | | | | | | | | 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 'all-projects' option to 'volume backup list'Jordan Pittier2016-11-081-0/+5
| | | | | | | Similar to what 'volume list --all-projects' does, 'volume backup list --all-projects' list volume backups accross all projects. Change-Id: Id5dda9b5adc822c4ddfb2dda339946d3322858e2
* Add options to "volume backup list" commandHuanxuan Ao2016-11-081-0/+31
| | | | | | | | | Add "--name", "--status", "--volume", "--marker" (v2 only) and "--limit" (v2 only) options to "volume backup list" command Change-Id: If20cb7650f2359d393ee314d9e055a8659c73009 Closes-Bug: #1612484 Closes-Bug: #1639712
* Add warning message for --state option of set command in volumeHuanxuan Ao2016-09-261-0/+2
| | | | | | | | | 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
* Add "volume backup set" command in volume v2Huanxuan Ao2016-09-221-0/+31
| | | | | | | | Add "volume backup set" command in volume v2 (v2 only) to set backup name, description and state Change-Id: If17e8457db9a4704fb5bb9c75921ed82fd0069cf Closes-Bug: #1613261
* Rename backup commands in volume v1 and v2Huanxuan Ao2016-08-111-0/+132
Backup commands are used only in volume service now, but "backup" is too generic, users may not know the commands are used for volume from the commands name. By seeing the command name, users can only see the "backup" but do not know which object the backup commands work for. It may confuse users. I think rename "backup" to "volume backup" can depict resource relation and will be helpful for users to know the commands clearly. So add new commands ``volume backup create/delete/ list/show/restore`` to replace the old commands ``backup create/delete/list/show/restore``. And also deprecate old commands. Change-Id: I4f844d9bc48573eb4d17288ce6b8a90cea00d16a Implements: bp backup-snapshot-renamed-for-volume-resource Co-Authored-By: Sheel Rana <ranasheel2000@gmail.com>