Skip to content

Commit

Permalink
Update getting_started.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
bringhurst committed Jul 6, 2016
1 parent 2fa2aba commit c02dc8a
Showing 1 changed file with 20 additions and 6 deletions.
26 changes: 20 additions & 6 deletions docs/getting_started.rst
Expand Up @@ -6,14 +6,28 @@ This document describes how to install and configure kafka-tools.
Prerequisites
-------------

These tools are generally written in Python, and besides a basic
installation, you will need the following additional modules:
Software that must be installed:

- Kazoo
- Python (https://www.python.org/)
- Kazoo (https://kazoo.readthedocs.io/en/latest/)
- Kafka (https://kafka.apache.org/)

In addition, you will need to run it on a host that has the following:
In addition, you will need to run it on a host that has:

- A copy of the Kafka admin tools (including kafka-reassign-partitions.sh).
- Access to the Zookeeper ensemble for the cluster.
- Access to the Zookeeper ensemble for the Kafka cluster.
- SSH access to the Kafka brokers (with credentials preferably loaded into
ssh-agent).

Quick Install
-------------

1) Download the Kafka binaries from https://kafka.apache.org/downloads.html.
2) Use pip to install the kafka-tools packge from pypi.

Source Install
--------------

1) Download the Kafka binaries from https://kafka.apache.org/downloads.html.
2) Clone the kafka-tools repository from https://github.com/linkedin/kafka-tools
3) Run the tests using tox.
4) Install kafka-tools using setup.py.

0 comments on commit c02dc8a

Please sign in to comment.