Aspirerelease/17.0
Watch Aspire live streamsDocsTry Aspire

FlociGcpContainerResource

Handle
📦 CommunityToolkit.Aspire.Hosting.Floci v13.6.1

Resource for the Floci GCP emulator container.

type FlociGcpContainerResource interface {
ExpressionValue
IComputeResource
Resource
ResourceWithArgs
ResourceWithConnectionString
ResourceWithEndpoints
ResourceWithEnvironment
ResourceWithWaitSupport
}

Properties

propertyConnectionStringExpression*ReferenceExpressionget
Gets the emulator endpoint URL, following the primary endpoint's Scheme.
ConnectionStringExpression() *ReferenceExpression
propertyHostEndpointReferenceExpressionget
Gets the host endpoint reference for the primary endpoint.
Host() EndpointReferenceExpression
propertyPortEndpointReferenceExpressionget
Gets the port endpoint reference for the primary endpoint.
Port() EndpointReferenceExpression
propertyPrimaryEndpointEndpointReferenceget
Gets the primary endpoint reference for the Floci container.
PrimaryEndpoint() EndpointReference
propertySchemeEndpointReferenceExpressionget
Gets the scheme endpoint reference for the primary endpoint. http unless a TLS certificate has been configured, in which case the endpoint is switched to https before the application starts. Floci serves both on the same port, so the port never changes.
Scheme() EndpointReferenceExpression

Methods

methodWithDataBindMountbuilder
Configures a bind mount for persistent Floci GCP state.
WithDataBindMount(
source string,
options ...*WithDataBindMountOptions,
) FlociGcpContainerResource
sourcestringThe host path to bind into the container.
options...*WithDataBindMountOptionsOptional settings, described under Options.

Optional parameters are passed in a trailing options ...*WithDataBindMountOptions argument.

IsReadOnly*boolWhether the bind mount should be read-only.
FlociGcpContainerResource

A reference to the IResourceBuilder for further configuration.

Returns a handle; failures surface later via Err().

methodWithDataVolumebuilder
Configures a named data volume for persistent Floci GCP state.
WithDataVolume(
name string,
options ...*WithDataVolumeOptions,
) FlociGcpContainerResource
namestringThe name of the volume to mount.
options...*WithDataVolumeOptionsOptional settings, described under Options.

Optional parameters are passed in a trailing options ...*WithDataVolumeOptions argument.

IsReadOnly*boolWhether the volume should be read-only.
FlociGcpContainerResource

A reference to the IResourceBuilder for further configuration.

Returns a handle; failures surface later via Err().

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(options ...*WithDockerSocketOptions) FlociGcpContainerResource
options...*WithDockerSocketOptionsOptional settings, described under Options.

Optional parameters are passed in a trailing options ...*WithDockerSocketOptions argument.

SocketPath*stringOptional. Host path to the Docker socket (default: /var/run/docker.sock). Non-standard paths (e.g. Podman at /run/user/1000/podman/podman.sock) are bind-mounted to /var/run/docker.sock inside the container.
FlociGcpContainerResource

A reference to the IResourceBuilder for further configuration.

Returns a handle; failures surface later via Err().

methodWithFlociUIbuilder
Adds a Floci UI web console container for the Floci GCP resource
WithFlociUI(options ...*WithFlociUIOptions) FlociGcpContainerResource
options...*WithFlociUIOptionsOptional settings, described under Options.

Optional parameters are passed in a trailing options ...*WithFlociUIOptions argument.

ConfigureContainerfunc(obj FlociUIContainerResource)callbackConfiguration callback for the Floci UI container resource.
ContainerName*stringOptional. The name of the Floci UI container (default: {floci-name}-ui).
FlociGcpContainerResource

A reference to the IResourceBuilder for further resource configuration.

Returns a handle; failures surface later via Err().