RedPandaServerResource

Handle

📦 CommunityToolkit.Aspire.Hosting.RedPanda v13.5.0

interface RedPandaServerResource
  extends IComputeResource,
    IExpressionValue,
    IManifestExpressionProvider,
    IResource,
    IResourceWithArgs,
    IResourceWithConnectionString,
    IResourceWithEndpoints,
    IResourceWithEnvironment,
    IResourceWithProbes,
    IResourceWithWaitSupport,
    IValueProvider,
    IValueWithReferences {
  readonly adminEndpoint: EndpointReference;
  readonly connectionStringExpression: ReferenceExpression;
  readonly host: EndpointReferenceExpression;
  readonly internalEndpoint: EndpointReference;
  readonly port: EndpointReferenceExpression;
  readonly primaryEndpoint: EndpointReference;
  readonly schemaRegistryEndpoint: EndpointReference;
  withConsole(configureContainer?: (obj: RedPandaConsoleContainerResource) => Promise<void>, containerName?: string): RedPandaServerResource;
  withDataBindMount(
      source: string,
      isReadOnly?: boolean): RedPandaServerResource;
  withDataVolume(
      name?: string,
      isReadOnly?: boolean): RedPandaServerResource;
  withKafkaUI(configureContainer?: (obj: RedPandaKafkaUiContainerResource) => Promise<void>, containerName?: string): RedPandaServerResource;
}

11 members

Properties

propertyadminEndpointEndpointReferenceget

Gets the Admin API HTTP endpoint for the Redpanda broker.

propertyconnectionStringExpressionReferenceExpressionget

Gets the connection string expression for the Redpanda broker in the form of `host:port`, suitable for use as the Kafka bootstrap servers value.

propertyhostEndpointReferenceExpressionget

Gets the host of the primary Kafka endpoint.

propertyinternalEndpointEndpointReferenceget

Gets the internal Kafka API endpoint used for container-to-container communication.

propertyportEndpointReferenceExpressionget

Gets the port of the primary Kafka endpoint.

propertyprimaryEndpointEndpointReferenceget

Gets the primary (Kafka API) endpoint for the Redpanda broker. This endpoint is reachable from the host.

propertyschemaRegistryEndpointEndpointReferenceget

Gets the Schema Registry HTTP endpoint for the Redpanda broker.

Methods

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

Parameters

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

containerNamestringoptional

Returns

RedPandaServerResource

methodwithDataBindMountbuilder

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

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

Parameters

sourcestring

isReadOnlybooleanoptional= False

Returns

RedPandaServerResource

methodwithDataVolumebuilder

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

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

Parameters

namestringoptional

isReadOnlybooleanoptional= False

Returns

RedPandaServerResource

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