97 Commits

Author SHA1 Message Date
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
Thomas Bechtold
903ae618bb Don't set html_last_updated_fmt without git
Using a timestamp as value for "html_last_updated_fmt" isn't good
for the reproducible builds initiative from different downstream
distributions because the build result always differs due to the
timestamp in the documentation.
Also when not setting "html_last_updated_fmt", the value can be set
via command line when running "sphinx-build -D".

Change-Id: Ic0c6dfc27a44d9b48e9a0c643f6301f596074c87
2016-04-13 08:46:31 +02:00
Oleksii Zamiatin
cc1cb30321 [zmq] Reduce number of connections
In this change 'use_router_proxy' option was added
to switch between direct connections and proxy.

Proxy was reimplemented and splitted onto two
types of proxies:

    * PUBLISHER proxy for fanout pattern
    * ROUTER proxy for direct messaging

Each type of proxy is configured over command line
argument --type.

Deployment guide was updated accordingly to the change.

Change-Id: If36e9c26e2a8ebe622cfa7e9f2a07b1a69aabe34
Closes-Bug: #1555007
2016-03-31 15:40:36 +03:00
Davanum Srinivas
4e4caf67da Fallback if git is absent
When building packages if git is absent, then we should
fall back to a safe default.

Closes-Bug: #1552251
Change-Id: I9731416117de088282259846d49c2ec3ce09d1dc
2016-03-02 16:27:14 -05:00
venkatamahesh
2b77d508de Fix misspellings
Change-Id: Ic2f98e3fbf7fd1591838a9bc440b20ddf2833e6b
2016-02-04 07:02:22 +05:30
Jenkins
d58bc69d8c Merge "Adds document and configuration guide" 2016-01-27 06:00:03 +00:00
Jenkins
f3c8a5cce8 Merge "[zmq] Reduce proxy for direct messaging" 2016-01-26 21:40:59 +00:00
dukhlov
07822a0e74 Adds document and configuration guide
Change-Id: I18ff502eceaf4ddaba607319038a5cc14fe14c5b
2016-01-26 17:10:32 +02:00
Oleksii Zamiatin
08dd23d1d4 [zmq] Reduce proxy for direct messaging
Since the change I643a111fca8bac32f41ced232d54ff2a2ebcbf77
we don't need proxy for direct types because any message
woud be sent before server listening to the target
appears on name server registry, so DEALER wouldn't block.

Change-Id: I3c0f3e6930a4092cac5a6e18529d98e6d6e65f32
2016-01-26 14:26:24 +02:00
Jenkins
85525daea6 Merge "Replace deprecated library function os.popen() with subprocess" 2016-01-25 16:55:56 +00:00
Oleksii Zamiatin
0b350f2bf6 [zmq] Update zmq-guide with new options
In this change updated:

* Redis TTL 'zmq_target_expire'
* Proxy for RPC 'direct_over_proxy'
* PUB/SUB usage 'use_pub_sub'

Change-Id: Id3cf1a88353b8c876a307d759c81934df9d62c6a
2016-01-15 14:32:00 +02:00
ting.wang
5150661807 Replace deprecated library function os.popen() with subprocess
os.popen() is deprecated since python 2.6.
Resolved with use of subprocess module.

Change-Id: Ifc456fa960c37bdfdf4b9635eb4b069b443b6a4b
Closes-Bug: #1529836
2016-01-15 13:57:01 +08:00
Clint Byrum
817cb0c8ab Fix formatting of code blocks in zmq docs
They were mostly missing the preceding :: to make them appear as raw
text in generated docs.

Change-Id: I00ac461b13b75c4eef9961e7350fcd90394cdb77
2016-01-04 16:01:22 -08:00
Davanum Srinivas
33c1010c32 Option group for notifications
In change Ief6f95ea906bfd95b3218a930c9db5d8a764beb9, we 
decoupled RPC and Notifications a bit. We should take another
step and separate out the options for notifications into 
its own group.

Change-Id: Ib51e2839f9035d0cc0e3f459939d9f9003a8c810
2015-11-30 19:30:05 +00:00
Flavio Percoco
925eb734a9 Remove qpidd's driver from the tree
Back in liberty we marked this driver as deprecated. This patch removes
it from the tree. The patch also removes tests, options and other
references in the documentation. Note that one script is being kept
because it's required by the amqp driver.

Depends-On: If4b1773334e424d1f4a4e112bd1f10aca62682a9
Change-Id: I4a9cba314c4a2f24307504fa7b5427424268b114
2015-11-20 18:43:28 +00:00
Oleksii Zamiatin
d571b66425 [zmq] Update zmq-deployment guide according to the new driver
New driver introduced some new options and changed its architecture.
The first update of the deployment guide after the driver being
reimplemented. Following driver updates should be reflected in the
guide as well.

Change-Id: Id8629907560e335dfcff688082fe943b3657568c
Closes-Bug: #1497278
2015-11-13 10:36:11 +00:00
Clint Byrum
64518fa170 Move supported messaging drivers in-tree
Up until now it has only been available in the OpenStack spec, but it is
a living document and I believe we can maintain it in oslo.messaging's
tree.

Change-Id: I7bb9e5f02004f857d8f75909fcc0d05f2882a77d
2015-10-30 14:09:37 -07:00
Alexi Yelistratov
74871e0860 Remove unnecessary rpc_zmq_port option
Remove unnecessary rpc_zmq_port option from zmq driver, because zmq
driver doesn't use static port any more - dynamic port binding is used
for running servers.

Closes-Bug: #1497277
Change-Id: I91e978347dd364b2d4c00bc223b0e3ecface7c43
2015-10-02 13:10:35 +03:00
Davanum Srinivas
1893c495f6 Allow custom notification drivers
Our class hierarchy hides classes and modules that so its hard
for folks to write a custom Notification driver. We should
make these public and document them

Closes-Bug: #1426046
Change-Id: Ifb96c2ae9868426cac2700bf4917c27c02c90b15
2015-09-25 10:07:05 -04:00
Jenkins
0bebd34f0d Merge "Include changelog/history in docs" 2015-09-24 22:52:41 +00:00
Joshua Harlow
56cc57e418 Include changelog/history in docs
Change-Id: I2d1f8642498311ec37f1399fa3259eda4199f1f2
2015-09-24 13:29:30 -07:00
Davanum Srinivas
97892e656a Merge remote-tracking branch 'origin/feature/zmq' into merge-branch
Change-Id: If189d03131efc02045955508cef06fdd2ed590ee
2015-09-15 11:07:44 -04:00
Takashi NATSUME
4d0ab45200 Fix typos in a document and a comment
reciever => receiver
explict => explicit

Change-Id: I777ca463cefa222d8c5251ce29a898f46119b122
2015-09-01 16:46:15 +09:00
Doug Hellmann
0c65ef51c4 Add config options to the documentation
Add the directive to include the configuration options to the library
documentation.

Depends-On: I549c8db98bf548dd0a7e8869a57301fa4096f78c
(feature change in oslo.config)
Depends-On: I89e3e4fd41ed4c989c2dd4c9cd1d7b7e806fa15a
(global requirements change to update oslo.config version)

Change-Id: Ibec7071027fc33374a73abc30f8f672380bae6ea
2015-08-25 17:53:05 +00:00
Doug Hellmann
1b390c34b0 add plugin documentation for executors and notifiers
Document the plugins available for executors and notifiers.

Fix the formatting in the aioeventlet executor so the docstring renders
properly.

Change-Id: I7709b65f5aa68fab3822b4de11640309aa07b1d7
2015-07-20 18:30:00 +00:00
Doug Royal
76ec03c8f9 fix typo
Change-Id: I8a935ffc795b7233e2e83ae0680786d34dfd6ec0
2015-06-25 17:44:28 -05:00
Doug Hellmann
0a8c5145d4 Add drivers to the documentation
Use stevedore.sphinxext to populate a new page listing all available
drivers.

Add docstrings to the driver classes, including references to more
extensive documentation if it is available.

Depends-on: I1a24f9326b4e54174d9dc0ae366315fe29c3ac1b
Depends-on: Ie715f98fe0d3cba8b2f4f6235e7c2b6f79be7ea0

Change-Id: Ief0aa05e6deba0126d63faf13497d0fe0539e08d
2015-06-03 11:40:57 +00:00
Mehdi Abaakouk
65fecf2866 Remove outdated release notes
Oslo.messaging have an outdated release in the code tree.
but now the release note is published on the mailing.

This change removes it.

Change-Id: I0a3401b7c9bc8230169e75727e45a99e6c3c780f
2015-05-13 11:19:45 +02:00
Davanum Srinivas
d214770b2b Document notification_driver possible values
Add list of drivers to help and FAQ.

Closes-Bug: #1440480
Change-Id: Ia0ea4693f88aa7550e55e7fb63111065ad9b6c3b
2015-04-06 10:12:08 -04:00
Li Ma
5f875c0f15 ZeroMQ deployment guide
This guide introduces the basic scenario of zeromq
driver and how to correctly deploy zeromq driver
for OpenStack.

Change-Id: I23eeafc5863b44bfbeb89ce3571a4e79b4b01d01
Closes-Bug: #1382325
2015-03-17 19:44:17 -07:00
Doug Hellmann
097fb235b2 Add FAQ entry for notifier configuration
Create a new FAQ page and add a few entries related to configuring the
notifier.

Change-Id: Ibfd78b40fe65d20315ad563694dcb7c48641812c
Closes-Bug: #1422774
2015-02-17 10:21:30 -05:00
Doug Hellmann
bf4ab5a9e4 Treat sphinx warnings as errors
Closes-Bug: #1287415

Change-Id: I43f406a8608724ac55c9ae6aea847d75594ba6f6
2015-01-29 14:24:55 -05:00