Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
48 commits
Select commit Hold shift + click to select a range
665392d
docs: add auth method broker property
paulohtb6 Aug 7, 2025
50aa3ea
add more properties
paulohtb6 Aug 7, 2025
cfe22a4
add more examples
paulohtb6 Aug 7, 2025
764b2dd
add cross links
paulohtb6 Aug 7, 2025
31024a9
add more examples and make them use placeholders
paulohtb6 Aug 7, 2025
5ec4c56
fix nesting
paulohtb6 Aug 7, 2025
eec5d74
fix syntax
paulohtb6 Aug 7, 2025
08f63f7
OIDC bug?
paulohtb6 Aug 8, 2025
9949987
review comments
paulohtb6 Aug 8, 2025
c3d87d5
fix incorrect suggestions
paulohtb6 Aug 8, 2025
15c516f
Update modules/manage/pages/security/listener-configuration.adoc
paulohtb6 Aug 8, 2025
0f3349e
Update modules/reference/pages/properties/broker-properties.adoc
paulohtb6 Aug 11, 2025
a1e4ddf
Update modules/reference/pages/properties/broker-properties.adoc
paulohtb6 Aug 11, 2025
5487a32
add admin example
paulohtb6 Aug 11, 2025
19e2575
ca_file to truststore_file per review
paulohtb6 Aug 11, 2025
82bbb9b
adjust naming
paulohtb6 Aug 11, 2025
9f21902
Update modules/reference/pages/properties/broker-properties.adoc
paulohtb6 Aug 11, 2025
b570dc2
add new field ignore_existing_node_id
paulohtb6 Aug 11, 2025
1e6d922
fix examples
paulohtb6 Aug 11, 2025
15aa951
add accepted values for sasl_mech
paulohtb6 Aug 11, 2025
02e45ef
reorganize auth method
paulohtb6 Aug 11, 2025
5fdc33b
clean up
paulohtb6 Aug 11, 2025
f7d981f
pandaproxy disambuiguation
paulohtb6 Aug 11, 2025
04b1ccb
simplify examples
paulohtb6 Aug 11, 2025
a965d26
adjust links
paulohtb6 Aug 11, 2025
85a747e
adjut messaging around unauth http proxy
paulohtb6 Aug 11, 2025
d5bf899
add example for oidc
paulohtb6 Aug 11, 2025
8cdfa40
clarification in file structure
paulohtb6 Aug 11, 2025
32c8a57
Update modules/develop/partials/http-proxy.adoc
paulohtb6 Aug 12, 2025
c2b52f7
fix entry references
paulohtb6 Aug 12, 2025
7909609
add example to pandaproxy_client
paulohtb6 Aug 12, 2025
d4dd6ba
add more examples for top level entries
paulohtb6 Aug 12, 2025
27ac781
fix duplication
paulohtb6 Aug 12, 2025
581ea95
remove duplication
paulohtb6 Aug 12, 2025
e4f06f4
revert
paulohtb6 Aug 12, 2025
f2861a3
Apply suggestions from code review
paulohtb6 Aug 14, 2025
6186952
code review
paulohtb6 Aug 14, 2025
05e20b7
http proxy examples fixes
paulohtb6 Aug 14, 2025
e2a1d19
auth examples fixes
paulohtb6 Aug 14, 2025
f155de3
code review
paulohtb6 Aug 14, 2025
3d636c5
code rabbit api_doc_dir
paulohtb6 Aug 14, 2025
7bcc0f4
update scram examples
paulohtb6 Aug 14, 2025
ba69842
fix explanations on SR properties
paulohtb6 Aug 14, 2025
1ebee5d
fix list
paulohtb6 Aug 14, 2025
48ea124
explain relationship between client/server
paulohtb6 Aug 14, 2025
61ac16d
fix api_doc_dir placement
paulohtb6 Aug 14, 2025
d977c8e
fix defaults
paulohtb6 Aug 14, 2025
93b0499
explicit examples
paulohtb6 Aug 14, 2025
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
46 changes: 46 additions & 0 deletions modules/develop/partials/http-proxy.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -899,6 +899,52 @@ pretty(res)
--
=====

=== OIDC Authentication

If HTTP Proxy is configured to support OIDC, you can provide an OIDC token in the Authorization header. For example:

[tabs]
=====
curl::
+
--
[,bash]
----
curl -s -H "Authorization: Bearer <oidc-token>" "<host-address>:8082/topics"
----

--
NodeJS::
+
--
[,javascript]
----
let options = {
headers: { Authorization: `Bearer <oidc-token>` },
};

axios
.get(`${base_uri}/topics`, options)
.then(response => console.log(response.data))
.catch(error => console.log);
----

--
Python::
+
--
[,python]
----
headers = {"Authorization": "Bearer <oidc-token>"}
res = requests.get(f"{base_uri}/topics", headers=headers).json()
pretty(res)
----

--
=====

For details about configuring OIDC authentication, see xref:manage:security/authentication.adoc#oidc-authentication[OIDC Authentication].

Comment thread
paulohtb6 marked this conversation as resolved.
== Use Swagger with HTTP Proxy

You can use Swagger UI to test and interact with Redpanda HTTP Proxy endpoints.
Expand Down
5 changes: 0 additions & 5 deletions modules/get-started/pages/release-notes/redpanda.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -47,12 +47,7 @@ The `confluent-kafka-javascript` client is now validated with Redpanda. For a li

== HTTP Proxy authentication changes

[IMPORTANT]
====
include::shared:partial$http-proxy-ephemeral-credentials-breaking-change.adoc[tags=!*;include-config-link]
====

HTTP Proxy previously used automatically-generated ephemeral credentials to authenticate with the Kafka API when the HTTP Proxy listeners specified xref:reference:properties/broker-properties.adoc#http_proxy_auth_method[`authentication_method`]: `none`. To improve security and simplify the authentication model, ephemeral credentials are no longer available.

If you need to maintain the current HTTP Proxy functionality while transitioning to authenticated clients, configure the following HTTP Proxy client properties in your `redpanda.yaml` configuration:

Expand Down
6 changes: 0 additions & 6 deletions modules/manage/partials/authentication.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -657,10 +657,7 @@ endif::[]

Schema Registry and HTTP Proxy connect to Redpanda over the Kafka API.
Comment thread
paulohtb6 marked this conversation as resolved.

[IMPORTANT]
====
include::shared:partial$http-proxy-ephemeral-credentials-breaking-change.adoc[tags=!*;include-release-notes-link]
====

Schema Registry and HTTP Proxy support only the SASL/SCRAM mechanism.

Expand Down Expand Up @@ -1793,10 +1790,7 @@ For all available endpoints, see xref:api:ROOT:pandaproxy-schema-registry.adoc[]

To disable authentication for a listener, set xref:reference:properties/broker-properties.adoc#kafka_api_auth_method[`authentication_method`] broker property to `none`:

[IMPORTANT]
====
include::shared:partial$http-proxy-ephemeral-credentials-breaking-change.adoc[tags=!*;include-release-notes-link]
====

ifdef::env-kubernetes[]
[tabs]
Expand Down