io.micronaut.gradle.docker

Class NativeImageDockerfile

java.lang.Object

org.gradle.api.internal.AbstractTask

org.gradle.api.DefaultTask

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

io.micronaut.gradle.docker.NativeImageDockerfile

All Implemented Interfaces:

groovy.lang.GroovyObject, DockerBuildOptions, java.lang.Comparable<org.gradle.api.Task>, org.gradle.api.internal.DynamicObjectAware, org.gradle.api.internal.TaskInternal, org.gradle.api.plugins.ExtensionAware, org.gradle.api.Task, org.gradle.util.Configurable<org.gradle.api.Task>

public class NativeImageDockerfile
extends com.bmuschko.gradle.docker.tasks.image.Dockerfile
implements DockerBuildOptions

Specialization of Dockerfile for building native images.

Since:

1.0.0

Nested Class Summary

Nested classes/interfaces inherited from class com.bmuschko.gradle.docker.tasks.image.Dockerfile

com.bmuschko.gradle.docker.tasks.image.Dockerfile.AddFileInstruction, com.bmuschko.gradle.docker.tasks.image.Dockerfile.ArgInstruction, com.bmuschko.gradle.docker.tasks.image.Dockerfile.CommentInstruction, com.bmuschko.gradle.docker.tasks.image.Dockerfile.CopyFile, com.bmuschko.gradle.docker.tasks.image.Dockerfile.CopyFileInstruction, com.bmuschko.gradle.docker.tasks.image.Dockerfile.DefaultCommandInstruction, com.bmuschko.gradle.docker.tasks.image.Dockerfile.EntryPointInstruction, com.bmuschko.gradle.docker.tasks.image.Dockerfile.EnvironmentVariableInstruction, com.bmuschko.gradle.docker.tasks.image.Dockerfile.ExposePortInstruction, com.bmuschko.gradle.docker.tasks.image.Dockerfile.File, com.bmuschko.gradle.docker.tasks.image.Dockerfile.FileInstruction<T extends com.bmuschko.gradle.docker.tasks.image.Dockerfile.File>, com.bmuschko.gradle.docker.tasks.image.Dockerfile.From, com.bmuschko.gradle.docker.tasks.image.Dockerfile.FromInstruction, com.bmuschko.gradle.docker.tasks.image.Dockerfile.GenericInstruction, com.bmuschko.gradle.docker.tasks.image.Dockerfile.Instruction, com.bmuschko.gradle.docker.tasks.image.Dockerfile.LabelInstruction, com.bmuschko.gradle.docker.tasks.image.Dockerfile.MapInstruction, com.bmuschko.gradle.docker.tasks.image.Dockerfile.OnBuildInstruction, com.bmuschko.gradle.docker.tasks.image.Dockerfile.RunCommandInstruction, com.bmuschko.gradle.docker.tasks.image.Dockerfile.StringArrayInstruction, com.bmuschko.gradle.docker.tasks.image.Dockerfile.StringCommandInstruction, com.bmuschko.gradle.docker.tasks.image.Dockerfile.UserInstruction, com.bmuschko.gradle.docker.tasks.image.Dockerfile.VolumeInstruction, com.bmuschko.gradle.docker.tasks.image.Dockerfile.WorkDirInstruction

Nested classes/interfaces inherited from interface org.gradle.api.Task

org.gradle.api.Task.Namer

Field Summary

Fields inherited from interface org.gradle.api.Task

TASK_ACTION, TASK_CONSTRUCTOR_ARGS, TASK_DEPENDS_ON, TASK_DESCRIPTION, TASK_GROUP, TASK_NAME, TASK_OVERWRITE, TASK_TYPE

Constructor Summary

Constructors

Constructor and Description
NativeImageDockerfile()

Method Summary

Modifier and Type	Method and Description
NativeImageDockerfile	args(java.lang.String... args) Adds additional args to pass to the native image executable.
NativeImageDockerfile	baseImage(java.lang.String imageName) The base image to use.
void	create()
DockerBuildOptions	exportPorts(java.lang.Integer... ports)
org.gradle.api.provider.ListProperty<java.lang.String>	getArgs()
org.gradle.api.provider.Property<java.lang.String>	getBaseImage()
org.gradle.api.provider.ListProperty<java.lang.Integer>	getExposedPorts()
org.gradle.api.provider.Property<java.lang.String>	getGraalImage()
org.gradle.api.provider.Property<java.lang.String>	getGraalVersion()
org.gradle.api.provider.Property<java.lang.String>	getJdkVersion()
org.gradle.api.provider.Property<MicronautRuntime>	getMicronautRuntime()
org.gradle.api.provider.Property<java.lang.Boolean>	getRequireGraalSdk()
NativeImageDockerfile	graalImage(java.lang.String imageName)

Methods inherited from class com.bmuschko.gradle.docker.tasks.image.Dockerfile

addFile, addFile, addFile, arg, arg, copyFile, copyFile, copyFile, defaultCommand, defaultCommand, entryPoint, entryPoint, environmentVariable, environmentVariable, environmentVariable, exposePort, exposePort, from, from, from, getDestDir, getDestFile, getInstructions, instruction, instruction, instructionsFromTemplate, instructionsFromTemplate, instructionsFromTemplate, label, label, onBuild, onBuild, runCommand, runCommand, user, user, volume, volume, workingDir, workingDir

Methods inherited from class org.gradle.api.internal.AbstractTask

appendParallelSafeAction, compareTo, configure, dependsOn, doFirst, doFirst, doFirst, doLast, doLast, doLast, finalizedBy, getActions, getAnt, getAsDynamicObject, getConvention, getDependsOn, getDescription, getDestroyables, getDidWork, getEnabled, getExtensions, getFinalizedBy, getGroup, getIdentityPath, getImpliesSubProjects, getInputs, getLocalState, getLogger, getLogging, getMustRunAfter, getName, getOnlyIf, getOutputs, getPath, getProject, getRequiredServices, getServices, getSharedResources, getShouldRunAfter, getStandardOutputCapture, getState, getTaskActions, getTaskDependencies, getTaskIdentity, getTemporaryDir, getTemporaryDirFactory, getTimeout, hasProperty, hasTaskActions, injectIntoNewInstance, isEnabled, isHasCustomActions, mustRunAfter, onlyIf, onlyIf, prependParallelSafeAction, property, replaceLogger, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setFinalizedBy, setGroup, setImpliesSubProjects, setMustRunAfter, setOnlyIf, setOnlyIf, setProperty, setShouldRunAfter, shouldRunAfter, usesService

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface groovy.lang.GroovyObject

getMetaClass, getProperty, invokeMethod, setMetaClass, setProperty

Constructor Detail

NativeImageDockerfile

public NativeImageDockerfile()

Method Detail

getRequireGraalSdk

public org.gradle.api.provider.Property<java.lang.Boolean> getRequireGraalSdk()

Returns:

Whether a Graal SDK is required (defaults to 'true').

getJdkVersion

public org.gradle.api.provider.Property<java.lang.String> getJdkVersion()

Returns:

The JDK version to use with native image.

getMicronautRuntime

@Input
public org.gradle.api.provider.Property<MicronautRuntime> getMicronautRuntime()

Returns:

The micronaut runtime

getArgs

public org.gradle.api.provider.ListProperty<java.lang.String> getArgs()

Specified by:

getArgs in interface DockerBuildOptions

Returns:

The arguments to pass to the native image executable when starting up in the docker container.

getGraalImage

public org.gradle.api.provider.Property<java.lang.String> getGraalImage()

Returns:

the GraalVM docker image to use

getGraalVersion

public org.gradle.api.provider.Property<java.lang.String> getGraalVersion()

Returns:

The Graal version to use.

getBaseImage

@Nullable
public org.gradle.api.provider.Property<java.lang.String> getBaseImage()

Specified by:

getBaseImage in interface DockerBuildOptions

Returns:

The base image to use

getExposedPorts

public org.gradle.api.provider.ListProperty<java.lang.Integer> getExposedPorts()

Specified by:

getExposedPorts in interface DockerBuildOptions

Returns:

The exposed ports

create

public void create()

Overrides:

create in class com.bmuschko.gradle.docker.tasks.image.Dockerfile

args

public NativeImageDockerfile args(java.lang.String... args)

Adds additional args to pass to the native image executable.

Specified by:

args in interface DockerBuildOptions

Parameters:

args - The args

Returns:

This instance.

baseImage

public NativeImageDockerfile baseImage(java.lang.String imageName)

Description copied from interface: DockerBuildOptions

The base image to use.

Specified by:

baseImage in interface DockerBuildOptions

Parameters:

imageName - The base image name

Returns:

This

exportPorts

public DockerBuildOptions exportPorts(java.lang.Integer... ports)

Specified by:

exportPorts in interface DockerBuildOptions

Parameters:

ports - The ports to expose

Returns:

The ports

graalImage

public NativeImageDockerfile graalImage(java.lang.String imageName)