You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: modules/manage/partials/authentication.adoc
+29-2Lines changed: 29 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -657,10 +657,17 @@ endif::[]
657
657
658
658
Schema Registry and HTTP Proxy connect to Redpanda over the Kafka API. For the Kafka username and password, Redpanda uses ephemeral credentials internal to the cluster. Ephemeral credentials are regular SCRAM credentials, but they're only stored in memory and are lost when a broker restarts. When the Schema Registry or HTTP Proxy start up, they broadcast an ephemeral credential to other brokers over the internal RPC. If authentication fails to a particular broker, new ephemeral credentials are sent to that broker, and the service reconnects.
659
659
660
+
[IMPORTANT]
661
+
====
662
+
*Breaking change in Redpanda 25.2:* Ephemeral credentials for HTTP Proxy are removed. If your HTTP Proxy API listeners use `authentication_method: none`, you must configure explicit SASL credentials for HTTP Proxy to authenticate with the Kafka API. Without these credentials, HTTP Proxy will fail to connect to the Kafka API.
663
+
664
+
This change does not affect Schema Registry, which continues to use ephemeral credentials.
665
+
====
666
+
660
667
Schema Registry and HTTP Proxy support only the SASL/SCRAM mechanism.
661
668
662
669
ifndef::env-kubernetes[]
663
-
You can override the ephemeral credentials and manually configure Schema Registry and HTTP Proxy to connect to Redpanda with SASL. This approach is particularly useful when you want to apply specific access control through ACLs for the Schema Registry and HTTP Proxy users.
670
+
Starting in Redpanda 25.2, you must manually configure HTTP Proxy to connect to Redpanda with SASL when HTTP Proxy API listeners use `authentication_method: none`. For Schema Registry, you can override the ephemeral credentials and manually configure Schema Registry to connect to Redpanda with SASL. This approach is particularly useful when you want to apply specific access control through ACLs for the Schema Registry and HTTP Proxy users.
664
671
665
672
. xref:manage:security/authorization/index.adoc[Create appropriate ACLs] for the Schema Registry and HTTP Proxy users to define and restrict their access rights within the Redpanda cluster.
666
673
@@ -698,7 +705,22 @@ schema_registry_client:
698
705
sasl_mechanism: SCRAM-SHA-256
699
706
----
700
707
+
701
-
For HTTP Proxy:
708
+
For HTTP Proxy (required when `authentication_method: none` starting in Redpanda 25.2):
709
+
+
710
+
[,yaml]
711
+
----
712
+
pandaproxy_client:
713
+
brokers:
714
+
- address: 127.0.0.1
715
+
port: 9092
716
+
scram_username: <username>
717
+
scram_password: <password>
718
+
sasl_mechanism: SCRAM-SHA-256
719
+
----
720
+
+
721
+
When HTTP Proxy API listeners use `authentication_method: none`, the HTTP Proxy client uses these credentials to authenticate with the Kafka API. The user specified in `scram_username` must have appropriate permissions to access the required Kafka resources.
722
+
+
723
+
If TLS is enabled for the Kafka API, additional configuration is required:
702
724
+
703
725
[,yaml]
704
726
----
@@ -1757,6 +1779,11 @@ For all available endpoints, see xref:api:ROOT:pandaproxy-schema-registry.adoc[]
1757
1779
1758
1780
To disable authentication for a listener, set `authentication_method` to `none`:
1759
1781
1782
+
[IMPORTANT]
1783
+
====
1784
+
*Breaking change in Redpanda 25.2:* When HTTP Proxy API listeners use `authentication_method: none`, you must configure explicit SASL credentials for HTTP Proxy to authenticate with the Kafka API. Configure the `pandaproxy_client` properties: `scram_username`, `scram_password`, and `sasl_mechanism`. For more information, see xref:reference:properties/broker-properties.adoc#scram_username[HTTP Proxy Client properties].
Copy file name to clipboardExpand all lines: modules/reference/pages/properties/broker-properties.adoc
+11-3Lines changed: 11 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -778,7 +778,11 @@ Delay (in milliseconds) for initial retry backoff.
778
778
779
779
=== sasl_mechanism
780
780
781
-
The SASL mechanism to use when connecting.
781
+
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.
782
+
783
+
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.
784
+
785
+
For more information, see xref:manage:security/authentication.adoc#schema-and-http-to-redpanda[Configure HTTP Proxy to connect to Redpanda with SASL].
782
786
783
787
*Visibility:* `user`
784
788
@@ -790,7 +794,9 @@ The SASL mechanism to use when connecting.
790
794
791
795
=== scram_password
792
796
793
-
Password to use for SCRAM authentication mechanisms.
797
+
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.
798
+
799
+
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`.
794
800
795
801
*Visibility:* `user`
796
802
@@ -802,7 +808,9 @@ Password to use for SCRAM authentication mechanisms.
802
808
803
809
=== scram_username
804
810
805
-
Username to use for SCRAM authentication mechanisms.
811
+
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.
812
+
813
+
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`.
Copy file name to clipboardExpand all lines: modules/upgrade/partials/incompat-changes.adoc
+2Lines changed: 2 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,7 @@
1
1
=== Review incompatible changes
2
2
3
+
* Starting in version 25.2, ephemeral credentials for HTTP Proxy are removed. If your HTTP Proxy API listeners use `authentication_method: none`, you must configure explicit SASL credentials (xref:reference:properties/broker-properties.adoc#scram_username[`scram_username`], xref:reference:properties/broker-properties.adoc#scram_password[`scram_password`], and xref:reference:properties/broker-properties.adoc#sasl_mechanism[`sasl_mechanism`]) for HTTP Proxy to authenticate with the Kafka API. Without these credentials, HTTP Proxy will fail to connect to the Kafka API. For more information, see xref:manage:security/authentication.adoc#schema-and-http-to-redpanda[Configure HTTP Proxy to connect to Redpanda with SASL].
4
+
3
5
* Redpanda Console v3.0.0 introduces breaking changes. If you are using Redpanda Console v2.x, xref:migrate:console-v3.adoc[review the migration guide] to address breaking changes before upgrading Redpanda Console.
4
6
5
7
* Starting in version 24.2, when managing configuration properties using the AlterConfigs API directly, Redpanda resets all unspecified values to the default values. This aligns more closely with the behavior in Apache Kafka. There is no change if you're managing your configuration with tools like `rpk`, Redpanda Console, Kubernetes, Helm, or Terraform.
0 commit comments