io.fabric8.maven

Class ApplyMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

io.fabric8.maven.AbstractNamespacedMojo

io.fabric8.maven.AbstractFabric8Mojo

io.fabric8.maven.ApplyMojo

All Implemented Interfaces:

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

Direct Known Subclasses:

CleanMojo, RecreateMojo, RollingMojo

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

Applies the Kubernetes JSON to a namespace in a kubernetes environment

Field Summary

Fields

Modifier and Type	Field and Description
protected List<org.apache.maven.artifact.repository.ArtifactRepository>	remoteRepositories List of Remote Repositories used by the resolver
protected org.apache.maven.artifact.resolver.ArtifactResolver	resolver Used to look up Artifacts in the remote repository.

Fields inherited from class io.fabric8.maven.AbstractFabric8Mojo

appConfigDir, combineDependencies, environmentVariableToAnnotationsFile, envPropertiesFile, ICON_EXTENSIONS, iconRef, kubernetesSourceJson, pureKubernetes, zipFile

Fields inherited from class io.fabric8.maven.AbstractNamespacedMojo

failOnError, recreate, routeDomain

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
static void	addConfig(Collection<io.fabric8.kubernetes.api.model.KubernetesResource> resources, Object resource)
protected Object	applyTemplates(io.fabric8.openshift.api.model.Template template, io.fabric8.kubernetes.client.KubernetesClient kubernetes, io.fabric8.kubernetes.api.Controller controller, String fileName)
static io.fabric8.openshift.api.model.Route	createRouteForService(String routeDomainPostfix, String namespace, io.fabric8.kubernetes.api.model.Service service, org.apache.maven.plugin.logging.Log log)
protected void	createRoutes(io.fabric8.kubernetes.client.KubernetesClient kubernetes, Collection<io.fabric8.kubernetes.api.model.HasMetadata> collection)
protected void	disableOpenShiftFeatures(io.fabric8.kubernetes.api.Controller controller) Lets disable OpenShift-only features if we are not running on OpenShift
void	execute()
org.apache.maven.project.MavenProject	getProject()
boolean	isRollingUpgradePreserveScale()
boolean	isRollingUpgrades()
static void	loadDependency(org.apache.maven.plugin.logging.Log log, Collection<io.fabric8.kubernetes.api.model.KubernetesResource> resources, File file)
void	setRollingUpgrades(boolean rollingUpgrades)
protected static boolean	shouldCreateRouteForService(org.apache.maven.plugin.logging.Log log, io.fabric8.kubernetes.api.model.Service service, String id) Should we try to create a route for the given service? By default lets ignore the kubernetes services and any service which does not expose ports 80 and 443

Methods inherited from class io.fabric8.maven.AbstractFabric8Mojo

addEnvironmentAnnotations, addEnvironmentAnnotations, addEnvironmentAnnotations, addPropertiesFileToMap, addPropertiesFileToMap, copyAppConfigFiles, copyIconToFolder, copyReadMe, copyReadMe, copyReadMe, copySummaryText, createClassLoader, createExceptionIterable, createURLClassLoader, findDocumentationUrl, findProjectDistributionManagement, getCompileClassLoader, getDockerImage, getEnvironmentVariableJsonSchema, getEnvironmentVariableProperties, getGitCommitId, getGitRepository, getKubernetesCombineJson, getKubernetesJson, getProjectAndFabric8Properties, getReplicas, getTestClassLoader, getZipFile, hasConfigDir, isIgnoreProject, isInCDBuild, isPom, isPomProject, loadJsonFile, loadPluginResource, overrideTemplateParameters, printSummary, replaceProperties, shouldGenerateForThisProject, toBeExclude, tryDefaultAnnotationEnvVar, unquoteTemplateExpression, warnIfInCDBuild, warnIfInCDBuild

Methods inherited from class io.fabric8.maven.AbstractNamespacedMojo

createController, findProjectConfig, getKubernetes, getNamespace, getNamespaceForEnvironment, getRootProject, getRootProjectFolder, getRouteDomain, isFailOnError, isRecreate, setFailOnError, setNamespace, setRecreate, setRouteDomain

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

resolver

@Component
protected org.apache.maven.artifact.resolver.ArtifactResolver resolver

Used to look up Artifacts in the remote repository.

remoteRepositories

@Parameter(defaultValue="${project.remoteArtifactRepositories}",
           readonly=true,
           required=true)
protected List<org.apache.maven.artifact.repository.ArtifactRepository> remoteRepositories

List of Remote Repositories used by the resolver

Constructor Detail

ApplyMojo

public ApplyMojo()

Method Detail

execute

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

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

isRollingUpgrades

public boolean isRollingUpgrades()

setRollingUpgrades

public void setRollingUpgrades(boolean rollingUpgrades)

isRollingUpgradePreserveScale

public boolean isRollingUpgradePreserveScale()

getProject

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

Overrides:

getProject in class AbstractFabric8Mojo

disableOpenShiftFeatures

protected void disableOpenShiftFeatures(io.fabric8.kubernetes.api.Controller controller)

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

applyTemplates

protected Object applyTemplates(io.fabric8.openshift.api.model.Template template,
                                io.fabric8.kubernetes.client.KubernetesClient kubernetes,
                                io.fabric8.kubernetes.api.Controller controller,
                                String fileName)
                         throws Exception

Throws:

Exception

createRoutes

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

createRouteForService

public static io.fabric8.openshift.api.model.Route createRouteForService(String routeDomainPostfix,
                                                                         String namespace,
                                                                         io.fabric8.kubernetes.api.model.Service service,
                                                                         org.apache.maven.plugin.logging.Log log)

shouldCreateRouteForService

protected static boolean shouldCreateRouteForService(org.apache.maven.plugin.logging.Log log,
                                                     io.fabric8.kubernetes.api.model.Service service,
                                                     String id)

Should we try to create a route for the given service?

By default lets ignore the kubernetes services and any service which does not expose ports 80 and 443

Returns:

true if we should create an OpenShift Route for this service.

addConfig

public static void addConfig(Collection<io.fabric8.kubernetes.api.model.KubernetesResource> resources,
                             Object resource)

loadDependency

public static void loadDependency(org.apache.maven.plugin.logging.Log log,
                                  Collection<io.fabric8.kubernetes.api.model.KubernetesResource> resources,
                                  File file)
                           throws IOException

Throws:

IOException