Package io.micronaut.maven

Class AbstractDockerMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

io.micronaut.maven.AbstractMicronautMojo

io.micronaut.maven.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 AbstractMicronautMojo

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	Description
protected List<String>	appArguments	List of additional arguments that will be passed to the application.
protected final ApplicationConfigurationService	applicationConfigurationService
static final String	ARM_ARCH
protected String	baseImageRun	The Docker image used to run the native image.
static final String	DEFAULT_BASE_IMAGE_GRAALVM_RUN
static final String	DEFAULT_ORACLE_LINUX_VERSION
protected final DockerService	dockerService
protected final org.apache.maven.plugin.PluginParameterExpressionEvaluator	expressionEvaluator
static final String	GDS_DOWNLOAD_URL
protected final JibConfigurationService	jibConfigurationService
static final String	LATEST_TAG
protected String	mainClass	The main class of the application, as defined in the Exec Maven Plugin.
protected final org.apache.maven.project.MavenProject	mavenProject
protected final org.apache.maven.execution.MavenSession	mavenSession
protected String	micronautRuntime	The target runtime of the application.
static final String	MOSTLY_STATIC_NATIVE_IMAGE_GRAALVM_FLAG
protected List<String>	nativeImageBuildArgs	Additional arguments that will be passed to the native-image executable.
protected String	networkMode	Networking mode for the RUN instructions during build.
static final String	ORACLE_CLOUD_FUNCTION_DEFAULT_CMD
protected String	oracleLinuxVersion	The version of Oracle Linux to use as a native-compile base when building a native image inside a Docker container.
protected Boolean	staticNativeImage	Whether to produce a static native image when using docker-native packaging.
static final String	X86_64_ARCH

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

ROLE

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractDockerMojo(org.apache.maven.project.MavenProject mavenProject, JibConfigurationService jibConfigurationService, ApplicationConfigurationService applicationConfigurationService, DockerService dockerService, org.apache.maven.execution.MavenSession mavenSession, org.apache.maven.plugin.MojoExecution mojoExecution)

Method Summary

Modifier and Type	Method	Description
protected void	copyDependencies()	Copy project dependencies to a target/dependency directory.
protected String	getBaseImage()
protected String	getCmd()
protected String	getFrom()
protected Optional<String>	getFromImage()
protected Optional<String>	getNetworkMode()
protected String	getPorts()
protected Map<String,String>	getProxyBuildArgs()
protected Set<String>	getTags()
protected String	graalVmArch()
protected String	graalVmDownloadUrl()
protected String	graalVmJvmVersion()
protected boolean	isArm()	Check os.arch against known ARM architecture identifiers.
protected org.apache.maven.artifact.versioning.ArtifactVersion	javaVersion()
protected void	oracleCloudFunctionCmd(File dockerfile)	Adds cmd to docker oracle cloud function file.

Methods inherited from class io.micronaut.maven.AbstractMicronautMojo

setLog

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

getLog, getPluginContext, 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 Details

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

DEFAULT_ORACLE_LINUX_VERSION

public static final String DEFAULT_ORACLE_LINUX_VERSION

See Also:

• Constant Field Values

ORACLE_CLOUD_FUNCTION_DEFAULT_CMD

public static final String ORACLE_CLOUD_FUNCTION_DEFAULT_CMD

See Also:

• Constant Field Values

GDS_DOWNLOAD_URL

public static final String GDS_DOWNLOAD_URL

See Also:

• Constant Field Values

mavenProject

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

mavenSession

protected final org.apache.maven.execution.MavenSession mavenSession

jibConfigurationService

protected final JibConfigurationService jibConfigurationService

applicationConfigurationService

protected final ApplicationConfigurationService applicationConfigurationService

dockerService

protected final DockerService dockerService

expressionEvaluator

protected final org.apache.maven.plugin.PluginParameterExpressionEvaluator expressionEvaluator

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="cgr.dev/chainguard/wolfi-base:latest")
protected String baseImageRun

The Docker image used to run the native image.

Since:

1.2

oracleLinuxVersion

@Parameter(property="micronaut.native-image.ol.version",
           defaultValue="ol9")
protected String oracleLinuxVersion

The version of Oracle Linux to use as a native-compile base when building a native image inside a Docker container.

networkMode

@Parameter(property="docker.networkMode")
protected String networkMode

Networking mode for the RUN instructions during build.

Since:

4.0.0

Constructor Details

AbstractDockerMojo

protected AbstractDockerMojo(org.apache.maven.project.MavenProject mavenProject,
 JibConfigurationService jibConfigurationService,
 ApplicationConfigurationService applicationConfigurationService,
 DockerService dockerService,
 org.apache.maven.execution.MavenSession mavenSession,
 org.apache.maven.plugin.MojoExecution mojoExecution)

Method Details

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.

graalVmJvmVersion

protected String graalVmJvmVersion()

Returns:

the JVM version to use for GraalVM.

graalVmDownloadUrl

protected String graalVmDownloadUrl()

Returns:

the GraalVM download URL depending on the Java version.

graalVmArch

protected String graalVmArch()

Returns:

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

getFrom

protected String getFrom()

Returns:

the base FROM image for the native image.

isArm

protected boolean isArm()

Check os.arch against known ARM architecture identifiers.

Returns:

true if we think we're running on an arm JDK

getFromImage

protected Optional<String> getFromImage()

Returns:

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

getTags

protected Set<String> getTags()

Returns:

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

getPorts

protected String getPorts()

Returns:

the application ports to expose by looking at the Jib configuration or 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.

getNetworkMode

protected Optional<String> getNetworkMode()

Returns:

Networking mode for the RUN instructions during build (if any).

getProxyBuildArgs

protected Map<String,String> getProxyBuildArgs()

Returns:

Map of proxy-related build arguments for Docker builds.

getBaseImage

protected String getBaseImage()

Returns:

the base image to use for the Dockerfile.

oracleCloudFunctionCmd

protected void oracleCloudFunctionCmd(File dockerfile)
                               throws IOException

Adds cmd to docker oracle cloud function file.

Parameters:

dockerfile - the docker file

Throws:

IOException