Kontainers Common/io.microkt.kontainers.domain

Package io.microkt.kontainers.domain

Kontainers domain specification.

Types

Link copied to clipboard
class BoundKontainerPort(port: Int, protocol: KontainerPort.Protocol, bindPort: Int) : KontainerPort
Content copied to clipboard
Link copied to clipboard
interface DatabaseKontainer : Kontainer
Content copied to clipboard
Link copied to clipboard
abstract class GenericKontainer(kontainerSpec: KontainerSpec, delegate: PlatformKontainer) : Kontainer
Content copied to clipboard

Provides an abstract Kontainer implementation to handle common Kontainer actions. Delegates to a platform specific parent Kontainer to run the given kontainerSpec.

Link copied to clipboard
open class GenericTcpKontainer(kontainerSpec: KontainerSpec, delegate: PlatformKontainer) : GenericKontainer
Content copied to clipboard

Provides a base implementation's GenericKontainer.waitForReady based on TCP socket connectivity to the Kontainer's default TCP port.

Link copied to clipboard
interface JdbcKontainer : DatabaseKontainer
Content copied to clipboard

Provides JDBC specific extensions to Kontainer's interface.

Link copied to clipboard
interface Kontainer
Content copied to clipboard

Provides a platform-agnostic method for interacting with containers defined by a Kontainer specification.

Link copied to clipboard
interface KontainerFactory<T : Kontainer>
Content copied to clipboard

Factory for creating Kontainers of type T.

Link copied to clipboard
open class KontainerPort(port: Int, protocol: KontainerPort.Protocol)
Content copied to clipboard

Represents a port number and protocol to be exposed by a Kontainer.

Link copied to clipboard
data class KontainerSpec(name: String, image: String, command: List<String>, environment: Map<String, String>, ports: List<KontainerPort>, resources: KontainerSpecResources)
Content copied to clipboard

Provides a platform-agnostic specification for running OCI image based containers across various backends.

Link copied to clipboard
data class KontainerSpecResources(memory: ULong)
Content copied to clipboard
Link copied to clipboard
interface PlatformKontainer : Kontainer
Content copied to clipboard

Provides an interface to be implemented by Kontainer delegates capable of translating method invocations into vendor platform calls.

Link copied to clipboard
interface R2dbcKontainer : DatabaseKontainer
Content copied to clipboard

Functions

Link copied to clipboard
inline fun <T : Kontainer> createKontainer(kontainerSpec: KontainerSpec, delegate: PlatformKontainer): T
Content copied to clipboard
Link copied to clipboard
fun Double.toKontainerBytes(multiplier: Long): ULong
Content copied to clipboard
fun Int.toKontainerBytes(multiplier: Long): ULong
Content copied to clipboard
fun Long.toKontainerBytes(multiplier: Long): ULong
Content copied to clipboard

Properties

Link copied to clipboard
val Double.GB: ULong
Content copied to clipboard
Link copied to clipboard
val Long.GB: ULong
Content copied to clipboard
Link copied to clipboard
val Int.GB: ULong
Content copied to clipboard
Link copied to clipboard
const val GIGABYTES: Long = 1073741824
Content copied to clipboard
Link copied to clipboard
val Double.MB: ULong
Content copied to clipboard
Link copied to clipboard
val Long.MB: ULong
Content copied to clipboard
Link copied to clipboard
val Int.MB: ULong
Content copied to clipboard
Link copied to clipboard
const val MEGABYTES: Long = 1048576
Content copied to clipboard