openstack/nova
Code Issues Proposed changes

Improve nova.rpc conf options documentation

Browse Source 
Change-Id: Ie214c8377f1c53120e5601c732616a3d1a75a72d
Implements: blueprint centralize-config-options-newton
This commit is contained in:
Balazs Gibizer 2016-04-07 13:19:02 +02:00
parent d8891f8d45
commit 5b27592eed
1 changed files with 6 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
nova/conf/rpc.py
View File

@ -20,31 +20,19 @@ notification_format = cfg.StrOpt(
default='both', default='both',
help="""Specifies which notification format shall be used by nova. help="""Specifies which notification format shall be used by nova.
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
consuming the newer format of notifications. After this occurs, this option
will be removed (possibly in the "P" release).
Possible values: Possible values:
* unversioned: Only the legacy unversioned notifications are emitted. * unversioned: Only the legacy unversioned notifications are emitted.
* versioned: Only the new versioned notifications are emitted. * versioned: Only the new versioned notifications are emitted.
* both: Both the legacy unversioned and the new versioned notifications are * both: Both the legacy unversioned and the new versioned notifications are
emitted. (Default) emitted. (Default)
Currently there is no feature parity between unversioned and versioned The list of versioned notifications is visible in
notifications. If the deployment needs the full range of legacy notifications
then the recommended setting is 'both' or 'unversioned'. Nova does not allow
adding new legacy notifications so new notification will be emitted as
versioned notifications. If the deployment needs the new notifications then
either 'both' or 'versioned' value is required. The list of versioned
notifications is visible in
http://docs.openstack.org/developer/nova/notifications.html http://docs.openstack.org/developer/nova/notifications.html
Nova is planning to deprecate this parameter as soon as feature parity is
achieved.
This is an advanced option, deployers rarely needs to change the default value.
Services which consume this:
* nova-api
* nova-conductor
* nova-compute
* nova-scheduler
Related options: Related options: