OpenWebUIResource

Handle

📦 CommunityToolkit.Aspire.Hosting.Ollama v13.4.0

interface OpenWebUIResource
  extends IComputeResource,
    IExpressionValue,
    IManifestExpressionProvider,
    IResource,
    IResourceWithArgs,
    IResourceWithConnectionString,
    IResourceWithEndpoints,
    IResourceWithEnvironment,
    IResourceWithProbes,
    IResourceWithWaitSupport,
    IValueProvider,
    IValueWithReferences {
  readonly connectionStringExpression: ReferenceExpression;
  readonly host: EndpointReferenceExpression;
  readonly ollamaResources: IOllamaResource[];
  readonly port: EndpointReferenceExpression;
  readonly primaryEndpoint: EndpointReference;
  readonly uriExpression: ReferenceExpression;
  withDataVolume(
      name?: string,
      isReadOnly?: boolean): OpenWebUIResource;
  withHostPort(port: number): OpenWebUIResource;
}

8 members

Properties

property connectionStringExpression ReferenceExpression get

Gets the connection string expression for the Open WebUI endpoint.

property host EndpointReferenceExpression get

Gets the host endpoint reference for this resource.

property ollamaResources IOllamaResource[] get

Gets the list of Ollama resources that are associated with this Open WebUI resource.

property port EndpointReferenceExpression get

Gets the port endpoint reference for this resource.

property primaryEndpoint EndpointReference get

Gets the http endpoint for the Open WebUI resource.

property uriExpression ReferenceExpression get

Gets the connection URI expression for the Open WebUI endpoint.

Methods

method withDataVolume builder

Adds a data volume to the Open WebUI container.

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

Parameters

name string optional

isReadOnly boolean optional = False

Returns

OpenWebUIResource

method withHostPort builder

Configures the host port that the Open WebUI resource is exposed on instead of using randomly assigned port.

withHostPort(port: number): OpenWebUIResource

Parameters

port number

Returns

OpenWebUIResource