From e86604fb6579e2333ab9ab5a6926ef84d201152a Mon Sep 17 00:00:00 2001 From: Balazs Gibizer Date: Mon, 30 Oct 2017 12:59:12 +0100 Subject: [PATCH] Document the real behavior of notify_on_state_change The documentation of the notify_on_state_change config param was incomplete and misleading. The code is untouched since 2012 so the document is updated to reflect the current behavior. Change-Id: I51d0deffc4f42ff2722a8d21aa6b8c8008c62723 Closes-Bug: #1535254 --- nova/conf/notifications.py | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/nova/conf/notifications.py b/nova/conf/notifications.py index 1afe8fc3e58c..6507da0e8f17 100644 --- a/nova/conf/notifications.py +++ b/nova/conf/notifications.py @@ -32,17 +32,22 @@ ALL_OPTS = [ choices=(None, 'vm_state', 'vm_and_task_state'), deprecated_group='DEFAULT', help=""" -If set, send compute.instance.update notifications on instance state -changes. +If set, send compute.instance.update notifications on +instance state changes. -Please refer to https://wiki.openstack.org/wiki/SystemUsageData for +Please refer to +https://docs.openstack.org/nova/latest/reference/notifications.html for additional information on notifications. Possible values: * None - no notifications -* "vm_state" - notifications on VM state changes -* "vm_and_task_state" - notifications on VM and task state changes +* "vm_state" - notifications are sent with VM state transition information in + the ``old_state`` and ``state`` fields. The ``old_task_state`` and + ``new_task_state`` fields will be set to the current task_state of the + instance. +* "vm_and_task_state" - notifications are sent with VM and task state + transition information. """), cfg.StrOpt(