io.fabric8.maven

Class JsonMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

io.fabric8.maven.AbstractNamespacedMojo

io.fabric8.maven.AbstractFabric8Mojo

io.fabric8.maven.JsonMojo

All Implemented Interfaces:

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

@Mojo(name="json",
      defaultPhase=GENERATE_RESOURCES)
public class JsonMojo
extends AbstractFabric8Mojo

Generates or copies the Kubernetes JSON file and attaches it to the build so its installed and released to maven repositories like other build artifacts.

Field Summary

Fields

Modifier and Type	Field and Description
protected Boolean	containerPrivileged
static String	FABRIC8_CONTAINER_PORT_SERVICE
static String	FABRIC8_ICON_URL_ANNOTATION
static String	FABRIC8_METRICS_PORT
static String	FABRIC8_METRICS_PORT_ANNOTATION
static String	FABRIC8_METRICS_PREFIX
static String	FABRIC8_METRICS_SCHEME
static String	FABRIC8_METRICS_SCHEME_ANNOTATION
static String	FABRIC8_METRICS_SCRAPE
static String	FABRIC8_METRICS_SCRAPE_ANNOTATION
static String	FABRIC8_NODE_PORT_SERVICE
static String	FABRIC8_PORT_CONTAINER_PREFIX
static String	FABRIC8_PORT_HOST_PREFIX
static String	FABRIC8_PORT_SERVICE
static String	FABRIC8_PROTOCOL_SERVICE
protected org.apache.maven.artifact.repository.ArtifactRepository	localRepository
protected File	podSpecAnnotationsFile The properties file used to specify the annotations to be added to the generated PodSpec
protected File	rcAnnotationsFile The properties file used to specify the annotations to be added to the generated ReplicationController
protected List	remoteRepositories
protected org.apache.maven.artifact.resolver.ArtifactResolver	resolver
protected String	serviceAccount
protected File	serviceAnnotationsFile The properties file used to specify the annotations to be added to the generated Service
protected File	templateAnnotationsFile The properties file used to specify the annotations to be added to the generated Template
protected File	templateParametersPropertiesFile The properties file used to specify the OpenShift Template parameter values and descriptions.

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
JsonMojo()

Method Summary

Modifier and Type	Method and Description
protected void	addDocumentationAnnotations(io.fabric8.openshift.api.model.Template template, Map<String,String> annotations)
protected static void	addIfNotDefined(Map<String,Object> variables, String key, String value)
protected boolean	addLabelIfNotExist(io.fabric8.kubernetes.api.model.HasMetadata object, String label, String value)
protected void	addLabelIntoObjects(List<io.fabric8.kubernetes.api.model.HasMetadata> objects, String label, String value)
protected void	addPersistentVolumeClaims(io.fabric8.kubernetes.api.model.KubernetesListBuilder builder, List<io.fabric8.kubernetes.api.model.Volume> volumes)
protected boolean	addServiceAccountIfIUsingSecretAnnotations(io.fabric8.kubernetes.api.model.KubernetesListBuilder builder, Map<String,String> annotations)
protected void	addServiceConstraints(io.fabric8.kubernetes.api.model.KubernetesListBuilder builder, List<io.fabric8.kubernetes.api.model.Volume> volumes, boolean containerPrivileged)
protected Object	applyTemplates(io.fabric8.openshift.api.model.Template template)
protected void	combineDependentJsonFiles(File json)
protected void	combineJsonFiles(File json, File kubernetesExtraJson)
protected void	configureTemplateDescriptionAndIcon(io.fabric8.openshift.api.model.Template template, String iconUrl)
protected String	convertIconFileToURL(File iconFile)
protected String	embeddedIconsInConsole(String iconRef, String prefix) To use embedded icons provided by the fabric8-console
void	execute()
protected Object	filterPureKubernetes(Object dto)
protected void	generateKubernetesJson(File kubernetesJson)
String	getCombineProjectName()
List<io.fabric8.kubernetes.api.model.ContainerPort>	getContainerPorts()
Boolean	getContainerPrivileged()
Map<String,Integer>	getDefaultContainerPortMap()
List<io.fabric8.kubernetes.api.model.EnvVar>	getEnvironmentVariables()
Map<String,String>	getExportedEnvironmentVariables()
String	getGroupName()
protected String	getIconUrl() Generate a URL for the icon.
String	getImagePullPolicy()
String	getKubernetesContainerName()
Map<String,String>	getLabels()
protected io.fabric8.kubernetes.api.model.Probe	getLivenessProbe()
protected io.fabric8.openshift.api.model.ImageStream	getOrAddImageStream(List<io.fabric8.kubernetes.api.model.HasMetadata> list, String imageStreamName, Map<String,String> labels)
protected static io.fabric8.kubernetes.api.model.EnvVar	getOrCreateEnv(Map<String,io.fabric8.kubernetes.api.model.EnvVar> envMap, String name)
protected static io.fabric8.kubernetes.api.model.ContainerPort	getOrCreatePort(Map<String,io.fabric8.kubernetes.api.model.ContainerPort> portMap, String name)
Map<String,String>	getPodSpecAnnotations()
protected io.fabric8.kubernetes.api.model.Probe	getProbe(String prefix)
String	getProjectName()
Map<String,String>	getRCAnnotations()
protected io.fabric8.kubernetes.api.model.Probe	getReadinessProbe()
Map<String,String>	getServiceAnnotations()
io.fabric8.openshift.api.model.Template	getTemplate()
Map<String,String>	getTemplateAnnotations()
protected String	getTemplateKey(io.fabric8.openshift.api.model.Template template, String key)
List<io.fabric8.kubernetes.api.model.VolumeMount>	getVolumeMounts()
List<io.fabric8.kubernetes.api.model.Volume>	getVolumes()
protected boolean	hasHostVolume(List<io.fabric8.kubernetes.api.model.Volume> volumes)
protected Map<String,String>	loadAnnotations(File annotationsFile, String propertiesPrefix, String annotationsName)
protected void	loadParametersFromProperties(Properties properties, List<io.fabric8.openshift.api.model.Parameter> parameters, Set<String> paramNames)
protected Integer	parsePort(String portText, String propertyName)
static List<String>	parseSecretNames(String value)
protected Set<org.apache.maven.artifact.Artifact>	resolveArtifacts(org.apache.maven.artifact.Artifact artifact)
void	setCombineProjectName(String combineProjectName)
void	setContainerPorts(List<io.fabric8.kubernetes.api.model.ContainerPort> ports)
void	setDefaultContainerPortMap(Map<String,Integer> defaultContainerPortMap)
void	setGroupName(String groupName)
void	setKubernetesContainerName(String kubernetesContainerName)
void	setLabels(Map<String,String> labels)
void	setProjectName(String projectName)
void	setServicePorts(List<io.fabric8.kubernetes.api.model.ServicePort> ports)
protected boolean	shouldGenerateForThisProject()
protected void	wrapInDeploymentConfigs(File json)
protected List<io.fabric8.kubernetes.api.model.HasMetadata>	wrapInDeploymentConfigs(List<io.fabric8.kubernetes.api.model.HasMetadata> items)
protected void	wrapInDeploymentConfigs(List<io.fabric8.kubernetes.api.model.HasMetadata> list, io.fabric8.kubernetes.api.model.ReplicationController replicationController) Wraps the given ReplicationController in a DeploymentConfig and adds it to the given list along with any other required entities

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, getProject, getProjectAndFabric8Properties, getReplicas, getTestClassLoader, getZipFile, hasConfigDir, isIgnoreProject, isInCDBuild, isPom, isPomProject, loadJsonFile, loadPluginResource, overrideTemplateParameters, printSummary, replaceProperties, 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

FABRIC8_PORT_HOST_PREFIX

public static final String FABRIC8_PORT_HOST_PREFIX

See Also:

Constant Field Values

FABRIC8_PORT_CONTAINER_PREFIX

public static final String FABRIC8_PORT_CONTAINER_PREFIX

See Also:

Constant Field Values

FABRIC8_PORT_SERVICE

public static final String FABRIC8_PORT_SERVICE

See Also:

Constant Field Values

FABRIC8_CONTAINER_PORT_SERVICE

public static final String FABRIC8_CONTAINER_PORT_SERVICE

See Also:

Constant Field Values

FABRIC8_NODE_PORT_SERVICE

public static final String FABRIC8_NODE_PORT_SERVICE

See Also:

Constant Field Values

FABRIC8_PROTOCOL_SERVICE

public static final String FABRIC8_PROTOCOL_SERVICE

See Also:

Constant Field Values

FABRIC8_METRICS_PREFIX

public static final String FABRIC8_METRICS_PREFIX

See Also:

Constant Field Values

FABRIC8_METRICS_SCRAPE

public static final String FABRIC8_METRICS_SCRAPE

See Also:

Constant Field Values

FABRIC8_METRICS_SCRAPE_ANNOTATION

public static final String FABRIC8_METRICS_SCRAPE_ANNOTATION

See Also:

Constant Field Values

FABRIC8_METRICS_PORT

public static final String FABRIC8_METRICS_PORT

See Also:

Constant Field Values

FABRIC8_METRICS_PORT_ANNOTATION

public static final String FABRIC8_METRICS_PORT_ANNOTATION

See Also:

Constant Field Values

FABRIC8_METRICS_SCHEME

public static final String FABRIC8_METRICS_SCHEME

See Also:

Constant Field Values

FABRIC8_METRICS_SCHEME_ANNOTATION

public static final String FABRIC8_METRICS_SCHEME_ANNOTATION

See Also:

Constant Field Values

FABRIC8_ICON_URL_ANNOTATION

public static final String FABRIC8_ICON_URL_ANNOTATION

See Also:

Constant Field Values

containerPrivileged

@Parameter(property="fabric8.containerPrivileged")
protected Boolean containerPrivileged

serviceAccount

@Parameter(property="fabric8.serviceAccount")
protected String serviceAccount

templateParametersPropertiesFile

@Parameter(property="fabric8.templateParametersFile",
           defaultValue="${basedir}/src/main/fabric8/templateParameters.properties")
protected File templateParametersPropertiesFile

The properties file used to specify the OpenShift Template parameter values and descriptions. The properties file should be of the form

         FOO.value = ABC
         FOO.description = this is the description of FOO
     

podSpecAnnotationsFile

@Parameter(property="fabric8.podSpecAnnotationsFile",
           defaultValue="${basedir}/src/main/fabric8/podSpecAnnotations.properties")
protected File podSpecAnnotationsFile

The properties file used to specify the annotations to be added to the generated PodSpec

         acme.com/cheese = SOMETHING
     

rcAnnotationsFile

@Parameter(property="fabric8.rcAnnotationsFile",
           defaultValue="${basedir}/src/main/fabric8/rcAnnotations.properties")
protected File rcAnnotationsFile

The properties file used to specify the annotations to be added to the generated ReplicationController

         acme.com/cheese = SOMETHING
     

templateAnnotationsFile

@Parameter(property="fabric8.templateAnnotationsFile",
           defaultValue="${basedir}/src/main/fabric8/templateAnnotations.properties")
protected File templateAnnotationsFile

The properties file used to specify the annotations to be added to the generated Template

         acme.com/cheese = SOMETHING
     

serviceAnnotationsFile

@Parameter(property="fabric8.serviceAnnotationsFile",
           defaultValue="${basedir}/src/main/fabric8/serviceAnnotations.properties")
protected File serviceAnnotationsFile

The properties file used to specify the annotations to be added to the generated Service

         acme.com/cheese = SOMETHING
     

resolver

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

localRepository

@Parameter(property="localRepository",
           readonly=true,
           required=true)
protected org.apache.maven.artifact.repository.ArtifactRepository localRepository

remoteRepositories

@Parameter(property="project.remoteArtifactRepositories")
protected List remoteRepositories

Constructor Detail

JsonMojo

public JsonMojo()

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

shouldGenerateForThisProject

protected boolean shouldGenerateForThisProject()

Overrides:

shouldGenerateForThisProject in class AbstractFabric8Mojo

combineDependentJsonFiles

protected void combineDependentJsonFiles(File json)
                                  throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

addLabelIntoObjects

protected void addLabelIntoObjects(List<io.fabric8.kubernetes.api.model.HasMetadata> objects,
                                   String label,
                                   String value)

addLabelIfNotExist

protected boolean addLabelIfNotExist(io.fabric8.kubernetes.api.model.HasMetadata object,
                                     String label,
                                     String value)

applyTemplates

protected Object applyTemplates(io.fabric8.openshift.api.model.Template template)
                         throws IOException

Throws:

IOException

filterPureKubernetes

protected Object filterPureKubernetes(Object dto)
                               throws IOException

Throws:

IOException

resolveArtifacts

protected Set<org.apache.maven.artifact.Artifact> resolveArtifacts(org.apache.maven.artifact.Artifact artifact)

combineJsonFiles

protected void combineJsonFiles(File json,
                                File kubernetesExtraJson)
                         throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

wrapInDeploymentConfigs

protected void wrapInDeploymentConfigs(File json)
                                throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

wrapInDeploymentConfigs

protected List<io.fabric8.kubernetes.api.model.HasMetadata> wrapInDeploymentConfigs(List<io.fabric8.kubernetes.api.model.HasMetadata> items)

wrapInDeploymentConfigs

protected void wrapInDeploymentConfigs(List<io.fabric8.kubernetes.api.model.HasMetadata> list,
                                       io.fabric8.kubernetes.api.model.ReplicationController replicationController)

Wraps the given ReplicationController in a DeploymentConfig and adds it to the given list along with any other required entities

getOrAddImageStream

protected io.fabric8.openshift.api.model.ImageStream getOrAddImageStream(List<io.fabric8.kubernetes.api.model.HasMetadata> list,
                                                                         String imageStreamName,
                                                                         Map<String,String> labels)

generateKubernetesJson

protected void generateKubernetesJson(File kubernetesJson)
                               throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

addPersistentVolumeClaims

protected void addPersistentVolumeClaims(io.fabric8.kubernetes.api.model.KubernetesListBuilder builder,
                                         List<io.fabric8.kubernetes.api.model.Volume> volumes)

addServiceAccountIfIUsingSecretAnnotations

protected boolean addServiceAccountIfIUsingSecretAnnotations(io.fabric8.kubernetes.api.model.KubernetesListBuilder builder,
                                                             Map<String,String> annotations)

addServiceConstraints

protected void addServiceConstraints(io.fabric8.kubernetes.api.model.KubernetesListBuilder builder,
                                     List<io.fabric8.kubernetes.api.model.Volume> volumes,
                                     boolean containerPrivileged)

hasHostVolume

protected boolean hasHostVolume(List<io.fabric8.kubernetes.api.model.Volume> volumes)

parseSecretNames

public static List<String> parseSecretNames(String value)

configureTemplateDescriptionAndIcon

protected void configureTemplateDescriptionAndIcon(io.fabric8.openshift.api.model.Template template,
                                                   String iconUrl)

getTemplateKey

protected String getTemplateKey(io.fabric8.openshift.api.model.Template template,
                                String key)

addDocumentationAnnotations

protected void addDocumentationAnnotations(io.fabric8.openshift.api.model.Template template,
                                           Map<String,String> annotations)

getIconUrl

protected String getIconUrl()

Generate a URL for the icon. Lets use a data URL if possible if the icon is relatively small; otherwise lets try convert the icon name to an external link (e.g. using github).

convertIconFileToURL

protected String convertIconFileToURL(File iconFile)
                               throws IOException

Throws:

IOException

embeddedIconsInConsole

protected String embeddedIconsInConsole(String iconRef,
                                        String prefix)

To use embedded icons provided by the fabric8-console

Parameters:

iconRef - name of icon file

prefix - prefix location for the icons in the fabric8-console

Returns:

the embedded icon ref, or null if no embedded icon found to be used

getLivenessProbe

protected io.fabric8.kubernetes.api.model.Probe getLivenessProbe()

getReadinessProbe

protected io.fabric8.kubernetes.api.model.Probe getReadinessProbe()

getProbe

protected io.fabric8.kubernetes.api.model.Probe getProbe(String prefix)

getContainerPrivileged

public Boolean getContainerPrivileged()

getImagePullPolicy

public String getImagePullPolicy()

getKubernetesContainerName

public String getKubernetesContainerName()

setKubernetesContainerName

public void setKubernetesContainerName(String kubernetesContainerName)

getProjectName

public String getProjectName()

setProjectName

public void setProjectName(String projectName)

getCombineProjectName

public String getCombineProjectName()

setCombineProjectName

public void setCombineProjectName(String combineProjectName)

getGroupName

public String getGroupName()

setGroupName

public void setGroupName(String groupName)

getDefaultContainerPortMap

public Map<String,Integer> getDefaultContainerPortMap()

setDefaultContainerPortMap

public void setDefaultContainerPortMap(Map<String,Integer> defaultContainerPortMap)

getContainerPorts

public List<io.fabric8.kubernetes.api.model.ContainerPort> getContainerPorts()

getOrCreatePort

protected static io.fabric8.kubernetes.api.model.ContainerPort getOrCreatePort(Map<String,io.fabric8.kubernetes.api.model.ContainerPort> portMap,
                                                                               String name)

getOrCreateEnv

protected static io.fabric8.kubernetes.api.model.EnvVar getOrCreateEnv(Map<String,io.fabric8.kubernetes.api.model.EnvVar> envMap,
                                                                       String name)

parsePort

protected Integer parsePort(String portText,
                            String propertyName)

setContainerPorts

public void setContainerPorts(List<io.fabric8.kubernetes.api.model.ContainerPort> ports)

setServicePorts

public void setServicePorts(List<io.fabric8.kubernetes.api.model.ServicePort> ports)

getLabels

public Map<String,String> getLabels()

getPodSpecAnnotations

public Map<String,String> getPodSpecAnnotations()
                                         throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

getRCAnnotations

public Map<String,String> getRCAnnotations()
                                    throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

getTemplateAnnotations

public Map<String,String> getTemplateAnnotations()
                                          throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

getServiceAnnotations

public Map<String,String> getServiceAnnotations()
                                         throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

loadAnnotations

protected Map<String,String> loadAnnotations(File annotationsFile,
                                             String propertiesPrefix,
                                             String annotationsName)
                                      throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

getEnvironmentVariables

public List<io.fabric8.kubernetes.api.model.EnvVar> getEnvironmentVariables()
                                                                     throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

getExportedEnvironmentVariables

public Map<String,String> getExportedEnvironmentVariables()
                                                   throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

getVolumeMounts

public List<io.fabric8.kubernetes.api.model.VolumeMount> getVolumeMounts()

getVolumes

public List<io.fabric8.kubernetes.api.model.Volume> getVolumes()

getTemplate

public io.fabric8.openshift.api.model.Template getTemplate()
                                                    throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

loadParametersFromProperties

protected void loadParametersFromProperties(Properties properties,
                                            List<io.fabric8.openshift.api.model.Parameter> parameters,
                                            Set<String> paramNames)

setLabels

public void setLabels(Map<String,String> labels)

addIfNotDefined

protected static void addIfNotDefined(Map<String,Object> variables,
                                      String key,
                                      String value)