Kotlin Multiplatform Client for Docker/dev.limebeck.libs.docker.compose

Package-level declarations

Types

Discovery, logs and controls for existing Compose containers. No CLI or source files are needed. The caller owns the supplied client; this integration never closes it. HTTP failures return SDK errors; transport/decoding failures and cancellation propagate. Snapshots are not atomic: a container removed between list and inspect can fail discovery.

ComposeContainer

data class ComposeContainer(val id: String, val name: String?, val project: String?, val service: String?, val replicaNumber: Int?, val oneOff: Boolean?, val image: String?, val state: ContainerState?)

Metadata from labels and inspect. Nullable metadata remains unknown, never guessed from names. state retains Docker health separately from running status; running does not imply healthy. Labels and daemon data are untrusted and may contain sensitive information.

ComposeContainerOperationResult

data class ComposeContainerOperationResult(val container: ComposeContainer, val result: Result<Unit, ErrorResponse>)

SDK response paired with the pre-operation snapshot. Errors retain context; start/stop HTTP 304 becomes success.

ComposeDiscovery

data class ComposeDiscovery(val projects: List<ComposeProject>, val unassignedContainers: List<ComposeContainer>)

Container-backed discovery snapshot. No desired configuration or readiness is inferred.

ComposeLogLine

data class ComposeLogLine(val project: String, val service: String?, val containerId: String, val containerName: String?, val replicaNumber: Int?, val oneOff: Boolean?, val log: LogLine)

One SDK log record with its source. TTY records retain the SDK's UNKNOWN stream type.

ComposeOperation

enum ComposeOperation : Enum<ComposeOperation>

Engine operations on existing containers; these are not Compose up/down.

ComposeOperationReport

data class ComposeOperationReport(val project: String, val operation: ComposeOperation, val results: List<ComposeContainerOperationResult>)

Completed batch; inspect results even when the enclosing SDK Result is successful.

ComposeProject

data class ComposeProject(val name: String, val services: List<ComposeService>, val unassignedContainers: List<ComposeContainer>)

Observed services plus containers whose service label is absent or blank.

ComposeService

data class ComposeService(val name: String, val containers: List<ComposeContainer>)

Observed containers, including stopped replicas, one-offs and unknown one-off metadata.

Properties

compose

val DockerClient.compose: Compose

Cached Compose integration using this client's endpoint and lifetime.