CommunityToolkit.Aspire.Hosting.Floci

📦 CommunityToolkit.Aspire.Hosting.Flociv13.5.0

23Functions

4Types

4 types and 16 members

Types

handleFlociAwsContainerResource10 members

handleFlociAzureContainerResource9 members

handleFlociGcpContainerResource9 members

handleFlociUIContainerResource5 members

Functions

methodaddFlociAwsbuilder

Adds a Floci AWS emulator container resource

addFlociAws(name: string, port?: number, defaultRegion?: string, defaultAccountId?: string): FlociAwsContainerResource

methodaddFlociAzurebuilder

Adds a Floci Azure emulator container resource

addFlociAzure(name: string, port?: number): FlociAzureContainerResource

methodaddFlociGcpbuilder

Adds a Floci GCP emulator container resource

addFlociGcp(name: string, port?: number, defaultProjectId?: string): FlociGcpContainerResource

methodwithAwsReferencebuilder

Attaches an additional Floci AWS resource to a Floci UI console

withAwsReference(cloud: FlociAwsContainerResource): FlociUIContainerResource

methodwithAzureReferencebuilder

Attaches an additional Floci Azure resource to a Floci UI console

withAzureReference(cloud: FlociAzureContainerResource): FlociUIContainerResource

methodwithConfigFilebuilder

Mounts a custom Quarkus `application.yml` configuration file into the Floci container. The file is mounted read-only at `/deployments/config/application.yml`, which Quarkus reads on startup and merges with built-in defaults.

withConfigFile(hostPath: string): FlociAwsContainerResource

methodwithDataBindMountbuilder

Configures a bind mount for persistent Floci state.

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

methodwithDataBindMountbuilder

Configures a bind mount for persistent Floci Azure state.

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

methodwithDataBindMountbuilder

Configures a bind mount for persistent Floci GCP state.

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

methodwithDataVolumebuilder

Configures a named data volume for persistent Floci state.

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

methodwithDataVolumebuilder

Configures a named data volume for persistent Floci Azure state.

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

methodwithDataVolumebuilder

Configures a named data volume for persistent Floci GCP state.

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

methodwithDockerSocketbuilder

Mounts the Docker socket into the Floci container so that Lambda and other container-backed AWS services can launch sibling containers. Also sets `FLOCI_DOCKER_DOCKER_HOST` to `unix:///var/run/docker.sock` (the container-side path where the socket is always mounted) so Floci can connect to it.

withDockerSocket(socketPath?: string): FlociAwsContainerResource

methodwithDockerSocketbuilder

Mounts the Docker socket into the Floci Azure container so that Azure Functions and other container-backed services can launch sibling containers. Also sets `FLOCI_AZ_DOCKER_DOCKER_HOST` to `unix:///var/run/docker.sock` (the container-side path where the socket is always mounted) so Floci can connect to it.

withDockerSocket(socketPath?: string): FlociAzureContainerResource

methodwithDockerSocketbuilder

Mounts the Docker socket into the Floci GCP container so that Cloud Run, Cloud SQL, and other container-backed services can launch sibling containers. Also sets `FLOCI_GCP_DOCKER_DOCKER_HOST` to `unix:///var/run/docker.sock` (the container-side path where the socket is always mounted) so Floci can connect to it.

withDockerSocket(socketPath?: string): FlociGcpContainerResource

methodwithFlociAwsReferencebuilder

Adds a reference to a Floci AWS emulator resource

withFlociAwsReference(floci: FlociAwsContainerResource): IResourceWithEnvironment

methodwithFlociAzureReferencebuilder

Adds a reference to a Floci Azure emulator resource

withFlociAzureReference(floci: FlociAzureContainerResource): IResourceWithEnvironment

methodwithFlociGcpReferencebuilder

Adds a reference to a Floci GCP emulator resource

withFlociGcpReference(floci: FlociGcpContainerResource): IResourceWithEnvironment

methodwithFlociUIbuilder

Adds a Floci UI web console container for the Floci Azure resource

withFlociUI(configureContainer?: (obj: FlociUIContainerResource) => Promise<void>, containerName?: string): FlociAzureContainerResource

methodwithFlociUIbuilder

Adds a Floci UI web console container for the Floci resource

withFlociUI(configureContainer?: (obj: FlociUIContainerResource) => Promise<void>, containerName?: string): FlociAwsContainerResource

methodwithFlociUIbuilder

Adds a Floci UI web console container for the Floci GCP resource

withFlociUI(configureContainer?: (obj: FlociUIContainerResource) => Promise<void>, containerName?: string): FlociGcpContainerResource

methodwithGcpReferencebuilder

Attaches an additional Floci GCP resource to a Floci UI console

withGcpReference(cloud: FlociGcpContainerResource): FlociUIContainerResource

methodwithHostPortbuilder

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

withHostPort(port: number): FlociUIContainerResource