Adapt README.md to a Bazel in-tree build

While the Buck build has been removed, the README.md instructions
were still stuck with it. Adapt all the instructions to reflect
what is needed to successfuly build the plugin with Bazel
using a Gerrit in-tree style plugin build process.

Change-Id: I32282c89ba799ccbf09e9023eb5c33ee5eebbff9
1 file changed
tree: bb418301bdcd36ea902c8c8c70e4bbaebd4a5610
  1. src/
  2. BUILD
  3. external_plugin_deps.bzl
  4. LICENSE
  5. README.md
README.md

Kafka: Gerrit event producer for Apache Kafka

Build Status

Synopsis

This plugins allows to define a distributed stream of events published by Gerrit.

Events can be anything, from the traditional stream events to the Gerrit metrics.

This plugin requires Gerrit 2.13 or laster.

Environments

  • linux
  • java-1.8
  • Bazel

Build

Kafka plugin can be build as a regular ‘in-tree’ plugin. That means that is required to clone a Gerrit source tree first and then to have the Kafka plugin source directory into the /plugins path. Additionally, the plugins/external_plugin_deps.bzl file needs to be updated to match the Kafka plugin one.

git clone --recursive https://gerrit.googlesource.com/gerrit
git clone https://gerrit.googlesource.com/plugins/kafka-events gerrit/plugins/kafka-events
cd gerrit
rm plugins/external_plugin_deps.bzl
ln -s ./kafka-events/external_plugin_deps.bzl plugins/.

To build the kafka-events plugins, issue the command from the Gerrit source path:

bazel build plugins/kafka-events

The output is created in

bazel-genfiles/plugins/kafka-events/kafka-events.jar

Minimum Configuration

Assuming a running Kafka broker on the same Gerrit host, add the following settings to gerrit.config:

  [plugin "kafka-events"]
    bootstrapServers = localhost:9092