[
https://issues.apache.org/jira/browse/METRON-1866?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16682026#comment-16682026
]
ASF GitHub Bot commented on METRON-1866:
----------------------------------------
Github user nickwallen commented on a diff in the pull request:
https://github.com/apache/metron-bro-plugin-kafka/pull/17#discussion_r232413911
--- Diff: README.md ---
@@ -12,24 +12,72 @@ This software is a part of the [Apache
Metron](http://metron.apache.org/) projec
## Installation
+### `bro-pkg` Installation
+
+`bro-pkg` is the preferred mechanism for installing this plugin, as it
will dynamically retrieve, build, test, and load the plugin. Note, that you
will still need to [activate](#activation) and configure the plugin after your
installation.
+
+1. Install [librdkafka](https://github.com/edenhill/librdkafka), a native
client library for Kafka. This plugin has been tested against the latest
release of librdkafka, which at the time of this writing is v0.9.4.
+
+ In order to use this plugin within a kerberized Kafka environment, you
will also need `libsasl2` installed and will need to pass `--enable-sasl` to
the `configure` script.
+
+ ```
+ $ curl -L https://github.com/edenhill/librdkafka/archive/v0.9.4.tar.gz
| tar xvz
+ $ cd librdkafka-0.9.4/
+ $ ./configure --enable-sasl
+ $ make
+ $ sudo make install
+ ```
+
+1. Configure `bro-pkg` by following the quickstart guide
[here](https://bro-package-manager.readthedocs.io/en/stable/quickstart.html).
+
+1. Install the plugin using `bro-pkg install`.
+
+ ```
+ $ bro-pkg install apache/metron-bro-plugin-kafka --version master
+ The following packages will be INSTALLED:
+ bro/apache/metron-bro-plugin-kafka (master)
+
+ Verify the following REQUIRED external dependencies:
+ (Ensure their installation on all relevant systems before proceeding):
+ from bro/apache/metron-bro-plugin-kafka (master):
+ librdkafka ~0.9.4
+
+ Proceed? [Y/n]
+ bro/apache/metron-bro-plugin-kafka asks for LIBRDKAFKA_ROOT (Path to
librdkafka installation tree) ? [/usr/local/lib]
+ Saved answers to config file: /home/jonzeolla/.bro-pkg/config
+ Running unit tests for "bro/apache/metron-bro-plugin-kafka"
+ all 10 tests successful
+
+
+ Installing "bro/apache/metron-bro-plugin-kafka"........
+ Installed "bro/apache/metron-bro-plugin-kafka" (master)
+ Loaded "bro/apache/metron-bro-plugin-kafka"
+ ```
+
--- End diff --
I think it would be good to add the same sanity check that we have at the
end of the manual installation instructions, as the last step here.
```
[root@localhost ~]# bro -N Apache::Kafka
Apache::Kafka - Writes logs to Kafka (dynamic, version 0.3)
```
> Improve metron-bro-plugin-kafka documentation
> ---------------------------------------------
>
> Key: METRON-1866
> URL: https://issues.apache.org/jira/browse/METRON-1866
> Project: Metron
> Issue Type: Task
> Reporter: Jon Zeolla
> Priority: Major
>
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
