openstack
/
oslo.messaging
Code Issues Proposed changes

Merge "Mark the Pika driver as deprecated"

This commit is contained in:
Jenkins 2017-05-31 03:37:08 +00:00 committed by Gerrit Code Review
parent 268ca151dc c35fb276ce
commit 40532a2a45
3 changed files with 23 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/source/pika_driver.rst
View File

@ -4,6 +4,10 @@ Pika Driver Deployment Guide
.. currentmodule:: oslo_messaging
.. warning:: the Pika driver is no longer maintained and will be
removed from Oslo.Messaging at a future date. It is recommended that
all users of the Pika driver transition to using the Rabbit driver.
============
Introduction
============

16
oslo_messaging/_drivers/impl_pika.py
View File

@ -12,6 +12,7 @@
# License for the specific language governing permissions and limitations
# under the License.
from debtcollector import deprecate
from oslo_config import cfg
from oslo_log import log as logging
from oslo_utils import timeutils
@ -127,15 +128,20 @@ rpc_opts = [
class PikaDriver(base.BaseDriver):
"""Pika Driver
The ``pika`` driver is the successor to the existing rabbit/kombu driver.
It is based on the Pika client library and supports the RabbitMQ broker as
the messaging back end.
See :doc:`pika_driver` for details.
**Warning**: The ``pika`` driver has been deprecated and will be removed in
a future release. It is recommended that all users of the ``pika`` driver
transition to using the ``rabbit`` driver.
"""
def __init__(self, conf, url, default_exchange=None,
allowed_remote_exmods=None):
deprecate("The pika driver is no longer maintained. It has been"
" deprecated",
message="It is recommended that all users of the pika driver"
" transition to using the rabbit driver.",
version="pike", removal_version="rocky")
opt_group = cfg.OptGroup(name='oslo_messaging_pika',
title='Pika driver options')
conf.register_group(opt_group)

8
releasenotes/notes/pika-driver-has-been-deprecated-e2407fa53c91fe5c.yaml Normal file
View File

@ -0,0 +1,8 @@
---
deprecations:
- The pika driver has been deprecated for removal in Rocky. This
driver was developed as a replacement for the default rabbit
driver. However testing has not shown any appreciable improvement
over the default rabbit driver in terms of performance and
stability.