RedPandaServerResource.withKafkaUI

1. Docs
2. /Reference
3. /Search TypeScript APIs
4. /CommunityToolkit.Aspire.Hosting.RedPanda
5. /RedPandaServerResource
6. /withKafkaUI

Method

📦 CommunityToolkit.Aspire.Hosting.RedPanda v13.5.0

interface RedPandaServerResource {
  // ... omitted for brevity
  withKafkaUI(configureContainer?: (obj: RedPandaKafkaUiContainerResource) => Promise<void>, containerName?: string): RedPandaServerResource;
}

Signature

methodwithKafkaUIbuilder

Adds a Kafka UI container to the application, configured to connect to the Redpanda broker. This is the same Kafka management UI (the `kafbat/kafka-ui` image) used by the official Aspire Kafka integration, so it works against any Kafka API compatible broker.

withKafkaUI(configureContainer?: (obj: RedPandaKafkaUiContainerResource) => Promise<void>, containerName?: string): RedPandaServerResource

Parameters

configureContainer(obj: RedPandaKafkaUiContainerResource) => Promise<void>optional

containerNamestringoptional

Returns

RedPandaServerResource

Defined on

This method is defined on the following type:

handleRedPandaServerResource11 members