openstack/ironic
Code Issues Proposed changes

Increment API version for Secure RBAC

Browse Source 
This patch increments the API version for the Secure RBAC
as was covered in the specification in order to signify to
API consumers that may need to be aware if the API surface
can support Secure RBAC policy configuration.

Change-Id: Ia659708bb89ff416b65367505d3e068c6d4a198f
This commit is contained in:
Julia Kreger 2021-03-05 06:33:46 -08:00
parent 1404f3e00b
commit e5b391c32d
4 changed files with 24 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
doc/source/contributor/webapi-version-history.rst
View File

@ -2,12 +2,20 @@
REST API Version History
========================
1.70 (Wallaby, TBD)
-------------------
1.71 (Wallaby)
--------------
Signifier of the API supporting keystone ``system`` scoped roles and
access controls. This is an informational flag for clients to be aware of
the server's capability.
1.70 (Wallaby)
--------------
Add support for ``disable_ramdisk`` parameter to provisioning endpoint
``/v1/nodes/{node_ident}/states/provision``.
1.69 (Wallaby, 16.2)
----------------------

4
ironic/api/controllers/v1/versions.py
View File

@ -108,6 +108,7 @@ BASE_VERSION = 1
# v1.68: Add agent_verify_ca to heartbeat.
# v1.69: Add deploy_steps to provisioning
# v1.70: Add disable_ramdisk to manual cleaning.
# v1.71: Add signifier for Scope based roles.
MINOR_0_JUNO = 0
MINOR_1_INITIAL_VERSION = 1
@ -180,6 +181,7 @@ MINOR_67_NODE_VIF_ATTACH_PORT = 67
MINOR_68_HEARTBEAT_VERIFY_CA = 68
MINOR_69_DEPLOY_STEPS = 69
MINOR_70_CLEAN_DISABLE_RAMDISK = 70
MINOR_71_RBAC_SCOPES = 71
# When adding another version, update:
# - MINOR_MAX_VERSION
@ -187,7 +189,7 @@ MINOR_70_CLEAN_DISABLE_RAMDISK = 70
# explanation of what changed in the new version
# - common/release_mappings.py, RELEASE_MAPPING['master']['api']
MINOR_MAX_VERSION = MINOR_70_CLEAN_DISABLE_RAMDISK
MINOR_MAX_VERSION = MINOR_71_RBAC_SCOPES
# String representations of the minor and maximum versions
_MIN_VERSION_STRING = '{}.{}'.format(BASE_VERSION, MINOR_1_INITIAL_VERSION)

2
ironic/common/release_mappings.py
View File

@ -302,7 +302,7 @@ RELEASE_MAPPING = {
}
},
'master': {
'api': '1.70',
'api': '1.71',
'rpc': '1.53',
'objects': {
'Allocation': ['1.1'],

10
releasenotes/notes/secure-rbac-api-version-increment-1785544f54a487b3.yaml Normal file
View File

@ -0,0 +1,10 @@
---
other:
- |
The API version of the Bare Metal API provided by the ``ironic-api``
service has been incremented to ``1.71`` to signify that the API supports
System and Project scoped Role Based Access Controls, which is purely
informational in nature, as the version itself cannot be used to change
the API behavior for access controls. In excess of 1500 unit tests were
added as part of the effort to implement Role Based Access Controls to
help ensure the effort did not break the API behavior.