summaryrefslogtreecommitdiff
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
* Correctly handle missing RabbitMQ queuesHervé Beraud2021-02-041-1/+2
| | | | | | | | | | | | | | | | | | | | | | | Currently, setting the '[oslo_messaging] direct_mandatory_flag' config option to 'True' (the default) will result in a 'MessageUndeliverable' exception being raised when sending a reply if a RabbitMQ queue is missing [1]. It was the responsibility of the application to handle this exception, however, many applications are not doing so. This has resulted in a number of bug reports. Start handling this error condition, using a retry loop to attempt to resend the message and work around any temporary glitches. Since attempting to send a reply will will no longer raise an exception, there is little benefit in retaining the '[oslo_messaging] direct_mandatory_flag' config option: users setting this to False will simply not benefit from the retry logic and improved logging added here. This option is already deprecated though and will be fully removed in a future release. [1] https://www.rabbitmq.com/channels.html Change-Id: Id5cddbefbe24ef100f1cc522f44430df77d217cb Closes-Bug: #1905965
* Fix doc title renderingHervé Beraud2020-12-041-2/+2
| | | | Change-Id: I9532f28a84b206c6268ead94c574aacb6216df6a
* Adding pre-commitHervé Beraud2020-09-222-1/+14
| | | | | | | | | | | | | | | | | | | | | | | | | | | | Introduced changes: - pre-commit config and rules - Add pre-commit to pep8 gate, Flake8 is covered in the pre-commit hooks. - Applying fixes for pre-commit compliance in all code. Also commit hash will be used instead of version tags in pre-commit to prevend arbitrary code from running in developer's machines. pre-commit will be used to: - trailing whitespace; - Replaces or checks mixed line ending (mixed-line-ending); - Forbid files which have a UTF-8 byte-order marker (check-byte-order-marker); - Checks that non-binary executables have a proper shebang (check-executables-have-shebangs); - Check for files that contain merge conflict strings (check-merge-conflict); - Check for debugger imports and py37+ breakpoint() calls in python source (debug-statements); - Attempts to load all yaml files to verify syntax (check-yaml); - Run flake8 checks (flake8) (local) For further details about tests please refer to: https://github.com/pre-commit/pre-commit-hooks Change-Id: Ibd0c3d64fdc5c293d9d676d33eab828d9fde971f Co-authored-by: Moisés Guimarães de Medeiros <moguimar@redhat.com>
* Fix pygments stylemelissaml2020-06-041-1/+1
| | | | | | | | New theme of docs respects pygments_style. more info: http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html Change-Id: I287fd718f9283e5d7d6951b9e55d5a6b48e07e3c
* Switch to newer openstackdocstheme and reno versionsAndreas Jaeger2020-05-182-6/+6
| | | | | | | | | | | | | | | | | | | | Switch to openstackdocstheme 2.2.0 and reno 3.1.0 versions. Using these versions will allow especially: * Linking from HTML to PDF document * Allow parallel building of documents * Fix some rendering Update Sphinx version as well. Remove docs requirements from lower-constraints, they are not needed during install or test but only for docs building. openstackdocstheme renames some variables, so follow the renames before the next release removes them. A couple of variables are also not needed anymore, remove them. Depends-On: https://review.opendev.org/728938 Change-Id: I70c7edf8b95cde890e6263195be1de6bb826e700
* Add release notes links to doc indexHervé Beraud2020-04-161-0/+8
| | | | Change-Id: I93ae9330509b89629d8c360437065267db637f49
* [ussuri][goal] Drop python 2.7 support and testing11.0.0Hervé Beraud2020-02-031-2/+1
| | | | | | | | | | | | | | OpenStack is dropping the py2.7 support in Ussuri cycle. Complete discussion & schedule can be found in - http://lists.openstack.org/pipermail/openstack-discuss/2019-October/010142.html - https://etherpad.openstack.org/p/drop-python2-support Ussuri Communtiy-wide goal: https://governance.openstack.org/tc/goals/selected/ussuri/drop-py27.html Change-Id: I15cc79159b603e232e442e202c78d6c56dc73252
* tox: Keeping going with docscaoyuan2019-10-241-2/+2
| | | | | | | | | | | | Sphinx 1.8 introduced [1] the '--keep-going' argument which, as its name suggests, keeps the build running when it encounters non-fatal errors. This is exceptionally useful in avoiding a continuous edit-build loop when undertaking large doc reworks where multiple errors may be introduced. [1] https://github.com/sphinx-doc/sphinx/commit/e3483e9b045 Change-Id: If9885a1f064226909181d8b69241eb814deb2105
* Introduce RabbitMQ driver documentation10.1.0Hervé Beraud2019-08-082-0/+268
| | | | | | | | | | | 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
* Merge "Support kafka message compression"10.0.0Zuul2019-08-051-0/+7
|\
| * Support kafka message compressionzhang-shaoman2019-06-201-0/+7
| | | | | | | | | | | | | | | | | | 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
* | Merge "Bump the openstackdocstheme extension to 1.20"Zuul2019-07-222-9/+1
|\ \
| * | Bump the openstackdocstheme extension to 1.20pengyuesheng2019-07-192-9/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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
* | | Merge "doc: Cleanup admin docs"Zuul2019-07-193-307/+204
|\ \ \
| * | | doc: Cleanup admin docsStephen Finucane2019-07-043-307/+204
| |/ / | | | | | | | | | | | | | | | | | | | | | 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>
* | | Blacklist sphinx 2.1.0 (autodoc bug)pengyuesheng2019-07-051-1/+1
|/ / | | | | | | | | | | | | See https://github.com/sphinx-doc/sphinx/issues/6440 for upstream details Depend-On: https://review.opendev.org/#/c/663060/ Change-Id: I648dd4d4a98a3d423c98d28c193737cffe1a2c49
* | Download kafka from archive.apache.orgBen Nemec2019-06-101-1/+1
|/ | | | | | | | 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
* Cap Bandit below 1.6.0 and update Sphinx requirementKenneth Giusti2019-05-141-1/+2
| | | | | | | | | | | Bandit 1.6.0 accidentally changed how the exclusion list option is handled and breaks our use of it. Cap to the previous version until Bandit has fixed the problem. Sphinx 2.0 no longer works on python 2.7, so we need to start capping it there as well. Change-Id: Ie6b379f2c99862c37891ac03c52464e07bc2b2cc
* Replace git.openstack.org URLs with opendev.org URLsjacky062019-04-262-5/+5
| | | | Change-Id: Ib4a523adf3275a8727d5a4f2a149e163a81be3cc
* Kafka driver deployment guideAndy Smith2019-01-232-0/+246
| | | | | Depends-On: Idfb9fe3700d882c8285c6dc56b0620951178eba2 Change-Id: If8370c0c83312d675bde837f768ae40ec3603972
* Switch driver to confluent-kafka client libraryAndy Smith2018-12-041-1/+1
| | | | | | | | | | | | | | | | | | | This patch switches the kafka python client from kafka-python to confluent-kafka due to documented threading issues with the kafka-python consumer and the recommendation to use multiplrocessing. The confluent-kafka client leverages the high performance librdkafka C client and is safe for multiple thread use. This patch: * switches to confluent-kafka library * revises consumer and producer message operations * utilizes event.tpool method for confluent-kafka blocking calls * updates unit tests * adds kafka specific timeouts for functional tests * adds release note Depends-On: Ice374dca539b8ed1b1965b75379bad5140121483 Change-Id: Idfb9fe3700d882c8285c6dc56b0620951178eba2
* Merge "doc: Remove crud from conf.py file"Zuul2018-10-231-49/+11
|\
| * doc: Remove crud from conf.py fileHervé Beraud2018-10-151-49/+11
| | | | | | | | Change-Id: I35c6221f78cac9fe4ab3e194e8a94ca4f0b24ca2
* | Using pip as a python module9.1.0Hervé Beraud2018-10-151-1/+1
|/ | | | | | | Since python 2.7.9 and python 3.4 pip is a stdin module Change-Id: I17c8c93337fa4f0a33f9131d4117739179133ea9
* Remove the deprecated ZeroMQ driverAndy Smith2018-08-283-610/+1
| | | | | | | | 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
* Mark the ZeroMQ driver deprecatedKenneth Giusti2018-06-111-0/+6
| | | | | | | | As per the Dublin 2018 PTG decision: http://lists.openstack.org/pipermail/openstack-dev/2018-March/128055.html Change-Id: I1cda5dffbc29aad5fea001a79562db7c144a339b
* Trivial: Update pypi url to new urlTovin Seven2018-04-201-4/+4
| | | | | | | | | Pypi url changed from [1] to [2] [1] https://pypi.python.org/pypi/<package> [2] https://pypi.org/project/<package> Change-Id: I1cee400bc9dce4f02235e519833b05bb0f4e500d
* Move requirements for the optional drivers (amqp1, kafka)Kenneth Giusti2018-04-162-14/+32
| | | | | | | | | | | 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
* Remove the deprecated Pika driver6.0.0Kenneth Giusti2018-03-212-161/+0
| | | | | | | | | | | 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
* Updated from global requirementsOpenStack Proposal Bot2018-03-151-1/+1
| | | | Change-Id: I9500a0d27953881cfad24d5542356c539353d6a7
* Updated from global requirementsOpenStack Proposal Bot2018-01-271-1/+1
| | | | Change-Id: I289f97bc931e865feea2beb7b78456f8020da8c6
* Updated from global requirementsOpenStack Proposal Bot2018-01-241-1/+1
| | | | Change-Id: Ieee5fa811e69e7ae4f597ce361319758d8030bde
* Create doc/requirements.txtKenneth Giusti2017-12-181-0/+12
| | | | | | | | | | | | For compliance with the Project Testing Interface as described in: https://governance.openstack.org/tc/reference/project-testing-interface.html Refer to: http://lists.openstack.org/pipermail/openstack-dev/2017-November/124815.html Change-Id: I3d8c70f66931c15247b530ff7e1c89bfc753446f
* Fix typo in contributor docs titleBen Nemec2017-10-021-3/+3
| | | | | | | "Contributing oslo.messaging" is not grammatically correct. It should be "Contributing to oslo.messaging". Change-Id: I71737086745beb6d8d76669ab04b7580f1b7b11a
* Merge "Add licenses and remove unused import in doc/source/conf.py"Jenkins2017-09-051-2/+15
|\
| * Add licenses and remove unused import in doc/source/conf.pyliuyamin2017-08-181-2/+15
| | | | | | | | Change-Id: I1bded5759442c3d6dc59729f79f8166b999c9c60
* | Update amqp 1.0 driver deployment guideAndrew Smith2017-08-231-34/+78
|/ | | | | | | | This patch: * Adds new options recently added to the driver * Updates the devstack support information Change-Id: I772e01ebb467a64c27b90e6105adf294bcb22654
* fix 'configration' typoAdam Spiers2017-07-314-4/+4
| | | | | | Fix typos in the documentation and corresponding directory structure. Change-Id: I90c40139f6c6af3d326f6f9251e6821d5c4b1a82
* switch from oslosphinx to openstackdocsthemeDong Ma2017-07-061-10/+10
| | | | Change-Id: Ic3d9b9cbef0040512e37c8e99df7bb028e344bc9
* rearrange content to fit the new standard layoutDong Ma2017-07-0629-24/+71
| | | | | Change-Id: I4dd1c9c289d31077b71f3d96877b776d9d5e16f7 Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454
* Fix html_last_updated_fmt for Python3.ZhangHongtao2017-06-091-2/+1
| | | | | | | | | 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
* Mark the Pika driver as deprecatedKenneth Giusti2017-05-301-0/+4
| | | | | | | | | | | | | 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
* Add get_rpc_transport callAndrew Smith2017-05-121-2/+0
| | | | | | | | | 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
* Use Sphinx 1.5 warning-is-errorStephen Finucane2017-03-162-9/+0
| | | | | | | | | | | | | 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
* Merge "Fix the typo"Jenkins2017-02-201-1/+1
|\
| * Fix the typochenxing2017-02-071-1/+1
| | | | | | | | Change-Id: Ieebb6d30a0b9e237eac930fb19d40a686d972aa1
* | [zmq] Update configurations documentationozamiatin2017-02-141-61/+385
|/ | | | | | | | In this change new configurations appeared in Ocata release like dynamic connections and other types of proxied deployments being described. Change-Id: Id6e9b062101d8916323edc143ea5379585192581
* [doc] Fix three typosAtsushi SAKAI2016-11-281-1/+1
| | | | | | olso => oslo Change-Id: I44dcc86cd6b50017a30393749e458507bea016f7
* Document the transport backend driver interfaceKenneth Giusti2016-11-222-0/+76
| | | | | | | | | 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
* Merge "update srouce doc pika_driver.rst the charactor then to than"Jenkins2016-11-081-1/+1
|\
View Lorry Controller Status