Dockerfile (gradle-docker-plugin 3.5.0 API)

com.bmuschko.gradle.docker.tasks.image.Dockerfile

Nested Class Summary

Nested classes
Modifiers	Name	Description
`static class`	`Dockerfile.AddFileInstruction`
`static class`	`Dockerfile.ArgInstruction`
`static class`	`Dockerfile.CompositeExecInstruction`	Helper Instruction used by DockerJavaApplicationPlugin to allow customizing generated ENTRYPOINT/CMD
`static class`	`Dockerfile.CopyFileInstruction`
`static class`	`Dockerfile.DefaultCommandInstruction`
`static class`	`Dockerfile.EntryPointInstruction`
`static class`	`Dockerfile.EnvironmentVariableInstruction`
`static class`	`Dockerfile.ExposePortInstruction`
`static class`	`Dockerfile.FileInstruction`
`static class`	`Dockerfile.FromInstruction`
`static class`	`Dockerfile.GenericInstruction`
`static interface`	`Dockerfile.Instruction`
`interface`	`Dockerfile.ItemJoiner`
`static class`	`Dockerfile.LabelInstruction`
`static class`	`Dockerfile.MaintainerInstruction`
`static class`	`Dockerfile.MapInstruction`
`static class`	`Dockerfile.MultiItemJoiner`
`static class`	`Dockerfile.OnBuildInstruction`
`static class`	`Dockerfile.RunCommandInstruction`
`static class`	`Dockerfile.SingleItemJoiner`
`static class`	`Dockerfile.StringArrayInstruction`
`static class`	`Dockerfile.StringCommandInstruction`
`static class`	`Dockerfile.UserInstruction`
`static class`	`Dockerfile.VolumeInstruction`
`static class`	`Dockerfile.WorkDirInstruction`

Inherited fields
Fields inherited from class	Fields
`class DefaultTask`	`TASK_NAME, TASK_DESCRIPTION, TASK_GROUP, TASK_TYPE, TASK_DEPENDS_ON, TASK_OVERWRITE, TASK_ACTION, TASK_CONSTRUCTOR_ARGS`
`class AbstractTask`	`TASK_NAME, TASK_DESCRIPTION, TASK_GROUP, TASK_TYPE, TASK_DEPENDS_ON, TASK_OVERWRITE, TASK_ACTION, TASK_CONSTRUCTOR_ARGS`

Properties Summary

Properties
Type	Name and description
`File`	`destFile`
`List<Instruction>`	`instructions`

Constructor Summary

Constructors
Constructor and description
`Dockerfile ()`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`void`	`addFile(String src, String dest)` The ADD instruction copies new files, directories or remote file URLs from and adds them to the filesystem of the container at the path .
	`void`	`addFile(Closure src, Closure dest)` The ADD instruction copies new files, directories or remote file URLs from and adds them to the filesystem of the container at the path .
	`void`	`arg(String arg)` The ARG instruction defines a variable that users can pass at build-time to the builder.
	`void`	`copyFile(String src, String dest, String stageName = null)` The COPY instruction copies new files or directories from and adds them to the filesystem of the container at the path .
	`void`	`copyFile(Closure src, Closure dest, Closure stageName)` The COPY instruction copies new files or directories from and adds them to the filesystem of the container at the path .
	`void`	`create()`
	`void`	`defaultCommand(String... command)` The main purpose of a CMD instruction is to provide defaults for an executing container.
	`void`	`defaultCommand(Closure command)` The main purpose of a CMD instruction is to provide defaults for an executing container.
	`void`	`entryPoint(String... entryPoint)` An ENTRYPOINT allows you to configure a container that will run as an executable.
	`void`	`entryPoint(Closure entryPoint)` An ENTRYPOINT allows you to configure a container that will run as an executable.
	`void`	`environmentVariable(String key, String value)` The ENV instruction sets the environment variable to the value .
	`void`	`environmentVariable(Map<String, String> envVars)` The ENV instruction sets multiple environment variables at once.
	`void`	`environmentVariable(Closure envVars)` The ENV instruction sets multiple environment variables at once.
	`void`	`exposePort(Integer... ports)` The EXPOSE instruction informs Docker that the container will listen on the specified network ports at runtime.
	`void`	`exposePort(Closure ports)` The EXPOSE instruction informs Docker that the container will listen on the specified network ports at runtime.
	`void`	`from(String image, String stageName = null)` The FROM instruction sets the Base Image for subsequent instructions.
	`void`	`from(Closure image, Closure stageName = null)` The FROM instruction sets the Base Image for subsequent instructions.
	`void`	`instruction(String instruction)` Adds a full instruction as String.
	`void`	`instruction(Closure instruction)` Adds a full instruction as Closure with return type String.
	`void`	`instructionsFromTemplate(File template)`
	`void`	`instructionsFromTemplate(String templatePath)`
	`void`	`instructionsFromTemplate(Closure templatePath)`
	`void`	`label(Map<String, String> labels)` The LABEL instruction adds metadata to an image.
	`void`	`label(Closure labels)` The LABEL instruction adds metadata to an image.
	`void`	`maintainer(String maintainer)` The MAINTAINER instruction allows you to set the Author field of the generated images.
	`void`	`maintainer(Closure maintainer)` The MAINTAINER instruction allows you to set the Author field of the generated images.
	`void`	`onBuild(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(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(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(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(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(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(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(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(String dir)` The WORKDIR instruction sets the working directory for any RUN, CMD and ENTRYPOINT instructions that follow it in the Dockerfile.
	`void`	`workingDir(Closure dir)` The WORKDIR instruction sets the working directory for any RUN, CMD and ENTRYPOINT instructions that follow it in the Dockerfile.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class DefaultTask`	getLogger, configure, configure, leftShift, getDescription, property, isEnabled, setEnabled, hasProperty, getGroup, getInputs, getInputs, getIdentityPath, getProject, getAnt, getConvention, getLogging, getLogging, getStandardOutputCapture, setDescription, setGroup, doLast, doLast, doLast, deleteAllActions, getEnabled, getOutputs, getOutputs, getDestroyables, getLocalState, getTemporaryDir, mustRunAfter, setMustRunAfter, getMustRunAfter, finalizedBy, setFinalizedBy, getFinalizedBy, shouldRunAfter, setActions, getDependsOn, setDependsOn, dependsOn, onlyIf, onlyIf, setOnlyIf, setOnlyIf, setDidWork, getDidWork, doFirst, doFirst, doFirst, getTaskDependencies, getTaskDependencies, setShouldRunAfter, getShouldRunAfter, dependsOnTaskDidWork, getAsDynamicObject, isHasCustomActions, getTaskIdentity, injectIntoNewInstance, prependParallelSafeAction, getTaskActions, hasTaskActions, getOnlyIf, getImpliesSubProjects, setImpliesSubProjects, getExecuter, setExecuter, getTemporaryDirFactory, addValidator, getValidators, appendParallelSafeAction, setProperty, toString, compareTo, compareTo, getName, execute, getActions, getState, getState, getPath, getExtensions, wait, wait, wait, equals, hashCode, getClass, notify, notifyAll
`class AbstractTask`	getLogger, configure, configure, leftShift, getDescription, property, isEnabled, setEnabled, hasProperty, getGroup, getInputs, getInputs, getIdentityPath, getProject, getAnt, getConvention, getLogging, getLogging, getStandardOutputCapture, setDescription, setGroup, doLast, doLast, doLast, deleteAllActions, getEnabled, getOutputs, getOutputs, getDestroyables, getLocalState, getTemporaryDir, mustRunAfter, setMustRunAfter, getMustRunAfter, finalizedBy, setFinalizedBy, getFinalizedBy, shouldRunAfter, setActions, getDependsOn, setDependsOn, dependsOn, onlyIf, onlyIf, setOnlyIf, setOnlyIf, setDidWork, getDidWork, doFirst, doFirst, doFirst, getTaskDependencies, getTaskDependencies, setShouldRunAfter, getShouldRunAfter, dependsOnTaskDidWork, getAsDynamicObject, isHasCustomActions, getTaskIdentity, injectIntoNewInstance, prependParallelSafeAction, getTaskActions, hasTaskActions, getOnlyIf, getImpliesSubProjects, setImpliesSubProjects, getExecuter, setExecuter, getTemporaryDirFactory, addValidator, getValidators, appendParallelSafeAction, setProperty, toString, compareTo, compareTo, getName, execute, getActions, getState, getState, getPath, getExtensions, wait, wait, wait, equals, hashCode, getClass, notify, notifyAll

- Property Detail
  - @OutputFile File destFile
  - @Internal List<Instruction> instructions
- Constructor Detail
  - Dockerfile()
- Method Detail
  - void addFile(String src, String dest)
    
    The ADD instruction copies new files, directories or remote file URLs from and adds them to the filesystem of the container at the path .
    Parameters:
    src - Source file
    dest - Destination path
  - void addFile(Closure src, Closure dest)
    
    The ADD instruction copies new files, directories or remote file URLs from and adds them to the filesystem of the container at the path .
    Parameters:
    src - Source file
    dest - Destination path
  - void arg(String arg)
    
    The ARG instruction defines a variable that users can pass at build-time to the builder.
    Parameters:
    arg - Argument to pass, possibly with default value.
  - void copyFile(String src, String dest, String stageName = null)
    
    The COPY instruction copies new files or directories from and adds them to the filesystem of the container at the path .
    Parameters:
    src - Source file
    dest - Destination path
    stageName - stage name in case of multi stage build
  - void copyFile(Closure src, Closure dest, Closure stageName)
    
    The COPY instruction copies new files or directories from and adds them to the filesystem of the container at the path .
    Parameters:
    src - Source file
    dest - Destination path
    stageName - closure returning stage name in case of multi stage build
  - @TaskAction void create()
  - void defaultCommand(String... command)
    
    The main purpose of a CMD instruction is to provide defaults for an executing container.
    Parameters:
    command - Command
  - void defaultCommand(Closure command)
    
    The main purpose of a CMD instruction is to provide defaults for an executing container.
    Parameters:
    command - Command
  - void entryPoint(String... entryPoint)
    
    An ENTRYPOINT allows you to configure a container that will run as an executable.
    Parameters:
    entryPoint - Entry point
  - void entryPoint(Closure entryPoint)
    
    An ENTRYPOINT allows you to configure a container that will run as an executable.
    Parameters:
    entryPoint - Entry point
  - void environmentVariable(String key, String value)
    
    The ENV instruction sets the environment variable to the value . This value will be passed to all future RUN instructions.
    Parameters:
    key - Key
    value - Value
  - void environmentVariable(Map<String, String> envVars)
    
    The ENV instruction sets multiple environment variables at once.
    Parameters:
    envVars - Environment variables
  - void environmentVariable(Closure envVars)
    
    The ENV instruction sets multiple environment variables at once.
    Parameters:
    envVars - Environment variables
  - void exposePort(Integer... ports)
    
    The EXPOSE instruction informs Docker that the container will listen on the specified network ports at runtime.
    Parameters:
    ports - Ports
  - void exposePort(Closure ports)
    
    The EXPOSE instruction informs Docker that the container will listen on the specified network ports at runtime.
    Parameters:
    ports - Ports
  - void from(String image, String stageName = null)
    
    The FROM instruction sets the Base Image for subsequent instructions.
    Parameters:
    image - Base image name
    stageName - stage name in case of multi-stage builds (default null)
  - void from(Closure image, Closure stageName = null)
    
    The FROM instruction sets the Base Image for subsequent instructions.
    Parameters:
    image - Base image name
    stageName - closure returning stage name in case of multi-stage builds (default null)
  - void instruction(String instruction)
    
    Adds a full instruction as String. Example:
```
 task createDockerfile(type: Dockerfile) {
     instruction 'FROM ubuntu:14.04'
     instruction 'MAINTAINER Benjamin Muschko "benjamin.muschko@gmail.com"'
 }
 
```
    Parameters:
    instruction - Instruction as String
  - void instruction(Closure instruction)
    
    Adds 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"' }
 }
 
```
    Parameters:
    instruction - Instruction as Closure
  - void instructionsFromTemplate(File template)
  - void instructionsFromTemplate(String templatePath)
  - void instructionsFromTemplate(Closure templatePath)
  - void label(Map<String, String> labels)
    
    The LABEL instruction adds metadata to an image.
    Parameters:
    labels - Labels
  - void label(Closure labels)
    
    The LABEL instruction adds metadata to an image.
    Parameters:
    labels - Labels
  - void maintainer(String maintainer)
    
    The MAINTAINER instruction allows you to set the Author field of the generated images.
    Parameters:
    maintainer - Maintainer
  - void maintainer(Closure maintainer)
    
    The MAINTAINER instruction allows you to set the Author field of the generated images.
    Parameters:
    maintainer - Maintainer
  - void onBuild(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.
    Parameters:
    instruction - Instruction
  - void onBuild(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.
    Parameters:
    instruction - Instruction
  - void runCommand(String command)
    
    The RUN instruction will execute any commands in a new layer on top of the current image and commit the results.
    Parameters:
    command - Command
  - void runCommand(Closure command)
    
    The RUN instruction will execute any commands in a new layer on top of the current image and commit the results.
    Parameters:
    command - Command
  - void user(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.
    Parameters:
    user - User
  - void user(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.
    Parameters:
    user - User
  - void volume(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.
    Parameters:
    volume - Volume
  - void volume(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.
    Parameters:
    volume - Volume
  - void workingDir(String dir)
    
    The WORKDIR instruction sets the working directory for any RUN, CMD and ENTRYPOINT instructions that follow it in the Dockerfile.
    Parameters:
    dir - Directory
  - void workingDir(Closure dir)
    
    The WORKDIR instruction sets the working directory for any RUN, CMD and ENTRYPOINT instructions that follow it in the Dockerfile.
    Parameters:
    dir - Directory

Summary:
Nested
Property
Constructor
Method

| Detail:
Property
Constructor
Method

Groovy Documentation

[Groovy] Class Dockerfile

Nested Class Summary

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

@OutputFile File destFile

@Internal List<Instruction> instructions

Constructor Detail

Dockerfile()

Method Detail

void addFile(String src, String dest)

void addFile(Closure src, Closure dest)

void arg(String arg)

void copyFile(String src, String dest, String stageName = null)

void copyFile(Closure src, Closure dest, Closure stageName)

@TaskAction void create()

void defaultCommand(String... command)

void defaultCommand(Closure command)

void entryPoint(String... entryPoint)

void entryPoint(Closure entryPoint)

void environmentVariable(String key, String value)

void environmentVariable(Map<String, String> envVars)

void environmentVariable(Closure envVars)

void exposePort(Integer... ports)

void exposePort(Closure ports)

void from(String image, String stageName = null)

void from(Closure image, Closure stageName = null)

void instruction(String instruction)

void instruction(Closure instruction)

void instructionsFromTemplate(File template)

void instructionsFromTemplate(String templatePath)

void instructionsFromTemplate(Closure templatePath)

void label(Map<String, String> labels)

void label(Closure labels)

void maintainer(String maintainer)

void maintainer(Closure maintainer)

void onBuild(String instruction)

void onBuild(Closure instruction)

void runCommand(String command)

void runCommand(Closure command)

void user(String user)

void user(Closure user)

void volume(String... volume)

void volume(Closure volume)

void workingDir(String dir)

void workingDir(Closure dir)