Skip to content

Commit 7555a0d

Browse files
committed
docs(redpanda): document new HTTP Proxy options
1 parent 675a3f5 commit 7555a0d

File tree

2 files changed

+21
-1
lines changed

2 files changed

+21
-1
lines changed

docs/modules/redpanda.md

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,12 @@ Since <a href="https://github.com/testcontainers/testcontainers-go/releases/tag/
55
## Introduction
66

77
Redpanda is a streaming data platform for developers. Kafka API compatible. 10x faster. No ZooKeeper. No JVM!
8-
This Testcontainers module provides three APIs:
8+
This Testcontainers module provides the following APIs:
99

1010
- Kafka API
1111
- Schema Registry API
1212
- Redpanda Admin API
13+
- HTTP Proxy API (PandaProxy)
1314

1415
## Adding this module to your project dependencies
1516

@@ -121,6 +122,12 @@ The `WithEnableWasmTransform` enables wasm transform.
121122

122123
The `WithEnableSchemaRegistryHTTPBasicAuth` enables HTTP basic authentication for the Schema Registry.
123124

125+
#### WithHTTPProxyAuthMethod
126+
127+
- Not available until the next release <a href="https://github.com/testcontainers/testcontainers-go"><span class="tc-version">:material-tag: main</span></a>
128+
129+
The `WithHTTPProxyAuthMethod` sets the authentication method for the HTTP Proxy API (PandaProxy). For HTTP Proxy to have BasicAuth, SASL must be enabled. See `WithEnableSASL()`.
130+
124131
#### WithAutoCreateTopics
125132

126133
- Since <a href="https://github.com/testcontainers/testcontainers-go/releases/tag/v0.22.0"><span class="tc-version">:material-tag: v0.22.0</span></a>
@@ -189,3 +196,14 @@ is an HTTP-based API and thus the returned format will be: http://host:port.
189196
<!--codeinclude-->
190197
[Get admin API address](../../modules/redpanda/redpanda_test.go) inside_block:adminAPIAddress
191198
<!--/codeinclude-->
199+
200+
#### HTTPProxyAddress
201+
202+
- Not available until the next release <a href="https://github.com/testcontainers/testcontainers-go"><span class="tc-version">:material-tag: main</span></a>
203+
204+
HTTPProxyAddress returns the address to the HTTP Proxy API (PandaProxy). This
205+
is an HTTP-based API and thus the returned format will be: http://host:port.
206+
207+
<!--codeinclude-->
208+
[Get HTTP Proxy address](../../modules/redpanda/redpanda_test.go) inside_block:httpProxyAddress
209+
<!--/codeinclude-->

modules/redpanda/redpanda_test.go

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,9 @@ func TestRedpanda(t *testing.T) {
7373
require.Equal(t, http.StatusOK, resp.StatusCode)
7474

7575
// Test HTTP Proxy API
76+
// httpProxyAddress {
7677
httpProxyURL, err := ctr.HTTPProxyAddress(ctx)
78+
// }
7779
require.NoError(t, err)
7880
req, err = http.NewRequestWithContext(ctx, http.MethodGet, httpProxyURL+"/topics", nil)
7981
require.NoError(t, err)

0 commit comments

Comments
 (0)