docs: Add clarification on required Kafka version field in cloud_even…#6502
Merged
Conversation
…ts configuration for FlyteAdmin
The current documentation for the FlyteAdmin cloudEvents Kafka configuration does not mention that the `version` field under the `kafka` block is required.
If this field is omitted, attempting to start FlyteAdmin with Kafka cloud events enabled leads to a panic error with the message "caught panic: invalid version".
An example of a minimal valid configuration is as follows:
```
cloudEvents:
enable: true
kafka:
brokers: 127.0.0.1:9092
version: my-kafka-version
eventsPublisher:
eventTypes:
- all
topicName: myTopic
type: kafka
```
This change aims to help users avoid runtime errors and improve the ease of adoption for this feature.
Signed-off-by: Daaa <[email protected]>
|
Thank you for opening this pull request! 🙌 These tips will help get your PR across the finish line:
|
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #6502 +/- ##
=======================================
Coverage 58.52% 58.52%
=======================================
Files 940 940
Lines 71532 71532
=======================================
+ Hits 41864 41865 +1
+ Misses 26489 26488 -1
Partials 3179 3179
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Sovietaced
approved these changes
Jun 21, 2025
|
Congrats on merging your first pull request! 🎉 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
…ts configuration for FlyteAdmin
The current documentation for the FlyteAdmin cloudEvents Kafka configuration does not mention that the
versionfield under thekafkablock is required.If this field is omitted, attempting to start FlyteAdmin with Kafka cloud events enabled leads to a panic error with the message "caught panic: invalid version".
An example of a minimal valid configuration is as follows:
This change aims to help users avoid runtime errors and improve the ease of adoption for this feature.
Tracking issue
Why are the changes needed?
What changes were proposed in this pull request?
How was this patch tested?
Labels
Please add one or more of the following labels to categorize your PR:
This is important to improve the readability of release notes.
Setup process
Screenshots
Check all the applicable boxes
Related PRs
Docs link
Summary by Bito
This pull request enhances the FlyteAdmin cloudEvents Kafka configuration documentation by clarifying that the 'version' field is required, which helps prevent runtime errors. An example of a minimal valid configuration is also included to assist users.