docker-client

0.8.9indexed

Offers a Docker client library supporting both JVM and Native platforms, embedding official Golang Docker client libraries for enhanced feature support and performance, unlike most libraries.

JVMNative·batect/docker-client

Stars

—

Used by

dependents

—

Health

/ 100

docker-client

A Docker client library for Kotlin/JVM and Kotlin/Native.

Status

:construction: This project is an ongoing work in progress. It is used by Batect as of v0.80, and should be stable enough for production use.

However, it only has the APIs required by Batect. Others are likely missing. If you require an API not provided here, please open a new issue.

How to use

Referencing in Gradle

Using the Kotlin Gradle DSL:

dependencies {
  implementation("dev.batect.docker:client:<version number here>") // Get the latest version number from https://github.com/batect/docker-client/releases/latest
}

Check the releases page for the latest release information, and the Maven Central page for examples of how to reference the library in other build systems.

Usage samples

Full sample projects demonstrating how to use this library are available in the samples directory.

Create a client

val client = DockerClient.create()

Pull an image

val image = client.pullImage("ubuntu:22.04")

Run a container

val containerSpec = ContainerCreationSpec.Builder(image)
    .withTTY()
    .withStdinAttached()
    .build()

val container = client.createContainer(containerSpec)

try {
    val exitCode = client.run(container, TextOutput.StandardOutput, TextOutput.StandardError, TextInput.StandardInput)

    println("Container exited with code $exitCode.")
} finally {
    client.removeContainer(container, force = true)
}

Documentation

Dokka documentation for the latest version of the library is available at https://batect.github.io/docker-client/.

Requirements

Operating system and architecture

This library supports the following:

Support for ARM64 Linux with Kotlin/Native will be added once Okio supports it (see https://github.com/square/okio/issues/1242).

Docker daemon

This library supports Docker 19.03.10 or later. However, using the most recent version of Docker is highly recommended.

This library may work with earlier versions of Docker, but this is untested and unsupported.

How is this different to other Docker client libraries?

(or: why have you created another client library?)

There are two major differences compared to other client libraries:

This library supports both Kotlin/JVM and Kotlin/Native, whereas most other existing libraries only support the JVM.
This library embeds the official Golang Docker client libraries, rather than invoking the docker executable or calling the Docker API itself.

This makes it much easier to add support for new Docker features and easier to provide features that require a lot of client logic (eg. BuildKit) without sacrificing performance.

Related libraries

Surfaced from shared tags and platforms — no rankings paid for.

kotlinx.collections.immutable★ 1.4k

KotlinImplements immutable and persistent collection interfaces with efficient, order-preserving options. Offers conversion functions, `+` and `-` operators, and a `mutate` extension for simplified modifications.Shared: kotlin-native

kotlinx-benchmark★ 635

KotlinToolkit for running benchmarks on multiplatform code, offering low noise, reliable results, statistical analysis, and detailed performance reports. Supports various target configurations and custom benchmark profiles.Shared: kotlin-native

uuid★ 578

benasher44Generates thread-safe, RFC4122-compliant UUIDs, compatible with iOS/Mac `NSUUID` and Java `java.util.UUID`. Ensures correctness through extensive testing. Aims to contribute functionality to the standard library.Shared: kotlin-native

redux-kotlin★ 505

reduxkotlinStandard redux implementation fostering an ecosystem of middleware, store enhancers, and dev tools. Offers modular development, supports multiple platforms, and promotes open development and community involvement.Shared: kotlin-native

moko-kswift★ 356

icerockdevGradle plugin generates Swift-friendly APIs from a native framework. Converts sealed classes/interfaces to Swift enums, supports platform class extensions, and allows custom generator creation based on metadata.Shared: kotlin-native

KMQTT★ 295

davidepianca98Provides an MQTT 3.1.1/5.0 client and broker supporting TCP, TLS, and WebSocket connections. Features include clustering, enhanced authentication, session persistence, and various platform compatibility.Shared: kotlin-native

macOS	x64 (Intel)	:white_check_mark:	:white_check_mark:
macOS	ARM64 (Silicon)	:white_check_mark:	:white_check_mark:
Linux	x64	:white_check_mark:	:white_check_mark:
Linux	ARM64	:white_check_mark:	:x:
Windows	x64	:white_check_mark:	:white_check_mark: