environment-plugin / com.cognifide.gradle.environment.docker / Docker

Docker

class Docker

Constructors

<init>

Docker(environment: EnvironmentExtension)

Properties

composeFile

val composeFile: RegularFileProperty!

composeTemplateFile

val composeTemplateFile: RegularFileProperty!

configPath

val configPath: String

containers

Provides API for manipulating Docker containers defined in 'docker-compose.yml'.

val containers: ContainerManager

environment

val environment: EnvironmentExtension

rootPath

val rootPath: String

running

val running: Boolean

runtime

Represents Docker runtime specific options. On Windows there could be installed Docker distribution named 'Desktop' or 'Toolbox'.

val runtime: Runtime

stack

Represents Docker stack named 'aem' and provides API for manipulating it.

val stack: Stack

up

val up: Boolean

workPath

val workPath: String

Functions

containers

Configure additional behavior for Docker containers defined in 'docker-compose.yml'.

fun containers(options: ContainerManager.() -> Unit): Unit

daemon

fun daemon(spec: DaemonSpec.() -> Unit): Unit

down

fun down(): Unit

init

fun init(): Unit

reload

fun reload(): Unit

run

fun run(spec: RunSpec.() -> Unit): DockerResult
fun run(image: String, command: String, exitCode: Int = 0): DockerResult
fun run(operation: String, image: String, command: String, exitCode: Int = 0): DockerResult

runShell

fun runShell(image: String, command: String, exitCode: Int = 0): DockerResult
fun runShell(operation: String, image: String, command: String, exitCode: Int = 0): DockerResult

up

fun up(): Unit