File: README — Documentation for karafka (1.1.2)

Framework used to simplify Apache Kafka based Ruby applications development.

It allows programmers to use approach similar to standard HTTP conventions (params and params_batch) when working with asynchronous Kafka messages.

Karafka not only handles incoming messages but also provides tools for building complex data-flow applications that receive and send messages.

How does it work

Karafka provides a higher-level abstraction that allows you to focus on your business logic development, instead of focusing on implementing lower level abstraction layers. It provides developers with a set of tools that are dedicated for building multi-topic applications similarly to how Rails applications are being built.

Some things you might wonder about:

You can integrate Karafka with any Ruby based application.
Karafka does not require Sidekiq or any other third party software (apart from Kafka itself).
Karafka works with Ruby on Rails but it is a standalone framework that can work without it.
Karafka has a minimal set of dependencies, so adding it won't be a huge burden for your already existing applications.

Karafka based applications can be easily deployed to any type of infrastructure, including those based on:

Heroku
Capistrano
Docker

Support

Karafka has a Wiki pages for almost everything and a pretty decent FAQ. It covers the whole installation, setup and deployment along with other useful details on how to run Karafka.

If you have any questions about using Karafka, feel free to join our Gitter chat channel.

Getting started

If you want to get started with Kafka and Karafka as fast as possible, then the best idea is to just clone our example repository:

git clone https://github.com/karafka/karafka-example-app ./example_app

then, just bundle install all the dependencies:

cd ./example_app
bundle install

and follow the instructions from the example app Wiki.

Note: you need to ensure, that you have Kafka up and running and you need to configure Kafka seed_brokers in the karafka.rb file.

If you need more details and know how on how to start Karafka with a clean installation, read the Getting started page section of our Wiki.

Notice

Karafka framework and Karafka team are not related to Kafka streaming service called CloudKarafka in any matter. We don't recommend nor discourage usage of their platform.

References

Note on contributions

First, thank you for considering contributing to Karafka! It's people like you that make the open source community such a great community!

Each pull request must pass all the rspec specs and meet our quality requirements.

To check if everything is as it should be, we use Coditsu that combines multiple linters and code analyzers for both code and documentation. Once you're done with your changes, submit a pull request.

Coditsu will automatically check your work against our quality standards. You can find your commit check results on the builds page of Karafka organization.

Contributors

This project exists thanks to all the people who contribute.