OpenStack Messaging (Zaqar)
Go to file
Eva Balycheva 5134d3018b Add Zaqar installation guide
This patch adds Zaqar-specific contents of the OpenStack Installation
Guide in the Zaqar repository per [1]. It only covers installation on
Red Hat-based systems.

Also this patch adds tox.ini environment for install-guide and adds
openstackdocs-theme to test-requirements.txt.

The Zaqar Installation Guide structure is based on Install Guide
Cookiecutter: https://review.openstack.org/#/c/314229/.

[1] http://specs.openstack.org/openstack/docs-specs/specs/newton/project-specific-installguides.html

Change-Id: I72300c146b22511da4432775fc84e8c821a3fd12
Implements: blueprint install-guide-in-tree
Partially-Implements: blueprint projectspecificinstallguides
2016-06-15 03:15:41 +03:00
api-ref/source Init commit to add API ref in tree 2016-05-30 15:40:10 +12:00
devstack Support Tempest test as gate job 2016-06-06 01:48:12 +00:00
doc Add Zaqar installation guide 2016-06-15 03:15:41 +03:00
etc Generate oslo.cache options via tox -e genconfig 2016-03-23 01:38:24 +03:00
install-guide/source Add Zaqar installation guide 2016-06-15 03:15:41 +03:00
rally-jobs Merge "Adds max failure rate limit" 2015-09-21 21:39:43 +00:00
releasenotes Update reno for stable/mitaka 2016-03-18 08:20:20 -04:00
samples Added samples in multiple languages 2016-04-05 14:46:34 -03:00
tools/doc Update oslo-config-generation code 2014-11-17 21:49:53 +01:00
zaqar Merge "Make the notifier max_workers configurable" 2016-06-07 02:45:40 +00:00
.coveragerc Rename Marconi to Zaqar 2014-08-04 10:36:50 +02:00
.gitignore Add reno for release notes management 2015-11-09 11:26:47 -03:00
.gitreview Fix .gitreview due to the repo rename/move 2014-08-16 21:30:22 +04:00
.testr.conf Add zaqar tempest plugin 2016-02-18 20:41:07 -05:00
AUTHORS.rst refactor: Rename AUTHORS so that it doesn't keep getting overwritten 2013-03-19 16:33:43 -04:00
babel.cfg Prepare marconi for localization 2014-06-04 22:31:55 +02:00
bench-requirements.txt Remove argparse from requirements 2016-01-20 19:27:59 +01:00
CONTRIBUTING.rst Added CONTRIBUTING.rst file 2015-11-16 00:27:43 +05:30
doc-test.conf Rename Marconi to Zaqar 2014-08-04 10:36:50 +02:00
dox.yml Add a dox.yml config file 2014-09-08 13:55:13 +02:00
HACKING.rst Fix few typos in headings 2015-09-19 16:37:56 +05:30
LICENSE Include full license text 2014-03-21 10:16:28 +01:00
README.rst Refactoring of docs during Mitaka cycle 2016-01-07 17:05:09 +03:00
requirements.txt Updated from global requirements 2016-05-29 23:12:36 +00:00
setup.cfg Rename notification/task to notification/tasks 2016-05-27 10:04:20 +12:00
setup.py Updated from global requirements 2015-09-19 05:42:08 +00:00
test-requirements.txt Add Zaqar installation guide 2016-06-15 03:15:41 +03:00
tox.ini Add Zaqar installation guide 2016-06-15 03:15:41 +03:00

Zaqar

Zaqar is a multi-tenant cloud messaging and notification service for web and mobile developers. It combines the ideas pioneered by Amazon's SQS product with additional semantics to support event broadcasting.

The service features a fully RESTful API, which developers can use to send messages between various components of their SaaS and mobile applications, by using a variety of communication patterns. Underlying this API is an efficient messaging engine designed with scalability and security in mind.

Other OpenStack components can integrate with Zaqar to surface events to end users and to communicate with guest agents that run in the "over-cloud" layer. Cloud operators can leverage Zaqar to provide equivalents of SQS and SNS to their customers.

General information is available in wiki:

https://wiki.openstack.org/wiki/Zaqar

The API v1.1 (stable) specification and documentation are available at:

https://wiki.openstack.org/wiki/Zaqar/specs/api/v1.1

Zaqar Contributor Documentation, the source of which is in doc/source/, is available at:

http://docs.openstack.org/developer/zaqar/

Contributors are encouraged to join IRC (#openstack-zaqar channel on irc.freenode.net):

https://wiki.openstack.org/wiki/IRC

Information on how to run unit and functional tests is available at:

http://docs.openstack.org/developer/zaqar/running_tests.html

Information on how to run benchmarking tool is available at:

http://docs.openstack.org/developer/zaqar/running_benchmark.html

Using Zaqar

If you are new to Zaqar and just want to try it, you can set up Zaqar in the development environment.

Using Zaqar in production environment:

Coming soon!

Using Zaqar in development environment:

The instruction is available at:

http://docs.openstack.org/developer/zaqar/devref/development.environment.html

This will allow you to run local Zaqar server with MongoDB as database.

This way is the easiest, quickest and most suitable for beginners.