Deploy steps - API & notifications

Adds a 'deploy_step' field to the nodes API.

Co-Authored-By: Ruby Loo <rloo@oath.com>

Change-Id: I1baeeaaa6ed521e4189958fd7624cd6c5de96707
Story: #1753128
Task: #22592

6 files changed, 19 insertions, 1 deletions

diff --git a/api-ref/source/baremetal-api-v1-nodes.inc b/api-ref/source/baremetal-api-v1-nodes.inc
index 6a6eaf1d1..13b57cad1 100644
--- a/api-ref/source/baremetal-api-v1-nodes.inc
+++ b/api-ref/source/baremetal-api-v1-nodes.inc
@@ -86,6 +86,9 @@ supplied when the Node is created, or the resource may be updated later.
   Introduced the ``rescue_interface`` field. If this field is not supplied
   when creating the Node, the default value will be used.
 
+.. versionadded:: 1.44
+  Introduced the ``deploy_step`` field.
+
 Normal response codes: 201
 
 Error codes: 400,403,406
@@ -132,7 +135,7 @@ and any defaults added for non-specified fields. Most fields default to "null"
 or "".
 
 The list and example below are representative of the response as of API
-microversion 1.43.
+microversion 1.44.
 
 .. rest_parameters:: parameters.yaml
 
@@ -159,6 +162,7 @@ microversion 1.43.
     - raid_config: raid_config
     - target_raid_config: target_raid_config
     - clean_step: clean_step
+    - deploy_step: deploy_step
     - links: links
     - ports: n_ports
     - portgroups: n_portgroups
@@ -333,6 +337,7 @@ Response
     - raid_config: raid_config
     - target_raid_config: target_raid_config
     - clean_step: clean_step
+    - deploy_step: deploy_step
     - links: links
     - ports: n_ports
     - portgroups: n_portgroups
@@ -416,6 +421,7 @@ Response
     - raid_config: raid_config
     - target_raid_config: target_raid_config
     - clean_step: clean_step
+    - deploy_step: deploy_step
     - links: links
     - ports: n_ports
     - portgroups: n_portgroups
@@ -500,6 +506,7 @@ Response
     - raid_config: raid_config
     - target_raid_config: target_raid_config
     - clean_step: clean_step
+    - deploy_step: deploy_step
     - links: links
     - ports: n_ports
     - portgroups: n_portgroups
diff --git a/api-ref/source/parameters.yaml b/api-ref/source/parameters.yaml
index 240ce9ab3..f3f2eb6dc 100644
--- a/api-ref/source/parameters.yaml
+++ b/api-ref/source/parameters.yaml
@@ -492,6 +492,12 @@ deploy_interface:
   in: body
   required: true
   type: string
+deploy_step:
+  description: |
+    The current deploy step.
+  in: body
+  required: false
+  type: string
 description:
   description: |
     Descriptive text about the Ironic service.
diff --git a/api-ref/source/samples/node-create-response.json b/api-ref/source/samples/node-create-response.json
index 64605e667..d9e66049e 100644
--- a/api-ref/source/samples/node-create-response.json
+++ b/api-ref/source/samples/node-create-response.json
@@ -6,6 +6,7 @@
   "console_interface": null,
   "created_at": "2016-08-18T22:28:48.643434+11:11",
   "deploy_interface": null,
+  "deploy_step": {},
   "driver": "agent_ipmitool",
   "driver_info": {
     "ipmi_password": "******",
diff --git a/api-ref/source/samples/node-show-response.json b/api-ref/source/samples/node-show-response.json
index 95e27c4ff..bea794cd1 100644
--- a/api-ref/source/samples/node-show-response.json
+++ b/api-ref/source/samples/node-show-response.json
@@ -6,6 +6,7 @@
   "console_interface": null,
   "created_at": "2016-08-18T22:28:48.643434+11:11",
   "deploy_interface": null,
+  "deploy_step": {},
   "driver": "fake",
   "driver_info": {
     "ipmi_password": "******",
diff --git a/api-ref/source/samples/node-update-driver-info-response.json b/api-ref/source/samples/node-update-driver-info-response.json
index 36dadef97..6723b2878 100644
--- a/api-ref/source/samples/node-update-driver-info-response.json
+++ b/api-ref/source/samples/node-update-driver-info-response.json
@@ -6,6 +6,7 @@
   "console_interface": null,
   "created_at": "2016-08-18T22:28:48.643434+11:11",
   "deploy_interface": null,
+  "deploy_step": {},
   "driver": "fake",
   "driver_info": {
     "deploy_kernel": "http://127.0.0.1/images/kernel",
diff --git a/api-ref/source/samples/nodes-list-details-response.json b/api-ref/source/samples/nodes-list-details-response.json
index 7d17ce415..96e181b02 100644
--- a/api-ref/source/samples/nodes-list-details-response.json
+++ b/api-ref/source/samples/nodes-list-details-response.json
@@ -8,6 +8,7 @@
       "console_interface": null,
       "created_at": "2016-08-18T22:28:48.643434+11:11",
       "deploy_interface": null,
+      "deploy_step": {},
       "driver": "fake",
       "driver_info": {
         "ipmi_password": "******",
@@ -105,6 +106,7 @@
       "console_interface": "no-console",
       "created_at": "2016-08-18T22:28:48.643434+11:11",
       "deploy_interface": "iscsi",
+      "deploy_step": {},
       "driver": "ipmi",
       "driver_info": {
         "ipmi_password": "******",