Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: Update doc for configuring topic names #1999

Merged
merged 1 commit into from
Nov 14, 2020
Merged

docs: Update doc for configuring topic names #1999

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions docs/how/kafka-config.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,12 +28,34 @@ By default, ingestion relies upon the `MetadataChangeEvent_v4`, `MetadataAuditEv

We've included environment variables to customize the name each of these topics, if your company or organization has naming rules for your topics.

### datahub-gms
- `METADATA_CHANGE_EVENT_NAME`: The name of the metadata change event topic.
- `METADATA_AUDIT_EVENT_NAME`: The name of the metadata audit event topic.
- `FAILED_METADATA_CHANGE_EVENT_NAME`: The name of the failed metadata change event topic.

### datahub-mce-consumer
- `KAFKA_MCE_TOPIC_NAME`: The name of the metadata change event topic.
- `KAFKA_FMCE_TOPIC_NAME`: The name of the failed metadata change event topic.

### datahub-mae-consumer
- `KAFKA_TOPIC_NAME`: The name of the metadata audit event topic.

Please ensure that these environment variables are set consistently throughout your ecosystem. DataHub has a few different applications running which communicate with Kafka (see above).

**How to apply configuration?**
- For quickstart, add these environment variables to the corresponding application's docker.env
- For helm charts, add these environment variables as extraEnvs to the corresponding application's chart.
For example,
```
extraEnvs:
- name: METADATA_CHANGE_EVENT_NAME
value: "MetadataChangeEvent"
- name: METADATA_AUDIT_EVENT_NAME
value: "MetadataAuditEvent"
- name: FAILED_METADATA_CHANGE_EVENT_NAME
value: "FailedMetadataChangeEvent"
```

## SSL

We are using the Spring Boot framework to start our apps, including setting up Kafka. You can
Expand Down