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, org.eclipse.jkube.kit.build.service.docker.helper.ConfigHelper.Customizer, KitLoggerProvider

Direct Known Subclasses:

BuildMojo, PushMojo, WatchMojo

public abstract class AbstractDockerMojo
extends org.apache.maven.plugin.AbstractMojo
implements org.eclipse.jkube.kit.build.service.docker.helper.ConfigHelper.Customizer, org.codehaus.plexus.personality.plexus.lifecycle.phase.Contextualizable, KitLoggerProvider

Field Summary

Fields

Modifier and Type	Field and Description
protected org.eclipse.jkube.kit.config.access.ClusterConfiguration	access
protected String	apiVersion
protected org.eclipse.jkube.kit.config.image.build.RegistryAuthConfiguration	authConfig
protected org.eclipse.jkube.kit.build.service.docker.auth.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.JKubeBuildStrategy	buildStrategy Build mode when 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	DMP_PLUGIN_DESCRIPTOR
static String	DOCKER_BUILD_TIMESTAMP
static String	DOCKER_EXTRA_DIR
protected org.eclipse.jkube.kit.build.service.docker.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 org.eclipse.jkube.kit.build.service.docker.config.handler.ImageConfigResolver	imageConfigResolver
protected String	imagePullPolicy
protected List<org.eclipse.jkube.kit.config.image.ImageConfiguration>	images Image configurations configured directly.
protected org.eclipse.jkube.kit.common.JavaProject	javaProject
protected JKubeServiceHub	jkubeServiceHub
protected boolean	keepContainer
protected boolean	keepRunning
protected org.eclipse.jkube.kit.common.KitLogger	log
protected String	logDate
protected org.eclipse.jkube.kit.build.service.docker.access.log.LogOutputSpecFactory	logOutputSpecFactory
protected boolean	logStdout
protected org.eclipse.jkube.kit.build.service.docker.config.DockerMachineConfiguration	machine
protected int	maxConnections
protected String	minimalApiVersion
protected org.apache.maven.plugin.MojoExecution	mojoExecution
protected String	namespace Namespace to use when accessing Kubernetes or OpenShift
protected boolean	offline
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 String	registry
protected boolean	removeVolumes
protected List<org.eclipse.jkube.kit.config.image.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 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 completely
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 boolean	watchFollow
protected int	watchInterval
protected org.eclipse.jkube.kit.config.image.WatchMode	watchMode Watching mode for rebuilding images
protected String	watchPostExec
protected String	watchPostGoal
protected String	watchShowLogs

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 BuildServiceConfig.BuildServiceConfigBuilder	buildServiceConfigBuilder()
protected void	callBuildPlugin(File outputDir, String buildPluginClass)
protected boolean	canExecute()
void	contextualize(org.codehaus.plexus.context.Context context)
List<org.eclipse.jkube.kit.config.image.ImageConfiguration>	customizeConfig(List<org.eclipse.jkube.kit.config.image.ImageConfiguration> configs) Customization hook called by the base plugin.
protected void	doExecute()
void	execute()
protected void	executeBuildPlugins()
protected abstract void	executeInternal() 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 org.eclipse.jkube.generator.api.GeneratorContext.GeneratorContextBuilder	generatorContextBuilder()
protected File	getAndEnsureOutputDirectory()
org.eclipse.jkube.kit.config.resource.RuntimeMode	getConfiguredRuntimeMode()
protected org.eclipse.jkube.kit.build.service.docker.DockerAccessFactory.DockerAccessContext	getDockerAccessContext()
org.eclipse.jkube.kit.enricher.api.EnricherContext	getEnricherContext()
protected org.eclipse.jkube.kit.build.core.GavLabel	getGavLabel()
protected org.eclipse.jkube.kit.config.image.build.JKubeBuildStrategy	getJKubeBuildStrategy()
org.eclipse.jkube.kit.common.KitLogger	getKitLogger()
protected org.eclipse.jkube.kit.build.service.docker.access.log.LogDispatcher	getLogDispatcher(org.eclipse.jkube.kit.build.service.docker.DockerServiceHub hub)
protected String	getLogPrefix()
protected org.eclipse.jkube.kit.common.RegistryConfig	getRegistryConfig(String specificRegistry)
protected List<org.eclipse.jkube.kit.config.image.ImageConfiguration>	getResolvedImages() Get all images to use.
protected void	init()
protected org.eclipse.jkube.kit.config.access.ClusterConfiguration	initClusterConfiguration()
protected org.eclipse.jkube.kit.common.JKubeConfiguration	initJKubeConfiguration()
protected boolean	isDockerAccessRequired()
protected void	logException(Exception exp)
protected void	processDmpPluginDescription(URL pluginDesc, File outputDir)
protected boolean	shouldSkipBecauseOfPomPackaging()
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_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

mojoExecution

@Parameter(defaultValue="${mojoExecution}",
           readonly=true)
protected org.apache.maven.plugin.MojoExecution mojoExecution

apiVersion

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

verbose

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

logDate

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

logStdout

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

dockerHost

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

URL to docker daemon

certPath

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

machine

@Parameter
protected org.eclipse.jkube.kit.build.service.docker.config.DockerMachineConfiguration machine

skipMachine

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

Whether the usage of docker machine should be skipped completely

maxConnections

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

useColor

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

filter

@Parameter(property="jkube.image.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<org.eclipse.jkube.kit.config.image.ImageConfiguration> resolvedImages

settings

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

sourceDirectory

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

outputDirectory

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

autoPull

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

imagePullPolicy

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

pullRegistry

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

buildStrategy

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

Build mode when build is performed. Can be either "s2i" for an s2i binary build mode (in case of OpenShift) or "docker" for a binary docker mode or "jib" for binary jib build

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 org.eclipse.jkube.kit.build.service.docker.config.handler.ImageConfigResolver imageConfigResolver

skipExtendedAuth

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

Skip extended authentication

buildArgs

@Parameter
protected Map<String,String> buildArgs

authConfig

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

registry

@Parameter(property="jkube.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

dockerAccessFactory

@Component
protected org.eclipse.jkube.kit.build.service.docker.DockerAccessFactory dockerAccessFactory

images

@Parameter
protected List<org.eclipse.jkube.kit.config.image.ImageConfiguration> images

Image configurations configured directly.

skipBuild

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

skip

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

skipBuildPom

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

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>.

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 org.eclipse.jkube.kit.build.service.docker.auth.AuthConfigFactory authConfigFactory

log

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

logOutputSpecFactory

protected org.eclipse.jkube.kit.build.service.docker.access.log.LogOutputSpecFactory logOutputSpecFactory

minimalApiVersion

protected String minimalApiVersion

clusterAccess

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

jkubeServiceHub

protected JKubeServiceHub jkubeServiceHub

runtimeMode

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

plexusContainer

protected org.codehaus.plexus.PlexusContainer plexusContainer

watchMode

@Parameter(property="jkube.watch.mode",
           defaultValue="both")
protected org.eclipse.jkube.kit.config.image.WatchMode watchMode

Watching mode for rebuilding images

watchInterval

@Parameter(property="jkube.watch.interval",
           defaultValue="5000")
protected int watchInterval

keepRunning

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

watchPostGoal

@Parameter(property="jkube.watch.postGoal")
protected String watchPostGoal

watchPostExec

@Parameter(property="jkube.watch.postExec")
protected String watchPostExec

keepContainer

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

removeVolumes

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

watchFollow

@Parameter(property="jkube.watch.follow",
           defaultValue="false")
protected boolean watchFollow

watchShowLogs

@Parameter(property="jkube.watch.showLogs")
protected String watchShowLogs

containerNamePattern

@Parameter(property="jkube.watch.containerNamePattern")
protected String containerNamePattern

Naming pattern for how to name containers when started

namespace

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

Namespace to use when accessing Kubernetes or OpenShift

autoCreateCustomNetworks

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

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

offline

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

javaProject

protected org.eclipse.jkube.kit.common.JavaProject javaProject

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

getKitLogger

public org.eclipse.jkube.kit.common.KitLogger getKitLogger()

Specified by:

getKitLogger in interface KitLoggerProvider

getConfiguredRuntimeMode

public org.eclipse.jkube.kit.config.resource.RuntimeMode getConfiguredRuntimeMode()

execute

public final 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

init

protected void init()

canExecute

protected boolean canExecute()

doExecute

protected void doExecute()
                  throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

executeInternal

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

Hook for subclass for doing the real job

Throws:

IOException

org.apache.maven.plugin.MojoExecutionException

initJKubeConfiguration

protected org.eclipse.jkube.kit.common.JKubeConfiguration initJKubeConfiguration()
                                                                          throws org.apache.maven.artifact.DependencyResolutionRequiredException

Throws:

org.apache.maven.artifact.DependencyResolutionRequiredException

getAndEnsureOutputDirectory

protected File getAndEnsureOutputDirectory()

processDmpPluginDescription

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

Throws:

IOException

getRegistryConfig

protected org.eclipse.jkube.kit.common.RegistryConfig getRegistryConfig(String specificRegistry)

callBuildPlugin

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

Throws:

ClassNotFoundException

NoSuchMethodException

IllegalAccessException

InvocationTargetException

logException

protected void logException(Exception exp)

getDockerAccessContext

protected org.eclipse.jkube.kit.build.service.docker.DockerAccessFactory.DockerAccessContext getDockerAccessContext()

getResolvedImages

protected List<org.eclipse.jkube.kit.config.image.ImageConfiguration> getResolvedImages()

Get all images to use. Can be restricted via -Djkube.image.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()

buildServiceConfigBuilder

protected BuildServiceConfig.BuildServiceConfigBuilder buildServiceConfigBuilder()

customizeConfig

public List<org.eclipse.jkube.kit.config.image.ImageConfiguration> customizeConfig(List<org.eclipse.jkube.kit.config.image.ImageConfiguration> configs)

Customization hook called by the base plugin.

Specified by:

customizeConfig in interface org.eclipse.jkube.kit.build.service.docker.helper.ConfigHelper.Customizer

Parameters:

configs - configuration to customize

Returns:

the configuration customized by our generators.

getLogPrefix

protected String getLogPrefix()

getJKubeBuildStrategy

protected org.eclipse.jkube.kit.config.image.build.JKubeBuildStrategy getJKubeBuildStrategy()

getEnricherContext

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

Throws:

org.apache.maven.artifact.DependencyResolutionRequiredException

generatorContextBuilder

protected org.eclipse.jkube.generator.api.GeneratorContext.GeneratorContextBuilder generatorContextBuilder()
                                                                                                    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()

executeBuildPlugins

protected void executeBuildPlugins()

useColorForLogging

protected boolean useColorForLogging()

Determine whether to enable colorized log messages

Returns:

true if log statements should be colorized

initClusterConfiguration

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

getGavLabel

protected org.eclipse.jkube.kit.build.core.GavLabel getGavLabel()

getLogDispatcher

protected org.eclipse.jkube.kit.build.service.docker.access.log.LogDispatcher getLogDispatcher(org.eclipse.jkube.kit.build.service.docker.DockerServiceHub hub)