Aspirerelease/17.0
Watch Aspire live streamsDocsTry Aspire

RedPandaServerResource

Handle
📦 CommunityToolkit.Aspire.Hosting.RedPanda v13.6.1

A resource that represents a Redpanda streaming platform container.

type RedPandaServerResource interface {
ExpressionValue
IComputeResource
Resource
ResourceWithArgs
ResourceWithConnectionString
ResourceWithEndpoints
ResourceWithEnvironment
ResourceWithWaitSupport
}

Properties

propertyAdminEndpointEndpointReferenceget
Gets the Admin API HTTP endpoint for the Redpanda broker.
AdminEndpoint() EndpointReference
propertyConnectionStringExpression*ReferenceExpressionget
Gets the connection string expression for the Redpanda broker in the form of host:port, suitable for use as the Kafka bootstrap servers value.
ConnectionStringExpression() *ReferenceExpression
propertyHostEndpointReferenceExpressionget
Gets the host of the primary Kafka endpoint.
Host() EndpointReferenceExpression
propertyInternalEndpointEndpointReferenceget
Gets the internal Kafka API endpoint used for container-to-container communication.
InternalEndpoint() EndpointReference
propertyPortEndpointReferenceExpressionget
Gets the port of the primary Kafka endpoint.
Port() EndpointReferenceExpression
propertyPrimaryEndpointEndpointReferenceget
Gets the primary (Kafka API) endpoint for the Redpanda broker. This endpoint is reachable from the host.
PrimaryEndpoint() EndpointReference
propertySchemaRegistryEndpointEndpointReferenceget
Gets the Schema Registry HTTP endpoint for the Redpanda broker.
SchemaRegistryEndpoint() EndpointReference

Methods

methodWithConsolebuilder
Adds a Redpanda Console container to the application, configured to connect to the Redpanda broker.
WithConsole(options ...*WithConsoleOptions) RedPandaServerResource
options...*WithConsoleOptionsOptional settings, described under Options.

Optional parameters are passed in a trailing options ...*WithConsoleOptions argument.

ConfigureContainerfunc(obj RedPandaConsoleContainerResource)callbackAn optional callback to configure the Redpanda Console container resource.
ContainerName*stringThe name of the container (optional).
RedPandaServerResource

A reference to the IResourceBuilder for the Redpanda server resource.

Returns a handle; failures surface later via Err().

methodWithDataBindMountbuilder
Adds a bind mount for the data folder to a Redpanda container resource.
WithDataBindMount(
source string,
options ...*WithDataBindMountOptions,
) RedPandaServerResource
sourcestringThe source directory on the host to mount into the container.
options...*WithDataBindMountOptionsOptional settings, described under Options.

Optional parameters are passed in a trailing options ...*WithDataBindMountOptions argument.

IsReadOnly*boolA flag that indicates if this is a read-only mount.
RedPandaServerResource

A reference to the IResourceBuilder.

Returns a handle; failures surface later via Err().

methodWithDataVolumebuilder
Adds a named volume for the data folder to a Redpanda container resource.
WithDataVolume(options ...*WithDataVolumeOptions) RedPandaServerResource
options...*WithDataVolumeOptionsOptional settings, described under Options.

Optional parameters are passed in a trailing options ...*WithDataVolumeOptions argument.

Name*stringThe name of the volume. Defaults to an auto-generated name based on the application and resource names.
IsReadOnly*boolA flag that indicates if this is a read-only volume.
RedPandaServerResource

A reference to the IResourceBuilder.

Returns a handle; failures surface later via Err().

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(options ...*WithKafkaUIOptions) RedPandaServerResource
options...*WithKafkaUIOptionsOptional settings, described under Options.

Optional parameters are passed in a trailing options ...*WithKafkaUIOptions argument.

ConfigureContainerfunc(obj RedPandaKafkaUiContainerResource)callbackAn optional callback to configure the Kafka UI container resource.
ContainerName*stringThe name of the container (optional).
RedPandaServerResource

A reference to the IResourceBuilder for the Redpanda server resource.

Returns a handle; failures surface later via Err().