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

fix(kafka-setup): Make topic name consistent with other images #7103

Merged
merged 4 commits into from
Jan 24, 2023

Conversation

pedro93
Copy link
Collaborator

@pedro93 pedro93 commented Jan 23, 2023

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

@github-actions github-actions bot added the devops PR or Issue related to DataHub backend & deployment label Jan 23, 2023
Copy link
Collaborator

@jjoyce0510 jjoyce0510 left a comment

Choose a reason for hiding this comment

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

Are these changes backward compatible? Will they break folks with custom topic names?

@pedro93
Copy link
Collaborator Author

pedro93 commented Jan 24, 2023

Are these changes backward compatible? Will they break folks with custom topic names?

They are not. Folks with custom topic names will have to change the environment variable names they are using to set names. This PR makes that name consistent for all components. Kafka-setup job was the outlier using inconsistent env var names compared to GMS & standalone consumers. I have made a note about this in updating-datahub.md

@@ -6,6 +6,9 @@ This file documents any backwards-incompatible changes in DataHub and assists pe

### Breaking Changes

- #7103 This should only impact users who have configured explicit non-default names for DataHub's Kafka topics. The environment variables used to configure Kafka topics for DataHub used in the `kafka-setup` docker image have been updated to be in-line with other DataHub components, for more info see our docs on [Configuring Kafka in DataHub
](https://datahubproject.io/docs/how/kafka-config). They have been suffixed with `_TOPIC`. This change should not affect any user who is using default Kafka names.
Copy link
Collaborator

Choose a reason for hiding this comment

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

they have been suffixed with _TOPIC_NAME right?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Before they were suffixed with _TOPIC, now it's _TOPIC_NAME

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Updated the doc.

Copy link
Collaborator

@jjoyce0510 jjoyce0510 left a comment

Choose a reason for hiding this comment

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

Once the doc is updated LGTM

@jjoyce0510 jjoyce0510 merged commit 5db3a1f into master Jan 24, 2023
@jjoyce0510 jjoyce0510 deleted the fix-kafka-setup-topic-convention branch January 24, 2023 18:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
devops PR or Issue related to DataHub backend & deployment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants