openstack/python-cinderclient
Code Issues Proposed changes
e2afc016b2
python-cinderclient/doc/source/index.rst

180 lines
7.8 KiB
ReStructuredText
Raw Normal View History

Docs in cinderlcient were never actually updated. Not only were the docs and release info here not being maintainted properly, but the examples that were given were not correct. This change is an attempt to set us on the right path going forward and includes info on how to import the API and history info for the upcoming release/push to PyPi. Fixes bug: 1156994 Change-Id: I169b1c01380ef653a6a25eb8946b9a06d6419e62
2013-03-19 00:24:32 -06:00
Python API
==========
In order to use the python api directly, you must first obtain an auth token and identify which endpoint you wish to speak to. Once you have done so, you can use the API like so::
>>> from cinderclient import client
>>> cinder = client.Client('1', $OS_USER_NAME, $OS_PASSWORD, $OS_TENANT_NAME, $OS_AUTH_URL)
>>> cinder.volumes.list()
[]
>>> myvol = cinder.volumes.create(display_name="test-vol", size=1)
>>> myvol.id
ce06d0a8-5c1b-4e2c-81d2-39eca6bbfb70
>>> cinder.volumes.list()
[<Volume: ce06d0a8-5c1b-4e2c-81d2-39eca6bbfb70>]
>>>myvol.delete
Command-line Tool
=================
In order to use the CLI, you must provide your OpenStack username, password, tenant, and auth endpoint. Use the corresponding configuration options (``--os-username``, ``--os-password``, ``--os-tenant-id``, and ``--os-auth-url``) or set them in environment variables::
export OS_USERNAME=user
export OS_PASSWORD=pass
export OS_TENANT_ID=b363706f891f48019483f8bd6503c54b
export OS_AUTH_URL=http://auth.example.com:5000/v2.0
Once you've configured your authentication parameters, you can run ``cinder help`` to see a complete listing of available commands.
Provide cinder CLI man page. Provide basic but hopefully useful man page. shell.rst was merged into and replaced by the man page in HTML docs. pbr is used to determine version. Docs copyright was changed to more accurate "OpenStack Contributors". Fixes: bug 1206968 Implements: blueprint clients-man-pages Change-Id: Iedd7b4b161ced564833fd9433762b87a4c1a374d
2013-07-31 13:07:14 -04:00
See also :doc:`/man/cinder`.
Docs in cinderlcient were never actually updated. Not only were the docs and release info here not being maintainted properly, but the examples that were given were not correct. This change is an attempt to set us on the right path going forward and includes info on how to import the API and history info for the upcoming release/push to PyPi. Fixes bug: 1156994 Change-Id: I169b1c01380ef653a6a25eb8946b9a06d6419e62
2013-03-19 00:24:32 -06:00
Release Notes
=============
Update release notes for push to pypi Need to get a 1.08 out, so just modifying the release notes for the push version. Change-Id: Icf9684ab0fabf0168662c3ff4047db54a2670d11
2014-01-31 08:33:15 -07:00
Fix typos in cinderclient Small nit-pics in volume_transfers. Change-Id: I846b38970b14e6385269a02bb495c63464ea0842 Closes-Bug: #1255905
2014-02-05 11:57:13 +05:30
MASTER
Bump client doc index version to 1.0.9 Prep for push of new client for icehouse release. Change-Id: I281aaa7b628738d423f2cbfe5b78733e4e41714d
2014-04-21 09:17:26 -06:00
-----
Update version to 1.1.1 in index Prep for new tag Change-Id: I49f8f7fcc2647dc09e38fee1fa5068df714a8d83
2014-09-23 18:17:40 -06:00
1.1.1
------
.. _1370152 http://bugs.launchpad.net/python-cinderclient/+bug/1370152
Update index file for release of 1.1.0 Change-Id: I75bbf1cf88fb516409f0ed30b962af7e5ac6236e
2014-09-09 19:45:18 -06:00
1.1.0
------
* Add support for ConsistencyGroups
* Use Adapter from keystoneclient
* Add support for Replication feature
* Add pagination for Volume List
.. _1325773 http://bugs.launchpad.net/python-cinderclient/+bug/1325773
.. _1333257 http://bugs.launchpad.net/python-cinderclient/+bug/1333257
.. _1268480 http://bugs.launchpad.net/python-cinderclient/+bug/1268480
.. _1275025 http://bugs.launchpad.net/python-cinderclient/+bug/1275025
.. _1258489 http://bugs.launchpad.net/python-cinderclient/+bug/1258489
.. _1241682 http://bugs.launchpad.net/python-cinderclient/+bug/1241682
.. _1203471 http://bugs.launchpad.net/python-cinderclient/+bug/1203471
.. _1210874 http://bugs.launchpad.net/python-cinderclient/+bug/1210874
.. _1200214 http://bugs.launchpad.net/python-cinderclient/+bug/1200214
.. _1130572 http://bugs.launchpad.net/python-cinderclient/+bug/1130572
.. _1156994 http://bugs.launchpad.net/python-cinderclient/+bug/1156994
** Note Connection refused --> Connection error commit: c9e7818f3f90ce761ad8ccd09181c705880a4266
** Note Mask Passwords in log output commit: 80582f2b860b2dadef7ae07bdbd8395bf03848b1
Bump client doc index version to 1.0.9 Prep for push of new client for icehouse release. Change-Id: I281aaa7b628738d423f2cbfe5b78733e4e41714d
2014-04-21 09:17:26 -06:00
1.0.9
Fix typos in cinderclient Small nit-pics in volume_transfers. Change-Id: I846b38970b14e6385269a02bb495c63464ea0842 Closes-Bug: #1255905
2014-02-05 11:57:13 +05:30
------
.. _1255905: http://bugs.launchpad.net/python-cinderclient/+bug/1255905
Require ctrl_location for encryption-type-create This bug fix addresses bug #1267168, adding a default value to the optional control_location parameter for the encryption-type-create command. Prior to this fix, any invocation of encryption-type-create that omitted the control_location parameter would fail. The failure arose from the expectations of the cinder volume encryption type API extension, which expects to always receive a value for the control_location on encryption type creation. control_location indicates which service will conduct the volume encryption for the encryption-type under consideration; valid options are 'front-end' (i.e., nova) and 'back-end' (i.e., cinder). The new default value is 'front-end' and is used whenever control_location is omitted from encryption-type-create invocation. For prior discussion and information, see the abandoned patch below: https://review.openstack.org/#/c/58303/ blueprint encrypt-cinder-volumes https://blueprints.launchpad.net/nova/+spec/encrypt-cinder-volumes Change-Id: I8db80929adbf5a3d818b9d3a8115067ae8e7d9e2 Closes-Bug: #1267168 DocImpact
2014-02-11 08:36:41 -05:00
.. _1267168: http://bugs.launchpad.net/python-cinderclient/+bug/1267168
Accept deleting multiple snapshots in one shot In bug 1241941 the delete and force-delete commands were updated to accept multiple volumes for deleting in the same call. This patch adds the same behaviour to the snapshot-delete command. Closes-Bug: #1284540 Change-Id: I5e4bf8641d7fd261fa24b03832bad08007e43c12
2014-02-25 10:25:24 +01:00
.. _1284540: http://bugs.launchpad.net/python-cinderclient/+bug/1284540
Fix typos in cinderclient Small nit-pics in volume_transfers. Change-Id: I846b38970b14e6385269a02bb495c63464ea0842 Closes-Bug: #1255905
2014-02-05 11:57:13 +05:30
Update release notes for push to pypi Need to get a 1.08 out, so just modifying the release notes for the push version. Change-Id: Icf9684ab0fabf0168662c3ff4047db54a2670d11
2014-01-31 08:33:15 -07:00
1.0.8
-----
Reset-state and snapshot-reset-state for multiple objects This allows a user to call reset-state or snapshot-reset-state on a list of objects. The behavior is modeled after a similar change to delete multiple volumes. $ cinder reset-state good_volume good_volume_2 <no output> Error behavior is as follows: One success/one failure: $ cinder reset-state good_volume asdf Reset state for volume asdf failed: No volume with a name or ID of 'asdf' exists. One failure: $ cinder reset-state asdf ERROR: Reset state for volume asdf failed: No volume with a name or ID of 'asdf' exists. Two failures: $ cinder reset-state asdf qwert Reset state for volume asdf failed: No volume with a name or ID of 'asdf' exists. Reset state for volume qwert failed: No volume with a name or ID of 'qwert' exists. ERROR: Unable to reset the state for any of the specified volumes. Related-Bug: 1241941 Closes-Bug: 1256069 Change-Id: Id0a36fb7de0d69be0dac98ea04e4708775250b7a
2013-12-02 18:05:54 -05:00
* Add support for reset-state on multiple volumes or snapshots at once
Add retype to index.rst Retype patch was merged but not added to index.rst Change-Id: I15e52153fccf07026d4b1dfcc1fb62a27d6d3ca2
2014-01-26 09:28:48 +02:00
* Add volume retype command
Reset-state and snapshot-reset-state for multiple objects This allows a user to call reset-state or snapshot-reset-state on a list of objects. The behavior is modeled after a similar change to delete multiple volumes. $ cinder reset-state good_volume good_volume_2 <no output> Error behavior is as follows: One success/one failure: $ cinder reset-state good_volume asdf Reset state for volume asdf failed: No volume with a name or ID of 'asdf' exists. One failure: $ cinder reset-state asdf ERROR: Reset state for volume asdf failed: No volume with a name or ID of 'asdf' exists. Two failures: $ cinder reset-state asdf qwert Reset state for volume asdf failed: No volume with a name or ID of 'asdf' exists. Reset state for volume qwert failed: No volume with a name or ID of 'qwert' exists. ERROR: Unable to reset the state for any of the specified volumes. Related-Bug: 1241941 Closes-Bug: 1256069 Change-Id: Id0a36fb7de0d69be0dac98ea04e4708775250b7a
2013-12-02 18:05:54 -05:00
Remove RAX-specific auth in cinderclient Change-Id: Idd36694a322f467ba5e8c1f58bfac701bff8f3f8 Closes-Bug: #966329
2014-01-25 08:13:25 +05:30
.. _966329: https://bugs.launchpad.net/python-cinderclient/+bug/966329
Updates .gitignore for environment files Adding ignore for Eclipse IDE environment files These files .project and .pydevproject should be ignored while pushing to repositories. Change-Id: I44dbdaae71c3ed37c11122f1795d36c401dd431a Closes-Bug: #1256043
2013-11-28 16:56:53 +00:00
.. _1256043: https://bugs.launchpad.net/python-cinderclient/+bug/1256043
Fix inappropriate comment for set_metadata Fix inappropriate comment for the param of set_metadata Change-Id: I01495f59b11ed88389b0e0f2f5fb34289f64dbac Closes-Bug: 1254951
2013-11-26 11:42:17 +08:00
.. _1254951: http://bugs.launchpad.net/python-cinderclient/+bug/1254951
Fix typo in cinderclient sematics --> semantics hypen-separated --> hyphen-separated typicaly --> typically Change-Id: I5df277ef7036082d0e4b079c23d41da809e5270f Closes-Bug: #1254587
2013-11-25 18:08:01 +08:00
.. _1254587: http://bugs.launchpad.net/python-cinderclient/+bug/1254587
Add assert to delete multiple test Make sure calls are made to delete both volumes. Also removed redundant fields in v1 fake volume. Closes-Bug: #1253142 Change-Id: I51078041c6d765f28edb155d44928286ee2b0dd6
2013-10-29 18:01:41 +02:00
.. _1253142: http://bugs.launchpad.net/python-cinderclient/+bug/1253142
Add search_opts into the method list() for VolumeTypeManager Since the method base.ManagerWithFind.findall has been modified by adding the search_opts for all tenants support, the parameter search_opts should also be added to all the manager classes, which can be called whithin this method. volumetypemanager does not have this parameter for its method list(). Adding search_opts will resolve this issue. Closes-Bug: #1252665 Change-Id: I526500625f1b5483cb5d88ea15e6ac8485a66ae3
2013-11-20 04:34:38 -05:00
.. _1252665: http://bugs.launchpad.net/python-cinderclient/+bug/1252665
Ignore swap files generated during file edting by vim To ignore swap files from getting into repository currently the implemented ignore is *.swp however vim adds more swap files if these files exists, so improving this with .*.sw? Change-Id: I11965d5fb22aeae622dad8bb29cf1f0533ed439a Closes-Bug: #1255876
2013-11-28 22:13:47 +08:00
.. _1255876: http://bugs.launchpad.net/python-cinderclient/+bug/1255876
Discrepancy between README.rst and cinder help 1) --version in README should be --os-volume-api-version 2) CINDER_URL should be OS_AUTH_URL Change-Id: I409634f3025463f2ae9419ddd0d99fa50554a04d Closes-Bug: 1251385
2013-11-14 18:50:30 +00:00
.. _1251385: http://bugs.launchpad.net/python-cinderclient/+bug/1251385
Fix inappropriate comment for volume update api Change-Id: Id7a436cc864772bd2662fce0ef80d647c9e3dcf0 Closes-Bug: #1264415
2013-12-27 10:32:11 +08:00
.. _1264415: http://bugs.launchpad.net/python-cinderclient/+bug/1264415
Fix RateLimit.__repr__ - self.method is undefined Using self.verb instead of self.method, unit tests added to cover this fix. Closes-bug: #1258489 Change-Id: I4a84179ff96c50b230afcaea7a19fb54613577fb
2013-12-03 15:47:58 +04:00
.. _1258489: http://bugs.launchpad.net/python-cinderclient/+bug/1258489
Fix 'search_opts' unexpected keyword argument error When executing 'encryption-type-create' command using resource name, it will use the findall() in base.py, then error will occur because list() in findall() used 'search_opts' argument which list() in VolumeEncryptionTypeManager did not have. Some other command like 'transfer-delete' met same issue. This patch will add 'search_opts' argument in list() function in child class to avoid the bug. Closes-Bug: #1248519 Related-Bug: #1252665 Change-Id: If1cd8b812af21335e5d4351766539a927a8fbdf4
2014-01-20 15:29:55 +08:00
.. _1248519: http://bugs.launchpad.net/python-cinderclient/+bug/1248519
Add shell tests for snapshot_delete snapshot_delete does not have a shell test covering it. Closes-Bug: #1257747 Change-Id: I22252f5025c11a7c115aa75e07c78424eec75ba1
2013-12-02 18:56:45 -05:00
.. _1257747: http://bugs.launchpad.net/python-cinderclient/+bug/1257747
Add index.rst section for patches merged to master Add new section called "MASTER" to the release notes, where all patches that implement blueprints or fix bugs should update the list. This list will be used for the release notes when a new version is released. Change-Id: If842bfbb85851fb7a9e22259423da204f4c308f4
2013-11-14 19:30:46 +02:00
Update version and index.rst for push Update prior to push 1.0.7 to PyPi. Includes changes/updates to doc/source/index and adds link to README.rst Change-Id: I666f3e6004885db7a688abdac88fa1154d83f8c9
2013-10-30 11:36:37 -06:00
1.0.7
-----
* Add support for read-only volumes
* Add support for setting snapshot metadata
* Deprecate volume-id arg to backup restore in favor of --volume
* Add quota-usage command
* Fix exception deprecation warning message
* Report error when no args supplied to rename cmd
.. _1241941: http://bugs.launchpad.net/python-cinderclient/+bug/1241941
.. _1242816: http://bugs.launchpad.net/python-cinderclient/+bug/1242816
.. _1233311: http://bugs.launchpad.net/python-cinderclient/+bug/1233311
.. _1227307: http://bugs.launchpad.net/python-cinderclient/+bug/1227307
.. _1240151: http://bugs.launchpad.net/python-cinderclient/+bug/1240151
.. _1241682: http://bugs.launchpad.net/python-cinderclient/+bug/1241682
Update docs/index.rst with release info for 1.0.6 Add features and bugs list for 1.0.6 pypi release. Change-Id: I27134a04670bcfd1bca201ce1e0bba201e8ff98c
2013-10-03 17:22:34 -06:00
1.0.6
-----
* Add support for multiple endpoints
* Add response info for backup command
* Add metadata option to cinder list command
* Add timeout parameter for requests
* Add update action for snapshot metadata
* Add encryption metadata support
* Add volume migrate support
Update version and index.rst for push Update prior to push 1.0.7 to PyPi. Includes changes/updates to doc/source/index and adds link to README.rst Change-Id: I666f3e6004885db7a688abdac88fa1154d83f8c9
2013-10-30 11:36:37 -06:00
* Add support for QoS specs
Update docs/index.rst with release info for 1.0.6 Add features and bugs list for 1.0.6 pypi release. Change-Id: I27134a04670bcfd1bca201ce1e0bba201e8ff98c
2013-10-03 17:22:34 -06:00
.. _1221104: http://bugs.launchpad.net/python-cinderclient/+bug/1221104
.. _1220590: http://bugs.launchpad.net/python-cinderclient/+bug/1220590
.. _1220147: http://bugs.launchpad.net/python-cinderclient/+bug/1220147
.. _1214176: http://bugs.launchpad.net/python-cinderclient/+bug/1214176
.. _1210874: http://bugs.launchpad.net/python-cinderclient/+bug/1210874
.. _1210296: http://bugs.launchpad.net/python-cinderclient/+bug/1210296
.. _1210292: http://bugs.launchpad.net/python-cinderclient/+bug/1210292
.. _1207635: http://bugs.launchpad.net/python-cinderclient/+bug/1207635
.. _1207609: http://bugs.launchpad.net/python-cinderclient/+bug/1207609
.. _1207260: http://bugs.launchpad.net/python-cinderclient/+bug/1207260
.. _1206968: http://bugs.launchpad.net/python-cinderclient/+bug/1206968
.. _1203471: http://bugs.launchpad.net/python-cinderclient/+bug/1203471
.. _1200214: http://bugs.launchpad.net/python-cinderclient/+bug/1200214
.. _1195014: http://bugs.launchpad.net/python-cinderclient/+bug/1195014
Update index.rst Update the release info in index.rst to get ready to push new version to PyPi. Change-Id: Id3b4b6bfd7374b74bf8566dc133ea66f5d2f74ed
2013-07-13 14:46:57 -06:00
1.0.5
-----
Add a couple more things to index before release Most of the new features are in and oslo req's are synched, making the cut off here and getting a new client version pushed up to PyPi. Change-Id: If208b2341db06b438851d7b2aaab541efc79ea35
2013-08-06 16:00:51 -06:00
* Add CLI man page
* Add Availability Zone list command
Update index.rst Update the release info in index.rst to get ready to push new version to PyPi. Change-Id: Id3b4b6bfd7374b74bf8566dc133ea66f5d2f74ed
2013-07-13 14:46:57 -06:00
* Add support for scheduler-hints
* Add support to extend volumes
* Add support to reset state on volumes and snapshots
* Add snapshot support for quota class
.. _1190853: http://bugs.launchpad.net/python-cinderclient/+bug/1190853
.. _1190731: http://bugs.launchpad.net/python-cinderclient/+bug/1190731
.. _1169455: http://bugs.launchpad.net/python-cinderclient/+bug/1169455
.. _1188452: http://bugs.launchpad.net/python-cinderclient/+bug/1188452
.. _1180393: http://bugs.launchpad.net/python-cinderclient/+bug/1180393
.. _1182678: http://bugs.launchpad.net/python-cinderclient/+bug/1182678
.. _1179008: http://bugs.launchpad.net/python-cinderclient/+bug/1179008
.. _1180059: http://bugs.launchpad.net/python-cinderclient/+bug/1180059
.. _1170565: http://bugs.launchpad.net/python-cinderclient/+bug/1170565
Update release info in index.rst. Add release notes and fix revision number mishap. Change-Id: Ia48be8462e17c900562b794fd69ba2234f6c6c03
2013-05-01 17:25:58 -06:00
1.0.4
-----
Fixed typos found by RETF rules Rules are available at https://en.wikipedia.org/wiki/Wikipedia:AutoWikiBrowser/Typos Change-Id: I8de0631346b703870ce8ebe9ce728a0360f1ba7f
2014-05-02 18:32:06 +02:00
* Added support for backup-service commands
Update release info in index.rst. Add release notes and fix revision number mishap. Change-Id: Ia48be8462e17c900562b794fd69ba2234f6c6c03
2013-05-01 17:25:58 -06:00
.. _1163546: http://bugs.launchpad.net/python-cinderclient/+bug/1163546
.. _1161857: http://bugs.launchpad.net/python-cinderclient/+bug/1161857
.. _1160898: http://bugs.launchpad.net/python-cinderclient/+bug/1160898
.. _1161857: http://bugs.launchpad.net/python-cinderclient/+bug/1161857
.. _1156994: http://bugs.launchpad.net/python-cinderclient/+bug/1156994
1.0.3
Docs in cinderlcient were never actually updated. Not only were the docs and release info here not being maintainted properly, but the examples that were given were not correct. This change is an attempt to set us on the right path going forward and includes info on how to import the API and history info for the upcoming release/push to PyPi. Fixes bug: 1156994 Change-Id: I169b1c01380ef653a6a25eb8946b9a06d6419e62
2013-03-19 00:24:32 -06:00
-----
* Added support for V2 Cinder API
Fixed typos found by RETF rules Rules are available at https://en.wikipedia.org/wiki/Wikipedia:AutoWikiBrowser/Typos Change-Id: I8de0631346b703870ce8ebe9ce728a0360f1ba7f
2014-05-02 18:32:06 +02:00
* Corrected upload-volume-to-image help messaging
Docs in cinderlcient were never actually updated. Not only were the docs and release info here not being maintainted properly, but the examples that were given were not correct. This change is an attempt to set us on the right path going forward and includes info on how to import the API and history info for the upcoming release/push to PyPi. Fixes bug: 1156994 Change-Id: I169b1c01380ef653a6a25eb8946b9a06d6419e62
2013-03-19 00:24:32 -06:00
* Align handling of metadata args for all methods
* Update OSLO version
* Correct parsing of volume metadata
* Enable force delete of volumes and snapshots in error state
* Implement clone volume API call
* Add list-extensions call to cinderclient
* Add bootable column to list output
* Add retries to cinderclient operations
* Add Type/Extra-Specs support
* Add volume and snapshot rename commands
.. _1155655: http://bugs.launchpad.net/python-cinderclient/+bug/1155655
.. _1130730: http://bugs.launchpad.net/python-cinderclient/+bug/1130730
.. _1068521: http://bugs.launchpad.net/python-cinderclient/+bug/1068521
.. _1052161: http://bugs.launchpad.net/python-cinderclient/+bug/1052161
.. _1071003: http://bugs.launchpad.net/python-cinderclient/+bug/1071003
.. _1065275: http://bugs.launchpad.net/python-cinderclient/+bug/1065275
.. _1053432: http://bugs.launchpad.net/python-cinderclient/+bug/1053432
Copy Permalink