io.micronaut.build

Class AbstractDockerMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

io.micronaut.build.AbstractDockerMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

Direct Known Subclasses:

DockerCracMojo, DockerfileMojo, DockerMojo, DockerNativeMojo, DockerPushMojo

public abstract class AbstractDockerMojo
extends org.apache.maven.plugin.AbstractMojo

Abstract base class for mojos related to Docker files and builds.

Since:

1.1

Author:

Álvaro Sánchez-Mariscal, Iván López

Field Summary

Fields

Modifier and Type	Field and Description
protected List<String>	appArguments List of additional arguments that will be passed to the application.
protected ApplicationConfigurationService	applicationConfigurationService
static String	ARM_ARCH
protected String	baseImageRun The Docker image used to run the native image.
static String	DEFAULT_BASE_IMAGE_GRAALVM_RUN
protected DockerService	dockerService
protected JibConfigurationService	jibConfigurationService
static String	LATEST_TAG
protected String	mainClass The main class of the application, as defined in the Exec Maven Plugin.
protected org.apache.maven.project.MavenProject	mavenProject
protected String	micronautRuntime The target runtime of the application.
static String	MOSTLY_STATIC_NATIVE_IMAGE_GRAALVM_FLAG
protected List<String>	nativeImageBuildArgs Additional arguments that will be passed to the native-image executable.
protected Boolean	staticNativeImage Whether to produce a static native image when using docker-native packaging.
static String	X86_64_ARCH

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractDockerMojo(org.apache.maven.project.MavenProject mavenProject, JibConfigurationService jibConfigurationService, ApplicationConfigurationService applicationConfigurationService, DockerService dockerService)

Method Summary

Modifier and Type	Method and Description
protected void	copyDependencies() Copy project dependencies to a target/dependency directory.
protected String	getCmd() Returns the Docker CMD command.
protected String	getFrom() Determines the base FROM image for the native image.
protected Optional<String>	getFromImage() Returns the base image from the jib configuration (if any).
protected String	getGraalVmBuildArgs() Returns any additional GraalVM arguments.
protected String	getPort() Determines the application port to expose by looking at the application configuration.
protected Set<String>	getTags() Calculates the Docker image tags by looking at the Jib plugin configuration.
protected String	graalVmArch() Detects the OS architecture to use for GraalVM depending on the os.arch system property.
protected String	graalVmJvmVersion() Calculates the JVM version to use for GraalVM.
protected String	graalVmVersion() Returns the GraalVM version from the graalvm.version property, which is expected to come from the Micronaut Parent POM.
protected org.apache.maven.artifact.versioning.ArtifactVersion	javaVersion() Returns the Java version from either the maven.compiler.target property or the java.version property.

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.maven.plugin.Mojo

execute

Field Detail

LATEST_TAG

public static final String LATEST_TAG

See Also:

Constant Field Values

DEFAULT_BASE_IMAGE_GRAALVM_RUN

public static final String DEFAULT_BASE_IMAGE_GRAALVM_RUN

See Also:

Constant Field Values

MOSTLY_STATIC_NATIVE_IMAGE_GRAALVM_FLAG

public static final String MOSTLY_STATIC_NATIVE_IMAGE_GRAALVM_FLAG

See Also:

Constant Field Values

ARM_ARCH

public static final String ARM_ARCH

See Also:

Constant Field Values

X86_64_ARCH

public static final String X86_64_ARCH

See Also:

Constant Field Values

mavenProject

protected final org.apache.maven.project.MavenProject mavenProject

jibConfigurationService

protected final JibConfigurationService jibConfigurationService

applicationConfigurationService

protected final ApplicationConfigurationService applicationConfigurationService

dockerService

protected final DockerService dockerService

nativeImageBuildArgs

@Parameter(property="micronaut.native-image.args")
protected List<String> nativeImageBuildArgs

Additional arguments that will be passed to the native-image executable. Note that this will only be used when using a packaging of type docker-native. For native-image packaging you should use the Native Image Maven Plugin configuration options.

appArguments

@Parameter(property="mn.appArgs")
protected List<String> appArguments

List of additional arguments that will be passed to the application.

mainClass

@Parameter(defaultValue="${exec.mainClass}",
           required=true)
protected String mainClass

The main class of the application, as defined in the Exec Maven Plugin.

staticNativeImage

@Parameter(defaultValue="false",
           property="micronaut.native-image.static")
protected Boolean staticNativeImage

Whether to produce a static native image when using docker-native packaging.

micronautRuntime

@Parameter(property="micronaut.runtime",
           defaultValue="NONE")
protected String micronautRuntime

The target runtime of the application.

baseImageRun

@Parameter(property="micronaut.native-image.base-image-run",
           defaultValue="frolvlad/alpine-glibc:alpine-3.12")
protected String baseImageRun

The Docker image used to run the native image.

Since:

1.2

Constructor Detail

AbstractDockerMojo

protected AbstractDockerMojo(org.apache.maven.project.MavenProject mavenProject,
                             JibConfigurationService jibConfigurationService,
                             ApplicationConfigurationService applicationConfigurationService,
                             DockerService dockerService)

Method Detail

javaVersion

protected org.apache.maven.artifact.versioning.ArtifactVersion javaVersion()

Returns the Java version from either the maven.compiler.target property or the java.version property.

graalVmVersion

protected String graalVmVersion()

Returns the GraalVM version from the graalvm.version property, which is expected to come from the Micronaut Parent POM.

graalVmJvmVersion

protected String graalVmJvmVersion()

Calculates the JVM version to use for GraalVM.

graalVmArch

protected String graalVmArch()

Detects the OS architecture to use for GraalVM depending on the os.arch system property.

getFrom

protected String getFrom()

Determines the base FROM image for the native image.

getFromImage

protected Optional<String> getFromImage()

Returns the base image from the jib configuration (if any).

getTags

protected Set<String> getTags()

Calculates the Docker image tags by looking at the Jib plugin configuration.

getPort

protected String getPort()

Determines the application port to expose by looking at the application configuration.

copyDependencies

protected void copyDependencies()
                         throws IOException

Copy project dependencies to a target/dependency directory.

Throws:

IOException

getCmd

protected String getCmd()

Returns the Docker CMD command.

getGraalVmBuildArgs

protected String getGraalVmBuildArgs()

Returns any additional GraalVM arguments.