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	addNewConfigMapEntriesToExistingConfigMap(io.fabric8.kubernetes.api.model.ConfigMapBuilder configMapBuilder, String key, Path filePath)
static void	addNewEntriesFromDirectoryToExistingConfigMap(io.fabric8.kubernetes.api.model.ConfigMapBuilder configMapBuilder, Path path) Deprecated. Should be replaced with Fabric8 Kubernetes Client's methods
static void	addNewEntryToExistingConfigMap(io.fabric8.kubernetes.api.model.ConfigMapBuilder configMapBuilder, Map.Entry<String,String> entry, Path file) Deprecated. Should be replaced with Fabric8 Kubernetes Client's methods
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 Map.Entry<String,String>	createConfigMapEntry(String key, Path file) Deprecated. Should be replaced with Fabric8 Kubernetes Client's methods
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 String	getNameWithSuffix(String name, String kind)
static io.fabric8.kubernetes.api.model.HasMetadata	getResource(PlatformMode platformMode, ResourceVersioning apiVersions, File file, String appName) Read a Kubernetes resource fragment and add meta information extracted from the filename to the resource descriptor.
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)
protected static void	initializeKindFilenameMapper()
static boolean	isContainerImage(ImageConfiguration imageConfig, ControllerResourceConfig config)
static boolean	isFileWithBinaryContent(Path file) Deprecated. Should be replaced with Fabric8 Kubernetes Client's methods
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 item1, io.fabric8.kubernetes.api.model.HasMetadata item2)
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 io.fabric8.kubernetes.api.model.KubernetesListBuilder	readResourceFragmentsFrom(PlatformMode platformMode, ResourceVersioning apiVersions, String defaultName, File[] resourceFiles) Read all Kubernetes resource fragments from a directory and create a KubernetesListBuilder which can be adapted later.
protected static void	remove(String kind, String filename)
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	updateKindFilenameMapper(Map<String,List<String>> mappings)
static void	updateKindFilenameMappings(List<MappingConfig> mappings)
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

readResourceFragmentsFrom

public static io.fabric8.kubernetes.api.model.KubernetesListBuilder readResourceFragmentsFrom(PlatformMode platformMode,
                                                                                              ResourceVersioning apiVersions,
                                                                                              String defaultName,
                                                                                              File[] resourceFiles)
                                                                                       throws IOException

Read all Kubernetes resource fragments from a directory and create a KubernetesListBuilder which can be adapted later.

Parameters:

platformMode - platform whether it's Kubernetes/OpenShift

apiVersions - the api versions to use

defaultName - the default name to use when none is given

resourceFiles - files to add.

Returns:

the list builder

Throws:

IOException - in case file is not found

getResource

public static io.fabric8.kubernetes.api.model.HasMetadata getResource(PlatformMode platformMode,
                                                                      ResourceVersioning apiVersions,
                                                                      File file,
                                                                      String appName)
                                                               throws IOException

Read a Kubernetes resource fragment and add meta information extracted from the filename to the resource descriptor. I.e. the following elements are added if not provided in the fragment:

• name - Name of the resource added to metadata
• kind - Resource's kind
• apiVersion - API version (given as parameter to this method)

Parameters:

platformMode - Platform whether it's Kubernetes/OpenShift

apiVersions - the API versions to add if not given.

file - file to read.

appName - resource name specifying resources belonging to this application

Returns:

HasMetadata object for resource

Throws:

IOException - in case file loading is failed

initializeKindFilenameMapper

protected static void initializeKindFilenameMapper()

remove

protected static void remove(String kind,
                             String filename)

updateKindFilenameMappings

public static void updateKindFilenameMappings(List<MappingConfig> mappings)

updateKindFilenameMapper

public static void updateKindFilenameMapper(Map<String,List<String>> mappings)

removeItemFromKubernetesBuilder

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

getNameWithSuffix

public static String getNameWithSuffix(String name,
                                       String kind)

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

createConfigMapEntry

@Deprecated
public static Map.Entry<String,String> createConfigMapEntry(String key,
                                                                        Path file)
                                                                 throws IOException

Deprecated. Should be replaced with Fabric8 Kubernetes Client's methods

Create a ConfigMap entry based on file contents

Parameters:

key - key for entry

file - file path whose contents would be used in value of entry

Returns:

an entry containing key and value

Throws:

IOException - in case of error while reading file

isFileWithBinaryContent

@Deprecated
public static boolean isFileWithBinaryContent(Path file)
                                                   throws IOException

Deprecated. Should be replaced with Fabric8 Kubernetes Client's methods

Whether a file is binary file or not

Parameters:

file - file to check

Returns:

boolean value indicating whether file is binary file or not

Throws:

IOException - in case of failure while reading file

addNewEntriesFromDirectoryToExistingConfigMap

@Deprecated
public static void addNewEntriesFromDirectoryToExistingConfigMap(io.fabric8.kubernetes.api.model.ConfigMapBuilder configMapBuilder,
                                                                             Path path)
                                                                      throws IOException

Deprecated. Should be replaced with Fabric8 Kubernetes Client's methods

Add ConfigMap entries from a directory to current ConfigMap

Parameters:

configMapBuilder - ConfigMap builder object

path - path to directory

Throws:

IOException - in case of failure while reading directory

addNewEntryToExistingConfigMap

@Deprecated
public static void addNewEntryToExistingConfigMap(io.fabric8.kubernetes.api.model.ConfigMapBuilder configMapBuilder,
                                                              Map.Entry<String,String> entry,
                                                              Path file)
                                                       throws IOException

Deprecated. Should be replaced with Fabric8 Kubernetes Client's methods

Add single entry to ConfigMap

Parameters:

configMapBuilder - ConfigMap builder object

entry - key value pair which will be added to data/binaryData

file - file which needs to be processed

Throws:

IOException - in case of failure while reading file

addNewConfigMapEntriesToExistingConfigMap

public static void addNewConfigMapEntriesToExistingConfigMap(io.fabric8.kubernetes.api.model.ConfigMapBuilder configMapBuilder,
                                                             String key,
                                                             Path filePath)
                                                      throws IOException

Throws:

IOException

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 item1,
                                 io.fabric8.kubernetes.api.model.HasMetadata item2)