Contribution Guide

• Welcome new contributors
  • First Steps
  • How can I contribute?
• Project Info
  • Maintainers
  • Useful links
  • Where can I discuss and propose changes?
• Setting up a development environment
  • Virtual environments
  • DevStack
  • Running tests
  • Running the benchmarking tool
  • Contributing your work
• Your first patch
  • Create your contributor accounts and set up your code environment
  • Making a patch
  • Submitting a patch
  • Professional conduct
• Your first review
  • Step by step
• Project hosting with Launchpad
  • Launchpad credentials
  • Mailing list
  • Bug tracking
  • Feature requests (Blueprints)
  • Technical support (Answers)
• Code reviews with Gerrit
• Continuous integration with Jenkins
• Reviewer Guide
  • Overview
  • Be Professional
  • Reviewing Docs
  • Reviewing Code
  • Use Prefixes
• Running tests
  • Preferred way to run the tests
  • Running functional tests
• Test suite structure
  • Test types
  • Code structure
  • Test invocation

Modules reference

Zaqar is composed of two layers:

• Transport
• API reference for storage drivers
• MongoDB Driver

The transport drivers are responsible for interacting with Zaqar clients. Every query made by clients is processed by the transport layer, which is in charge of passing this information to the backend and then returning the response in a format understandable by the client.

The storage drivers are responsible for interacting with the storage backends and, that way, store or retrieve the data coming from the transport layer.

In order to keep these layers decoupled, we have established that checks should be performed in the appropriate layer. In other words, transport drivers must guarantee that the incoming data is well-formed and storage drivers must enforce their data model stays consistent.