diff options
author | Ruby Loo <rloo@verizonmedia.com> | 2020-08-27 12:15:36 +0000 |
---|---|---|
committer | Ruby Loo <rloo@verizonmedia.com> | 2020-08-27 12:15:36 +0000 |
commit | 5c467e7d363fb379134023211131297a5df9a7ce (patch) | |
tree | 534b45d7377cb42e954860b8acdeaeb448988eee /doc | |
parent | 99e8fc981056735928443fa572a38a10d07a51ff (diff) | |
download | ironic-5c467e7d363fb379134023211131297a5df9a7ce.tar.gz |
Update nodes in notifications documentation
This updates the notifications documentation so that the
node information in the sample node-related notifications
reflect the latest versions of the notification payloads.
Which includes the driver_internal_info recently added to
version 1.16 of NodeSetProvisionStatePayload.
Change-Id: I87fb443ff393a2a58f9d19a9011df062f85af3af
Story: #2008054
Task: #40771
Diffstat (limited to 'doc')
-rw-r--r-- | doc/source/admin/notifications.rst | 62 |
1 files changed, 56 insertions, 6 deletions
diff --git a/doc/source/admin/notifications.rst b/doc/source/admin/notifications.rst index b84133d26..2f83e6483 100644 --- a/doc/source/admin/notifications.rst +++ b/doc/source/admin/notifications.rst @@ -184,7 +184,7 @@ Example of node CRUD notification:: "payload":{ "ironic_object.namespace":"ironic", "ironic_object.name":"NodeCRUDPayload", - "ironic_object.version":"1.8", + "ironic_object.version":"1.13", "ironic_object.data":{ "chassis_uuid": "db0eef9d-45b2-4dc0-94a8-fc283c01171f", "clean_step": None, @@ -192,6 +192,7 @@ Example of node CRUD notification:: "console_enabled": False, "created_at": "2016-01-26T20:41:03+00:00", "deploy_step": None, + "description": "my sample node", "driver": "ipmi", "driver_info": { "ipmi_address": "192.168.0.111", @@ -202,9 +203,11 @@ Example of node CRUD notification:: "instance_info": {}, "instance_uuid": None, "last_error": None, + "lessee": None, "maintenance": False, "maintenance_reason": None, "fault": None, + "bios_interface": "no-bios", "boot_interface": "pxe", "console_interface": "no-console", "deploy_interface": "iscsi", @@ -217,15 +220,20 @@ Example of node CRUD notification:: "storage_interface": "noop", "vendor_interface": "no-vendor", "name": None, + "owner": None, "power_state": "power off", "properties": { "memory_mb": 4096, "cpu_arch": "x86_64", "local_gb": 10, "cpus": 8}, + "protected": False, + "protected_reason": None, "provision_state": "deploying", "provision_updated_at": "2016-01-27T20:41:03+00:00", "resource_class": None, + "retired": None, + "retired_reason": None, "target_power_state": None, "target_provision_state": "active", "traits": [ @@ -414,12 +422,14 @@ node maintenance notification:: "payload":{ "ironic_object.namespace":"ironic", "ironic_object.name":"NodePayload", - "ironic_object.version":"1.10", + "ironic_object.version":"1.15", "ironic_object.data":{ "clean_step": None, "conductor_group": "", "console_enabled": False, "created_at": "2016-01-26T20:41:03+00:00", + "deploy_step": None, + "description": "my sample node", "driver": "ipmi", "extra": {}, "inspection_finished_at": None, @@ -427,6 +437,7 @@ node maintenance notification:: "instance_info": {}, "instance_uuid": None, "last_error": None, + "lessee": None, "maintenance": True, "maintenance_reason": "hw upgrade", "fault": None, @@ -443,15 +454,20 @@ node maintenance notification:: "storage_interface": "noop", "vendor_interface": "no-vendor", "name": None, + "owner": None, "power_state": "power off", "properties": { "memory_mb": 4096, "cpu_arch": "x86_64", "local_gb": 10, "cpus": 8}, + "protected": False, + "protected_reason": None, "provision_state": "available", "provision_updated_at": "2016-01-27T20:41:03+00:00", "resource_class": None, + "retired": None, + "retired_reason": None, "target_power_state": None, "target_provision_state": None, "traits": [ @@ -496,12 +512,14 @@ level, "error" has ERROR. Example of node console notification:: "payload":{ "ironic_object.namespace":"ironic", "ironic_object.name":"NodePayload", - "ironic_object.version":"1.10", + "ironic_object.version":"1.15", "ironic_object.data":{ "clean_step": None, "conductor_group": "", "console_enabled": True, "created_at": "2016-01-26T20:41:03+00:00", + "deploy_step": None, + "description": "my sample node", "driver": "ipmi", "extra": {}, "inspection_finished_at": None, @@ -509,6 +527,7 @@ level, "error" has ERROR. Example of node console notification:: "instance_info": {}, "instance_uuid": None, "last_error": None, + "lessee": None, "maintenance": False, "maintenance_reason": None, "fault": None, @@ -525,15 +544,20 @@ level, "error" has ERROR. Example of node console notification:: "storage_interface": "noop", "vendor_interface": "no-vendor", "name": None, + "owner": None, "power_state": "power off", "properties": { "memory_mb": 4096, "cpu_arch": "x86_64", "local_gb": 10, "cpus": 8}, + "protected": False, + "protected_reason": None, "provision_state": "available", "provision_updated_at": "2016-01-27T20:41:03+00:00", "resource_class": None, + "retired": None, + "retired_reason": None, "target_power_state": None, "target_provision_state": None, "traits": [ @@ -572,22 +596,25 @@ ironic-conductor is attempting to change the node:: "payload":{ "ironic_object.namespace":"ironic", "ironic_object.name":"NodeSetPowerStatePayload", - "ironic_object.version":"1.10", + "ironic_object.version":"1.15", "ironic_object.data":{ "clean_step": None, "conductor_group": "", "console_enabled": False, "created_at": "2016-01-26T20:41:03+00:00", "deploy_step": None, + "description": "my sample node", "driver": "ipmi", "extra": {}, "inspection_finished_at": None, "inspection_started_at": None, "instance_uuid": "d6ea00c1-1f94-4e95-90b3-3462d7031678", "last_error": None, + "lessee": None, "maintenance": False, "maintenance_reason": None, "fault": None, + "bios_interface": "no-bios", "boot_interface": "pxe", "console_interface": "no-console", "deploy_interface": "iscsi", @@ -600,15 +627,20 @@ ironic-conductor is attempting to change the node:: "storage_interface": "noop", "vendor_interface": "no-vendor", "name": None, + "owner": None, "power_state": "power off", "properties": { "memory_mb": 4096, "cpu_arch": "x86_64", "local_gb": 10, "cpus": 8}, + "protected": False, + "protected_reason": None "provision_state": "available", "provision_updated_at": "2016-01-27T20:41:03+00:00", "resource_class": None, + "retired": None, + "retired_reason": None, "target_power_state": None, "target_provision_state": None, "traits": [ @@ -642,22 +674,25 @@ prior to the correction:: "payload":{ "ironic_object.namespace":"ironic", "ironic_object.name":"NodeCorrectedPowerStatePayload", - "ironic_object.version":"1.10", + "ironic_object.version":"1.15", "ironic_object.data":{ "clean_step": None, "conductor_group": "", "console_enabled": False, "created_at": "2016-01-26T20:41:03+00:00", "deploy_step": None, + "description": "my sample node", "driver": "ipmi", "extra": {}, "inspection_finished_at": None, "inspection_started_at": None, "instance_uuid": "d6ea00c1-1f94-4e95-90b3-3462d7031678", "last_error": None, + "lessee": None, "maintenance": False, "maintenance_reason": None, "fault": None, + "bios_interface": "no-bios", "boot_interface": "pxe", "console_interface": "no-console", "deploy_interface": "iscsi", @@ -670,15 +705,20 @@ prior to the correction:: "storage_interface": "noop", "vendor_interface": "no-vendor", "name": None, + "owner": None, "power_state": "power off", "properties": { "memory_mb": 4096, "cpu_arch": "x86_64", "local_gb": 10, "cpus": 8}, + "protected": False, + "protected_reason": None, "provision_state": "available", "provision_updated_at": "2016-01-27T20:41:03+00:00", "resource_class": None, + "retired": None, + "retired_reason": None, "target_power_state": None, "target_provision_state": None, "traits": [ @@ -723,23 +763,28 @@ indicate a node's provision states before state change, "event" is the FSM "payload":{ "ironic_object.namespace":"ironic", "ironic_object.name":"NodeSetProvisionStatePayload", - "ironic_object.version":"1.10", + "ironic_object.version":"1.16", "ironic_object.data":{ "clean_step": None, "conductor_group": "", "console_enabled": False, "created_at": "2016-01-26T20:41:03+00:00", "deploy_step": None, + "description": "my sample node", "driver": "ipmi", + "driver_internal_info": { + "is_whole_disk_image": True}, "extra": {}, "inspection_finished_at": None, "inspection_started_at": None, "instance_info": {}, "instance_uuid": None, "last_error": None, + "lessee": None, "maintenance": False, "maintenance_reason": None, "fault": None, + "bios_interface": "no-bios", "boot_interface": "pxe", "console_interface": "no-console", "deploy_interface": "iscsi", @@ -752,15 +797,20 @@ indicate a node's provision states before state change, "event" is the FSM "storage_interface": "noop", "vendor_interface": "no-vendor", "name": None, + "owner": None, "power_state": "power off", "properties": { "memory_mb": 4096, "cpu_arch": "x86_64", "local_gb": 10, "cpus": 8}, + "protected": False, + "protected_reason": None, "provision_state": "deploying", "provision_updated_at": "2016-01-27T20:41:03+00:00", "resource_class": None, + "retired": None, + "retired_reason": None, "target_power_state": None, "target_provision_state": "active", "traits": [ |