oscerd opened a new pull request, #3035:
URL: https://github.com/apache/camel-kamelets/pull/3035
`kafka-source-description.adoc` documents properties that this Kamelet does
not have.
## What is wrong
It states the Kamelet *"requires SASL/PLAIN authentication"* and lists
**User** and **Password** as required properties. The Kamelet actually declares
`saslAuthType` (default `NONE`), `saslUsername` and `saslPassword`, and only
`topic` and `bootstrapServers` are required.
The part that bites: both usage examples pass
```yaml
user: "kafka-user"
password: "kafka-password"
```
`user` and `password` are not properties of `kafka-source`, so copying
either example does not work.
The Security section is wrong in the other direction — it claims
*"SASL/PLAIN authentication mechanism with TLS encryption enabled"*, when
nothing is enabled by default.
## Why it drifted
Not sloppy writing — the text was accurate when it landed. e4b1ad0f1 (#2589,
2025-09-23) moved it out of `spec.definition.description`, and at that point
`user` and `password` were the real property names. f4be62637 (#2703,
2026-01-20) consolidated the Kafka Kamelets, introduced `saslAuthType` and
renamed the credentials, and the partial was not updated. It has been stale
since January.
## What this changes
Rewritten against the current definition:
- **Authentication** describes `saslAuthType` and which property group each
mechanism needs — `PLAIN` / `SCRAM_SHA_*` take the SASL pair, `OAUTH` takes the
four OAuth properties, `SSL` takes the keystore and truststore, and
`AWS_MSK_IAM` / `KERBEROS` come from the environment.
- **Configuration** lists the properties that exist, with their defaults,
and says plainly that only `topic` and `bootstrapServers` are required.
- **Security** says nothing is on unless configured, instead of claiming
SASL and TLS are enabled.
- Both examples use `saslAuthType` / `saslUsername` / `saslPassword`.
Property names, types and defaults were read out of
`kamelets/kafka-source.kamelet.yaml` rather than written from memory.
Documentation only — no change to the Kamelet, so no behaviour change.
Found while working on #3032, which touches the Output Format section of the
same file. The two edits are in different sections and do not conflict.
---
_Claude Code on behalf of Andrea Cosentino_
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
