Yoga Series Release Notes

4.0.0

Upgrade Notes

  • Python 2.7 support has been dropped. Last release of python-keystoneclient to support python 2.7 is OpenStack Train. The minimum version of Python now supported is Python 3.6.

3.22.0

New Features

  • Adds support for creating access rules as an attribute of application credentials as well as for retrieving and deleting them.

3.21.0

New Features

  • Now keystone client supports to list projects which belongs to the given parent project.

3.19.0

New Features

  • [blueprint return-request-id-to-caller] Instantiating client with include_metadata=True will cause manager response to return data along with request_ids for better tracing. Refer [using-api-v3]

    Added support to return “x-openstack-request-id” header in request_ids attribute if include_metadata=True. Also, for APIs which return response as None, client will return request_ids as well if include_metadata is True.

3.18.0

Deprecation Notes

  • The region resource in Keystone never support or contain “enabled” property. Thus the property is deprecated and will be removed in future versions.

3.17.0

New Features

  • Added support for managing project-specific limits. The POST API for limits in keystone supports batch creation, but the client implementation does not. Creation for limits using the client must be done one at a time.

  • Added support for managing registered limits. The POST API for registered limits in keystone supports batch creation, but the client implementation does not. Creation of registered limits using the client must be done one at a time.

3.15.0

New Features

  • Adds support for creating, reading, and deleting application credentials. With application credentials, a user can grant their applications limited access to their cloud resources. Applications can use keystoneauth with the v3applicationcredential auth plugin to authenticate with keystone without needing the user’s password.

  • [blueprint project-tags] The keystoneclient now supports project tags feature in keystone. This allows operators to use the client to associate tags to a project, retrieve tags associated with a project, delete tags associated with a project, and filter projects based on tags.

3.12.0

Prelude

Keystone Client now supports endpoint group filtering.

New Features

  • Support for handling the relationship between endpoint groups and projects has been added. It is now possible to list, associate, check and disassociate endpoint groups that have access to a project.

3.11.0

Deprecation Notes

  • Deprecate the keystoneclient.generic client. This client used to be able to determine available API versions and some basics around installed extensions however the APIs were never upgraded for the v3 API. It doesn’t seem to be used in the openstack ecosystem.

3.10.0

New Features

  • Added ability to filter on multiple values with the same parameter key. For example, we can now filter on user names that contain both test and user using keystone.users.list(name__contains=['test', 'user']).

3.9.0

Bug Fixes

  • [bug 1616105] Only log the response body when the Content-Type header is set to application/json. This avoids logging large binary objects (such as images). Other Content-Type will not be logged. Additional Content-Type strings can be added as required.

  • The X-Service-Token header value is now properly masked, and is displayed as a hash value, in the log.

3.8.0

New Features

  • Added a allow_expired argument to validate and get_token_data in keystoneclient.v3.tokens. Setting this to True, allos for a token validation query to fetch expired tokens.

3.7.0

New Features

  • Added support for domain configs. A user can now upload domain specific configurations to keytone using the client. See client.domain_configs.create, client.domain_configs.delete, client.domain_configs.get and client.domain_configs.update.

3.6.0

Prelude

The data argument for creating and updating credentials has been removed.

Other Notes

  • The data argument for creating and updating credentials was deprecated in the 1.7.0 release. It has been replaced by the blob argument.

3.0.0

Prelude

The keystone CLI has been removed.

Other Notes

  • Removed keystoneclient.apiclient.exceptions. This file was deprecated in v0.7.1 and has now been replaced by keystoneclient.exceptions.

  • The keystone CLI has been removed, using the openstack CLI is recommended. This feature has been deprecated since the Liberty release of Keystone.

2.3.0

New Features

  • support for implied roles in v3 API.

2.2.0

New Features

  • [bug 1479569] With the include_names parameter set to True the names of the role assignments are returned with the entities IDs. (GET /role_assignments?include_names=True)

Deprecation Notes

  • [blueprint deprecate-to-ksa] Several modules related to authentication in keystoneclient have been deprecated in favor of [keystoneauth] These modules include: keystoneclient.session, keystoneclient.adapter, keystoneclient.httpclient, keystoneclient.auth.base, keystoneclient.auth.cli, keystoneclient.auth.conf, keystoneclient.auth.identity.base, and keystoneclient.auth.token_endpoint. Tips for migrating to keystoneauth have been [documented].

2.1.0

Prelude

keystoneclient.middleware has been removed.

keystoneclient.apiclient has been removed.

Critical Issues

  • [bug 1449066] The keystoneclient.middleware module has been removed in favor of the keystonemiddleware library. The aforementioned module has been deprecated since keystoneclient v0.10.0 which was included in the Juno release of OpenStack.

  • [bug 1526651] The keystoneclient.apiclient module has been removed in favor of keystoneclient.exceptions. The aforementioned module has been deprecated since keystoneclient v0.7.1 which was inclued in the Juno release of OpenStack.

Bug Fixes

  • [bug 1462694] Add support for include_subtree in list_role_assignments.

  • [bug 1526686] Replace textwrap with faster code in cms functions.

  • [bug 1457702] Change default endpoint to public for keystone v3.

  • [bug 1520244] Support truncated flag returned from server.

Other Notes

  • Support v2 parameters for the v3 service create method.