Kotlin Multiplatform Client for Docker/dev.limebeck.libs.docker.client.api/Swarm

Swarm

Swarm resource APIs. Accessing this group does not initialize or join a swarm. Resource operations require a manager. No operation closes the supplied client. HTTP errors return Result errors; transport/decoding failures and cancellation throw. No automatic retries.

Constructors

Swarm

constructor(dockerClient: DockerClient)

Properties

configs

val configs: Configs

Config data, metadata and lifecycle operations.

nodes

val nodes: Nodes

Cluster nodes.

secrets

val secrets: Secrets

Secret metadata and lifecycle operations.

services

val services: Services

Service specifications and logs.

tasks

val tasks: Tasks

Scheduled tasks and logs.

Functions

getInfo

suspend fun getInfo(): Result<Swarm, ErrorResponse>

Inspects the cluster, including sensitive join tokens. Requires a manager.

getUnlockKey

suspend fun getUnlockKey(): Result<UnlockKeyResponse, ErrorResponse>

Returns the sensitive manager unlock key. Requires a manager.

init

suspend fun init(request: SwarmInitRequest): Result<String, ErrorResponse>

Explicitly initializes a cluster on this daemon; returns its node ID. Supply a listen address.

join

suspend fun join(request: SwarmJoinRequest): Result<Unit, ErrorResponse>

Explicitly joins this daemon using a sensitive join token.

leave

suspend fun leave(force: Boolean = false): Result<Unit, ErrorResponse>

Leaves the swarm. Force can break manager quorum and is never enabled implicitly.

unlock

suspend fun unlock(request: SwarmUnlockRequest): Result<Unit, ErrorResponse>

Unlocks a locked manager using its key.

update

suspend fun update(version: ULong, spec: SwarmSpec, rotateWorkerToken: Boolean = false, rotateManagerToken: Boolean = false, rotateManagerUnlockKey: Boolean = false): Result<Unit, ErrorResponse>

Replaces the cluster spec at its inspected version, optionally rotating credentials.