ironic/releasenotes/notes/add-runbooks-38c3efa97ace8c67.yaml
cid 48f50248c2 Self-Service via Runbooks
Adds runbooks; the new API feature that makes it possible for
project members to self-serve maintenance tasks through curated step
lists associated with target nodes via traits.

In addition to basic CRUD support, runbook extends current API flow for
performing manual cleaning and servicing to support runbooks in lieu of
an explicit/arbitrary ``clean_steps`` and ``service_steps`` user-defined
lists.

Demo Video: https://youtu.be/00PJS4SXFYQ
Closes-Bug: #2027690

Change-Id: I43555ef72cb882adcada2ed875fda40eed0dd034
2024-08-02 05:44:29 +01:00

20 lines
729 B
YAML

---
features:
- |
Adds a new API concept, runbooks, to enable self-service of maintenance
items on nodes by project members.
Runbooks are curated lists of steps that can be run on nodes only
associated via traits and used in lieu of an explicit list of steps
for manual cleaning or servicing.
- |
Adds a new top-level REST API endpoint `/v1/runbooks/` with basic CRUD
support.
- |
Extends the `/v1/nodes/<node>/states/provision` API to accept a runbook
ident (name or UUID) instead of `clean_steps` or `service_steps` for
servicing or manual cleaning.
- |
Implements RBAC-aware lifecycle management for runbooks, allowing projects
to limit who can CRUD and use a runbook.