CommunityToolkit.Aspire.Hosting.Floci
📦 CommunityToolkit.Aspire.Hosting.Flociv13.6.1Import path
apphost/modules/aspire27Functions
7Types
7 types, 27 functions and 28 members
Handles
Functions
DistributedApplicationBuilder
method
AddFlociAwsbuilderAdds a Floci AWS emulator container resource
AddFlociAws(name string, options ...*AddFlociAwsOptions) FlociAwsContainerResourcemethod
AddFlociAzurebuilderAdds a Floci Azure emulator container resource
AddFlociAzure(name string, options ...*AddFlociAzureOptions) FlociAzureContainerResourcemethod
AddFlociGcpbuilderAdds a Floci GCP emulator container resource
AddFlociGcp(name string, options ...*AddFlociGcpOptions) FlociGcpContainerResourceFlociAwsContainerResource
method
WithConfigFilebuilderMounts 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) FlociAwsContainerResourcemethod
WithDataBindMountbuilderConfigures a bind mount for persistent Floci state.
WithDataBindMount(source string, options ...*WithDataBindMountOptions) FlociAwsContainerResourcemethod
WithDataVolumebuilderConfigures a named data volume for persistent Floci state.
WithDataVolume(name string, options ...*WithDataVolumeOptions) FlociAwsContainerResourcemethod
WithDockerSocketbuilderMounts 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(options ...*WithDockerSocketOptions) FlociAwsContainerResourcemethod
WithFlociUIbuilderAdds a Floci UI web console container for the Floci resource
WithFlociUI(options ...*WithFlociUIOptions) FlociAwsContainerResourceFlociAzureContainerResource
method
WithCosmosbuilderAdds a Cosmos DB child resource to the Floci Azure emulator
WithCosmos(options ...*WithCosmosOptions) FlociAzureCosmosResourcemethod
WithDataBindMountbuilderConfigures a bind mount for persistent Floci Azure state.
WithDataBindMount(source string, options ...*WithDataBindMountOptions) FlociAzureContainerResourcemethod
WithDataVolumebuilderConfigures a named data volume for persistent Floci Azure state.
WithDataVolume(name string, options ...*WithDataVolumeOptions) FlociAzureContainerResourcemethod
WithDockerSocketbuilderMounts 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(options ...*WithDockerSocketOptions) FlociAzureContainerResourcemethod
WithFlociUIbuilderAdds a Floci UI web console container for the Floci Azure resource
WithFlociUI(options ...*WithFlociUIOptions) FlociAzureContainerResourcemethod
WithServiceBusbuilderAdds a Service Bus child resource to the Floci Azure emulator
WithServiceBus(options ...*WithServiceBusOptions) FlociAzureServiceBusResourcemethod
WithStoragebuilderAdds a Storage child resource to the Floci Azure emulator
WithStorage(options ...*WithStorageOptions) FlociAzureStorageResourceFlociGcpContainerResource
method
WithDataBindMountbuilderConfigures a bind mount for persistent Floci GCP state.
WithDataBindMount(source string, options ...*WithDataBindMountOptions) FlociGcpContainerResourcemethod
WithDataVolumebuilderConfigures a named data volume for persistent Floci GCP state.
WithDataVolume(name string, options ...*WithDataVolumeOptions) FlociGcpContainerResourcemethod
WithDockerSocketbuilderMounts 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(options ...*WithDockerSocketOptions) FlociGcpContainerResourcemethod
WithFlociUIbuilderAdds a Floci UI web console container for the Floci GCP resource
WithFlociUI(options ...*WithFlociUIOptions) FlociGcpContainerResourceFlociUIContainerResource
method
WithAwsReferencebuilderAttaches an additional Floci AWS resource to a Floci UI console
WithAwsReference(cloud FlociAwsContainerResource) FlociUIContainerResourcemethod
WithAzureReferencebuilderAttaches an additional Floci Azure resource to a Floci UI console
WithAzureReference(cloud FlociAzureContainerResource) FlociUIContainerResourcemethod
WithGcpReferencebuilderAttaches an additional Floci GCP resource to a Floci UI console
WithGcpReference(cloud FlociGcpContainerResource) FlociUIContainerResourcemethod
WithHostPortbuilderConfigures the host port that the Floci UI resource is exposed on instead of using a randomly assigned port.
WithHostPort(port *float64) FlociUIContainerResourceResourceWithEnvironment
method
WithFlociAwsReferencebuilderAdds a reference to a Floci AWS emulator resource
WithFlociAwsReference(floci FlociAwsContainerResource) ResourceWithEnvironmentmethod
WithFlociAzureReferencebuilderAdds a reference to a Floci Azure emulator resource
WithFlociAzureReference(floci FlociAzureContainerResource) ResourceWithEnvironmentmethod
WithFlociAzureServiceBusReferencebuilderAdds a Floci Azure Service Bus reference
WithFlociAzureServiceBusReference(serviceBus FlociAzureServiceBusResource, options ...*WithFlociAzureServiceBusReferenceOptions) ResourceWithEnvironmentmethod
WithFlociGcpReferencebuilderAdds a reference to a Floci GCP emulator resource
WithFlociGcpReference(floci FlociGcpContainerResource) ResourceWithEnvironment