openstack/nova
Code Issues Proposed changes

Document how to disable notifications

Browse Source 
This adds information to the "notification_format" config
option help and notifications docs on how to disable notifications.

While updating the config option help text, a stale reference
to Pike is removed.

Change-Id: I736025a0a88fc969831558805687b642da8cd365
Closes-Bug: #1761405
This commit is contained in:
Matt Riedemann
2018-04-16 14:12:12 -04:00
parent fb0b785169
commit 11528966ba
2 changed files with 12 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
doc/source/reference/notifications.rst
View File

@@ -29,6 +29,14 @@ following::
"payload": <json serialized dict, defined by the sender> "payload": <json serialized dict, defined by the sender>
} }
Notifications can be completely disabled by setting the following in
your nova configuration file:
.. code-block:: ini
[oslo_messaging_notifications]
driver = noop
There are two types of notifications in Nova: legacy notifications which have There are two types of notifications in Nova: legacy notifications which have
an unversioned payload and newer notifications which have a versioned payload. an unversioned payload and newer notifications which have a versioned payload.

5
nova/conf/notifications.py
View File

@@ -94,7 +94,10 @@ Specifies which notification format shall be used by nova.
The default value is fine for most deployments and rarely needs to be changed. The default value is fine for most deployments and rarely needs to be changed.
This value can be set to 'versioned' once the infrastructure moves closer to This value can be set to 'versioned' once the infrastructure moves closer to
consuming the newer format of notifications. After this occurs, this option consuming the newer format of notifications. After this occurs, this option
will be removed (possibly in the "P" release). will be removed.
Note that notifications can be completely disabled by setting ``driver=noop``
in the ``[oslo_messaging_notifications]`` group.
Possible values: Possible values:
* unversioned: Only the legacy unversioned notifications are emitted. * unversioned: Only the legacy unversioned notifications are emitted.