summaryrefslogtreecommitdiff
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
* Remove v2 classesBrian Rosmaita2021-07-141-2/+2
| | | | | | | | | Remove all cinderclient.v2 classes, mostly incorporating them into their v3 counterparts and updating the tests and test fixtures. Depends-on: https://review.opendev.org/c/openstack/horizon/+/800814 Change-Id: I335db5c1799edb2273bf8bfc9e1bc9de404a4ba5
* Update requirements for wallaby releaseBrian Rosmaita2021-03-111-1/+1
| | | | | | | Updates requirements to what we're using now and revises the lower-constraints file to contain only direct dependencies. Change-Id: I1a3cc999b94dc6b6482b1ca44218b42ee2638a8c
* Dropping explicit unicode literaltushargite962021-03-111-4/+4
| | | | | | | | | In python 3, all strings are considered as unicode string. This patch drops the explicit unicode literal (u'...') or (u"..") appearances from the unicode strings. Change-Id: I9902966892a1dc4f85d449dfe580fb128647487b
* Doc: Functional Tests in python-cinderclienttushargite962021-02-231-2/+2
| | | | | | | ostestr command is deprecated. Closes-bug: #1866376 Change-Id: I24398d481002f30754368ac601ff3ac304f3fb82
* Merge "doc: Update Py37 instead of py27"Zuul2020-10-151-3/+3
|\
| * doc: Update Py37 instead of py27tushargite962020-09-171-3/+3
| | | | | | | | | | | | | | Examples in this section should use a Python 3 environment and not py27. Change-Id: If082b92e089af980e411b4b4c1319e462862a55f Closes-Bug: #1866375
* | Python API in python-cinderclienttushargite962020-09-151-1/+1
|/ | | | | | | "myvol.delete" should be "myvol.delete()" Change-Id: Iadddfed8deec1f0dee2b71effb3b4de2689d6ada Closes-Bug: #1866374
* Merge "Add doc linting to pep8 target"Zuul2020-08-262-7/+11
|\
| * Add doc linting to pep8 targetSean McGinnis2020-06-052-7/+11
| | | | | | | | | | | | | | | | This adds doc8 to the pep8 job to lint the docs. Also fixes a few issues it highlighted. Change-Id: Id0f4b9bee1f6a0103ec581b20037a9b74201aaca Signed-off-by: Sean McGinnis <sean.mcginnis@gmail.com>
* | trivial: Drop references to os-testrStephen Finucane2020-07-092-2/+2
|/ | | | | | | os-testr is dead. Long live stestr. Change-Id: Ie37f00e2f5ef2230adcff0d662e2d0b214b8c74c Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
* Add directive to document CLISean McGinnis2020-06-034-4473/+190
| | | | | | | | | | | | | | | | Our CLI docs are very out of date. These used to be generated by the docs team with some tooling they had. Since the docs moved in-repo, that tooling has gone away, and for the most part no one has done any updates to the CLI docs. This adds a sphinx directive that will generate these docs every time the docs are built. This way, whenever someone makes a CLI change, they do not need to have to know to also edit a documentation file to match their change. Any code changes will automatically be picked up and reflected in the docs. Change-Id: I4406872ab6e9335e338b710e492171580df74fa5 Signed-off-by: Sean McGinnis <sean.mcginnis@gmail.com>
* Switch to newer openstackdocstheme and reno versionsAndreas Jaeger2020-05-222-9/+8
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | Switch to openstackdocstheme 2.2.1 and reno 3.1.0 versions. Using these versions will allow especially: * Linking from HTML to PDF document * Allow parallel building of documents * Fix some rendering problems Update Sphinx version as well. openstackdocstheme renames some variables, so follow the renames. A couple of variables are also not needed anymore, remove them. Set openstackdocs_auto_name to use project as name. Set openstackdocs_pdf_link to link to PDF file. Note that the link to the published document only works on docs.openstack.org where the PDF file is placed in the top-level html directory. The site-preview places the PDF in a pdf directory. Change pygments_style to 'native' since old theme version always used 'native' and the theme now respects the setting and using 'sphinx' can lead to some strange rendering. See also http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html Change-Id: I2cc022495b162bec1424ec69611acb879900c005
* Merge "Remove autogen warning"Zuul2020-04-071-18/+0
|\
| * Remove autogen warningIan Wienand2020-03-251-18/+0
| | | | | | | | | | | | This isn't autogenerated ... it would be good if it was, but it isn't. Change-Id: Iaf8b2375051e2dbd8cf6fd653fac4cdc60b4e7ea
* | Merge "Add support for Block Storage API mv 3.60"Zuul2020-04-061-17/+59
|\ \ | |/ |/|
| * Add support for Block Storage API mv 3.60wanghao2020-04-061-17/+59
| | | | | | | | | | | | | | | | | | | | | | | | | | Change I1f43c37c2266e43146637beadc027ccf6dec017e adds time-comparison filtering to the volume list calls (summary and detail) in the Block Storage API microversion 3.60. The current cinderclient filter support will pass these filters correctly, so the only change needed on the client side is to bump the MAX_VERSION so that the client can make calls to mv 3.60. Co-authored-by: Brian Rosmaita <rosmaita.fossdev@gmail.com> Change-Id: Ib4b7cbc7e527c0524336e139e127f19accfb7568 Partially-Implements: bp support-to-query-cinder-resources-filter-by-time-comparison-operators
* | Remove --bypass-url documentationIan Wienand2020-03-242-9/+4
|/ | | | | | | This was removed with I3b951cc4eb3adff23f3d2cbe674971816261ef56; cleanup old references. Change-Id: I71e6da99dff04d86b9dd67a754764b1e742d366a
* Merge "Fix doc bug filing link"Zuul2020-03-111-2/+2
|\
| * Fix doc bug filing linkEric Harney2020-03-061-2/+2
| | | | | | | | | | | | | | | | | | This needs to go to "python-cinderclient" to work instead of "cinderclient". Add a "doc" tag to these bugs as well. Change-Id: I45ae03e9c071dd9b159b1c0183b53db4dd837453
* | Ussuri contrib docs community goalBrian Rosmaita2020-03-052-0/+15
|/ | | | | | | This patch standardizes the CONTRIBUTING.rst file and adds doc/source/contributor/contributing.rst Change-Id: I892e49f96573b77b46bd8847a5d2ac8254e8e5e1
* Drop support for python 2xuanyandong2020-01-161-2/+1
| | | | | | | | | | | Also adds support for py3.6 and py3.7 check and gate jobs. Co-authored-by: xuanyandong <xuanyandong@inspur.com> Co-authored-by: Brian Rosmaita <rosmaita.fossdev@gmail.com> Closes-bug: #1853372 Change-Id: Ia978b692ade23ee6482957f41b17cb879c96fea7
* Update hacking versionjacky062019-10-301-1/+1
| | | | | | Use latest release 1.1.0 and compatible changes w.r.t pep8 Change-Id: I1ae708f0753249226ceb47610a1a4d0b558c1d0e
* Update docs to refer to PROJECT instead of TENANTSean McGinnis2019-09-103-7/+7
| | | | | | | | Updates several references for things like OS_TENANT_NAME and --os-tenant-name. Change-Id: If71710740b4d4573a1b3f515a5762a4f82bc727d Signed-off-by: Sean McGinnis <sean.mcginnis@gmail.com>
* Merge "Autonegotiate API version for shell"Zuul2019-09-041-0/+8
|\
| * Autonegotiate API version for shellEric Harney2019-08-281-0/+8
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | If OS_VOLUME_API_VERSION is not set, use the highest supported by both the client and the server. If OS_VOLUME_API_VERSION exceeds that supported by the server, use the highest supported by both the client and the server. A warning message is printed for the user indicating that this happened. (This is similar to the behavior of the manila CLI, and is mostly code from manilaclient tweaked to work in cinderclient.) Change-Id: Ie1403eca2a191f62169e60c0cde1622575327387
* | Change PDF file nameAndreas Jaeger2019-09-041-1/+1
| | | | | | | | | | | | | | | | | | | | | | The previously choosen PDF file name conflicts in some repos with the project logos (badge). Thus change https://review.opendev.org/679777 renames the desired PDF name to be doc-PROJECT.pdf to allow using the badge in PDF files. Follow this rename. Change-Id: Ife8461f00ba2206d18ae45837bbc31d211e29841
* | Add support for building pdf documentationWalter A. Boring IV2019-08-271-0/+47
| | | | | | | | | | | | | | | | | | This patch updates tox.ini to build the pdf version of cinderclient documentation. run tox -epdf-docs Change-Id: If1f43e593db6ff6740b8a88b517c4505e39a3edd
* | Merge "Blacklist sphinx 2.1.0 (autodoc bug)"Zuul2019-08-081-1/+1
|\ \
| * | Blacklist sphinx 2.1.0 (autodoc bug)pengyuesheng2019-07-301-1/+1
| | | | | | | | | | | | | | | | | | See https://github.com/sphinx-doc/sphinx/issues/6440 for upstream details Change-Id: I1d923d9922bdaaca381611cba299522c21546736
* | | Merge "Remove the hard-coded version number."Zuul2019-07-191-2/+0
|\ \ \ | |/ / |/| |
| * | Remove the hard-coded version number.cychiang2019-06-261-2/+0
| |/ | | | | | | | | | | | | | | | | Reference the python-novaclient cli doc. And removed the "cinder version 2.2.0." in python-cinderclient cli doc to avoid confusing users. Closes-Bug: #1831636 Change-Id: I67ef7e532ba46932d9f5d2835a611162140b354c
* | Merge "Remove promote/reenable replication"Zuul2019-07-101-8/+0
|\ \
| * | Remove promote/reenable replicationMinmin Ren2019-06-191-8/+0
| |/ | | | | | | | | | | | | | | | | | | The replication 1.0 API os-promote-replica and os-reenable-replica were removed[1], then remove useless code from cinderclient. [1]: https://review.openstack.org/#/c/275797/ Change-Id: Icf98f294c089942e11607786e932abc959f77b3b
* | Bump openstackdocstheme to 1.20.0翟小君2019-07-042-12/+7
|/ | | | | | | | | | | | Some options are now automatically configured by the version 1.20: - project - html_last_updated_fmt - latex_engine - latex_elements - version - release. Change-Id: Icbfa21da1e83f745a98822a2f33c4ebc8d11fd0c
* Update sphinx dependencypengyuesheng2019-05-221-1/+2
| | | | Change-Id: I798f826c1da97b20ccf9decd177754a7a0b055fa
* Merge "Cleanup the home page"Zuul2019-02-065-91/+11
|\
| * Cleanup the home pageMatt Riedemann2018-12-045-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
* | Fix doc build errorEric Harney2018-12-141-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
* 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
* Updated from global requirementsOpenStack Proposal Bot2018-03-151-1/+1
| | | | Change-Id: I24bc426d17cd29ba4c162de3fbdda6248214b7be
* 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>
* Merge "Remove unit tests about run_test"Zuul2018-03-011-99/+0
|\
| * 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>
* | Updated from global requirementsOpenStack Proposal Bot2018-01-241-1/+1
|/ | | | Change-Id: Ie7534a355e2b884707b9326243efa10c866bd97a
* Updated from global requirementsOpenStack Proposal Bot2018-01-181-1/+1
| | | | Change-Id: I25be0e60459c2dc652b4ee8672984a65d3cf143e
* Updated from global requirementsOpenStack Proposal Bot2018-01-021-0/+3
| | | | Change-Id: I4d4efd8f1713972164a6ede13f3aa7d62f8e9717
* Follow the new PTI for document buildjiansong2017-12-211-0/+4
| | | | | | | | | | | | For compliance with the Project Testing Interface as described in: https://governance.openstack.org/tc/reference/project-testing-interface.html For more detials information, please refer to: http://lists.openstack.org/pipermail/openstack-dev/2017-December/125710.html Change-Id: I7615e33c0d00c56b3ee6cb856a0553e32a1664c6
View Lorry Controller Status