Skip to content

Commit 8e45ad5

Browse files
authored
Merge pull request #26828 from redpanda-data/update-description-ephemeral-creds
docs: update descriptions for ephemeral creds
2 parents 7a05125 + b5d1993 commit 8e45ad5

1 file changed

Lines changed: 23 additions & 3 deletions

File tree

src/v/kafka/client/configuration.cc

Lines changed: 23 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -149,19 +149,39 @@ configuration::configuration()
149149
, sasl_mechanism(
150150
*this,
151151
"sasl_mechanism",
152-
"The SASL mechanism to use when connecting.",
152+
"The SASL mechanism to use when the HTTP Proxy client connects to the "
153+
"Kafka API. These credentials are used when the HTTP Proxy API "
154+
"listener has `authentication_method: none` but the cluster requires "
155+
"authenticated access to the Kafka API. Starting in Redpanda 25.2, "
156+
"ephemeral credentials for HTTP Proxy are removed. If your HTTP Proxy "
157+
"listeners use `authentication_method: none`, you must configure these "
158+
"SASL properties for HTTP Proxy to authenticate with the Kafka API. "
159+
"For more information, see "
160+
"https://docs.redpanda.com/current/manage/security/authentication/",
153161
{},
154162
"")
155163
, scram_username(
156164
*this,
157165
"scram_username",
158-
"Username to use for SCRAM authentication mechanisms.",
166+
"Username to use for SCRAM authentication mechanisms when the HTTP "
167+
"Proxy client connects to the Kafka API. This property is required "
168+
"when the HTTP Proxy API listener has `authentication_method: none` "
169+
"but the cluster requires authenticated access to the Kafka API. "
170+
"Starting in Redpanda 25.2, ephemeral credentials for HTTP Proxy are "
171+
"removed. You must configure this property if your HTTP Proxy "
172+
"listeners use `authentication_method: none`.",
159173
{},
160174
"")
161175
, scram_password(
162176
*this,
163177
"scram_password",
164-
"Password to use for SCRAM authentication mechanisms.",
178+
"Password to use for SCRAM authentication mechanisms when the HTTP "
179+
"Proxy client connects to the Kafka API. This property is required "
180+
"when the HTTP Proxy API listener has `authentication_method: none` "
181+
"but the cluster requires authenticated access to the Kafka API. "
182+
"Starting in Redpanda 25.2, ephemeral credentials for HTTP Proxy are "
183+
"removed. You must configure this property if your HTTP Proxy "
184+
"listeners use `authentication_method: none`.",
165185
{.secret = config::is_secret::yes},
166186
"")
167187
, client_identifier(

0 commit comments

Comments
 (0)