| Fields inherited from class | Fields |
|---|---|
class org.gradle.api.DefaultTask |
TASK_NAME, TASK_DESCRIPTION, TASK_GROUP, TASK_TYPE, TASK_DEPENDS_ON, TASK_OVERWRITE, TASK_ACTION, TASK_CONSTRUCTOR_ARGS |
class org.gradle.api.internal.AbstractTask |
TASK_NAME, TASK_DESCRIPTION, TASK_GROUP, TASK_TYPE, TASK_DEPENDS_ON, TASK_OVERWRITE, TASK_ACTION, TASK_CONSTRUCTOR_ARGS |
| Type | Name and description |
|---|---|
java.io.File |
destFile |
java.util.List<Instruction> |
instructions |
| Constructor and description |
|---|
Dockerfile
() |
| Type Params | Return Type | Name and description |
|---|---|---|
|
void |
addFile(java.lang.String src, java.lang.String dest)The ADD instruction copies new files, directories or remote file URLs from |
|
void |
addFile(groovy.lang.Closure src, groovy.lang.Closure dest)The ADD instruction copies new files, directories or remote file URLs from |
|
void |
arg(java.lang.String arg)The ARG instruction defines a variable that users can pass at build-time to the builder. |
|
void |
copyFile(java.lang.String src, java.lang.String dest)The COPY instruction copies new files or directories from |
|
void |
copyFile(groovy.lang.Closure src, groovy.lang.Closure dest)The COPY instruction copies new files or directories from |
|
void |
create() |
|
void |
defaultCommand(java.lang.String... command)The main purpose of a CMD instruction is to provide defaults for an executing container. |
|
void |
defaultCommand(groovy.lang.Closure command)The main purpose of a CMD instruction is to provide defaults for an executing container. |
|
void |
entryPoint(java.lang.String... entryPoint)An ENTRYPOINT allows you to configure a container that will run as an executable. |
|
void |
entryPoint(groovy.lang.Closure entryPoint)An ENTRYPOINT allows you to configure a container that will run as an executable. |
|
void |
environmentVariable(java.lang.String key, java.lang.String value)The ENV instruction sets the environment variable |
|
void |
environmentVariable(java.util.Map<java.lang.String, java.lang.String> envVars)The ENV instruction sets multiple environment variables at once. |
|
void |
environmentVariable(groovy.lang.Closure envVars)The ENV instruction sets multiple environment variables at once. |
|
void |
exposePort(java.lang.Integer... ports)The EXPOSE instruction informs Docker that the container will listen on the specified network ports at runtime. |
|
void |
exposePort(groovy.lang.Closure ports)The EXPOSE instruction informs Docker that the container will listen on the specified network ports at runtime. |
|
void |
from(java.lang.String image)The FROM instruction sets the Base Image for subsequent instructions. |
|
void |
from(groovy.lang.Closure image)The FROM instruction sets the Base Image for subsequent instructions. |
|
void |
instruction(java.lang.String instruction)Adds a full instruction as String. |
|
void |
instruction(groovy.lang.Closure instruction)Adds a full instruction as Closure with return type String. |
|
void |
instructionsFromTemplate(java.io.File template) |
|
void |
instructionsFromTemplate(java.lang.String templatePath) |
|
void |
instructionsFromTemplate(groovy.lang.Closure templatePath) |
|
void |
label(java.util.Map<java.lang.String, java.lang.String> labels)The LABEL instruction adds metadata to an image. |
|
void |
label(groovy.lang.Closure labels)The LABEL instruction adds metadata to an image. |
|
void |
maintainer(java.lang.String maintainer)The MAINTAINER instruction allows you to set the Author field of the generated images. |
|
void |
maintainer(groovy.lang.Closure maintainer)The MAINTAINER instruction allows you to set the Author field of the generated images. |
|
void |
onBuild(java.lang.String instruction)The ONBUILD instruction adds to the image a trigger instruction to be executed at a later time, when the image is used as the base for another build. |
|
void |
onBuild(groovy.lang.Closure instruction)The ONBUILD instruction adds to the image a trigger instruction to be executed at a later time, when the image is used as the base for another build. |
|
void |
runCommand(java.lang.String command)The RUN instruction will execute any commands in a new layer on top of the current image and commit the results. |
|
void |
runCommand(groovy.lang.Closure command)The RUN instruction will execute any commands in a new layer on top of the current image and commit the results. |
|
void |
user(java.lang.String user)The USER instruction sets the user name or UID to use when running the image and for any RUN, CMD and ENTRYPOINT instructions that follow it in the Dockerfile. |
|
void |
user(groovy.lang.Closure user)The USER instruction sets the user name or UID to use when running the image and for any RUN, CMD and ENTRYPOINT instructions that follow it in the Dockerfile. |
|
void |
volume(java.lang.String... volume)The VOLUME instruction will create a mount point with the specified name and mark it as holding externally mounted volumes from native host or other containers. |
|
void |
volume(groovy.lang.Closure volume)The VOLUME instruction will create a mount point with the specified name and mark it as holding externally mounted volumes from native host or other containers. |
|
void |
workingDir(java.lang.String dir)The WORKDIR instruction sets the working directory for any RUN, CMD and ENTRYPOINT instructions that follow it in the Dockerfile. |
|
void |
workingDir(groovy.lang.Closure dir)The WORKDIR instruction sets the working directory for any RUN, CMD and ENTRYPOINT instructions that follow it in the Dockerfile. |
| Methods inherited from class | Name |
|---|---|
class org.gradle.api.DefaultTask |
org.gradle.api.DefaultTask#getLogger(), org.gradle.api.DefaultTask#leftShift(groovy.lang.Closure), org.gradle.api.DefaultTask#configure(groovy.lang.Closure), org.gradle.api.DefaultTask#configure(groovy.lang.Closure), org.gradle.api.DefaultTask#getDescription(), org.gradle.api.DefaultTask#property(java.lang.String), org.gradle.api.DefaultTask#isEnabled(), org.gradle.api.DefaultTask#setEnabled(boolean), org.gradle.api.DefaultTask#hasProperty(java.lang.String), org.gradle.api.DefaultTask#getGroup(), org.gradle.api.DefaultTask#getInputs(), org.gradle.api.DefaultTask#getInputs(), org.gradle.api.DefaultTask#getProject(), org.gradle.api.DefaultTask#setDescription(java.lang.String), org.gradle.api.DefaultTask#getAnt(), org.gradle.api.DefaultTask#getStandardOutputCapture(), org.gradle.api.DefaultTask#getIdentityPath(), org.gradle.api.DefaultTask#getConvention(), org.gradle.api.DefaultTask#getLogging(), org.gradle.api.DefaultTask#getLogging(), org.gradle.api.DefaultTask#setGroup(java.lang.String), org.gradle.api.DefaultTask#setOnlyIf(groovy.lang.Closure), org.gradle.api.DefaultTask#setOnlyIf(org.gradle.api.specs.Spec), org.gradle.api.DefaultTask#dependsOnTaskDidWork(), org.gradle.api.DefaultTask#setActions(java.util.List), org.gradle.api.DefaultTask#dependsOn([Ljava.lang.Object;), org.gradle.api.DefaultTask#onlyIf(groovy.lang.Closure), org.gradle.api.DefaultTask#onlyIf(org.gradle.api.specs.Spec), org.gradle.api.DefaultTask#getDestroyables(), org.gradle.api.DefaultTask#getLocalState(), org.gradle.api.DefaultTask#getTemporaryDir(), org.gradle.api.DefaultTask#mustRunAfter([Ljava.lang.Object;), org.gradle.api.DefaultTask#setMustRunAfter(java.lang.Iterable), org.gradle.api.DefaultTask#getMustRunAfter(), org.gradle.api.DefaultTask#finalizedBy([Ljava.lang.Object;), org.gradle.api.DefaultTask#setFinalizedBy(java.lang.Iterable), org.gradle.api.DefaultTask#getFinalizedBy(), org.gradle.api.DefaultTask#shouldRunAfter([Ljava.lang.Object;), org.gradle.api.DefaultTask#setShouldRunAfter(java.lang.Iterable), org.gradle.api.DefaultTask#getShouldRunAfter(), org.gradle.api.DefaultTask#getTaskDependencies(), org.gradle.api.DefaultTask#getTaskDependencies(), org.gradle.api.DefaultTask#setDidWork(boolean), org.gradle.api.DefaultTask#getDidWork(), org.gradle.api.DefaultTask#doFirst(java.lang.String, org.gradle.api.Action), org.gradle.api.DefaultTask#doFirst(org.gradle.api.Action), org.gradle.api.DefaultTask#doFirst(groovy.lang.Closure), org.gradle.api.DefaultTask#doLast(groovy.lang.Closure), org.gradle.api.DefaultTask#doLast(org.gradle.api.Action), org.gradle.api.DefaultTask#doLast(java.lang.String, org.gradle.api.Action), org.gradle.api.DefaultTask#deleteAllActions(), org.gradle.api.DefaultTask#getEnabled(), org.gradle.api.DefaultTask#getOutputs(), org.gradle.api.DefaultTask#getOutputs(), org.gradle.api.DefaultTask#getDependsOn(), org.gradle.api.DefaultTask#setDependsOn(java.lang.Iterable), org.gradle.api.DefaultTask#getAsDynamicObject(), org.gradle.api.DefaultTask#isHasCustomActions(), org.gradle.api.DefaultTask#injectIntoNewInstance(org.gradle.api.internal.project.ProjectInternal, java.lang.String, java.lang.Class, java.util.concurrent.Callable), org.gradle.api.DefaultTask#prependParallelSafeAction(org.gradle.api.Action), org.gradle.api.DefaultTask#getTaskActions(), org.gradle.api.DefaultTask#hasTaskActions(), org.gradle.api.DefaultTask#getOnlyIf(), org.gradle.api.DefaultTask#getImpliesSubProjects(), org.gradle.api.DefaultTask#setImpliesSubProjects(boolean), org.gradle.api.DefaultTask#getExecuter(), org.gradle.api.DefaultTask#setExecuter(org.gradle.api.internal.tasks.TaskExecuter), org.gradle.api.DefaultTask#getTemporaryDirFactory(), org.gradle.api.DefaultTask#addValidator(org.gradle.api.internal.tasks.execution.TaskValidator), org.gradle.api.DefaultTask#getValidators(), org.gradle.api.DefaultTask#appendParallelSafeAction(org.gradle.api.Action), org.gradle.api.DefaultTask#setProperty(java.lang.String, java.lang.Object), org.gradle.api.DefaultTask#toString(), org.gradle.api.DefaultTask#compareTo(org.gradle.api.Task), org.gradle.api.DefaultTask#compareTo(java.lang.Object), org.gradle.api.DefaultTask#getName(), org.gradle.api.DefaultTask#execute(), org.gradle.api.DefaultTask#getActions(), org.gradle.api.DefaultTask#getState(), org.gradle.api.DefaultTask#getState(), org.gradle.api.DefaultTask#getPath(), org.gradle.api.DefaultTask#getExtensions(), org.gradle.api.DefaultTask#wait(long, int), org.gradle.api.DefaultTask#wait(long), org.gradle.api.DefaultTask#wait(), org.gradle.api.DefaultTask#equals(java.lang.Object), org.gradle.api.DefaultTask#hashCode(), org.gradle.api.DefaultTask#getClass(), org.gradle.api.DefaultTask#notify(), org.gradle.api.DefaultTask#notifyAll() |
class org.gradle.api.internal.AbstractTask |
org.gradle.api.internal.AbstractTask#getLogger(), org.gradle.api.internal.AbstractTask#leftShift(groovy.lang.Closure), org.gradle.api.internal.AbstractTask#configure(groovy.lang.Closure), org.gradle.api.internal.AbstractTask#configure(groovy.lang.Closure), org.gradle.api.internal.AbstractTask#getDescription(), org.gradle.api.internal.AbstractTask#property(java.lang.String), org.gradle.api.internal.AbstractTask#isEnabled(), org.gradle.api.internal.AbstractTask#setEnabled(boolean), org.gradle.api.internal.AbstractTask#hasProperty(java.lang.String), org.gradle.api.internal.AbstractTask#getGroup(), org.gradle.api.internal.AbstractTask#getInputs(), org.gradle.api.internal.AbstractTask#getInputs(), org.gradle.api.internal.AbstractTask#getProject(), org.gradle.api.internal.AbstractTask#setDescription(java.lang.String), org.gradle.api.internal.AbstractTask#getAnt(), org.gradle.api.internal.AbstractTask#getStandardOutputCapture(), org.gradle.api.internal.AbstractTask#getIdentityPath(), org.gradle.api.internal.AbstractTask#getConvention(), org.gradle.api.internal.AbstractTask#getLogging(), org.gradle.api.internal.AbstractTask#getLogging(), org.gradle.api.internal.AbstractTask#setGroup(java.lang.String), org.gradle.api.internal.AbstractTask#setOnlyIf(groovy.lang.Closure), org.gradle.api.internal.AbstractTask#setOnlyIf(org.gradle.api.specs.Spec), org.gradle.api.internal.AbstractTask#dependsOnTaskDidWork(), org.gradle.api.internal.AbstractTask#setActions(java.util.List), org.gradle.api.internal.AbstractTask#dependsOn([Ljava.lang.Object;), org.gradle.api.internal.AbstractTask#onlyIf(groovy.lang.Closure), org.gradle.api.internal.AbstractTask#onlyIf(org.gradle.api.specs.Spec), org.gradle.api.internal.AbstractTask#getDestroyables(), org.gradle.api.internal.AbstractTask#getLocalState(), org.gradle.api.internal.AbstractTask#getTemporaryDir(), org.gradle.api.internal.AbstractTask#mustRunAfter([Ljava.lang.Object;), org.gradle.api.internal.AbstractTask#setMustRunAfter(java.lang.Iterable), org.gradle.api.internal.AbstractTask#getMustRunAfter(), org.gradle.api.internal.AbstractTask#finalizedBy([Ljava.lang.Object;), org.gradle.api.internal.AbstractTask#setFinalizedBy(java.lang.Iterable), org.gradle.api.internal.AbstractTask#getFinalizedBy(), org.gradle.api.internal.AbstractTask#shouldRunAfter([Ljava.lang.Object;), org.gradle.api.internal.AbstractTask#setShouldRunAfter(java.lang.Iterable), org.gradle.api.internal.AbstractTask#getShouldRunAfter(), org.gradle.api.internal.AbstractTask#getTaskDependencies(), org.gradle.api.internal.AbstractTask#getTaskDependencies(), org.gradle.api.internal.AbstractTask#setDidWork(boolean), org.gradle.api.internal.AbstractTask#getDidWork(), org.gradle.api.internal.AbstractTask#doFirst(java.lang.String, org.gradle.api.Action), org.gradle.api.internal.AbstractTask#doFirst(org.gradle.api.Action), org.gradle.api.internal.AbstractTask#doFirst(groovy.lang.Closure), org.gradle.api.internal.AbstractTask#doLast(groovy.lang.Closure), org.gradle.api.internal.AbstractTask#doLast(org.gradle.api.Action), org.gradle.api.internal.AbstractTask#doLast(java.lang.String, org.gradle.api.Action), org.gradle.api.internal.AbstractTask#deleteAllActions(), org.gradle.api.internal.AbstractTask#getEnabled(), org.gradle.api.internal.AbstractTask#getOutputs(), org.gradle.api.internal.AbstractTask#getOutputs(), org.gradle.api.internal.AbstractTask#getDependsOn(), org.gradle.api.internal.AbstractTask#setDependsOn(java.lang.Iterable), org.gradle.api.internal.AbstractTask#getAsDynamicObject(), org.gradle.api.internal.AbstractTask#isHasCustomActions(), org.gradle.api.internal.AbstractTask#injectIntoNewInstance(org.gradle.api.internal.project.ProjectInternal, java.lang.String, java.lang.Class, java.util.concurrent.Callable), org.gradle.api.internal.AbstractTask#prependParallelSafeAction(org.gradle.api.Action), org.gradle.api.internal.AbstractTask#getTaskActions(), org.gradle.api.internal.AbstractTask#hasTaskActions(), org.gradle.api.internal.AbstractTask#getOnlyIf(), org.gradle.api.internal.AbstractTask#getImpliesSubProjects(), org.gradle.api.internal.AbstractTask#setImpliesSubProjects(boolean), org.gradle.api.internal.AbstractTask#getExecuter(), org.gradle.api.internal.AbstractTask#setExecuter(org.gradle.api.internal.tasks.TaskExecuter), org.gradle.api.internal.AbstractTask#getTemporaryDirFactory(), org.gradle.api.internal.AbstractTask#addValidator(org.gradle.api.internal.tasks.execution.TaskValidator), org.gradle.api.internal.AbstractTask#getValidators(), org.gradle.api.internal.AbstractTask#appendParallelSafeAction(org.gradle.api.Action), org.gradle.api.internal.AbstractTask#setProperty(java.lang.String, java.lang.Object), org.gradle.api.internal.AbstractTask#toString(), org.gradle.api.internal.AbstractTask#compareTo(org.gradle.api.Task), org.gradle.api.internal.AbstractTask#compareTo(java.lang.Object), org.gradle.api.internal.AbstractTask#getName(), org.gradle.api.internal.AbstractTask#execute(), org.gradle.api.internal.AbstractTask#getActions(), org.gradle.api.internal.AbstractTask#getState(), org.gradle.api.internal.AbstractTask#getState(), org.gradle.api.internal.AbstractTask#getPath(), org.gradle.api.internal.AbstractTask#getExtensions(), org.gradle.api.internal.AbstractTask#wait(long, int), org.gradle.api.internal.AbstractTask#wait(long), org.gradle.api.internal.AbstractTask#wait(), org.gradle.api.internal.AbstractTask#equals(java.lang.Object), org.gradle.api.internal.AbstractTask#hashCode(), org.gradle.api.internal.AbstractTask#getClass(), org.gradle.api.internal.AbstractTask#notify(), org.gradle.api.internal.AbstractTask#notifyAll() |
The ADD instruction copies new files, directories
or remote file URLs from src - Source filedest - Destination path
The ADD instruction copies new files, directories
or remote file URLs from src - Source filedest - Destination path
The ARG instruction defines a variable that users can pass at build-time to the builder.
arg - Argument to pass, possibly with default value. The COPY instruction copies new files or directories
from src - Source filedest - Destination path
The COPY instruction copies new files or directories
from src - Source filedest - Destination path
The main purpose of a CMD instruction is to provide defaults for an executing container.
command - CommandThe main purpose of a CMD instruction is to provide defaults for an executing container.
command - CommandAn ENTRYPOINT allows you to configure a container that will run as an executable.
entryPoint - Entry pointAn ENTRYPOINT allows you to configure a container that will run as an executable.
entryPoint - Entry point The ENV instruction sets the environment variable
key - Keyvalue - Value
The ENV instruction sets multiple environment variables at once.
envVars - Environment variablesThe ENV instruction sets multiple environment variables at once.
envVars - Environment variablesThe EXPOSE instruction informs Docker that the container will listen on the specified network ports at runtime.
ports - PortsThe EXPOSE instruction informs Docker that the container will listen on the specified network ports at runtime.
ports - PortsThe FROM instruction sets the Base Image for subsequent instructions.
image - Base image nameThe FROM instruction sets the Base Image for subsequent instructions.
image - Base image nameAdds a full instruction as String. Example:
task createDockerfile(type: Dockerfile) {
instruction 'FROM ubuntu:14.04'
instruction 'MAINTAINER Benjamin Muschko "benjamin.muschko@gmail.com"'
}
instruction - Instruction as StringAdds a full instruction as Closure with return type String. Example:
task createDockerfile(type: Dockerfile) {
instruction { 'FROM ubuntu:14.04' }
instruction { 'MAINTAINER Benjamin Muschko "benjamin.muschko@gmail.com"' }
}
instruction - Instruction as ClosureThe LABEL instruction adds metadata to an image.
labels - LabelsThe LABEL instruction adds metadata to an image.
labels - LabelsThe MAINTAINER instruction allows you to set the Author field of the generated images.
maintainer - MaintainerThe MAINTAINER instruction allows you to set the Author field of the generated images.
maintainer - MaintainerThe ONBUILD instruction adds to the image a trigger instruction to be executed at a later time, when the image is used as the base for another build.
instruction - InstructionThe ONBUILD instruction adds to the image a trigger instruction to be executed at a later time, when the image is used as the base for another build.
instruction - InstructionThe RUN instruction will execute any commands in a new layer on top of the current image and commit the results.
command - CommandThe RUN instruction will execute any commands in a new layer on top of the current image and commit the results.
command - CommandThe USER instruction sets the user name or UID to use when running the image and for any RUN, CMD and ENTRYPOINT instructions that follow it in the Dockerfile.
user - UserThe USER instruction sets the user name or UID to use when running the image and for any RUN, CMD and ENTRYPOINT instructions that follow it in the Dockerfile.
user - UserThe VOLUME instruction will create a mount point with the specified name and mark it as holding externally mounted volumes from native host or other containers.
volume - VolumeThe VOLUME instruction will create a mount point with the specified name and mark it as holding externally mounted volumes from native host or other containers.
volume - VolumeThe WORKDIR instruction sets the working directory for any RUN, CMD and ENTRYPOINT instructions that follow it in the Dockerfile.
dir - DirectoryThe WORKDIR instruction sets the working directory for any RUN, CMD and ENTRYPOINT instructions that follow it in the Dockerfile.
dir - DirectoryGroovy Documentation