128 Commits

Author SHA1 Message Date
Hervé Beraud
b56380654a Introduce RabbitMQ driver documentation
Introduce a RabbitMQ driver documentation for admin.

Describing:
- some RabbitMQ and AMQP specifications (exchanges, queues, routing-key)
- the heartbeat specification and the type of used threads
- the driver options

Change-Id: I8fd1624834510f8dee81ab9342c708d726b8f827
2019-08-08 17:59:56 +02:00
Zuul
dfc8fe9a8f Merge "Support kafka message compression" 2019-08-05 15:53:35 +00:00
Zuul
a5276be3dc Merge "Bump the openstackdocstheme extension to 1.20" 2019-07-22 15:12:22 +00:00
pengyuesheng
33dc529c37 Bump the openstackdocstheme extension to 1.20
Some options are now automatically configured by the version 1.20:
- project
- html_last_updated_fmt
- latex_engine
- latex_elements
- version
- release.

Change-Id: Ib5e22f6a5374f05e576bbc00a209209fdb09acad
2019-07-19 11:24:08 +08:00
Stephen Finucane
f0eee1e16b doc: Cleanup admin docs
Use a sensible header style, fix some syntax highlighting, and generally
tidy things up.

Change-Id: I0b141b968ed8db10ff41a626569dd185edbdc641
Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
2019-07-04 14:50:57 +01:00
zhang-shaoman
9a752862e2 Support kafka message compression
When the message is large, in order to improve the efficiency of
kafka, we need to compress the message before send it, so we need to
support kafka message compression.

Change-Id: I9e86d43ad934c1f82dc3dcf93d317538f9d2568e
Implements: blueprint support-kafka-compression
2019-06-20 11:18:35 +08:00
Ben Nemec
70b03bcf83 Download kafka from archive.apache.org
It seems that versions are deleted from www.apache.org pretty quickly.
They stick around longer on archive.apache.org so we won't have to
be constantly chasing the latest version in our functional tests.

Change-Id: I047edac67699dd598f8dfd0f859b3772f6068bd3
2019-06-10 15:35:43 +00:00
jacky06
9b7bcbda2f Replace git.openstack.org URLs with opendev.org URLs
Change-Id: Ib4a523adf3275a8727d5a4f2a149e163a81be3cc
2019-04-26 10:31:26 +08:00
Andy Smith
0953fa1759 Kafka driver deployment guide
Depends-On: Idfb9fe3700d882c8285c6dc56b0620951178eba2
Change-Id: If8370c0c83312d675bde837f768ae40ec3603972
2019-01-23 08:27:43 -05:00
Zuul
7b6e2e49e3 Merge "doc: Remove crud from conf.py file" 2018-10-23 10:23:04 +00:00
Hervé Beraud
0410bcbf54 Using pip as a python module
Since python 2.7.9 and python 3.4
pip is a stdin module

Change-Id: I17c8c93337fa4f0a33f9131d4117739179133ea9
2018-10-15 10:56:55 +02:00
Hervé Beraud
ad0d99c812 doc: Remove crud from conf.py file
Change-Id: I35c6221f78cac9fe4ab3e194e8a94ca4f0b24ca2
2018-10-15 09:42:18 +02:00
Andy Smith
f2fd8d4375 Remove the deprecated ZeroMQ driver
Users of the oslo.messaging RPC communications service must use
the rabbit ("rabbit://...") or AMQP 1.0 ("amqp://...") drivers.

Change-Id: If3474142f1fe99d41d7b4466061ed0e23ca38549
Closes-Bug: 1789259
2018-08-28 16:00:50 -04:00
Kenneth Giusti
42f0358d5d Mark the ZeroMQ driver deprecated
As per the Dublin 2018 PTG decision:

http://lists.openstack.org/pipermail/openstack-dev/2018-March/128055.html

Change-Id: I1cda5dffbc29aad5fea001a79562db7c144a339b
2018-06-11 15:11:31 -04:00
Tovin Seven
d1f241a410 Trivial: Update pypi url to new url
Pypi url changed from [1] to [2]

[1] https://pypi.python.org/pypi/<package>
[2] https://pypi.org/project/<package>

Change-Id: I1cee400bc9dce4f02235e519833b05bb0f4e500d
2018-04-20 17:12:43 +07:00
Kenneth Giusti
1231c4cbf2 Move requirements for the optional drivers (amqp1, kafka)
Move the requirements for the optional drivers to
test-requirements.txt and setup.cfg.  The default rabbitmq driver's
dependencies should be the only hard requirements for the base
package.

Leaving ZeroMQ deps unchanged for now as it will be removed in Stein

Change-Id: I19dd699ccf87e43202ccefb99258fbaa9ea17b7e
2018-04-16 10:38:07 -04:00
Kenneth Giusti
222a939361 Remove the deprecated Pika driver
It is recommended that all users of the Pika driver transition to
using the Rabbit driver instead.  Typically this is done by changing
the prefix of the transport_url configuration option from "pika://..."
to "rabbit://...".  There are no changes required to the RabbitMQ
server configuration.

Change-Id: I52ea5ccb7e7c247abd95e2d8d50dac4c4ad11246
Closes-Bug: #1744741
2018-03-21 10:58:23 -04:00
Ben Nemec
47d66d2b46 Fix typo in contributor docs title
"Contributing oslo.messaging" is not grammatically correct.  It
should be "Contributing to oslo.messaging".

Change-Id: I71737086745beb6d8d76669ab04b7580f1b7b11a
2017-10-02 23:52:24 +00:00
Jenkins
dc7bd0591b Merge "Add licenses and remove unused import in doc/source/conf.py" 2017-09-05 15:32:27 +00:00
Andrew Smith
8203b9ed73 Update amqp 1.0 driver deployment guide
This patch:
* Adds new options recently added to the driver
* Updates the devstack support information

Change-Id: I772e01ebb467a64c27b90e6105adf294bcb22654
2017-08-23 14:21:33 -04:00
liuyamin
59c0c8baa5 Add licenses and remove unused import in doc/source/conf.py
Change-Id: I1bded5759442c3d6dc59729f79f8166b999c9c60
2017-08-18 01:15:07 +00:00
Adam Spiers
1038a1c038 fix 'configration' typo
Fix typos in the documentation and corresponding directory structure.

Change-Id: I90c40139f6c6af3d326f6f9251e6821d5c4b1a82
2017-07-31 11:28:28 +01:00
Dong Ma
bff426f0eb switch from oslosphinx to openstackdocstheme
Change-Id: Ic3d9b9cbef0040512e37c8e99df7bb028e344bc9
2017-07-06 15:50:11 +00:00
Dong Ma
280cb368f7 rearrange content to fit the new standard layout
Change-Id: I4dd1c9c289d31077b71f3d96877b776d9d5e16f7
Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454
2017-07-06 03:19:38 +08:00
ZhangHongtao
53b699b90a Fix html_last_updated_fmt for Python3.
html_last_updated_fmt option is interpreted as a
byte string in python3, causing Sphinx build to break.
This patch makes it utf-8 string.

Change-Id: Ifde17e94d0345a289eea29ba3d664d31f1eb51d9
Closes-Bug:#1693670
2017-06-09 17:38:47 +08:00
Kenneth Giusti
c35fb276ce Mark the Pika driver as deprecated
The Pika driver was intended to be a more stable and performant
replacement for the default rabbit driver.  However due to lack of
both maintainers and compelling evidence that pika is superior to the
existing rabbit driver in either performance or stability it has been
deprecated for removal.

See:
http://lists.openstack.org/pipermail/openstack-dev/2017-May/116679.html

Change-Id: I98e0123edd3248be665325833283689fc3a897f7
2017-05-30 13:21:23 -04:00
Andrew Smith
ec4d6639bc Add get_rpc_transport call
The get_rpc_transport wraps get_transport to unify the API in
anticipation of comprehensive separation of RPC and Notification
messaging backends.

Related-Bug: 1680192
Change-Id: Ic6af07b98ff43806c2af38a3ba129991f1e0ec86
2017-05-12 12:30:41 -04:00
Stephen Finucane
1251c0fef1 Use Sphinx 1.5 warning-is-error
With pbr 2.0 and Sphinx 1.5, the setting for treat sphinx warnings as
errors is setting warning-is-error in build_sphinx section. Migrate
the setting from the old warnerrors one.

The history document is removed because some of the commit messages used
in ChangeLog were being identified as invalid markup and there doesn't
appear to be anyway to edit there retroactively nor disable warnings on
a specific file.

Change-Id: I79e7ac56d5af1151865686761f3d40a11efbf472
2017-03-16 15:22:18 +00:00
Jenkins
296d93d586 Merge "Fix the typo" 2017-02-20 20:09:48 +00:00
ozamiatin
6c7094a921 [zmq] Update configurations documentation
In this change new configurations appeared in Ocata release
like dynamic connections and other types of proxied deployments
being described.

Change-Id: Id6e9b062101d8916323edc143ea5379585192581
2017-02-14 12:41:21 +02:00
chenxing
7e767256c3 Fix the typo
Change-Id: Ieebb6d30a0b9e237eac930fb19d40a686d972aa1
2017-02-07 02:39:25 +00:00
Atsushi SAKAI
081a5fb10e [doc] Fix three typos
olso => oslo

Change-Id: I44dcc86cd6b50017a30393749e458507bea016f7
2016-11-28 21:14:31 +09:00
Kenneth Giusti
adf4cd9d05 Document the transport backend driver interface
Add detailed documentation to the driver API to help driver developers
create drivers that behave consistently.  Specifically prescribes a
set of operational characteristics that a driver must conform to in
order to provide consistent behavior across different implementations.

Change-Id: Icb251ee724f9a0ac4fede702a367910de4ba95e3
2016-11-22 08:11:22 -05:00
Jenkins
23c8e6d6cb Merge "update srouce doc pika_driver.rst the charactor then to than" 2016-11-08 06:33:15 +00:00
wanglmopenstack
f9eebeef21 update srouce doc pika_driver.rst the charactor then to than
update srouce doc pika_driver.rst the charactor
the word:more then shoud be more than

Closes-Bug: #1639995

Change-Id: I41460492c4503cf395c93b0bf643ccb98f4e12c3
2016-11-07 19:26:25 -08:00
ericxiett
b1866630de This patch cleans up the 'notification_listener.rst' documetion
by removing some class which don't exist and adding some function
which exist in current source.

Change-Id: I1aa78db34051dd554bfdb81e9e24378cbf7f0ea3
Closes-Bugs: #1637930
2016-11-05 13:34:49 +08:00
Gevorg Davoian
cf0c18a214 Remove nonexistent functions from documentation
This patch cleans up the documentation by removing some functions
which don't exist anymore and cause sphinx warnings. The patch also
adds pika_driver to index.rst.

Change-Id: I23908089ef6ad1f05c78521c2eea3a0a3276eb2a
Closes-Bug: #1639171
2016-11-04 14:54:37 +02:00
Kenneth Giusti
9bc9c0dc6a Fixups to the inline documentation
Rework the inline documentation for executors, RPC servers and
clients, notifiers and notification listeners for clarity and flow.

Change-Id: If4f1db853a7fc85340177fd2c9c43a479d72459d
2016-09-12 09:49:00 -04:00
Jenkins
d6f206c246 Merge "[AMQP 1.0] Add Acknowledgement and Batch Notification Topics" 2016-08-31 19:34:57 +00:00
Jenkins
4723011f20 Merge "Allow dispatcher to restrict endpoint methods." 2016-08-31 10:16:12 +00:00
Paul Vinciguerra
d3a8f280eb Allow dispatcher to restrict endpoint methods.
Implements access_policy for dispatcher to restrict endpoint methods.

Implements the following access policies:
* LegacyRPCAccessPolicy
* DefaultRPCAccessPolicy
* ExplicitRPCAccessPolicy

* Implement decorator @rpc.expose for use with the
 ExplicitRPCAccessPolicy

* Modify get_rpc_server to allow optional access_policy argument
* Set default access_policy to LegacyRPCAccessPolicy (Nova exposes
 _associate_floating_ip in tempest tests). Added debtcollector
 notification.
* Add test cases for access_policy=None
* Clarify documentation

Change-Id: I42239e6c8a8be158ddf5c3b1773463b7dc93e881
Closes-Bug: 1194279
Closes-Bug: 1555845
2016-08-30 20:32:35 -04:00
Andrew Smith
e451a9e79d [AMQP 1.0] Add Acknowledgement and Batch Notification Topics
Explain difference in message acknowledgement for intermediary
types and relationship to use of batch notification.

Change-Id: I5877d143c55ae6ac23bf79856fef94e7b14cb722
2016-08-30 10:50:39 -04:00
Gevorg Davoian
6881d14d16 [zmq] Update ZMQ-driver documentation
Change-Id: Ibcbba504a02df077fc37c8022de8fadc98cabda3
2016-08-24 12:42:40 +00:00
Kenneth Giusti
39c3901b8c Merge remote-tracking branch 'origin/master' into resync-to-master
Change-Id: Id59697351a2f5d00d8e145e95bfe6e7a919b86f2
2016-08-17 09:30:09 -04:00
Oleksii Zamiatin
7c5d039fd3 Move zmq driver options into its own group
ZeroMQ driver options are current stored into the DEFAULT group.
This change makes the zmq configuration clearer by putting its
options into oslo_messaging_zmq group.

Change-Id: Ia00fda005b1664750d2646f8c82ebdf295b156fb
Closes-bug: #1417040
Co-Authored-By: Oleksii Zamiatin <ozamiatin@mirantis.com>
2016-08-05 11:36:50 +03:00
Andrew Smith
827a5176d9 [AMQP 1.0] AMQP 1.0 Driver User Guide Document update
This patch includes updates to the user guide document for the
amqp-dispatch-router feature branch. Includes information for deploying
driver to operate with router or broker intermediaries.

Change-Id: Icb32743a82bf0f1e5969a215d880dc736a22f408
Closes-Bug: #1596649
2016-08-02 13:49:37 -04:00
Edan David
2668177256 Fix typo: 'olso' to 'oslo'
Change-Id: Ic86ded995ecf24b094b25c140da264526eafe611
2016-06-02 02:06:28 -04:00
ozamiatin
681c9fe5dd [zmq] Add Sentinel instructions to deployment guide
Updated deployment guide with redis HA instructions.

Change-Id: I3a83d56cffcd0d0154f52e3a49debff61f52a5ce
2016-05-10 10:01:02 +00:00
Jenkins
90e7b26016 Merge "Don't set html_last_updated_fmt without git" 2016-05-09 10:22:53 +00:00
ozamiatin
b5955b6ca9 [zmq] Redesign router proxy
In this change router was redesigned in a way most
appropriate for routing concept of zmq.ROUTER socket.

DEALER(cli)-ROUTER(proxy)-DEALER(srv) instead of
DEALER-ROUTER-DEALER-ROUTER (3 layers instead of 4)

The main reason is to use zmq.DEALER identity in message
routing. For this reason DealerConsumer was introduced
server-side. RouterConsumer is left for peer-to-peer
DEALER-ROUTER deployment option.

Also handled assertions in receive-methods in order
to not stop server when received message with wrong format.

Change-Id: If25edf500fa8d220d4233bb13d67121824e841c6
Closes-Bug: #1558601
Related-Bug: #1555007
2016-05-04 15:12:10 +03:00