119 lines
4.4 KiB
Python
119 lines
4.4 KiB
Python
# Copyright (c) 2016 Intel, Inc.
|
|
# Copyright (c) 2013 OpenStack Foundation
|
|
# All Rights Reserved.
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License"); you may
|
|
# not use this file except in compliance with the License. You may obtain
|
|
# a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
|
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
|
# License for the specific language governing permissions and limitations
|
|
# under the License.
|
|
|
|
from oslo_config import cfg
|
|
|
|
notifications_group = cfg.OptGroup(
|
|
name='notifications',
|
|
title='Notifications options',
|
|
help="""
|
|
Most of the actions in Nova which manipulate the system state generate
|
|
notifications which are posted to the messaging component (e.g. RabbitMQ) and
|
|
can be consumed by any service outside the OpenStack. More technical details
|
|
at https://docs.openstack.org/nova/latest/reference/notifications.html
|
|
""")
|
|
|
|
ALL_OPTS = [
|
|
cfg.StrOpt(
|
|
'notify_on_state_change',
|
|
choices=[
|
|
(None, 'no notifications'),
|
|
('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'),
|
|
],
|
|
deprecated_group='DEFAULT',
|
|
help="""
|
|
If set, send compute.instance.update notifications on
|
|
instance state changes.
|
|
|
|
Please refer to
|
|
https://docs.openstack.org/nova/latest/reference/notifications.html for
|
|
additional information on notifications.
|
|
"""),
|
|
|
|
cfg.StrOpt(
|
|
'default_level',
|
|
default='INFO',
|
|
choices=('DEBUG', 'INFO', 'WARN', 'ERROR', 'CRITICAL'),
|
|
deprecated_group='DEFAULT',
|
|
deprecated_name='default_notification_level',
|
|
help="Default notification level for outgoing notifications."),
|
|
cfg.StrOpt(
|
|
'notification_format',
|
|
default='unversioned',
|
|
choices=[
|
|
('both', 'Both the legacy unversioned and the new versioned '
|
|
'notifications are emitted'),
|
|
('versioned', 'Only the new versioned notifications are emitted'),
|
|
('unversioned', 'Only the legacy unversioned notifications are '
|
|
'emitted'),
|
|
],
|
|
deprecated_group='DEFAULT',
|
|
help="""
|
|
Specifies which notification format shall be emitted by nova.
|
|
|
|
The versioned notification interface are in feature parity with the legacy
|
|
interface and the versioned interface is actively developed so new consumers
|
|
should used the versioned interface.
|
|
|
|
However, the legacy interface is heavily used by ceilometer and other mature
|
|
OpenStack components so it remains the default.
|
|
|
|
Note that notifications can be completely disabled by setting ``driver=noop``
|
|
in the ``[oslo_messaging_notifications]`` group.
|
|
|
|
The list of versioned notifications is visible in
|
|
https://docs.openstack.org/nova/latest/reference/notifications.html
|
|
"""),
|
|
cfg.ListOpt(
|
|
'versioned_notifications_topics',
|
|
default=['versioned_notifications'],
|
|
help="""
|
|
Specifies the topics for the versioned notifications issued by nova.
|
|
|
|
The default value is fine for most deployments and rarely needs to be changed.
|
|
However, if you have a third-party service that consumes versioned
|
|
notifications, it might be worth getting a topic for that service.
|
|
Nova will send a message containing a versioned notification payload to each
|
|
topic queue in this list.
|
|
|
|
The list of versioned notifications is visible in
|
|
https://docs.openstack.org/nova/latest/reference/notifications.html
|
|
"""),
|
|
cfg.BoolOpt(
|
|
'bdms_in_notifications',
|
|
default=False,
|
|
help="""
|
|
If enabled, include block device information in the versioned notification
|
|
payload. Sending block device information is disabled by default as providing
|
|
that information can incur some overhead on the system since the information
|
|
may need to be loaded from the database.
|
|
""")
|
|
]
|
|
|
|
|
|
def register_opts(conf):
|
|
conf.register_group(notifications_group)
|
|
conf.register_opts(ALL_OPTS, group=notifications_group)
|
|
|
|
|
|
def list_opts():
|
|
return {notifications_group: ALL_OPTS}
|