io.fabric8.maven.plugin.mojo.build

Class ApplyMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

io.fabric8.maven.plugin.mojo.AbstractFabric8Mojo

io.fabric8.maven.plugin.mojo.build.ApplyMojo

All Implemented Interfaces:

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

Direct Known Subclasses:

DebugMojo, DeployMojo, LogMojo, ResourceAndApplyMojo, UndeployMojo

@Mojo(name="apply",
      requiresDependencyResolution=COMPILE,
      defaultPhase=INSTALL)
public class ApplyMojo
extends AbstractFabric8Mojo

Base class for goals which deploy the generated artifacts into the Kubernetes cluster

Field Summary

Fields

Modifier and Type	Field and Description
protected ApplyService	applyService
static String	DEFAULT_KUBERNETES_MANIFEST
static String	DEFAULT_OPENSHIFT_MANIFEST
protected boolean	failOnError Should we fail the build if an apply fails?
protected boolean	recreate Should we update resources by deleting them first and then creating them again?
protected String	routeDomain The domain added to the service ID when creating OpenShift routes
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 long	serviceUrlWaitTimeSeconds How many seconds to wait for a URL to be generated for a service
protected boolean	skipApply

Fields inherited from class io.fabric8.maven.plugin.mojo.AbstractFabric8Mojo

access, log, project, session, settings, skip, useColor, verbose

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

ROLE

Constructor Summary

Constructors

Constructor and Description
ApplyMojo()

Method Summary

Modifier and Type	Method and Description
protected void	applyEntities(io.fabric8.kubernetes.client.KubernetesClient kubernetes, String namespace, String fileName, Set<io.fabric8.kubernetes.api.model.HasMetadata> entities)
protected void	createIngress(io.fabric8.kubernetes.client.KubernetesClient kubernetesClient, Collection<io.fabric8.kubernetes.api.model.HasMetadata> collection)
protected void	createRoutes(Collection<io.fabric8.kubernetes.api.model.HasMetadata> collection)
protected void	disableOpenShiftFeatures(ApplyService applyService) Lets disable OpenShift-only features if we are not running on OpenShift
void	executeInternal()
protected String	getExternalServiceURL(io.fabric8.kubernetes.api.model.Service service)
static io.fabric8.kubernetes.api.model.ServiceSpec	getOrCreateSpec(io.fabric8.kubernetes.api.model.Service entity)
org.apache.maven.project.MavenProject	getProject()
protected org.apache.maven.project.MavenProject	getRootProject() Returns the root project folder
protected File	getRootProjectFolder() Returns the root project folder
protected void	initServices(io.fabric8.kubernetes.client.KubernetesClient kubernetes, io.fabric8.maven.docker.util.Logger log)
protected boolean	isExposeService(io.fabric8.kubernetes.api.model.Service service)
boolean	isRollingUpgradePreserveScale()
boolean	isRollingUpgrades()

Methods inherited from class io.fabric8.maven.plugin.mojo.AbstractFabric8Mojo

createExternalProcessLogger, createLogger, execute, getClusterConfiguration, getProperty

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

DEFAULT_KUBERNETES_MANIFEST

public static final String DEFAULT_KUBERNETES_MANIFEST

See Also:

Constant Field Values

DEFAULT_OPENSHIFT_MANIFEST

public static final String DEFAULT_OPENSHIFT_MANIFEST

See Also:

Constant Field Values

routeDomain

@Parameter(property="fabric8.domain")
protected String routeDomain

The domain added to the service ID when creating OpenShift routes

failOnError

@Parameter(property="fabric8.deploy.failOnError",
           defaultValue="true")
protected boolean failOnError

Should we fail the build if an apply fails?

recreate

@Parameter(property="fabric8.recreate",
           defaultValue="false")
protected boolean recreate

Should we update resources by deleting them first and then creating them again?

serviceUrlWaitTimeSeconds

@Parameter(property="fabric8.serviceUrl.waitSeconds",
           defaultValue="5")
protected long serviceUrlWaitTimeSeconds

How many seconds to wait for a URL to be generated for a service

s2iBuildNameSuffix

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

skipApply

@Parameter(property="fabric8.skip.apply",
           defaultValue="false")
protected boolean skipApply

applyService

protected ApplyService applyService

Constructor Detail

ApplyMojo

public ApplyMojo()

Method Detail

executeInternal

public void executeInternal()
                     throws org.apache.maven.plugin.MojoExecutionException

Specified by:

executeInternal in class AbstractFabric8Mojo

Throws:

org.apache.maven.plugin.MojoExecutionException

initServices

protected void initServices(io.fabric8.kubernetes.client.KubernetesClient kubernetes,
                            io.fabric8.maven.docker.util.Logger log)

getOrCreateSpec

public static io.fabric8.kubernetes.api.model.ServiceSpec getOrCreateSpec(io.fabric8.kubernetes.api.model.Service entity)

applyEntities

protected void applyEntities(io.fabric8.kubernetes.client.KubernetesClient kubernetes,
                             String namespace,
                             String fileName,
                             Set<io.fabric8.kubernetes.api.model.HasMetadata> entities)
                      throws Exception

Throws:

Exception

getExternalServiceURL

protected String getExternalServiceURL(io.fabric8.kubernetes.api.model.Service service)

isExposeService

protected boolean isExposeService(io.fabric8.kubernetes.api.model.Service service)

isRollingUpgrades

public boolean isRollingUpgrades()

isRollingUpgradePreserveScale

public boolean isRollingUpgradePreserveScale()

getProject

public org.apache.maven.project.MavenProject getProject()

disableOpenShiftFeatures

protected void disableOpenShiftFeatures(ApplyService applyService)

Lets disable OpenShift-only features if we are not running on OpenShift

createRoutes

protected void createRoutes(Collection<io.fabric8.kubernetes.api.model.HasMetadata> collection)

createIngress

protected void createIngress(io.fabric8.kubernetes.client.KubernetesClient kubernetesClient,
                             Collection<io.fabric8.kubernetes.api.model.HasMetadata> collection)

getRootProjectFolder

protected File getRootProjectFolder()

Returns the root project folder

getRootProject

protected org.apache.maven.project.MavenProject getRootProject()

Returns the root project folder