From 5b27592eed1955ea37f0c928e1421cb2565246fc Mon Sep 17 00:00:00 2001 From: Balazs Gibizer Date: Thu, 7 Apr 2016 13:19:02 +0200 Subject: [PATCH] Improve nova.rpc conf options documentation Change-Id: Ie214c8377f1c53120e5601c732616a3d1a75a72d Implements: blueprint centralize-config-options-newton --- nova/conf/rpc.py | 24 ++++++------------------ 1 file changed, 6 insertions(+), 18 deletions(-) diff --git a/nova/conf/rpc.py b/nova/conf/rpc.py index 1e1fdcbb9c92..b9631482d729 100644 --- a/nova/conf/rpc.py +++ b/nova/conf/rpc.py @@ -20,31 +20,19 @@ notification_format = cfg.StrOpt( default='both', 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: * unversioned: Only the legacy unversioned notifications are emitted. * versioned: Only the new versioned notifications are emitted. * both: Both the legacy unversioned and the new versioned notifications are emitted. (Default) -Currently there is no feature parity between unversioned and versioned -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 +The list of versioned notifications is visible in 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: