Skip to content

Commit ddbfe2d

Browse files
authored
DOCS-71:Update authentication.adoc (#1317)
1 parent 9652a13 commit ddbfe2d

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

modules/manage/partials/authentication.adoc

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1379,6 +1379,8 @@ Before enabling authentication for the HTTP APIs, you must <<sasl,enable SASL au
13791379

13801380
==== Basic authentication
13811381

1382+
NOTE: Redpanda Data recommends that you use TLS when enabling HTTP Basic Auth.
1383+
13821384
Basic authentication provides a method for securing HTTP endpoints. With basic authentication enabled, HTTP user agents, such as web browsers, must provide a username and password when making a request.
13831385

13841386
To add users to the Redpanda credential store that HTTP basic authentication uses, create users with xref:reference:rpk/rpk-acl/rpk-acl-user-create.adoc[`rpk security user create`].
@@ -1480,6 +1482,8 @@ rpk cluster config set admin_api_require_auth true
14801482
rpk cluster config set http_authentication '["BASIC"]'
14811483
----
14821484

1485+
NOTE: Valid values for the cluster configuration property xref:reference:properties/cluster-properties.adoc#http_authentication[`http_authentication`] (cluster-wide) are `BASIC` and `OIDC`. The value `BASIC` here is different from the per-listener setting `http_basic`, which enables authentication on a listener using the broker property `authentication_method` (see xref:reference:properties/broker-properties.adoc#schema_registry_auth_method[`authentication_method`] for the Schema Registry listener and xref:reference:properties/broker-properties.adoc#http_proxy_auth_method[`authentication_method`] for the HTTP Proxy listener).
1486+
14831487
To enable basic authentication for specific listeners, set xref:reference:properties/broker-properties.adoc#schema_registry_auth_method[`authentication_method`] broker property to `http_basic`. For example, in `redpanda.yaml`, enter:
14841488

14851489
[,yaml,lines=5+10]
@@ -1588,6 +1592,8 @@ NOTE: If you enable OIDC authentication for the Admin API, you must also <<creat
15881592

15891593
To enable OIDC for the HTTP API listeners as well as basic authentication, include OIDC in the `http_authentication` cluster property list:
15901594

1595+
NOTE: Valid values for the cluster configuration property xref:reference:properties/cluster-properties.adoc#http_authentication[`http_authentication`] (cluster-wide) are `BASIC` and `OIDC`. The value `BASIC` here is different from the per-listener setting `http_basic`, which enables authentication on a listener using the broker property `authentication_method` (see xref:reference:properties/broker-properties.adoc#schema_registry_auth_method[`authentication_method`] for the Schema Registry listener and xref:reference:properties/broker-properties.adoc#http_proxy_auth_method[`authentication_method`] for the HTTP Proxy listener).
1596+
15911597
ifdef::env-kubernetes[]
15921598
[tabs]
15931599
======

0 commit comments

Comments
 (0)