Jump to: navigation, search

Difference between revisions of "Zaqar"

(→‎Core Team)
(→‎Status)
 
(103 intermediate revisions by 9 users not shown)
Line 1: Line 1:
 +
== Projects ==
  
−
== OpenStack Queuing and Notification Service ==
+
=== Zaqar ===
  
−
As OpenStack matures, it needs to support bigger, more complex web applications. Such applications require a robust, web-scale message queuing service to support the distributed nature of large web applications. Marconi is a new [[OpenStack]] project designed to fill this need. Our aim is to create an open alternative to SQS (producer-consumer) and SNS (pub-sub), for use in applications that run on OpenStack clouds. A message queueing service is vital component of big, complex web applications
+
{| border="1" cellpadding="2"
 +
| Official name
 +
| '''OpenStack Messaging'''
 +
|-
 +
| Source code
 +
| https://github.com/openstack/zaqar
 +
|-
 +
| Bug tracker
 +
| https://bugs.launchpad.net/zaqar
 +
|-
 +
| Feature tracker
 +
| https://blueprints.launchpad.net/zaqar
 +
|-
 +
| Contributor documentation
 +
| http://docs.openstack.org/developer/zaqar/
 +
|}
 +
 
 +
=== Python Zaqar Client ===
 +
{| border="1" cellpadding="2"
 +
| Source code
 +
| https://github.com/openstack/python-zaqarclient
 +
|-
 +
| Bug tracker
 +
| https://bugs.launchpad.net/python-zaqarclient
 +
|-
 +
| Feature tracker
 +
| https://blueprints.launchpad.net/python-zaqarclient
 +
|}
 +
 
 +
== Overview ==
  
−
The project will define a clean, RESTful API, use a modular architecture, and will support unified pub-sub and job-queuing semantics. Users will be able to customize Marconi to achieve a wide range of performance, durability, availability, and efficiency goals.
+
Zaqar is a multi-tenant cloud messaging service for web and mobile developers. It combines the ideas pioneered by Amazon's SQS product with additional semantics to support event broadcasting.
  
−
=== Core Team ===
+
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.
  
−
Kurt Griffiths (kgriffs) is the current PTL. Other core team members include:
+
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.
  
−
* Flavio Percoco (flaper87)
+
==== Key features ====
−
* Alejandro Cabrera (cpp-cabrera)
 
−
* [your name could be here!]
 
  
−
== Design ==
+
Zaqar provides the following key features:
  
−
Marconi aims to be pragmatic, building upon the real-world experiences of teams who have solid track records running and supporting web-scale message queueing systems. The project's overarching design philosophy is derived from Donald A. Norman:
+
* Choice between two communication transports. Both with Keystone support:
 +
** Firewall-friendly, HTTP-based RESTful API
 +
*** Many of today's developers prefer a more web-friendly HTTP API. They value the simplicity and transparency of the protocol, its firewall-friendly nature, and its huge ecosystem of tools, load balancers and proxies. In addition, cloud operators appreciate the scalability aspects of the REST architectural style.
 +
** Websocket-based API for persistent connections.
 +
*** Websocket protocol provides communication over persistent connections. Unlike HTTP, where new connections are opened for each request/response pair, Websocket can transfer multiple requests/responses over single TCP connection. It saves much network traffic and minimizes delays.
 +
* Multi-tenant queues based on Keystone project IDs
 +
* Support for several common patterns including event broadcasting, task distribution, and point-to-point messaging (See [[Zaqar/Use_Cases|Zaqar Use Cases]])
 +
* Component-based architecture with support for custom backends and message filters
 +
* Efficient reference implementation with an eye toward low latency and high throughput (dependent on backend)
 +
* Highly-available and horizontally scalable (See [[Server Architecture (Marconi)|Server Architecture]])
 +
* Support for subscriptions to queues. Several notification types are available:
 +
** Email notifications
 +
** Webhook notifications
 +
** Websocket notifications
  
−
<blockquote>The value of a well-designed object is when it has such a rich set of affordances that the people who use it can do things with it that the designer never imagined.</blockquote>
+
==== Project scope ====
  
−
Goals related to the above:
+
The Zaqar API is data-oriented. That is, it does not provision message brokers and expose those directly to clients. Instead, the API acts as a bridge between the client and one or more backends. A provisioning service for message brokers—however useful—serves a somewhat different market from what Zaqar is targeting today. With that in mind, if users are interested in a broker provisioning service, the community should consider starting a new project to address that need.
  
−
# Emergent functionality, utility
+
==== Design principles ====
−
# Modular, pluggable code base
 
−
# REST architectural style
 
  
−
Principles to live by:
+
Zaqar, as with all OpenStack projects, is designed with the following guidelines in mind:
  
−
# DRY
+
* '''Component-based architecture.''' Quickly add new behaviors
−
# YAGNI
+
* '''Highly available and scalable.''' Scale to very serious workloads
−
# KISS
+
* '''Fault tolerant.''' Isolated processes avoid cascading failures
 +
* '''Recoverable.''' Failures should be easy to diagnose, debug, and rectify
 +
* '''Open standards.''' Be a reference implementation for a community-driven
  
 +
==== Status ====
  
−
== Architecture ==
+
Zaqar is production-ready for small and medium-sized workloads. The project is in production at Rackspace and other companies are in the process of deploying it in their own clouds. Support for the v2 APIs is available for Python in [https://github.com/openstack/python-zaqarclient python-zaqarclient], and for other languages through [http://developer.rackspace.com/#home-sdks Rackspace-supported SDKs].
−
[[File:Marconi-architecture.png|none]]
 
  
−
== Use Cases ==
+
== Documentation ==
  
−
# Distribute tasks among multiple workers (transactional job queues)
+
Currently (during Mitaka release cycle) Zaqar team is reworking Zaqar documentation.
−
# Forward events to data collectors  (transactional event queues)
 
−
# Publish events to any number of subscribers (pub-sub)
 
−
# Send commands to one or more agents (point-to-point or pub-sub)
 
−
# Request an action or get information from an agent (RPC)
 
  
−
== Out of Scope ==
+
==== Zaqar Configuration Reference ====
  
−
Marconi may be used as the foundation for other services to support the following use cases, but will not support them directly within its code base.
+
[http://docs.openstack.org/newton/config-reference/message.html Message service Configuration Reference]
  
−
# Forwarding notifications to email, SMS, Twitter, etc.
+
==== Zaqar Contributor Guide ====
−
# Forwarding notifications to web hooks
 
−
# Forwarding notifications to APNS, GCM, etc.
 
−
# Scheduling-as-a-service
 
−
# Metering usage
 
  
−
== Etherpads ==
+
[http://docs.openstack.org/developer/zaqar/ Zaqar Contributor Guide]
  
−
* [https://etherpad.openstack.org/marconi-client Marconi Client Brainstorm #1]
+
==== Zaqar RESTful API Specs ====
−
* [https://etherpad.openstack.org/apiclient-marconi Common Code Improvements]
 
−
* [https://etherpad.openstack.org/marconi-client-zmq ZMQ Brainstorm #1]
 
−
* [https://etherpad.openstack.org/marconi-fifo FIFO Etc.]
 
−
* [https://etherpad.openstack.org/marconi-test-refactoring Tests Refactoring]
 
−
* [https://etherpad.openstack.org/marconi-placement Placement Service]
 
−
* [https://etherpad.openstack.org/marconi-proxy-issues Marconi Proxy Issues]
 
  
−
== Presentations ==
+
* [[Zaqar/specs/api/v1|API v1.0]] ('''Released in 2014.1''', '''Deprecated''')
 +
* [[Zaqar/specs/api/v1.1|API v1.1]] ('''Released in 2014.2''', '''Deprecated''')
 +
* [http://developer.openstack.org/api-ref/messaging/ API v2.0] ('''Current API Version''')
 +
 
 +
==== Other documentation ====
 +
 
 +
"Getting Started Guide",  "Zaqar RESTful API v1.0 Guide and Reference" are currently not hosted anywhere, but you can generate these documents from Zaqar source code repository. Here's how to do it:
 +
# Ensure you have '''maven''' and '''git''' programs installed on your system.
 +
# Clone Zaqar repository in the preferred directory on your machine by executing '''git clone <nowiki>https://github.com/openstack/zaqar.git</nowiki>'''
 +
# Inside cloned repository in ''doc/user-guide'' directory execute '''mvn clean generate-sources''' to generate documentation html files from sources.
 +
# You can view documentation by opening generated html files in your browser:
 +
## Getting Started Guide: ''doc/user-guide/zaqar-get-started/target/docbkx/webhelp/zaqar-get-started/index.html''
 +
## Zaqar Configuration Reference: ''doc/user-guide/zaqar-config-ref/target/docbkx/webhelp/zaqar-config-ref/index.html''
 +
## Zaqar API v1.0 Guide and Reference: ''doc/user-guide/zaqar-api-ref/target/docbkx/webhelp/zaqar-api-ref/index.html''
 +
 
 +
== Resources ==
 +
 
 +
The Zaqar team hangs out in '''#openstack-zaqar''' on Freenode. Feel free to stop in anytime to chat with us; the crew is always happy to hear your ideas and answer questions. If you run into a bug, please report it using our [https://bugs.launchpad.net/zaqar issue tracker].
 +
 
 +
==== FAQ ====
 +
 
 +
* [[Zaqar/Frequently asked questions|Frequently asked questions]]
 +
 
 +
==== Releases ====
 +
 
 +
<!-- TODO(kgriffs): Add release notes -->
 +
* 2014.1 ([http://tarballs.openstack.org/marconi/marconi-2014.1.tar.gz download] | [[Marconi/releases/icehouse|notes]])
 +
 
 +
==== Talks ====
  
 
* Alejandro Cabrera. Rackspace Atlanta. Introducing Openstack Marconi. July 17, 2013. [http://www.youtube.com/watch?v=b-IWDG7kKGQ Youtube] [https://speakerdeck.com/cabrera/introducing-openstack-marconi Speaker Deck]
 
* Alejandro Cabrera. Rackspace Atlanta. Introducing Openstack Marconi. July 17, 2013. [http://www.youtube.com/watch?v=b-IWDG7kKGQ Youtube] [https://speakerdeck.com/cabrera/introducing-openstack-marconi Speaker Deck]
 
* Flavio Percoco. EuroPython 2013. Marconi: Queuing and Notification Service for Openstack. July 2, 2013. [http://www.youtube.com/watch?v=iNOd7-_TdDo YouTube]
 
* Flavio Percoco. EuroPython 2013. Marconi: Queuing and Notification Service for Openstack. July 2, 2013. [http://www.youtube.com/watch?v=iNOd7-_TdDo YouTube]
−
* Kurt Griffiths, Allan Metts. Openstack Summit April 2013. Project Overview: OpenStack Queuing and Notification Service ("Marconi""). April 2013. [http://www.youtube.com/watch?feature=player_embedded&v=henTTZWtt2k YouTube]
+
* Kurt Griffiths, Allan Metts. Openstack Summit April 2013. Project Overview: OpenStack Queuing and Notification Service ("Marconi"). April 2013. [http://www.youtube.com/watch?feature=player_embedded&v=henTTZWtt2k YouTube]
−
* Kurt Griffiths, Flavio Percoco, Allan Metts. Openstack Summit November 2013. Openstack Queuing and Notification Service Marconi. November 2013. [http://www.youtube.com/watch?v=IgE3Jskqtek YouTube]
+
* Kurt Griffiths, Flavio Percoco, Allan Metts. Openstack Summit November 2013. Openstack Queuing and Notification Service. November 2013. [http://www.youtube.com/watch?v=IgE3Jskqtek YouTube]
 +
* Yeela Kaplan. EuroPython 2014. OpenStack Queuing and Notification Service ("Marconi"). July 22, 2014. [https://www.youtube.com/watch?v=d65TtqGp-9Q YouTube]
  
−
== Articles ==
+
==== Articles ====
  
−
* Oz Akan. Rackspace Devops Blog. July 25, 2013. [http://developer.rackspace.com/blog/openstack-marconi-api.html Openstack Marconi API].
+
* Oz Akan. Rackspace Devops Blog. July 25, 2013. [http://developer.rackspace.com/blog/openstack-marconi-api.html Openstack Zaqar API v1.0].
 +
* Flavio Percoco. Developer's Black Hole. March 2014. [http://blog.flaper87.com/post/531cd585d987d24e83f082a5 People don't like to queue up].
  
−
== FAQ ==
+
== Community ==
  
−
=== Will Marconi work with AMQP? ===
+
* [https://webchat.freenode.net/?channels=openstack-zaqar #openstack-zaqar] (IRC)
 +
* [[Zaqar/Feedback|Feedback]]
 +
* [https://ask.openstack.org/en/questions/ Ask OpenStack (Community Q&A)]
  
−
* Planned as a backend for v2 API
+
== Information for Contributors ==
−
* Transport TBD
 
−
* Talk to us about use cases
 
−
* Need contributors
 
  
−
=== How does Marconi compare to AWS (SQS/SNS)? ===
+
[http://docs.openstack.org/developer/zaqar/ Zaqar Contributor Guide]
  
−
* Targets similar workloads
+
''Note: If you can't find the information you are looking for, please drop us a line in IRC (#openstack-zaqar) and we'll be happy to help.''
−
* Marconi will provide a unified API to handle notifications and queuing
 
−
* Marconi is highly customizable
 
−
* FIFO and once-and-only-once guaranteed (depending on storage backend)
 
  
−
=== How mature is the project? ===
+
==== Design ====
  
−
* Marconi is used in production: [[Who Uses Marconi? | marconi_users]]
+
* [[Zaqar/Use_Cases|Zaqar Use Cases]]
−
* Number of contributors is growing
+
* [[Server Architecture (Marconi)|Server Architecture]]
 +
* Reference Clients
 +
** [[Python Client Library (Marconi)|Python Library & CLI]]
 +
** [https://github.com/abettadapur/marconiclient C# Library]
 +
* Summit Notes
 +
** [[Juno/Notes/Marconi|Juno Easel Pad]]
  
−
=== What's next for marconi? ===
+
==== Quality Engineering ====
  
−
* Releasing API v1.1 for Icehouse
+
* [[Application Security (Marconi)|Application Security]]
−
* Additional storage drivers
+
* [[Performance Testing (Marconi)|Performance Testing]]
−
* Storage sharding: scaling horizontally and heterogeneous storage
+
* [[Functional Testing (Marconi)|Functional Testing]]
−
* Notifications
+
* [[Integration Testing (Marconi)|Integration Testing]]
−
* Message signing
+
<!-- TODO(kgriffs): What about user experience design/testing? -->
−
* Additional ops features
 
−
* Reference client library
 
  
−
=== How easy is it to contribute/get up and running? ===
+
==== Community ====
  
−
* You don't need devstack
+
* [https://webchat.freenode.net/?channels=openstack-zaqar #openstack-zaqar] (IRC)
−
* You decide what you want to work on: storage, transport, client-side
+
* [[Meetings/Zaqar|Meetings]]
−
* Very decoupled
+
* [[Zaqar/Feedback|Feedback]]
−
* Easy: choose a bug and submit a patch
+
* [https://ask.openstack.org/en/questions/ Ask OpenStack (Community Q&A)]
  
−
== Resources ==
+
==== Administrivia ====
−
 
 
−
{| border="1" cellpadding="2" cellspacing="0"
 
−
|  Meetings
 
−
| [[Meetings/Marconi]]
 
−
|-
 
−
|  IRC
 
−
| #openstack-marconi on Freenode
 
−
|-
 
−
|  Trello
 
−
| https://trello.com/b/7NLODgbr (deprecated in favor of Launchpad)
 
−
|-
 
−
|  Havana Spec 
 
−
| [[Marconi/specs/havana]]
 
−
|-
 
−
|  API Blueprint 
 
−
| [[Marconi/specs/api/v1]]
 
−
[[Marconi/specs/zmq/api/v1]]
 
−
|-
 
−
|  Other Blueprints   
 
−
| https://blueprints.launchpad.net/marconi
 
−
|-
 
−
|  Milestones 
 
−
| https://launchpad.net/marconi/+milestones
 
−
|-
 
−
|  Developer Docs 
 
−
| [[Marconi/PythonClient|Python Client Bindings]]<br>[[Marconi/Drivers|Drivers]]<br>[[Marconi/guarantees|Guarantees]]
 
−
|-
 
−
|  Incubation 
 
−
| [[Marconi/Incubation]]
 
−
|-
 
−
| Source code 
 
−
| https://github.com/openstack/marconi
 
−
|-
 
−
| Client source code
 
−
| https://github.com/stackforge/python-marconiclient
 
−
|-
 
−
| Code Reviews
 
−
| https://review.openstack.org/#/q/status:open+project:stackforge/marconi,n,z
 
−
|-
 
−
|  Bug tracker 
 
−
| https://bugs.launchpad.net/marconi
 
−
|}
 
  
−
----
+
* [[Roadmap (Marconi)|Roadmap (Juno)]]
−
[[Category:Homepage]]
+
* [https://etherpad.openstack.org/p/naav-graduation Incubation Status]
 +
* [[How to Release (Marconi)|How to Release]]
 +
* [[Security/Juno/Marconi|OSSG Q&A for Zaqar (Juno)]]

Latest revision as of 02:17, 7 November 2016

Projects

Zaqar

Official name OpenStack Messaging
Source code https://github.com/openstack/zaqar
Bug tracker https://bugs.launchpad.net/zaqar
Feature tracker https://blueprints.launchpad.net/zaqar
Contributor documentation http://docs.openstack.org/developer/zaqar/

Python Zaqar Client

Source code https://github.com/openstack/python-zaqarclient
Bug tracker https://bugs.launchpad.net/python-zaqarclient
Feature tracker https://blueprints.launchpad.net/python-zaqarclient

Overview

Zaqar is a multi-tenant cloud messaging 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.

Key features

Zaqar provides the following key features:

  • Choice between two communication transports. Both with Keystone support:
    • Firewall-friendly, HTTP-based RESTful API
      • Many of today's developers prefer a more web-friendly HTTP API. They value the simplicity and transparency of the protocol, its firewall-friendly nature, and its huge ecosystem of tools, load balancers and proxies. In addition, cloud operators appreciate the scalability aspects of the REST architectural style.
    • Websocket-based API for persistent connections.
      • Websocket protocol provides communication over persistent connections. Unlike HTTP, where new connections are opened for each request/response pair, Websocket can transfer multiple requests/responses over single TCP connection. It saves much network traffic and minimizes delays.
  • Multi-tenant queues based on Keystone project IDs
  • Support for several common patterns including event broadcasting, task distribution, and point-to-point messaging (See Zaqar Use Cases)
  • Component-based architecture with support for custom backends and message filters
  • Efficient reference implementation with an eye toward low latency and high throughput (dependent on backend)
  • Highly-available and horizontally scalable (See Server Architecture)
  • Support for subscriptions to queues. Several notification types are available:
    • Email notifications
    • Webhook notifications
    • Websocket notifications

Project scope

The Zaqar API is data-oriented. That is, it does not provision message brokers and expose those directly to clients. Instead, the API acts as a bridge between the client and one or more backends. A provisioning service for message brokers—however useful—serves a somewhat different market from what Zaqar is targeting today. With that in mind, if users are interested in a broker provisioning service, the community should consider starting a new project to address that need.

Design principles

Zaqar, as with all OpenStack projects, is designed with the following guidelines in mind:

  • Component-based architecture. Quickly add new behaviors
  • Highly available and scalable. Scale to very serious workloads
  • Fault tolerant. Isolated processes avoid cascading failures
  • Recoverable. Failures should be easy to diagnose, debug, and rectify
  • Open standards. Be a reference implementation for a community-driven

Status

Zaqar is production-ready for small and medium-sized workloads. The project is in production at Rackspace and other companies are in the process of deploying it in their own clouds. Support for the v2 APIs is available for Python in python-zaqarclient, and for other languages through Rackspace-supported SDKs.

Documentation

Currently (during Mitaka release cycle) Zaqar team is reworking Zaqar documentation.

Zaqar Configuration Reference

Message service Configuration Reference

Zaqar Contributor Guide

Zaqar Contributor Guide

Zaqar RESTful API Specs

Other documentation

"Getting Started Guide", "Zaqar RESTful API v1.0 Guide and Reference" are currently not hosted anywhere, but you can generate these documents from Zaqar source code repository. Here's how to do it:

  1. Ensure you have maven and git programs installed on your system.
  2. Clone Zaqar repository in the preferred directory on your machine by executing git clone https://github.com/openstack/zaqar.git
  3. Inside cloned repository in doc/user-guide directory execute mvn clean generate-sources to generate documentation html files from sources.
  4. You can view documentation by opening generated html files in your browser:
    1. Getting Started Guide: doc/user-guide/zaqar-get-started/target/docbkx/webhelp/zaqar-get-started/index.html
    2. Zaqar Configuration Reference: doc/user-guide/zaqar-config-ref/target/docbkx/webhelp/zaqar-config-ref/index.html
    3. Zaqar API v1.0 Guide and Reference: doc/user-guide/zaqar-api-ref/target/docbkx/webhelp/zaqar-api-ref/index.html

Resources

The Zaqar team hangs out in #openstack-zaqar on Freenode. Feel free to stop in anytime to chat with us; the crew is always happy to hear your ideas and answer questions. If you run into a bug, please report it using our issue tracker.

FAQ

Releases

Talks

  • Alejandro Cabrera. Rackspace Atlanta. Introducing Openstack Marconi. July 17, 2013. Youtube Speaker Deck
  • Flavio Percoco. EuroPython 2013. Marconi: Queuing and Notification Service for Openstack. July 2, 2013. YouTube
  • Kurt Griffiths, Allan Metts. Openstack Summit April 2013. Project Overview: OpenStack Queuing and Notification Service ("Marconi"). April 2013. YouTube
  • Kurt Griffiths, Flavio Percoco, Allan Metts. Openstack Summit November 2013. Openstack Queuing and Notification Service. November 2013. YouTube
  • Yeela Kaplan. EuroPython 2014. OpenStack Queuing and Notification Service ("Marconi"). July 22, 2014. YouTube

Articles

Community

Information for Contributors

Zaqar Contributor Guide

Note: If you can't find the information you are looking for, please drop us a line in IRC (#openstack-zaqar) and we'll be happy to help.

Design

Quality Engineering

Community

Administrivia

Retrieved from "https://wiki.openstack.org/w/index.php?title=Zaqar&oldid=137446"