Skip to content

Commit d0d3c19

Browse files
Feediver1micheleRP
andauthored
Doc 1701: Per listener configuration of SASL mechanisms (#1457)
Co-authored-by: Michele Cyran <[email protected]>
1 parent e3e4610 commit d0d3c19

File tree

2 files changed

+25
-0
lines changed

2 files changed

+25
-0
lines changed

modules/manage/partials/authentication.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -505,6 +505,8 @@ SASL provides a flexible and adaptable framework for implementing various authen
505505

506506
ifndef::env-kubernetes[- <<kerberos, SASL/GSSAPI>> (Kerberos)]
507507

508+
NOTE: Redpanda provides an option to configure different SASL authentication mechanisms for specific listeners. For example, you could specify SCRAM for internal traffic and OAUTHBEARER for external clients. For details, see xref:reference:properties/cluster-properties.adoc#sasl_mechanisms_overrides[sasl_mechanisms_overrides].
509+
508510
==== Enable SASL
509511

510512
To enable SASL authentication for the Kafka API, set the xref:reference:properties/broker-properties.adoc#kafka_api_auth_method[`authentication_method`] broker property of the Kafka listeners to `sasl`.

modules/reference/pages/properties/cluster-properties.adoc

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5679,6 +5679,29 @@ endif::[]
56795679

56805680
// end::sasl_mechanisms[]
56815681

5682+
[[sasl_mechanisms_overrides]]
5683+
=== sasl_mechanisms_overrides
5684+
5685+
Configure different SASL authentication mechanisms for specific listeners. This overrides the cluster-wide <<sasl_mechanisms, `sasl_mechanisms`>> setting for the specified listener. Use this when you need different authentication methods on different listeners, such as SCRAM for internal traffic and OAUTHBEARER for external clients. The same requirements from `sasl_mechanisms` apply.
5686+
5687+
ifndef::env-cloud[]
5688+
include::reference:partial$enterprise-licensed-property.adoc[]
5689+
endif::[]
5690+
5691+
*Requires restart:* No
5692+
5693+
*Nullable:* No
5694+
5695+
*Visibility:* `user`
5696+
5697+
*Type:* array
5698+
5699+
*Example:* `[{'listener':'kafka_listener', 'sasl_mechanisms':['SCRAM']}]`
5700+
5701+
ifndef::env-cloud[]
5702+
*Default:* `[]`
5703+
endif::[]
5704+
56825705
=== schema_registry_always_normalize
56835706

56845707
Always normalize schemas. If set, this overrides the `normalize` parameter in requests to the Schema Registry API.

0 commit comments

Comments
 (0)