nova/releasenotes/notes/bp-add-locked-reason-fb757750f7f077ef.yaml
Surya Seetharaman c541ace518 Microversion 2.73: Support adding the reason behind a server lock
This patch adds a new parameter ``locked_reason`` to
``POST /servers/{server_id}/action`` request where the
action is lock. It enables the user to specify a reason when locking
a server.

The locked_reason will be exposed through ``GET servers/{server_id}``,
``GET /servers/detail``, ``POST /servers/{server_id}/action``  where
the action is rebuild and ``PUT servers/{server_id}`` requests' responses.

The InstanceActionNotification will emit the locked_reason
along with the other instance details. This patch hence changes the
payload object to include the "locked_reason" field.

Note that "locked" will be allowed as a valid filtering/sorting parameter
for ``GET /servers/detail`` and ``GET /servers`` from this new microversion.

Implements blueprint add-locked-reason

Change-Id: I46edd595e7417c584106487123774a73c6dbe65e
2019-05-11 21:48:27 +00:00

18 lines
806 B
YAML

---
features:
- |
Added a new ``locked_reason`` option in microversion 2.73 to the
``POST /servers/{server_id}/action`` request where the action is lock.
It enables the user to specify a reason when locking a server. This
information will be exposed through the response of the following APIs:
- ``GET servers/{server_id}``
- ``GET /servers/detail``
- ``POST /servers/{server_id}/action`` where the action is rebuild
- ``PUT servers/{server_id}``
In addition, ``locked`` will be supported as a valid filter/sort parameter
for ``GET /servers/detail`` and ``GET /servers`` so that users can filter
servers based on their locked value. Also the instance action versioned
notifications for the lock/unlock actions now contain the ``locked_reason``
field.