com.bmuschko.gradle.docker.tasks.container.DockerCreateContainer.groovy Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of gradle-docker-plugin Show documentation
Show all versions of gradle-docker-plugin Show documentation
Gradle plugin for managing Docker images and containers.
/*
* Copyright 2014 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.bmuschko.gradle.docker.tasks.container
import com.bmuschko.gradle.docker.tasks.image.DockerExistingImage
import com.bmuschko.gradle.docker.utils.CollectionUtil
import org.gradle.api.provider.ListProperty
import org.gradle.api.provider.Property
import org.gradle.api.tasks.Input
import org.gradle.api.tasks.Internal
import org.gradle.api.tasks.Optional
class DockerCreateContainer extends DockerExistingImage {
@Input
@Optional
final ListProperty links = project.objects.listProperty(String)
@Input
@Optional
final Property containerName = project.objects.property(String)
@Input
@Optional
final Property hostName = project.objects.property(String)
@Input
@Optional
final Property ipv4Address = project.objects.property(String)
@Input
@Optional
final ListProperty portSpecs = project.objects.listProperty(String)
@Input
@Optional
final Property user = project.objects.property(String)
/**
* A list of additional groups that the container process will run as.
*
* @since 4.4.0
*/
@Input
@Optional
final ListProperty groups = project.objects.listProperty(String)
@Input
@Optional
final Property stdinOpen = project.objects.property(Boolean)
@Input
@Optional
final Property stdinOnce = project.objects.property(Boolean)
@Input
@Optional
final Property memory = project.objects.property(Long)
@Input
@Optional
final Property memorySwap = project.objects.property(Long)
@Input
@Optional
final Property cpuset = project.objects.property(String)
@Input
@Optional
final ListProperty portBindings = project.objects.listProperty(String)
@Input
@Optional
final Property publishAll = project.objects.property(Boolean)
@Input
@Optional
final Property attachStdin = project.objects.property(Boolean)
@Input
@Optional
final Property attachStdout = project.objects.property(Boolean)
@Input
@Optional
final Property attachStderr = project.objects.property(Boolean)
@Input
@Optional
final Property> envVars = project.objects.property(Map)
@Input
@Optional
final ListProperty cmd = project.objects.listProperty(String)
@Input
@Optional
final ListProperty entrypoint = project.objects.listProperty(String)
@Input
@Optional
final ListProperty dns = project.objects.listProperty(String)
@Input
@Optional
final Property network = project.objects.property(String)
@Input
@Optional
final ListProperty networkAliases = project.objects.listProperty(String)
@Input
@Optional
final Property image = project.objects.property(String)
@Input
@Optional
final ListProperty volumes = project.objects.listProperty(String)
@Input
@Optional
final ListProperty volumesFrom = project.objects.listProperty(String)
@Input
@Optional
final Property workingDir = project.objects.property(String)
@Input
final ListProperty exposedPorts = project.objects.listProperty(ExposedPort)
@Input
@Optional
final Property> binds = project.objects.property(Map)
@Input
@Optional
final ListProperty extraHosts = project.objects.listProperty(String)
@Input
@Optional
final Property logConfig = project.objects.property(LogConfig)
@Input
@Optional
final Property privileged = project.objects.property(Boolean)
@Input
@Optional
final Property tty = project.objects.property(Boolean)
@Input
@Optional
final Property restartPolicy = project.objects.property(String)
@Input
@Optional
final Property pid = project.objects.property(String)
@Input
@Optional
final ListProperty devices = project.objects.listProperty(String)
/**
* Size of /dev/shm in bytes.
* The size must be greater than 0.
* If omitted the system uses 64MB.
*/
@Input
@Optional
final Property shmSize = project.objects.property(Long)
/*
* Automatically remove the container when the container's process exits.
*
* This has no effect if {@link #restartPolicy} is set.
* @since 3.6.2
*/
@Input
@Optional
final Property autoRemove = project.objects.property(Boolean)
@Input
@Optional
final Property> labels = project.objects.property(Map)
@Internal
final Property containerId = project.objects.property(String)
@Input
@Optional
final Property macAddress = project.objects.property(String)
DockerCreateContainer() {
links.set([])
portSpecs.set([])
stdinOpen.set(false)
stdinOnce.set(false)
portBindings.set([])
publishAll.set(false)
attachStdin.set(false)
attachStdout.set(false)
attachStderr.set(false)
cmd.set([])
entrypoint.set([])
dns.set([])
networkAliases.set([])
volumes.set([])
volumesFrom.set([])
exposedPorts.set([])
extraHosts.set([])
privileged.set(false)
tty.set(false)
devices.set([])
autoRemove.set(false)
groups.set([])
}
@Override
void runRemoteCommand(dockerClient) {
def containerCommand = dockerClient.createContainerCmd(imageId.get())
setContainerCommandConfig(containerCommand)
def container = containerCommand.exec()
final String localContainerName = containerName.getOrNull() ?: container.id
logger.quiet "Created container with ID '$localContainerName'."
containerId.set(container.id)
if(nextHandler) {
nextHandler.execute(container)
}
}
void logConfig(String type, Map config) {
this.logConfig.set(new LogConfig(type: type, config: config))
}
void exposePorts(String internetProtocol, List ports) {
exposedPorts.add(new ExposedPort(internetProtocol, ports))
}
void restartPolicy(String name, int maximumRetryCount) {
this.restartPolicy.set("${name}:${maximumRetryCount}".toString())
}
void withEnvVar(def key, def value) {
if (envVars.getOrNull()) {
envVars.get().put(key, value)
} else {
envVars.set([(key): value])
}
}
private void setContainerCommandConfig(containerCommand) {
if(containerName.getOrNull()) {
containerCommand.withName(containerName.get())
}
if(hostName.getOrNull()) {
containerCommand.withHostName(hostName.get())
}
if(ipv4Address.getOrNull()){
containerCommand.withIpv4Address(ipv4Address.get())
}
if(portSpecs.getOrNull()) {
containerCommand.withPortSpecs(portSpecs.get())
}
if(user.getOrNull()) {
containerCommand.withUser(user.get())
}
if(groups.getOrNull()) {
containerCommand.hostConfig.withGroupAdd(groups.get())
}
if(stdinOpen.getOrNull()) {
containerCommand.withStdinOpen(stdinOpen.get())
}
if(stdinOnce.getOrNull()) {
containerCommand.withStdInOnce(stdinOnce.get())
}
if(memory.getOrNull()) {
containerCommand.hostConfig.withMemory(memory.get())
}
if(memorySwap.getOrNull()) {
containerCommand.hostConfig.withMemorySwap(memorySwap.get())
}
if(cpuset.getOrNull()) {
containerCommand.hostConfig.withCpusetCpus(cpuset.get())
}
if(attachStdin.getOrNull()) {
containerCommand.withAttachStdin(attachStdin.get())
}
if(attachStdout.getOrNull()) {
containerCommand.withAttachStdout(attachStdout.get())
}
if(attachStderr.getOrNull()) {
containerCommand.withAttachStderr(attachStderr.get())
}
// marshall map into list
if(envVars.getOrNull()) {
final List localEnvVars = new ArrayList<>();
envVars.get().each { key, value ->
def localKey = key instanceof Closure ? key.call() : key
def localValue = value instanceof Closure ? value.call() : value
localEnvVars.add("${localKey}=${localValue}".toString())
}
containerCommand.withEnv(localEnvVars)
}
if(cmd.getOrNull()) {
containerCommand.withCmd(cmd.get())
}
if(entrypoint.getOrNull()) {
containerCommand.withEntrypoint(entrypoint.get())
}
if(dns.getOrNull()) {
containerCommand.hostConfig.withDns(dns.get())
}
if(network.getOrNull()) {
containerCommand.hostConfig.withNetworkMode(network.get())
}
if(networkAliases.getOrNull()) {
containerCommand.withAliases(networkAliases.get())
}
if(image.getOrNull()) {
containerCommand.withImage(image.get())
}
if(volumes.getOrNull()) {
def createdVolumes = volumes.get().collect { threadContextClassLoader.createVolume(it) }
containerCommand.volumes = threadContextClassLoader.createVolumes(createdVolumes)
}
if (links.getOrNull()) {
def createdLinks = links.get().collect { threadContextClassLoader.createLink(it) }
containerCommand.hostConfig.withLinks(CollectionUtil.toArray(createdLinks))
}
if(volumesFrom.getOrNull()) {
def createdVolumes = threadContextClassLoader.createVolumesFrom(volumesFrom.get() as String[])
containerCommand.hostConfig.withVolumesFrom(createdVolumes)
}
if(workingDir.getOrNull()) {
containerCommand.withWorkingDir(workingDir.get())
}
if(exposedPorts.getOrNull()) {
def ports = threadContextClassLoader.createExposedPortsArray(exposedPorts.get())
containerCommand.withExposedPorts(ports)
}
if(portBindings.getOrNull()) {
def createdPortBindings = portBindings.get().collect { threadContextClassLoader.createPortBinding(it) }
containerCommand.hostConfig.withPortBindings(threadContextClassLoader.createPorts(createdPortBindings))
}
if(publishAll.getOrNull()) {
containerCommand.hostConfig.withPublishAllPorts(publishAll.get())
}
if(binds.getOrNull()) {
def createdBinds = threadContextClassLoader.createBinds(binds.get())
containerCommand.hostConfig.withBinds(createdBinds)
}
if(extraHosts.getOrNull()) {
containerCommand.hostConfig.withExtraHosts(extraHosts.get() as String[])
}
if(logConfig.getOrNull()) {
containerCommand.hostConfig.withLogConfig(threadContextClassLoader.createLogConfig(logConfig.get().type, logConfig.get().config))
}
if(privileged.getOrNull()) {
containerCommand.hostConfig.withPrivileged(privileged.get())
}
if (restartPolicy.getOrNull()) {
containerCommand.hostConfig.withRestartPolicy(threadContextClassLoader.createRestartPolicy(restartPolicy.get()))
}
if (pid.getOrNull()) {
containerCommand.getHostConfig().withPidMode(pid.get())
}
if (devices.getOrNull()) {
def createdDevices = devices.get().collect { threadContextClassLoader.createDevice(it) }
containerCommand.hostConfig.withDevices(CollectionUtil.toArray(createdDevices))
}
if(tty.getOrNull()) {
containerCommand.withTty(tty.get())
}
if(shmSize.getOrNull() != null) { // 0 is valid input
containerCommand.hostConfig.withShmSize(shmSize.get())
}
if (autoRemove.getOrNull()) {
containerCommand.hostConfig.withAutoRemove(autoRemove.get())
}
if(labels.getOrNull()) {
containerCommand.withLabels(labels.get().collectEntries { [it.key, it.value.toString()] })
}
if(macAddress.getOrNull()) {
containerCommand.withMacAddress(macAddress.get())
}
}
static class LogConfig {
@Input String type
@Input Map config = [:]
}
static class ExposedPort {
@Input final String internetProtocol
@Input final List ports = []
ExposedPort(String internetProtocol, List ports) {
this.internetProtocol = internetProtocol
this.ports = ports
}
}
}