org.eclipse.jkube.maven.plugin.mojo.build

Class AbstractDockerMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.eclipse.jkube.maven.plugin.mojo.build.AbstractDockerMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo, org.codehaus.plexus.personality.plexus.lifecycle.phase.Contextualizable, ConfigHelper.Customizer

Direct Known Subclasses:

BuildMojo, PushMojo, WatchMojo

public abstract class AbstractDockerMojo
extends org.apache.maven.plugin.AbstractMojo
implements ConfigHelper.Customizer, org.codehaus.plexus.personality.plexus.lifecycle.phase.Contextualizable

Field Summary

Fields

Modifier and Type	Field and Description
protected org.eclipse.jkube.kit.config.access.ClusterConfiguration	access
protected String	apiVersion
protected org.apache.maven.archiver.MavenArchiveConfiguration	archive
protected org.eclipse.jkube.kit.config.image.build.RegistryAuthConfiguration	authConfig
protected AuthConfigFactory	authConfigFactory
protected boolean	autoCreateCustomNetworks Whether to create the customs networks (user-defined bridge networks) before starting automatically
protected String	autoPull
protected Map<String,String>	buildArgs
protected String	buildRecreate How to recreate the build config and/or image stream created by the build.
protected org.eclipse.jkube.kit.config.image.build.OpenShiftBuildStrategy	buildStrategy OpenShift build mode when an OpenShift build is performed.
protected String	certPath
protected org.eclipse.jkube.kit.config.access.ClusterAccess	clusterAccess
protected String	containerNamePattern Naming pattern for how to name containers when started
static String	CONTEXT_KEY_BUILD_TIMESTAMP
static String	CONTEXT_KEY_LOG_DISPATCHER
static String	CONTEXT_KEY_START_CALLED
static String	DMP_PLUGIN_DESCRIPTOR
static String	DOCKER_BUILD_TIMESTAMP
static String	DOCKER_EXTRA_DIR
protected DockerAccessFactory	dockerAccessFactory
protected String	dockerHost URL to docker daemon
protected org.eclipse.jkube.kit.config.resource.ProcessorConfig	enricher Enrichers used for enricher build objects
protected String	environment Environment name where resources are placed.
protected String	filter Whether to restrict operation to a single image.
protected boolean	forcePull While creating a BuildConfig, By default, if the builder image specified in the build configuration is available locally on the node, that image will be used.
protected org.eclipse.jkube.kit.config.resource.ProcessorConfig	generator Generator specific options.
protected ImageConfigResolver	imageConfigResolver
protected String	imagePullPolicy
protected List<ImageConfiguration>	images Image configurations configured directly.
protected org.eclipse.jkube.kit.config.service.JKubeServiceHub	jkubeServiceHub
protected boolean	keepContainer
protected boolean	keepRunning
protected org.eclipse.jkube.kit.common.KitLogger	log
protected String	logDate
protected boolean	logStdout
protected DockerMachineConfiguration	machine
protected org.apache.maven.shared.filtering.MavenFileFilter	mavenFileFilter
protected org.apache.maven.shared.filtering.MavenReaderFilter	mavenFilterReader
protected int	maxConnections
protected String	minimalApiVersion
protected org.eclipse.jkube.kit.config.resource.RuntimeMode	mode Whether to perform a Kubernetes build (i.e.
protected String	openshiftPullSecret The name of pullSecret to be used to pull the base image in case pulling from a protected registry which requires authentication.
protected String	outputDirectory
protected org.codehaus.plexus.PlexusContainer	plexusContainer
protected String	profile Profile to use.
protected org.apache.maven.project.MavenProject	project
protected org.apache.maven.project.MavenProjectHelper	projectHelper
protected String	pullRegistry
protected List<org.apache.maven.project.MavenProject>	reactorProjects
protected String	registry
protected boolean	removeVolumes
protected org.apache.maven.repository.RepositorySystem	repositorySystem
protected List<ImageConfiguration>	resolvedImages
protected File	resourceDir Folder where to find project specific files, e.g a custom profile
protected org.eclipse.jkube.kit.config.resource.ResourceConfig	resources Resource config for getting annotation and labels to be applied to enriched build objects
protected org.eclipse.jkube.kit.config.resource.RuntimeMode	runtimeMode
protected String	s2iBuildNameSuffix The S2I binary builder BuildConfig name suffix appended to the image name to avoid clashing with the underlying BuildConfig for the Jenkins pipeline
protected boolean	s2iImageStreamLookupPolicyLocal Allow the ImageStream used in the S2I binary build to be used in standard Kubernetes resources such as Deployment or StatefulSet.
protected ServiceHubFactory	serviceHubFactory
protected org.apache.maven.execution.MavenSession	session
protected org.apache.maven.settings.Settings	settings
protected boolean	skip
protected boolean	skipBuild
protected Boolean	skipBuildPom
protected boolean	skipExtendedAuth Skip extended authentication
protected boolean	skipMachine Whether the usage of docker machine should be skipped competely
protected String	sourceDirectory
protected boolean	useColor
protected boolean	useProjectClasspath Should we use the project's compile-time classpath to scan for additional enrichers/generators?
protected String	verbose
protected int	watchInterval
protected WatchMode	watchMode Watching mode for rebuilding images
protected String	watchPostExec
protected String	watchPostGoal

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

ROLE

Constructor Summary

Constructors

Constructor and Description
AbstractDockerMojo()

Method Summary

Modifier and Type	Method and Description
protected ImageConfiguration	addSimpleDockerfileConfig(ImageConfiguration image, File dockerfile)
protected void	callBuildPlugin(File outputDir, String buildPluginClass)
void	contextualize(org.codehaus.plexus.context.Context context)
protected JKubeBuildContext	createMojoParameters()
protected ImageConfiguration	createSimpleDockerfileConfig(File dockerFile)
List<ImageConfiguration>	customizeConfig(List<ImageConfiguration> configs) Customization hook called by the base plugin.
void	execute()
protected void	executeBuildPlugins()
protected abstract void	executeInternal(ServiceHub serviceHub) Hook for subclass for doing the real job
protected org.eclipse.jkube.kit.config.resource.ProcessorConfig	extractEnricherConfig()
protected org.eclipse.jkube.kit.config.resource.ProcessorConfig	extractGeneratorConfig()
protected boolean	follow()
protected File	getAndEnsureOutputDirectory()
protected BuildService.BuildContext	getBuildContext()
protected org.eclipse.jkube.kit.config.service.BuildService.BuildServiceConfig	getBuildServiceConfig()
protected Date	getBuildTimestamp() Get the current build timestamp.
protected File	getBuildTimestampFile()
protected org.eclipse.jkube.kit.config.access.ClusterConfiguration	getClusterConfiguration()
protected DockerAccessFactory.DockerAccessContext	getDockerAccessContext()
org.eclipse.jkube.maven.enricher.api.EnricherContext	getEnricherContext()
protected GavLabel	getGavLabel()
protected org.eclipse.jkube.generator.api.GeneratorContext	getGeneratorContext()
ImagePullManager	getImagePullManager(String imagePullPolicy, String autoPull)
protected org.eclipse.jkube.kit.config.service.JKubeServiceHub	getJKubeServiceHub()
protected LogDispatcher	getLogDispatcher(ServiceHub hub)
protected String	getLogPrefix()
protected Date	getReferenceDate()
protected RegistryService.RegistryConfig	getRegistryConfig(String specificRegistry)
protected List<ImageConfiguration>	getResolvedImages() Get all images to use.
protected ImagePullManager.CacheStore	getSessionCacheStore()
protected String	initImageConfiguration(Date buildTimeStamp)
protected boolean	isDockerAccessRequired()
protected void	logException(Exception exp)
protected void	processDmpPluginDescription(URL pluginDesc, File outputDir)
protected boolean	shouldSkipBecauseOfPomPackaging()
protected String	showLogs()
protected boolean	useColorForLogging() Determine whether to enable colorized log messages

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

Field Detail

DMP_PLUGIN_DESCRIPTOR

public static final String DMP_PLUGIN_DESCRIPTOR

See Also:

Constant Field Values

DOCKER_EXTRA_DIR

public static final String DOCKER_EXTRA_DIR

See Also:

Constant Field Values

CONTEXT_KEY_START_CALLED

public static final String CONTEXT_KEY_START_CALLED

See Also:

Constant Field Values

CONTEXT_KEY_LOG_DISPATCHER

public static final String CONTEXT_KEY_LOG_DISPATCHER

See Also:

Constant Field Values

CONTEXT_KEY_BUILD_TIMESTAMP

public static final String CONTEXT_KEY_BUILD_TIMESTAMP

See Also:

Constant Field Values

DOCKER_BUILD_TIMESTAMP

public static final String DOCKER_BUILD_TIMESTAMP

See Also:

Constant Field Values

access

@Parameter
protected org.eclipse.jkube.kit.config.access.ClusterConfiguration access

project

@Parameter(defaultValue="${project}",
           readonly=true)
protected org.apache.maven.project.MavenProject project

session

@Parameter(defaultValue="${session}",
           readonly=true)
protected org.apache.maven.execution.MavenSession session

apiVersion

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

verbose

@Parameter(property="docker.verbose",
           defaultValue="false")
protected String verbose

logDate

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

logStdout

@Parameter(property="docker.logStdout",
           defaultValue="false")
protected boolean logStdout

dockerHost

@Parameter(property="docker.host")
protected String dockerHost

URL to docker daemon

certPath

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

machine

@Parameter
protected DockerMachineConfiguration machine

skipMachine

@Parameter(property="docker.skip.machine",
           defaultValue="false")
protected boolean skipMachine

Whether the usage of docker machine should be skipped competely

maxConnections

@Parameter(property="docker.maxConnections",
           defaultValue="100")
protected int maxConnections

useColor

@Parameter(property="docker.useColor",
           defaultValue="true")
protected boolean useColor

filter

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

Whether to restrict operation to a single image. This can be either the image or an alias name. It can also be comma separated list. This parameter has to be set via the command line s system property.

resolvedImages

protected List<ImageConfiguration> resolvedImages

settings

@Parameter(defaultValue="${settings}",
           readonly=true)
protected org.apache.maven.settings.Settings settings

sourceDirectory

@Parameter(property="docker.source.dir",
           defaultValue="src/main/docker")
protected String sourceDirectory

outputDirectory

@Parameter(property="docker.target.dir",
           defaultValue="target/docker")
protected String outputDirectory

reactorProjects

@Parameter(defaultValue="${reactorProjects}",
           required=true,
           readonly=true)
protected List<org.apache.maven.project.MavenProject> reactorProjects

autoPull

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

imagePullPolicy

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

pullRegistry

@Parameter(property="docker.pull.registry")
protected String pullRegistry

profile

@Parameter(property="jkube.profile")
protected String profile

Profile to use. A profile contains the enrichers and generators to use as well as their configuration. Profiles are looked up in the classpath and can be provided as yaml files.

However, any given enricher and or generator configuration overrides the information provided by a profile.

imageConfigResolver

@Component
protected ImageConfigResolver imageConfigResolver

skipExtendedAuth

@Parameter(property="docker.skip.extendedAuth",
           defaultValue="false")
protected boolean skipExtendedAuth

Skip extended authentication

archive

@Parameter
protected org.apache.maven.archiver.MavenArchiveConfiguration archive

mavenFileFilter

@Component
protected org.apache.maven.shared.filtering.MavenFileFilter mavenFileFilter

mavenFilterReader

@Component
protected org.apache.maven.shared.filtering.MavenReaderFilter mavenFilterReader

buildArgs

@Parameter
protected Map<String,String> buildArgs

authConfig

@Parameter
protected org.eclipse.jkube.kit.config.image.build.RegistryAuthConfiguration authConfig

registry

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

buildRecreate

@Parameter(property="jkube.build.recreate",
           defaultValue="none")
protected String buildRecreate

How to recreate the build config and/or image stream created by the build. Only in effect when mode == openshift or mode is auto and openshift is detected. If not set, existing build config will not be recreated.

The possible values are:

• buildConfig or bc : Only the build config is recreated
• imageStream or is : Only the image stream is recreated
• all : Both, build config and image stream are recreated
• none : Neither build config nor image stream is recreated

projectHelper

@Component
protected org.apache.maven.project.MavenProjectHelper projectHelper

repositorySystem

@Component
protected org.apache.maven.repository.RepositorySystem repositorySystem

serviceHubFactory

@Component
protected ServiceHubFactory serviceHubFactory

dockerAccessFactory

@Component
protected DockerAccessFactory dockerAccessFactory

images

@Parameter
protected List<ImageConfiguration> images

Image configurations configured directly.

skipBuild

@Parameter(property="docker.skip.build",
           defaultValue="false")
protected boolean skipBuild

buildStrategy

@Parameter(property="jkube.build.strategy")
protected org.eclipse.jkube.kit.config.image.build.OpenShiftBuildStrategy buildStrategy

OpenShift build mode when an OpenShift build is performed. Can be either "s2i" for an s2i binary build mode or "docker" for a binary docker mode.

openshiftPullSecret

@Parameter(property="jkube.build.pullSecret",
           defaultValue="pullsecret-jkube")
protected String openshiftPullSecret

The name of pullSecret to be used to pull the base image in case pulling from a protected registry which requires authentication.

skip

@Parameter(property="jkube.skip",
           defaultValue="false")
protected boolean skip

mode

@Parameter(property="jkube.mode")
protected org.eclipse.jkube.kit.config.resource.RuntimeMode mode

Whether to perform a Kubernetes build (i.e. against a vanilla Docker daemon) or an OpenShift build (with a Docker build against the OpenShift API server.

skipBuildPom

@Parameter(property="jkube.skip.build.pom")
protected Boolean skipBuildPom

s2iBuildNameSuffix

@Parameter(property="jkube.s2i.buildNameSuffix",
           defaultValue="-s2i")
protected String s2iBuildNameSuffix

The S2I binary builder BuildConfig name suffix appended to the image name to avoid clashing with the underlying BuildConfig for the Jenkins pipeline

generator

@Parameter
protected org.eclipse.jkube.kit.config.resource.ProcessorConfig generator

Generator specific options. This is a generic prefix where the keys have the form <generator-prefix>-<option>.

s2iImageStreamLookupPolicyLocal

@Parameter(property="jkube.s2i.imageStreamLookupPolicyLocal",
           defaultValue="true")
protected boolean s2iImageStreamLookupPolicyLocal

Allow the ImageStream used in the S2I binary build to be used in standard Kubernetes resources such as Deployment or StatefulSet.

forcePull

@Parameter(property="jkube.build.forcePull",
           defaultValue="false")
protected boolean forcePull

While creating a BuildConfig, By default, if the builder image specified in the build configuration is available locally on the node, that image will be used.

ForcePull to override the local image and refresh it from the registry to which the image stream points.

useProjectClasspath

@Parameter(property="jkube.useProjectClasspath",
           defaultValue="false")
protected boolean useProjectClasspath

Should we use the project's compile-time classpath to scan for additional enrichers/generators?

resources

@Parameter
protected org.eclipse.jkube.kit.config.resource.ResourceConfig resources

Resource config for getting annotation and labels to be applied to enriched build objects

enricher

@Parameter
protected org.eclipse.jkube.kit.config.resource.ProcessorConfig enricher

Enrichers used for enricher build objects

resourceDir

@Parameter(property="jkube.resourceDir",
           defaultValue="${basedir}/src/main/jkube")
protected File resourceDir

Folder where to find project specific files, e.g a custom profile

environment

@Parameter(property="jkube.environment")
protected String environment

Environment name where resources are placed. For example, if you set this property to dev and resourceDir is the default one, Plugin will look at src/main/jkube/dev

authConfigFactory

protected AuthConfigFactory authConfigFactory

log

protected org.eclipse.jkube.kit.common.KitLogger log

minimalApiVersion

protected String minimalApiVersion

clusterAccess

protected org.eclipse.jkube.kit.config.access.ClusterAccess clusterAccess

jkubeServiceHub

protected org.eclipse.jkube.kit.config.service.JKubeServiceHub jkubeServiceHub

runtimeMode

protected org.eclipse.jkube.kit.config.resource.RuntimeMode runtimeMode

plexusContainer

protected org.codehaus.plexus.PlexusContainer plexusContainer

watchMode

@Parameter(property="docker.watchMode",
           defaultValue="both")
protected WatchMode watchMode

Watching mode for rebuilding images

watchInterval

@Parameter(property="docker.watchInterval",
           defaultValue="5000")
protected int watchInterval

keepRunning

@Parameter(property="docker.keepRunning",
           defaultValue="false")
protected boolean keepRunning

watchPostGoal

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

watchPostExec

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

keepContainer

@Parameter(property="docker.keepContainer",
           defaultValue="false")
protected boolean keepContainer

removeVolumes

@Parameter(property="docker.removeVolumes",
           defaultValue="false")
protected boolean removeVolumes

containerNamePattern

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

Naming pattern for how to name containers when started

autoCreateCustomNetworks

@Parameter(property="docker.autoCreateCustomNetworks",
           defaultValue="false")
protected boolean autoCreateCustomNetworks

Whether to create the customs networks (user-defined bridge networks) before starting automatically

Constructor Detail

AbstractDockerMojo

public AbstractDockerMojo()

Method Detail

contextualize

public void contextualize(org.codehaus.plexus.context.Context context)
                   throws org.codehaus.plexus.context.ContextException

Specified by:

contextualize in interface org.codehaus.plexus.personality.plexus.lifecycle.phase.Contextualizable

Throws:

org.codehaus.plexus.context.ContextException

execute

public void execute()
             throws org.apache.maven.plugin.MojoExecutionException,
                    org.apache.maven.plugin.MojoFailureException

Specified by:

execute in interface org.apache.maven.plugin.Mojo

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

executeInternal

protected abstract void executeInternal(ServiceHub serviceHub)
                                 throws IOException,
                                        org.apache.maven.plugin.MojoExecutionException

Hook for subclass for doing the real job

Parameters:

serviceHub - context for accessing backends

Throws:

IOException

org.apache.maven.plugin.MojoExecutionException

getBuildContext

protected BuildService.BuildContext getBuildContext()
                                             throws org.apache.maven.artifact.DependencyResolutionRequiredException

Throws:

org.apache.maven.artifact.DependencyResolutionRequiredException

createMojoParameters

protected JKubeBuildContext createMojoParameters()
                                          throws org.apache.maven.artifact.DependencyResolutionRequiredException

Throws:

org.apache.maven.artifact.DependencyResolutionRequiredException

getReferenceDate

protected Date getReferenceDate()
                         throws IOException

Throws:

IOException

getBuildTimestampFile

protected File getBuildTimestampFile()

getAndEnsureOutputDirectory

protected File getAndEnsureOutputDirectory()

getBuildTimestamp

protected Date getBuildTimestamp()
                          throws IOException

Get the current build timestamp. this has either already been created by a previous call or a new current date is created

Returns:

timestamp to use

Throws:

IOException

processDmpPluginDescription

protected void processDmpPluginDescription(URL pluginDesc,
                                           File outputDir)
                                    throws IOException

Throws:

IOException

getRegistryConfig

protected RegistryService.RegistryConfig getRegistryConfig(String specificRegistry)

callBuildPlugin

protected void callBuildPlugin(File outputDir,
                               String buildPluginClass)
                        throws ClassNotFoundException,
                               NoSuchMethodException,
                               IllegalAccessException,
                               InvocationTargetException

Throws:

ClassNotFoundException

NoSuchMethodException

IllegalAccessException

InvocationTargetException

createSimpleDockerfileConfig

protected ImageConfiguration createSimpleDockerfileConfig(File dockerFile)

addSimpleDockerfileConfig

protected ImageConfiguration addSimpleDockerfileConfig(ImageConfiguration image,
                                                       File dockerfile)

logException

protected void logException(Exception exp)

getDockerAccessContext

protected DockerAccessFactory.DockerAccessContext getDockerAccessContext()

getResolvedImages

protected List<ImageConfiguration> getResolvedImages()

Get all images to use. Can be restricted via -Ddocker.filter to pick a one or more images. The values are taken as comma separated list.

Returns:

list of image configuration to be use. Can be empty but never null.

isDockerAccessRequired

protected boolean isDockerAccessRequired()

shouldSkipBecauseOfPomPackaging

protected boolean shouldSkipBecauseOfPomPackaging()

getBuildServiceConfig

protected org.eclipse.jkube.kit.config.service.BuildService.BuildServiceConfig getBuildServiceConfig()
                                                                                              throws org.apache.maven.artifact.DependencyResolutionRequiredException

Throws:

org.apache.maven.artifact.DependencyResolutionRequiredException

customizeConfig

public List<ImageConfiguration> customizeConfig(List<ImageConfiguration> configs)

Customization hook called by the base plugin.

Specified by:

customizeConfig in interface ConfigHelper.Customizer

Parameters:

configs - configuration to customize

Returns:

the configuration customized by our generators.

getLogPrefix

protected String getLogPrefix()

getEnricherContext

public org.eclipse.jkube.maven.enricher.api.EnricherContext getEnricherContext()
                                                                        throws org.apache.maven.artifact.DependencyResolutionRequiredException

Throws:

org.apache.maven.artifact.DependencyResolutionRequiredException

getGeneratorContext

protected org.eclipse.jkube.generator.api.GeneratorContext getGeneratorContext()
                                                                        throws org.apache.maven.artifact.DependencyResolutionRequiredException

Throws:

org.apache.maven.artifact.DependencyResolutionRequiredException

getJKubeServiceHub

protected org.eclipse.jkube.kit.config.service.JKubeServiceHub getJKubeServiceHub()
                                                                           throws org.apache.maven.artifact.DependencyResolutionRequiredException

Throws:

org.apache.maven.artifact.DependencyResolutionRequiredException

extractGeneratorConfig

protected org.eclipse.jkube.kit.config.resource.ProcessorConfig extractGeneratorConfig()

extractEnricherConfig

protected org.eclipse.jkube.kit.config.resource.ProcessorConfig extractEnricherConfig()

getImagePullManager

public ImagePullManager getImagePullManager(String imagePullPolicy,
                                            String autoPull)

getSessionCacheStore

protected ImagePullManager.CacheStore getSessionCacheStore()

executeBuildPlugins

protected void executeBuildPlugins()

initImageConfiguration

protected String initImageConfiguration(Date buildTimeStamp)
                                 throws org.apache.maven.artifact.DependencyResolutionRequiredException

Throws:

org.apache.maven.artifact.DependencyResolutionRequiredException

useColorForLogging

protected boolean useColorForLogging()

Determine whether to enable colorized log messages

Returns:

true if log statements should be colorized

getClusterConfiguration

protected org.eclipse.jkube.kit.config.access.ClusterConfiguration getClusterConfiguration()

getGavLabel

protected GavLabel getGavLabel()

showLogs

protected String showLogs()

follow

protected boolean follow()

getLogDispatcher

protected LogDispatcher getLogDispatcher(ServiceHub hub)