Skip to content
This repository was archived by the owner on Oct 7, 2022. It is now read-only.

Commit f7aa42b

Browse files
author
João Assunção
committed
chore(README.md): fixes README references for includeKey, also adds a small bit about adding kafka to linux hosts
1 parent c85bfed commit f7aa42b

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ To create new injectors for your topics, you should create a new kubernetes depl
3939
- `ES_TIME_SUFFIX` Indicates what time unit to append to index names on Elasticsearch. Supported values are `day` and `hour`. Default value is `day` **OPTIONAL**
4040
- `KAFKA_CONSUMER_RECORD_TYPE` Kafka record type. Should be set to "avro" or "json". Defaults to avro. **OPTIONAL**
4141
- `KAFKA_CONSUMER_METRICS_UPDATE_INTERVAL` The interval which the app updates the exported metrics in the format of golang's `time.ParseDuration`. Defaults to 30s. **OPTIONAL**
42-
- `KAFKA_CONSUMER_WITH_KEY_AND_VALUE` If you would to combine the result message with the value present in the key. Defaults to false. **OPTIONAL**
42+
- `KAFKA_CONSUMER_INCLUDE_KEY` Determines whether to include the Kafka key in the Elasticsearch message(as the "key" field). Defaults to false. **OPTIONAL**
4343

4444
### Important note about Elasticsearch mappings and types
4545

@@ -160,7 +160,8 @@ To build the project from source, run from project root:
160160
go build cmd/injector.go
161161
```
162162

163-
To run tests, run `docker-compose up -d zookeeper kafka schema-registry elasticsearch` and run `make test`.
163+
To run tests, first add kafka to your /etc/hosts file `echo "127.0.0.1 kafka" | sudo tee -a /etc/hosts`
164+
and then run `docker-compose up -d zookeeper kafka schema-registry elasticsearch` and run `make test`.
164165

165166
### Versioning
166167

0 commit comments

Comments
 (0)