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

Docs: Disparities between the online quarkus-messaging-kafka extension docs #45892

Open
darbyredhat opened this issue Jan 27, 2025 · 4 comments
Labels
area/kafka kind/bug Something isn't working

Comments

@darbyredhat
Copy link

Describe the bug

This was reported by a customer.

I am seeing many disparities between the online quarkus-messaging-kafka extension docs and reality. The docs are incorrect about configuring the quarkus devservice; the runtime container reports that the several documented config elements are invalid, e.g., "Unrecognized configuration key quarkus.kafka.devservices.topics\ ...

... the documentation that still refers to the “mp…” config elements that were in the smallrye extension, Apache Kafka Reference Guide - Quarkus. When quarkus docs have a banner that says a newer version of an extension is available, SmallRye Reactive Messaging - Kafka Connector | Extensions, but the new version points to the old docs, Getting Started to Quarkus Messaging with Apache Kafka - Quarkus.

Expected behavior

The docs should match the Quarkus runtime behavior.

Actual behavior

Runtime container reports that the several documented config elements are invalid, e.g., "Unrecognized configuration key quarkus.kafka.devservices.topics\

How to Reproduce?

No response

Output of uname -a or ver

No response

Output of java -version

No response

Quarkus version or git rev

No response

Build tool (ie. output of mvnw --version or gradlew --version)

No response

Additional information

No response

@darbyredhat darbyredhat added the kind/bug Something isn't working label Jan 27, 2025
Copy link

quarkus-bot bot commented Jan 27, 2025

/cc @alesj (kafka), @cescoffier (kafka), @ozangunalp (kafka)

@cescoffier
Copy link
Member

Thanks for reporting this!
Do you have the list of inconsistencies? Are they all about configuration properties?

@gsmet
Copy link
Member

gsmet commented Feb 13, 2025

I had a look and I don't think we are pointing to an old guide.

Quarkus Messaging uses SmallRye Reactive Messaging under the hood. So if something looks old, could we clarify what exactly?

Then, I'm not exactly sure what quarkus.kafka.devservices.topics\ refers to. Could we have the full name of the property? Because this is not a valid property.

@ozangunalp
Copy link
Contributor

The correct build-time property to configure topics to create for the Kafka dev service is quarkus.kafka.devservices.topic-partitions.[topic-name]=[partition-count]

gsmet added a commit to gsmet/quarkus that referenced this issue Feb 14, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/kafka kind/bug Something isn't working
Projects
None yet
Development

No branches or pull requests

4 participants