Skip to content

docs: update descriptions for ephemeral creds #26828

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.

Sign up for GitHub

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
rockwotj merged 1 commit into from
Jul 15, 2025
Merged

docs: update descriptions for ephemeral creds #26828

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 23 additions & 3 deletions src/v/kafka/client/configuration.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -149,19 +149,39 @@ configuration::configuration()
, sasl_mechanism(
*this,
"sasl_mechanism",
"The SASL mechanism to use when connecting.",
"The SASL mechanism to use when the HTTP Proxy client connects to the "
"Kafka API. These credentials are used when the HTTP Proxy API "
"listener has `authentication_method: none` but the cluster requires "
"authenticated access to the Kafka API. Starting in Redpanda 25.2, "
"ephemeral credentials for HTTP Proxy are removed. If your HTTP Proxy "
"listeners use `authentication_method: none`, you must configure these "
"SASL properties for HTTP Proxy to authenticate with the Kafka API. "
"For more information, see "
"https://docs.redpanda.com/current/manage/security/authentication/",
{},
"")
, scram_username(
*this,
"scram_username",
"Username to use for SCRAM authentication mechanisms.",
"Username to use for SCRAM authentication mechanisms when the HTTP "
"Proxy client connects to the Kafka API. This property is required "
"when the HTTP Proxy API listener has `authentication_method: none` "
"but the cluster requires authenticated access to the Kafka API. "
"Starting in Redpanda 25.2, ephemeral credentials for HTTP Proxy are "
"removed. You must configure this property if your HTTP Proxy "
"listeners use `authentication_method: none`.",
{},
"")
, scram_password(
*this,
"scram_password",
"Password to use for SCRAM authentication mechanisms.",
"Password to use for SCRAM authentication mechanisms when the HTTP "
"Proxy client connects to the Kafka API. This property is required "
"when the HTTP Proxy API listener has `authentication_method: none` "
"but the cluster requires authenticated access to the Kafka API. "
"Starting in Redpanda 25.2, ephemeral credentials for HTTP Proxy are "
"removed. You must configure this property if your HTTP Proxy "
"listeners use `authentication_method: none`.",
{.secret = config::is_secret::yes},
"")
, client_identifier(
Expand Down
Loading