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.

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

refactor(configs): Simplify Kafka Topic name configurations + docs #5198

Conversation

jjoyce0510
Copy link
Collaborator

Summary

Simplify the environment variables for MAE / MCE consumer topic names for the deprecated legacy topics: MetadataChangeEvent, MetadataAuditEvent, FailedMetadataChangeEvent.

Previously, env variables were named inconsistently between GMS and the consumers.

Changes

datahub-mae-consumer: KAFKA_TOPIC_NAME --> METADATA_AUDIT_EVENT_NAME
datahub-mce-consumer: KAFKA_MCE_TOPIC_NAME --> METADATA_CHANGE_EVENT_NAME

These changes are backward compatible, so using the previous configuration values OR the new values will work.

Also updated + improved Kafka documentation to reflect these changes.

Checklist

  • The PR conforms to DataHub's Contributing Guideline (particularly Commit Message Format)
  • Links to related issues (if applicable)
  • Tests for the changes have been added/updated (if applicable)
  • Docs related to the changes have been added/updated (if applicable). If a new feature has been added a Usage Guide has been added for the same.
  • For any breaking change/potential downtime/deprecation/big changes an entry has been made in Updating DataHub

Copy link
Collaborator

@anshbansal anshbansal left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please add note of deprecations in updating-datahub.md

@github-actions
Copy link

github-actions bot commented Jun 17, 2022

Unit Test Results (build & test)

382 tests  ±0   382 ✔️ ±0   8m 45s ⏱️ -2s
  89 suites ±0       0 💤 ±0 
  89 files   ±0       0 ±0 

Results for commit a02f62d. ± Comparison against base commit e360d26.

♻️ This comment has been updated with latest results.

@jjoyce0510
Copy link
Collaborator Author

jjoyce0510 commented Jun 17, 2022

@anshbansal These are not just being deprecated now, these topics have been deprecated for some time.

Regardless calling these env vars specifically as deprecated (not topics themselves)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants