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>
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
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>
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
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
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
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 the URL in the document library, and use https instead of http
due to openstack document migration.
Change-Id: I991dff678ce613b0a50e3d0c9ab5ecd8cdf3e272
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
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
