Added Redis SentinelChannel to reference docs

This commit is contained in:
Matus Valo 2020-09-23 23:01:04 +02:00
parent 56e88dc275
commit f475285894
2 changed files with 22 additions and 3 deletions

View File

@ -22,3 +22,10 @@
.. autoclass:: Channel
:members:
:undoc-members:
SentinelChannel
---------------
.. autoclass:: SentinelChannel
:members:
:undoc-members:

View File

@ -1091,16 +1091,28 @@ class SentinelChannel(Channel):
Broker url is supposed to look like:
sentinel://0.0.0.0:26379;sentinel://0.0.0.0:26380/...
.. code-block::
sentinel://0.0.0.0:26379;sentinel://0.0.0.0:26380/...
where each sentinel is separated by a `;`.
Other arguments for the sentinel should come from the transport options
(see :method:`Celery.connection` which is in charge of creating the
`Connection` object).
(see `transport_options` of :class:`~kombu.connection.Connection`).
You must provide at least one option in Transport options:
* `master_name` - name of the redis group to poll
Example:
.. code-block:: python
>>> import kombu
>>> c = kombu.Connection(
'sentinel://sentinel1:26379;sentinel://sentinel2:26379',
transport_options={'master_name': 'mymaster'}
)
>>> c.connect()
"""
from_transport_options = Channel.from_transport_options + (