OpenWebUIResource

Handle

📦 CommunityToolkit.Aspire.Hosting.Ollama v13.5.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

propertyconnectionStringExpressionReferenceExpressionget

Gets the connection string expression for the Open WebUI endpoint.

propertyhostEndpointReferenceExpressionget

Gets the host endpoint reference for this resource.

propertyollamaResourcesIOllamaResource[]get

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

propertyportEndpointReferenceExpressionget

Gets the port endpoint reference for this resource.

propertyprimaryEndpointEndpointReferenceget

Gets the http endpoint for the Open WebUI resource.

propertyuriExpressionReferenceExpressionget

Gets the connection URI expression for the Open WebUI endpoint.

Methods

methodwithDataVolumebuilder

Adds a data volume to the Open WebUI container.

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

Parameters

namestringoptional

isReadOnlybooleanoptional= False

Returns

OpenWebUIResource

methodwithHostPortbuilder

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

withHostPort(port: number): OpenWebUIResource

Parameters

portnumber

Returns

OpenWebUIResource