Open Stack

We are chuffed to announce the release of:

python-cinderclient 5.0.0: OpenStack Block Storage API Client Library

This release is part of the train release series.

The source is available from:

    https://opendev.org/openstack/python-cinderclient

Download the package from:

    https://pypi.org/project/python-cinderclient

Please report issues through:

    https://bugs.launchpad.net/python-cinderclient/+bugs

For more details, please see below.

5.0.0
^^^^^


Prelude
*******

This is a major version release of python-cinderclient. Backwards
compatibility has been removed for some long standing deprecations and
support for the Cinder v1 API has been removed. Prior to upgrading to
this release, ensure all Cinder services that need to be managed are
13.0.0 (Rocky) or later.


New Features
************

* Automatic version negotiation for the cinderclient CLI. If an API
  version is not specified, the CLI will use the newest supported by
  the client and the server. If an API version newer than the server
  supports is requested, the CLI will fall back to the newest version
  supported by the server and issue a warning message. This does not
  affect cinderclient library usage.

* Starting with microversion 3.59, the "cinder transfer-list"
  command now supports the "--sort" argument to sort the returned
  results. This argument takes either just the attribute to sort on,
  or the attribute and the sort direction. Examples include "cinder
  transfer- list --sort=id" and "cinder transfer-list
  --sort=name:asc".


Upgrade Notes
*************

* Adding "is_public" support in "--filters" option for "type-list"
  and "group-type-list" command. This option is used to filter volume
  types and group types on the basis of visibility. This option has 3
  possible values : True, False, None with details as follows :

  * True: List public types only

  * False: List private types only

  * None: List both public and private types

* This version of the python-cinderclient no longer supports the
  Cinder v1 API. Ensure all mananaged services have at least the v2
  API available prior to upgrading this client.

* The "cinder endpoints" command was deprecated and has now been
  removed. The command "openstack catalog list" should be used
  instead.

* The "cinder credentials" command was deprecated and has now been
  removed. The command "openstack token issue" should be used instead.

* The use of "--os_tenant_name", "--os_tenant_id" and the
  environment variables "OS_TENANT_NAME" and "OS_TENANT_ID" have been
  deprecated for several releases and have now been removed. After
  upgrading, use the equivalent "--os_project_name", "--
  os_project_id", "OS_PROJECT_NAME" and "OS_PROJECT_ID".

* The deprecated volume create option "--allow-multiattach" has now
  been removed. Multiattach capability is now controlled using volume-
  type extra specs (https://docs.openstack.org/cinder/latest/admin
  /blockstorage-volume-multiattach.html).

* Support for the deprecated "--sort_key" and "--sort_dir" arguments
  have now been dropped. Use the supported "--sort" argument instead.

Changes in python-cinderclient 4.3.0..5.0.0
-------------------------------------------

246040a Drop support for --sort_key and --sort_dir
3c1b417 Drop support for --allow-multiattach
61fec71 Update docs to refer to PROJECT instead of TENANT
dce8a8e Drop support for OS_TENANT_NAME and OS_TENANT_ID
624b444 Optional filters parameters should be passed only once
6f761f6 Change PDF file name
4a3a2c3 Add custom CA support for get_server_version
d1b044b Autonegotiate API version for shell
4c031b9 Add support for building pdf documentation
4e3588f Flag safe usage of sha1 w/ #nosec
27e0a32 Migrate the functional job to Zuul v3
2134e92 Blacklist sphinx 2.1.0 (autodoc bug)
57301ec Fix: Quota update successfully executes with no params
8b1ed34 Add transfer-list --sort argument
f8cc121 Drop 'endpoints' and 'credentials' commands
2189e57 Drop support for Cinder v1 API
cd64f0b Add release note for major version bump
34ff180 Enable warnings-as-error for doc builds
6a49816 Add 'is_public' support in '--filters' option


Diffstat (except docs and test files)
-------------------------------------

.zuul.yaml                                         |   22 +-
cinderclient/api_versions.py                       |    7 +-
cinderclient/base.py                               |   33 +-
cinderclient/client.py                             |   42 +-
cinderclient/shell.py                              |  176 ++-
cinderclient/shell_utils.py                        |    3 +
cinderclient/v1/__init__.py                        |   17 -
cinderclient/v1/availability_zones.py              |   42 -
cinderclient/v1/client.py                          |  123 --
cinderclient/v1/contrib/__init__.py                |    0
cinderclient/v1/contrib/list_extensions.py         |   46 -
cinderclient/v1/limits.py                          |   92 --
cinderclient/v1/qos_specs.py                       |  149 --
cinderclient/v1/quota_classes.py                   |   47 -
cinderclient/v1/quotas.py                          |   57 -
cinderclient/v1/services.py                        |   64 -
cinderclient/v1/shell.py                           | 1436 --------------------
cinderclient/v1/volume_backups.py                  |   78 --
cinderclient/v1/volume_backups_restore.py          |   43 -
cinderclient/v1/volume_encryption_types.py         |   98 --
cinderclient/v1/volume_snapshots.py                |  183 ---
cinderclient/v1/volume_transfers.py                |   88 --
cinderclient/v1/volume_types.py                    |  118 --
cinderclient/v1/volumes.py                         |  428 ------
cinderclient/v2/shell.py                           |   48 +-
cinderclient/v2/volumes.py                         |   23 +-
cinderclient/v3/attachments.py                     |    5 +-
cinderclient/v3/group_types.py                     |   11 +-
cinderclient/v3/shell.py                           |  145 +-
cinderclient/v3/volume_transfers.py                |   20 +-
cinderclient/v3/volume_types.py                    |    3 +-
cinderclient/v3/volumes.py                         |   13 +-
.../legacy/cinderclient-dsvm-functional/post.yaml  |   80 --
.../legacy/cinderclient-dsvm-functional/run.yaml   |   49 -
playbooks/post.yaml                                |    6 +
playbooks/python-cinderclient-functional.yaml      |   14 +
...on-is-public-to-type-list-9a16bd9c2b8eb65a.yaml |   13 +
.../notes/cinderclient-5-de0508ce5a221d21.yaml     |   31 +
.../cli-api-ver-negotiation-9f8fd8b77ae299fd.yaml  |   12 +
.../notes/transfer-sort-ca622e9b8da605c1.yaml      |    8 +
roles/get-os-environment/defaults/main.yaml        |    2 +
roles/get-os-environment/tasks/main.yaml           |   12 +
tox.ini                                            |   14 +-
82 files changed, 640 insertions(+), 6324 deletions(-)