org.eclipse.jkube.kit.enricher.api.util

Class KubernetesResourceUtil

java.lang.Object

org.eclipse.jkube.kit.enricher.api.util.KubernetesResourceUtil

public class KubernetesResourceUtil
extends Object

Utility class for handling Kubernetes resource descriptors

Author:

roland

Field Summary

Fields

Modifier and Type	Field and Description
static String	API_APPS_VERSION
static String	API_EXTENSIONS_VERSION
static String	API_NETWORKING_VERSION
static String	API_VERSION
static String	CRONJOB_VERSION
static ResourceVersioning	DEFAULT_RESOURCE_VERSIONING
static String	EXTENSIONS_VERSION
static String	JOB_VERSION
static String	OPENSHIFT_V1_VERSION
static String	RBAC_VERSION

Method Summary

Modifier and Type	Method and Description
static void	appendInitContainer(io.fabric8.kubernetes.api.model.PodTemplateSpecBuilder builder, io.fabric8.kubernetes.api.model.Container initContainer, org.eclipse.jkube.kit.common.KitLogger log)
static boolean	checkForKind(io.fabric8.kubernetes.api.model.KubernetesListBuilder builder, String... kinds)
static io.fabric8.kubernetes.api.model.Container	createNewInitContainerFromConfig(InitContainerConfig initContainerConfig)
static List<io.fabric8.kubernetes.api.model.Container>	createNewInitContainersFromConfig(List<InitContainerConfig> initContainerConfigs)
static String	extractContainerName(GroupArtifactVersion groupArtifactVersion, ImageConfiguration imageConfig)
static io.fabric8.kubernetes.api.model.Container	getInitContainer(io.fabric8.kubernetes.api.model.PodTemplateSpecBuilder builder, String name)
static void	handleKubernetesClientException(io.fabric8.kubernetes.client.KubernetesClientException e, org.eclipse.jkube.kit.common.KitLogger logger)
static boolean	hasInitContainer(io.fabric8.kubernetes.api.model.PodTemplateSpecBuilder builder, String name)
static boolean	isContainerImage(ImageConfiguration imageConfig, ControllerResourceConfig config)
static boolean	isInitContainerImage(ImageConfiguration imageConfiguration, ControllerResourceConfig config)
protected static io.fabric8.kubernetes.api.model.HasMetadata	mergeConfigMaps(io.fabric8.kubernetes.api.model.ConfigMap cm1, io.fabric8.kubernetes.api.model.ConfigMap cm2, org.eclipse.jkube.kit.common.KitLogger log, boolean switchOnLocalCustomisation)
protected static io.fabric8.kubernetes.api.model.HasMetadata	mergeDeployments(io.fabric8.kubernetes.api.model.apps.Deployment resource1, io.fabric8.kubernetes.api.model.apps.Deployment resource2, org.eclipse.jkube.kit.common.KitLogger log, boolean switchOnLocalCustomisation)
static void	mergeMetadata(io.fabric8.kubernetes.api.model.HasMetadata target, io.fabric8.kubernetes.api.model.HasMetadata source)
static void	mergeMetadata(io.fabric8.kubernetes.api.model.ObjectMeta target, io.fabric8.kubernetes.api.model.ObjectMeta source)
static String	mergePodSpec(io.fabric8.kubernetes.api.model.PodSpecBuilder builder, io.fabric8.kubernetes.api.model.PodSpec defaultPodSpec, String defaultName)
static String	mergePodSpec(io.fabric8.kubernetes.api.model.PodSpecBuilder builder, io.fabric8.kubernetes.api.model.PodSpec defaultPodSpec, String defaultName, boolean sidecarEnabled)
static io.fabric8.kubernetes.api.model.HasMetadata	mergeResources(io.fabric8.kubernetes.api.model.HasMetadata item1, io.fabric8.kubernetes.api.model.HasMetadata item2, org.eclipse.jkube.kit.common.KitLogger log, boolean switchOnLocalCustomisation) Merges the given resources together into a single resource.
static void	mergeSimpleFields(Object targetValues, Object defaultValues) Uses reflection to copy over default values from the defaultValues object to the targetValues object similar to the following: if( values.get${FIELD}() == null ) { values.(with|set){FIELD}(defaultValues.get${FIELD}); } Only fields that which use primitives, boxed primitives, or String object are copied.
static void	removeInitContainer(io.fabric8.kubernetes.api.model.PodTemplateSpecBuilder builder, String initContainerName)
static void	removeItemFromKubernetesBuilder(io.fabric8.kubernetes.api.model.KubernetesListBuilder builder, io.fabric8.kubernetes.api.model.HasMetadata item)
static void	validateKubernetesMasterUrl(URL masterUrl)

Methods inherited from class java.lang.Object

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

Field Detail

API_VERSION

public static final String API_VERSION

See Also:

Constant Field Values

EXTENSIONS_VERSION

public static final String EXTENSIONS_VERSION

See Also:

Constant Field Values

API_APPS_VERSION

public static final String API_APPS_VERSION

See Also:

Constant Field Values

API_NETWORKING_VERSION

public static final String API_NETWORKING_VERSION

See Also:

Constant Field Values

JOB_VERSION

public static final String JOB_VERSION

See Also:

Constant Field Values

OPENSHIFT_V1_VERSION

public static final String OPENSHIFT_V1_VERSION

See Also:

Constant Field Values

CRONJOB_VERSION

public static final String CRONJOB_VERSION

See Also:

Constant Field Values

RBAC_VERSION

public static final String RBAC_VERSION

See Also:

Constant Field Values

API_EXTENSIONS_VERSION

public static final String API_EXTENSIONS_VERSION

See Also:

Constant Field Values

DEFAULT_RESOURCE_VERSIONING

public static final ResourceVersioning DEFAULT_RESOURCE_VERSIONING

Method Detail

removeItemFromKubernetesBuilder

public static void removeItemFromKubernetesBuilder(io.fabric8.kubernetes.api.model.KubernetesListBuilder builder,
                                                   io.fabric8.kubernetes.api.model.HasMetadata item)

extractContainerName

public static String extractContainerName(GroupArtifactVersion groupArtifactVersion,
                                          ImageConfiguration imageConfig)

checkForKind

public static boolean checkForKind(io.fabric8.kubernetes.api.model.KubernetesListBuilder builder,
                                   String... kinds)

validateKubernetesMasterUrl

public static void validateKubernetesMasterUrl(URL masterUrl)

handleKubernetesClientException

public static void handleKubernetesClientException(io.fabric8.kubernetes.client.KubernetesClientException e,
                                                   org.eclipse.jkube.kit.common.KitLogger logger)

mergeSimpleFields

public static void mergeSimpleFields(Object targetValues,
                                     Object defaultValues)

Uses reflection to copy over default values from the defaultValues object to the targetValues object similar to the following: if( values.get${FIELD}() == null ) { values.(with|set){FIELD}(defaultValues.get${FIELD}); } Only fields that which use primitives, boxed primitives, or String object are copied.

Parameters:

targetValues - Object of target values

defaultValues - Object of default values

mergePodSpec

public static String mergePodSpec(io.fabric8.kubernetes.api.model.PodSpecBuilder builder,
                                  io.fabric8.kubernetes.api.model.PodSpec defaultPodSpec,
                                  String defaultName)

mergePodSpec

public static String mergePodSpec(io.fabric8.kubernetes.api.model.PodSpecBuilder builder,
                                  io.fabric8.kubernetes.api.model.PodSpec defaultPodSpec,
                                  String defaultName,
                                  boolean sidecarEnabled)

mergeResources

public static io.fabric8.kubernetes.api.model.HasMetadata mergeResources(io.fabric8.kubernetes.api.model.HasMetadata item1,
                                                                         io.fabric8.kubernetes.api.model.HasMetadata item2,
                                                                         org.eclipse.jkube.kit.common.KitLogger log,
                                                                         boolean switchOnLocalCustomisation)

Merges the given resources together into a single resource. If switchOnLocalCustomisation is false then the overrides from item2 are merged into item1

Parameters:

item1 - item one

item2 - item two

log - KitLogger

switchOnLocalCustomisation - boolean value for local customization

Returns:

the newly merged resources

hasInitContainer

public static boolean hasInitContainer(io.fabric8.kubernetes.api.model.PodTemplateSpecBuilder builder,
                                       String name)

getInitContainer

public static io.fabric8.kubernetes.api.model.Container getInitContainer(io.fabric8.kubernetes.api.model.PodTemplateSpecBuilder builder,
                                                                         String name)

removeInitContainer

public static void removeInitContainer(io.fabric8.kubernetes.api.model.PodTemplateSpecBuilder builder,
                                       String initContainerName)

appendInitContainer

public static void appendInitContainer(io.fabric8.kubernetes.api.model.PodTemplateSpecBuilder builder,
                                       io.fabric8.kubernetes.api.model.Container initContainer,
                                       org.eclipse.jkube.kit.common.KitLogger log)

createNewInitContainersFromConfig

public static List<io.fabric8.kubernetes.api.model.Container> createNewInitContainersFromConfig(List<InitContainerConfig> initContainerConfigs)

createNewInitContainerFromConfig

public static io.fabric8.kubernetes.api.model.Container createNewInitContainerFromConfig(InitContainerConfig initContainerConfig)

isContainerImage

public static boolean isContainerImage(ImageConfiguration imageConfig,
                                       ControllerResourceConfig config)

isInitContainerImage

public static boolean isInitContainerImage(ImageConfiguration imageConfiguration,
                                           ControllerResourceConfig config)

mergeConfigMaps

protected static io.fabric8.kubernetes.api.model.HasMetadata mergeConfigMaps(io.fabric8.kubernetes.api.model.ConfigMap cm1,
                                                                             io.fabric8.kubernetes.api.model.ConfigMap cm2,
                                                                             org.eclipse.jkube.kit.common.KitLogger log,
                                                                             boolean switchOnLocalCustomisation)

mergeDeployments

protected static io.fabric8.kubernetes.api.model.HasMetadata mergeDeployments(io.fabric8.kubernetes.api.model.apps.Deployment resource1,
                                                                              io.fabric8.kubernetes.api.model.apps.Deployment resource2,
                                                                              org.eclipse.jkube.kit.common.KitLogger log,
                                                                              boolean switchOnLocalCustomisation)

mergeMetadata

public static void mergeMetadata(io.fabric8.kubernetes.api.model.HasMetadata target,
                                 io.fabric8.kubernetes.api.model.HasMetadata source)

mergeMetadata

public static void mergeMetadata(io.fabric8.kubernetes.api.model.ObjectMeta target,
                                 io.fabric8.kubernetes.api.model.ObjectMeta source)