org.eclipse.jkube.kit.enricher.api

Class BaseEnricher

java.lang.Object

org.eclipse.jkube.kit.enricher.api.BaseEnricher

All Implemented Interfaces:

org.eclipse.jkube.kit.common.Named, Enricher

public class BaseEnricher
extends Object
implements Enricher

Author:

roland

Field Summary

Fields

Modifier and Type	Field and Description
static String	CREATE_EXTERNAL_URLS
static String	ENRICH_ALL_WITH_IMAGE_TRIGGERS
protected EnricherContext	enricherContext
static String	FABRIC8_GENERATED_CONTAINERS
static String	IMAGE_CHANGE_TRIGGERS
static String	JKUBE_DOMAIN
static String	JKUBE_ENFORCED_REPLICAS
protected org.eclipse.jkube.kit.common.KitLogger	log
static String	NEED_IMAGECHANGE_TRIGGERS
static String	OPENSHIFT_DEPLOY_TIMEOUT_SECONDS
static String	OPENSHIFT_ENABLE_AUTOMATIC_TRIGGER
static String	OPENSHIFT_TRIM_IMAGE_IN_CONTAINER_SPEC
static String	SIDECAR

Fields inherited from interface org.eclipse.jkube.kit.enricher.api.Enricher

INTERNAL_ANNOTATION_PREFIX

Constructor Summary

Constructors

Constructor and Description
BaseEnricher(EnricherContext enricherContext, String name)

Method Summary

Modifier and Type	Method and Description
void	create(PlatformMode platformMode, io.fabric8.kubernetes.api.model.KubernetesListBuilder builder) Add default resources when they are missing.
void	enrich(PlatformMode platformMode, io.fabric8.kubernetes.api.model.KubernetesListBuilder builder) Final customization of the overall resource descriptor.
protected String	getConfig(org.eclipse.jkube.kit.common.Configs.Config key)
protected String	getConfig(org.eclipse.jkube.kit.common.Configs.Config key, String defaultVal)
protected Configuration	getConfiguration()
protected String	getConfigWithFallback(org.eclipse.jkube.kit.common.Configs.Config key, String fallbackPropertyKey, String defaultVal)
protected EnricherContext	getContext()
protected String	getControllerName(ResourceConfig resourceConfig, String defaultValue) This method overrides the controller name value by the value provided in XML config.
protected static String	getImagePullPolicy(ResourceConfig resourceConfig, String defaultValue) This method overrides the ImagePullPolicy value by the value provided in XML config.
protected List<ImageConfiguration>	getImages()
protected org.eclipse.jkube.kit.common.KitLogger	getLog()
String	getName()
static String	getNamespace(ResourceConfig resourceConfig, String defaultValue)
protected Long	getOpenshiftDeployTimeoutInSeconds(Long defaultValue)
protected List<String>	getProcessingInstructionViaKey(String key)
protected static int	getReplicaCount(io.fabric8.kubernetes.api.model.KubernetesListBuilder builder, ResourceConfig xmlResourceConfig, int defaultValue) This method just makes sure that the replica count provided in XML config overrides the default option; and resource fragments are always given topmost priority.
protected boolean	getValueFromConfig(String propertyName, boolean defaultValue) Getting a property value from configuration
protected String	getValueFromConfig(String propertyName, String defaultValue) Getting a property value from configuration
protected boolean	hasImageConfiguration()
protected boolean	isOpenShiftMode() Returns true if we are in OpenShift S2I binary building mode
protected void	setProcessingInstruction(String key, List<String> containerNames)
protected boolean	useDeploymentForOpenShift()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

enricherContext

protected EnricherContext enricherContext

FABRIC8_GENERATED_CONTAINERS

public static final String FABRIC8_GENERATED_CONTAINERS

See Also:

Constant Field Values

NEED_IMAGECHANGE_TRIGGERS

public static final String NEED_IMAGECHANGE_TRIGGERS

See Also:

Constant Field Values

IMAGE_CHANGE_TRIGGERS

public static final String IMAGE_CHANGE_TRIGGERS

See Also:

Constant Field Values

OPENSHIFT_TRIM_IMAGE_IN_CONTAINER_SPEC

public static final String OPENSHIFT_TRIM_IMAGE_IN_CONTAINER_SPEC

See Also:

Constant Field Values

OPENSHIFT_ENABLE_AUTOMATIC_TRIGGER

public static final String OPENSHIFT_ENABLE_AUTOMATIC_TRIGGER

See Also:

Constant Field Values

SIDECAR

public static final String SIDECAR

See Also:

Constant Field Values

ENRICH_ALL_WITH_IMAGE_TRIGGERS

public static final String ENRICH_ALL_WITH_IMAGE_TRIGGERS

See Also:

Constant Field Values

OPENSHIFT_DEPLOY_TIMEOUT_SECONDS

public static final String OPENSHIFT_DEPLOY_TIMEOUT_SECONDS

See Also:

Constant Field Values

CREATE_EXTERNAL_URLS

public static final String CREATE_EXTERNAL_URLS

See Also:

Constant Field Values

JKUBE_DOMAIN

public static final String JKUBE_DOMAIN

See Also:

Constant Field Values

JKUBE_ENFORCED_REPLICAS

public static final String JKUBE_ENFORCED_REPLICAS

See Also:

Constant Field Values

log

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

Constructor Detail

BaseEnricher

public BaseEnricher(EnricherContext enricherContext,
                    String name)

Method Detail

getName

public String getName()

Specified by:

getName in interface org.eclipse.jkube.kit.common.Named

enrich

public void enrich(PlatformMode platformMode,
                   io.fabric8.kubernetes.api.model.KubernetesListBuilder builder)

Description copied from interface: Enricher

Final customization of the overall resource descriptor. Fine tuning happens here.

Specified by:

enrich in interface Enricher

Parameters:

platformMode - platform mode for generated resource descriptors

builder - list to customer used to customize

create

public void create(PlatformMode platformMode,
                   io.fabric8.kubernetes.api.model.KubernetesListBuilder builder)

Description copied from interface: Enricher

Add default resources when they are missing. Each enricher should be responsible for a certain kind of resource and should detect whether a default resource should be added. This should be done defensive, so that when an object is already set it must not be overwritten. This method is only called on resources which are associated with the artefact to build. This is determined that the resource is named like the artifact to build.

Specified by:

create in interface Enricher

Parameters:

platformMode - platform mode for generated resource descriptors

builder - the build to examine and add to

getLog

protected org.eclipse.jkube.kit.common.KitLogger getLog()

getImages

protected List<ImageConfiguration> getImages()

hasImageConfiguration

protected boolean hasImageConfiguration()

getConfiguration

protected Configuration getConfiguration()

getConfig

protected String getConfig(org.eclipse.jkube.kit.common.Configs.Config key)

getConfig

protected String getConfig(org.eclipse.jkube.kit.common.Configs.Config key,
                           String defaultVal)

getConfigWithFallback

protected String getConfigWithFallback(org.eclipse.jkube.kit.common.Configs.Config key,
                                       String fallbackPropertyKey,
                                       String defaultVal)

getContext

protected EnricherContext getContext()

isOpenShiftMode

protected boolean isOpenShiftMode()

Returns true if we are in OpenShift S2I binary building mode

Returns:

boolean value indicating whether OpenShift or not.

getProcessingInstructionViaKey

protected List<String> getProcessingInstructionViaKey(String key)

getOpenshiftDeployTimeoutInSeconds

protected Long getOpenshiftDeployTimeoutInSeconds(Long defaultValue)

getControllerName

protected String getControllerName(ResourceConfig resourceConfig,
                                   String defaultValue)

This method overrides the controller name value by the value provided in XML config.

Parameters:

resourceConfig - resource config from plugin configuration

defaultValue - default value

Returns:

string as controller name

getImagePullPolicy

protected static String getImagePullPolicy(ResourceConfig resourceConfig,
                                           String defaultValue)

This method overrides the ImagePullPolicy value by the value provided in XML config.

Parameters:

resourceConfig - resource config from plugin configuration

defaultValue - default value

Returns:

string as image pull policy

getReplicaCount

protected static int getReplicaCount(io.fabric8.kubernetes.api.model.KubernetesListBuilder builder,
                                     ResourceConfig xmlResourceConfig,
                                     int defaultValue)

This method just makes sure that the replica count provided in XML config overrides the default option; and resource fragments are always given topmost priority.

Parameters:

builder - kubernetes list builder containing objects

xmlResourceConfig - xml resource config from plugin configuration

defaultValue - default value

Returns:

resolved replica count

getNamespace

public static String getNamespace(ResourceConfig resourceConfig,
                                  String defaultValue)

setProcessingInstruction

protected void setProcessingInstruction(String key,
                                        List<String> containerNames)

getValueFromConfig

protected boolean getValueFromConfig(String propertyName,
                                     boolean defaultValue)

Getting a property value from configuration

Parameters:

propertyName - name of property

defaultValue - default value if not defined (true or false)

Returns:

property value

useDeploymentForOpenShift

protected boolean useDeploymentForOpenShift()

getValueFromConfig

protected String getValueFromConfig(String propertyName,
                                    String defaultValue)

Getting a property value from configuration

Parameters:

propertyName - name of property

defaultValue - default value if not defined

Returns:

property value