macOS

curl -sSL https://aspire.dev/install.sh | bash

curl -sSL https://aspire.dev/install.sh | bash -s -- -q staging

curl -sSL https://aspire.dev/install.sh | bash -s -- -q dev

Linux

curl -sSL https://aspire.dev/install.sh | bash

curl -sSL https://aspire.dev/install.sh | bash -s -- -q staging

curl -sSL https://aspire.dev/install.sh | bash -s -- -q dev

Windows

irm https://aspire.dev/install.ps1 | iex

iex "& { $(irm https://aspire.dev/install.ps1) } -Quality staging"

iex "& { $(irm https://aspire.dev/install.ps1) } -Quality dev"

CommunityToolkit.Aspire.Hosting.RedPanda

📦 CommunityToolkit.Aspire.Hosting.RedPandav13.5.0

6Functions

3Types

3 types and 7 members

Types

handleRedPandaConsoleContainerResource1 members

handleRedPandaKafkaUiContainerResource

handleRedPandaServerResource11 members

Functions

methodaddRedPandabuilder

Adds a Redpanda container resource to the application. Redpanda is a Kafka API compatible streaming platform, so the resource can be referenced by any Kafka client integration.

addRedPanda(name: string, port?: number): RedPandaServerResource

methodwithConsolebuilder

Adds a Redpanda Console container to the application, configured to connect to the Redpanda broker.

withConsole(configureContainer?: (obj: RedPandaConsoleContainerResource) => Promise<void>, containerName?: string): RedPandaServerResource

methodwithDataBindMountbuilder

Adds a bind mount for the data folder to a Redpanda container resource.

withDataBindMount(source: string, isReadOnly?: boolean): RedPandaServerResource

methodwithDataVolumebuilder

Adds a named volume for the data folder to a Redpanda container resource.

withDataVolume(name?: string, isReadOnly?: boolean): RedPandaServerResource

methodwithHostPortbuilder

Configures the host port that the Redpanda Console resource is exposed on instead of using a randomly assigned port.

withHostPort(port: number): RedPandaConsoleContainerResource

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