Skip to content

kafka: deprecate redundant auth.plain_text #38883

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

Merged
merged 1 commit into from
Mar 24, 2025

Conversation

axw
Copy link
Contributor

@axw axw commented Mar 23, 2025

Description

If auth.plain_text is configured, internally SASL/PLAIN is configured.

This config is redundant and makes things harder to understand: as a user, should I configure auth.plain_text, or auth.sasl with mechanism PLAIN? If I set plain_text I can't specify the SASL protocol version, why not?

So let's simplify, at the expense of slightly more verbose, but more explicit, configuration. Instead of configuring:

auth:
  plain_text:
    username: alice
    password: bob

... you should configure this instead:

auth:
  sasl:
    mechanism: PLAIN
    username: alice
    password: bob

Link to tracking issue

None

Testing

N/A

Documentation

Updated READMEs.

If `auth.plain_text` is configured, internally
SASL/PLAIN is configured.

This config is redundant and makes things harder
to understand: as a user, should I configure
auth.plain_text, or auth.sasl with mechanism PLAIN?
If I set plain_text I can't specify the SASL protocol
version, why not?

So let's simplify, at the expense of slightly more
verbose, but more explicit, configuration. Instead of
configuring:

```yaml
auth:
  plain_text:
    username: alice
    password: bob
```

... you should configure this instead:

```yaml
auth:
  sasl:
    mechanism: PLAIN
    username: alice
    password: bob
```
@axw axw force-pushed the kafka-deprecate-plaintext branch from 869eb5b to 81968ea Compare March 23, 2025 05:59
@axw axw marked this pull request as ready for review March 23, 2025 23:26
@axw axw requested a review from a team as a code owner March 23, 2025 23:26
@MovieStoreGuy MovieStoreGuy merged commit a8f308e into open-telemetry:main Mar 24, 2025
175 of 176 checks passed
@github-actions github-actions bot added this to the next release milestone Mar 24, 2025
@axw axw deleted the kafka-deprecate-plaintext branch March 24, 2025 05:20
Fiery-Fenix pushed a commit to Fiery-Fenix/opentelemetry-collector-contrib that referenced this pull request Apr 24, 2025
#### Description

If `auth.plain_text` is configured, internally SASL/PLAIN is configured.

This config is redundant and makes things harder to understand: as a
user, should I configure auth.plain_text, or auth.sasl with mechanism
PLAIN? If I set plain_text I can't specify the SASL protocol version,
why not?

So let's simplify, at the expense of slightly more verbose, but more
explicit, configuration. Instead of configuring:

```yaml
auth:
  plain_text:
    username: alice
    password: bob
```

... you should configure this instead:

```yaml
auth:
  sasl:
    mechanism: PLAIN
    username: alice
    password: bob
```

#### Link to tracking issue

None

#### Testing

N/A

#### Documentation

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

Successfully merging this pull request may close these issues.

3 participants