summaryrefslogtreecommitdiff
path: root/doc/source
Commit message (Collapse)AuthorAgeFilesLines
* Merge "Fix doc build error" into stable/steinZuul2019-03-271-0/+2
|\
| * Fix doc build errorEric Harney2019-03-211-0/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | Doc build keeps failing w/ Recursion error: maximum recursion depth exceeded while pickling an object Sphinx recommends bumping up the recursion limit to get around this, and it appears to work. Change-Id: If0a78f9af2e4ddd5fd88c44757642355b3a5bf2e (cherry picked from commit 2505e2a9031f13fbcb1f639ee5f21a2a30f77715)
* | Cleanup the home pageMatt Riedemann2019-03-215-91/+11
|/ | | | | | | | | | | | | | | | Good lord this thing needed some love. This change does a few things: * Remove the duplicate man page. * Rename some titles to drop the CINDERCLIENT yelling - this is docs about cinderclient, I get it, no need to repeat in all caps. * Fixed the sub-section title formatting in the home page. * Dropped the duplicate usage guide wording and simply linked to the user docs from the home page. Change-Id: I259787a40151e8c875ad87021f655a141e06b15e (cherry picked from commit 85a3f0e30d7ac8532b86f359803eba341b9590d9)
* update the value of OS_AUTH_URL and OS_VOLUME_API_VERSIONunknown2018-05-213-5/+5
| | | | | | | In the file doc/source/cli/index.rst, doc/source/user/cinder.rst, doc/source/user/shell.rst, update OS_AUTH_URL and OS_VOLUME_API_VERSION. Change-Id: I543bb2fedf3a1326bf1a46804f0d026ad8e21680
* Merge "Support availability-zone in volume type"Zuul2018-05-201-1/+8
|\
| * Support availability-zone in volume typeTommyLike2018-05-021-1/+8
| | | | | | | | | | | | | | | | | | | | Since 3.52, new option '--filters' has been added to 'type-list' command, and it's only valid for administrator. Change-Id: I140f6d61a2747d4fcaabfbccea864dcc7eb841d1 Depends-On: I4e6aa7af707bd063e7edf2b0bf28e3071ad5c67a Partial-Implements: bp support-az-in-volumetype
* | Update python usage docsj-griffith2018-03-221-1/+2
|/ | | | | | | | | | | | | | The keystoneauth1 get_plugin_loader method requires that a OS_USER_DOMAIN be specified. Our docs don't include that detail. This change adds the extra needed field. There's also some problems currently with loading the client directly as it's currently documented, which appears to be a bug in the client code itself. Change-Id: Idacbb47f9aae1e461379eec4a5e224b0157a8dc4 Partial-Bug: #1758104
* Update unit_test.rst doc unit test py34 to py35Yuanbin.Chen2018-03-051-1/+1
| | | | | | | | CinderClient unit test use py27 or py35, Look: https://github.com/openstack/python-cinderclient/blob/master/tox.ini#L3 Change-Id: Ibc3ada82337c6393ab86b3159fa1b4f032495879 Signed-off-by: Yuanbin.Chen <cybing4@gmail.com>
* Remove unit tests about run_testYuanbin.Chen2018-02-241-99/+0
| | | | | | | | | | This patch remove unit tests about flags, beacuse the flags about run_test.sh has delete. About run_test.sh delete, look this patch. https://review.openstack.org/#/c/502120/ Change-Id: Ib0e04ed6d48ec5c52cc62abf59174c313d843792 Signed-off-by: Yuanbin.Chen <cybing4@gmail.com>
* Merge "Update old url for cinderclient's document"Jenkins2017-09-201-1/+1
|\
| * Update old url for cinderclient's documentzhangbailin2017-09-051-1/+1
| | | | | | | | | | | | | | Update the URL in the document library, and use https instead of http due to openstack document migration. Change-Id: I991dff678ce613b0a50e3d0c9ab5ecd8cdf3e272
* | doc: Remove cruft from conf.pyStephen Finucane2017-08-221-136/+6
| | | | | | | | Change-Id: I0c0c77c25d3c96dd3c6a2a01be4f196c02e71dd6
* | Use Sphinx 1.5 warning-is-errorStephen Finucane2017-08-226-96/+107
|/ | | | | | | | With pbr 2.0 and Sphinx 1.5, the setting for treat sphinx warnings as errors is setting warning-is-error in build_sphinx section. Migrate the setting from the old warnerrors one. Change-Id: Ifd411ead74497a43ab22c57090ece2e1c7cfddb5
* Fix man page buildThomas Bechtold2017-07-291-1/+1
| | | | | | | | | | Ia3b5ee2b6aaf17781d3de7546a9477f1c928092f moved cinder.rst from the doc/source/man directory into doc/source/cli, so we need to adjust the path in conf.py to avoid issues when running: python setup.py build_sphinx -b man Change-Id: I32ca20e0e184b11c68c9b81a9ff3d1247330ade4
* Rearrange existing documentation to fit the new standard layoutchenxing2017-07-266-2/+82
| | | | | | | | | | The layout is configured to follow the design from this spec: https://specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration.html This change is necessary to continue the doc migration process. Change-Id: I5ab2e47b67baf90bdd808cb831493a010d23a070
* import content from cli-reference in openstack-manualschenxing2017-07-263-1/+4469
| | | | | | | | | | | | | | This patch is part of the great doc migration from openstack-manuals to the individual repos. The changes are based on the spec here: https://specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration.html The cinder.rst file needs to be renamed index.rst so that the template that is being used by OpenStack manuals team will magically find the documentation. Change-Id: Ia3b5ee2b6aaf17781d3de7546a9477f1c928092f
* Merge "Update cinder.rst and shell.rst"Jenkins2017-07-262-2/+27
|\
| * Update cinder.rst and shell.rstjunboli2017-07-262-2/+27
| | | | | | | | | | | | | | | | In the file doc/source/man/cinder.rst, add cinder command examples, In the file doc/source/shell.rst, update OS_AUTH_URL and OS_VOLUME_API_VERSION Change-Id: I6ed2c5228daad8dd6dcab1d7278f8a0b049c0490
* | Update URLs in documentationHangdong Zhang2017-07-203-4/+4
| | | | | | | | | | | | | | Update URLs according to OpenStack document migration BTW: Do some optimization as well (http -> https) Change-Id: I9239e2012442f3e459a21f50afd380c8f58a6a98
* | Switch from oslosphinx to openstackdocsthemeVan Hung Pham2017-07-141-2/+12
|/ | | | | | | | | As part of the docs migration work[0] for Pike we need to switch to use the openstackdocstheme. [0]https://review.openstack.org/#/c/472275/ Change-Id: Ie5930c73c748bb308940606fced8f84eecdecdc8
* Add doc for noauth usagejohn-griffith2017-05-221-0/+32
| | | | | | Sometimes docs are useful, let's add one for using noauth. Change-Id: I7d450031929ca5f6ea1b285e49f693776a63a23d
* add an alternative way of authenticating clientLucas H. Xu2016-11-231-0/+15
| | | | Change-Id: I8e0745e17f25e53539405cdafc45dc3646dbb1ae
* Fix typos in the fileszhangyanxian2016-11-081-1/+1
| | | | | | TrivialFix Change-Id: I404bd8ac9c61e1b6351987223e4de23a7cd6d687
* Update release notes information for renoSean McGinnis2016-10-281-2/+5
| | | | | | | | We had stale release note information from before we made the switch to reno. Reno notes are now published to docs.openstack.org, so we should just point to the landing page for the project. Change-Id: Icad89345656e2e9a6a4d7c599b7003acfc7a5480
* Fix some PEP8 issues and Openstack Licensingpawnesh.kumar2016-10-141-37/+51
| | | | | | | [H102 H103] Contributed Source code should be licensed under the Apache 2.0 license. Change-Id: I7d69bd9c8138d9ea5306c2fda56de875e33c544e
* TrivialFix: Removed redundant 'the'Anh Tran2016-09-271-1/+1
| | | | Change-Id: If27d8e0ef23d5d202705b07283f4e13b3fb48402
* Add docs for running testsscott2016-04-202-0/+213
| | | | | | | Add documents for running unit and functional tests. Change-Id: I4616193dade844c5a774dd74aa1805452fd01a9e Closes-Bug: #1560615
* Add reno for release notes managementSean McGinnis2015-12-131-1/+4
| | | | | | | | | | Adopt reno for release notes like we have done for cinder. One difference for the client is we will not be backporting to Liberty per recommendation here [1]. [1] http://lists.openstack.org/pipermail/openstack-dev/2015-November/080694.html Change-Id: Icb2520cfa249d104674eb42b5ac93a50a6ce34b4
* Merge "Update release notes for 1.3.1 and 1.4.0 releases"Jenkins2015-10-211-2/+31
|\
| * Update release notes for 1.3.1 and 1.4.0 releasesSean McGinnis2015-10-091-2/+31
| | | | | | | | | | | | | | | | | | We've had a couple releases of the client but missed updating the docs with any release note information. Added summary of changes for each release. Change-Id: I47edb5199182ca0c952cf60e6b923e6d2edd80ff Closes-Bug: #1503705
* | Add note for broken cinderclient versions 1.2.?scottda2015-10-071-0/+6
|/ | | | | | | | | | | Version discovery was found to break deployments using proxies, so it was reverted. This was introduced in python-cinderclient 1.2.0, persisted in 1.2.1 and 1.2.2, and reverted in 1.3.0 . The 1.2.? versions make note of this in the release notes, and docs generated from release notes will now warn the user of this. Change-Id: Ia866dbf5f5d1c8afd7ff62b31758229f7b09bc99 Closes-Bug: #1503691
* Prep for 1.3.0Mike Perez2015-07-071-0/+17
| | | | Change-Id: I5c6665665427d0916a5e29396ab4fa0eb3e059c6
* Prep for 1.2.2John Griffith2015-06-051-0/+5
| | | | | | | Still in need of a push to pypi for dependency issues, here's the bump, coming up next tag and push. Change-Id: I60ed62278c6baa162405e1b36042d3f229395689
* Update release notes for 1.2.0 and 1.2.11.2.1Mike Perez2015-05-061-0/+80
| | | | | | Prepping for tag. Change-Id: I8ae5e5a0e7ea140d84a0838ffd2ce0c08fcc6aad
* Merge "Fixed typos found by RETF rules"Jenkins2014-11-251-2/+2
|\
| * Fixed typos found by RETF rulesChristian Berendt2014-09-081-2/+2
| | | | | | | | | | | | | | Rules are available at https://en.wikipedia.org/wiki/Wikipedia:AutoWikiBrowser/Typos Change-Id: I8de0631346b703870ce8ebe9ce728a0360f1ba7f
* | Merge "Stop using intersphinx"Jenkins2014-10-141-5/+1
|\ \
| * | Stop using intersphinxAndreas Jaeger2014-09-131-5/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Remove intersphinx from the docs build as it triggers network calls that occasionally fail, and we don't really use intersphinx (links other sphinx documents out on the internet) This also removes the requirement for internet access during docs build. This can cause docs jobs to fail if the project errors out on warnings. Change-Id: I71e941e2a639641a662a163c682eb86d51de42fb Related-Bug: #1368910
* | | Update version to 1.1.1 in index1.1.1John Griffith2014-09-231-0/+4
|/ / | | | | | | | | | | Prep for new tag Change-Id: I49f8f7fcc2647dc09e38fee1fa5068df714a8d83
* | Update index file for release of 1.1.0John Griffith2014-09-101-0/+23
| | | | | | | | Change-Id: I75bbf1cf88fb516409f0ed30b962af7e5ac6236e
* | Update theme for docsSteve Martinelli2014-07-241-2/+2
|/ | | | | | | | The current developer docs theme used is out of sync with the other openstack projects. This patch will update the docs to provide a more consistent look and feel when using developer docs Change-Id: I9fd11b61d4404ba2627569074dc86ee0ddf0f96a
* Bump client doc index version to 1.0.91.0.9John Griffith2014-04-211-0/+3
| | | | | | Prep for push of new client for icehouse release. Change-Id: I281aaa7b628738d423f2cbfe5b78733e4e41714d
* Accept deleting multiple snapshots in one shotXavier Queralt2014-04-031-0/+1
| | | | | | | | | 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
* Require ctrl_location for encryption-type-createPeter Hamilton2014-02-121-0/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | 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
* Fix typos in cinderclientSwapnil Kulkarni2014-02-051-0/+4
| | | | | | | Small nit-pics in volume_transfers. Change-Id: I846b38970b14e6385269a02bb495c63464ea0842 Closes-Bug: #1255905
* Revert "Update cinderclient to skip the additional GET during create"1.0.8Mike Perez2014-02-041-1/+0
| | | | | | | | | This reverts commit 47014971b09f0334e5cc3b414bef31784f88a37d. Conflicts: doc/source/index.rst Change-Id: Ica1e526b2c181d1ce72183b7293d21119371c822
* Update release notes for push to pypijohn-griffith2014-02-021-2/+3
| | | | | | | Need to get a 1.08 out, so just modifying the release notes for the push version. Change-Id: Icf9684ab0fabf0168662c3ff4047db54a2670d11
* Add shell tests for snapshot_deleteEric Harney2014-01-271-0/+1
| | | | | | | | snapshot_delete does not have a shell test covering it. Closes-Bug: #1257747 Change-Id: I22252f5025c11a7c115aa75e07c78424eec75ba1
* Merge "Remove RAX-specific auth in cinderclient"Jenkins2014-01-271-0/+1
|\
| * Remove RAX-specific auth in cinderclientSwapnil Kulkarni2014-01-251-0/+1
| | | | | | | | | | Change-Id: Idd36694a322f467ba5e8c1f58bfac701bff8f3f8 Closes-Bug: #966329
View Lorry Controller Status