Skip to content

zalando-nakadi/nakadi-manual

Repository files navigation

Nakadi Reference Manual

Nakadi is a distributed, open-source event broker under development at Zalando. It is available on GitHub.

Why Nakadi?

The goal of Nakadi is to enable convenient development of event-driven applications and asynchronous microservices by allowing producers to publish streams of event data to multiple consumers, without direct integration. It does this by exposing an HTTP API to let microservices maintain their boundaries and not force a particular technology dependency on producers and consumers. If you can speak HTTP, you can use Nakadi.

Operations is also a factor behind Nakadi's design. Managing upgrades to systems like Kafka becomes easier when technology sits behind an API and isn't a shared dependency between microservices. Asychronous event delivery can be a simpler overall option for a microservice architecture compared to synchronized and deep call paths that have to be mitigated with caches, bulkheads and circuit breakers.

The section "Comparison to Other Systems" describes Nakadi relative to systems such as Apache Kafka, AWS Kinesis, Google Pub/Sub and Azure EventHub.

Features

  • A secured HTTP API. This allows microservices teams to maintain service boundaries, and not directly depend on any specific message broker technology. Access to the API can be managed and secured using OAuth scopes.

  • An event type registry. Events sent to Nakadi can be defined with a schema and managed via a registry. Events can be validated before they are distributed to consumers.

  • Inbuilt event types. Nakadi also has optional support for events describing business processes and data changes using standard primitives for identity, timestamps, event types, and causality.

  • Low latency event delivery. Once a publisher sends an event using a simple HTTP POST, consumers can be pushed to via a streaming HTTP connection, allowing near real-time event processing. The consumer connection has keepalive controls and support for managing stream offsets.

  • Compatibility with the STUPS project. STUPS is Zalando's open source platform infrastructure for running and securing microservices on AWS.

  • Built on proven infrastructure. Nakadi uses the excellent Apache Kafka as its internal message broker and the also excellent PostgreSQL as a backing database.

Roadmap Note: Upcoming Features

Subscription API

The API reference focuses on the existing core API. The project is also planning a higher level subscription API. The details are to be finalised but the features are likely to be:

  • Basic functionality for supporting consumer groups via a subscription.
  • Server managed and persisted checkpointing of partition cursors.
  • Server managed rebalancing of partitions on behalf of consumers.

Event Filtering

As an extension to the subscription API, event filtering would allow consumer group subscribers to declare a filter for events on the stream.

Contributing

Nakadi accepts contributions from the open-source community. Please see the project issue tracker for things to work on.

Before making a contribution, please let us know by posting a comment to the relevant issue. And if you would like to propose a new feature, do start a new issue explaining the feature you’d like to contribute.

About

This book is generated using Gitbook and published to GitHub Pages via a Travis CI build. The project is here and the toolchain is described here. The project has an MIT License.

Releases

No releases published

Packages

No packages published