Skip to content

Commit 3222949

Browse files
committed
Fix README
1 parent 5ff291e commit 3222949

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
# kafka-ops
2-
Yet another CLI utility to automate Kafka cluster management
2+
33
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://github.com/agapoff/kafka-ops/blob/master/LICENSE)
44

5+
Yet another CLI utility to automate Kafka cluster management
6+
57
**Kafka-Ops** is a command-line utility written in Go and mostly inspired by [KafkaSpecs](https://github.com/streamthoughts/kafka-specs) java tool. It allows to automate Kafka management by describing resources (topics, ACLs) and their configs in spec-files and applying them to Kafka cluster. Kafka-Ops uses AdminClient Kafka API to align cluster resources with the spec idempotently. The spec can be manifested either in YAML or JSON format.
68

79

@@ -52,6 +54,7 @@ acls:
5254
The format is quite evident. Just few remarks:
5355
* The topic config values are always strings
5456
* The topic config value can be set to *default*. This will remove the per-topic setting and the topic will be using the cluster default value
57+
* *replication_factor* for topic is optional. If utility will need to create the topic and this setting will not be defined then it will be set to 1 on single-node clusters and to 2 on multi-node clusters
5558
* The ACL operation is described as *OperationType:Host*
5659
5760
kafka-cluster-example2.json:
@@ -215,7 +218,7 @@ You need golang and GNU make to be installed.
215218
make build
216219
```
217220

218-
If you have rpm-build installed then you may build RPM-package
221+
If you have rpm-build installed then you can build RPM-package
219222

220223
```bash
221224
make rpm

0 commit comments

Comments
 (0)