org.eclipse.jkube.kit.common.util

Class KubernetesHelper

java.lang.Object

org.eclipse.jkube.kit.common.util.KubernetesHelper

public class KubernetesHelper
extends Object

Since:

23.05.17

Author:

roland

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	DATE_TIME_FORMAT
static Pattern	FILENAME_PATTERN
protected static String[]	POD_CONTROLLER_KINDS
static Pattern	PROFILES_PATTERN

Method Summary

Modifier and Type	Method and Description
static io.fabric8.kubernetes.api.model.ContainerPort	addPort(String portNumberText, String portName, KitLogger log)
static boolean	containsPort(List<io.fabric8.kubernetes.api.model.ContainerPort> ports, String portValue)
static List<io.fabric8.kubernetes.api.model.HTTPHeader>	convertMapToHTTPHeaderList(Map<String,String> headers)
static List<io.fabric8.kubernetes.api.model.EnvVar>	convertToEnvVarList(Map<String,String> envVars) Convert a map of env vars to a list of K8s EnvVar objects.
static io.fabric8.kubernetes.api.model.IntOrString	createIntOrString(int intVal) Creates an IntOrString from the given string which could be a number or a name
static io.fabric8.kubernetes.api.model.IntOrString	createIntOrString(String nameOrNumber) Creates an IntOrString from the given string which could be a number or a name
static String	currentUserName()
static io.fabric8.kubernetes.api.model.LabelSelector	extractPodLabelSelector(Collection<io.fabric8.kubernetes.api.model.HasMetadata> entities)
static io.fabric8.kubernetes.api.model.LabelSelector	extractPodLabelSelector(io.fabric8.kubernetes.api.model.HasMetadata entity)
static String	getAnnotationValue(io.fabric8.kubernetes.api.model.HasMetadata item, String annotationKey)
static String	getBuildStatusPhase(io.fabric8.openshift.api.model.Build build)
static String	getBuildStatusReason(io.fabric8.openshift.api.model.Build build)
static List<io.fabric8.kubernetes.api.model.Container>	getContainers(io.fabric8.kubernetes.api.model.Pod pod)
static List<io.fabric8.kubernetes.api.model.Container>	getContainers(io.fabric8.kubernetes.api.model.PodSpec podSpec)
static io.fabric8.kubernetes.client.dsl.base.CustomResourceDefinitionContext	getCrdContext(io.fabric8.kubernetes.api.model.apiextensions.v1beta1.CustomResourceDefinitionList customResourceDefinitionList, GenericCustomResource customResource)
static Date	getCreationTimestamp(io.fabric8.kubernetes.api.model.HasMetadata hasMetadata)
static String	getDefaultNamespace()
static String	getEnvVar(List<io.fabric8.kubernetes.api.model.EnvVar> envVarList, String name, String defaultValue)
static String	getFullyQualifiedApiGroupWithKind(io.fabric8.kubernetes.client.dsl.base.CustomResourceDefinitionContext crdContext)
static String	getKind(io.fabric8.kubernetes.api.model.HasMetadata entity) Returns the kind of the entity
static Map<String,String>	getLabels(io.fabric8.kubernetes.api.model.HasMetadata entity)
static Map<String,String>	getLabels(io.fabric8.kubernetes.api.model.ObjectMeta metadata) Returns the labels of the given metadata object or an empty map if the metadata or labels are null
static String	getName(io.fabric8.kubernetes.api.model.HasMetadata entity)
static String	getName(io.fabric8.kubernetes.api.model.ObjectMeta entity)
static String	getNamespace(io.fabric8.kubernetes.api.model.HasMetadata entity)
static String	getNamespace(io.fabric8.kubernetes.api.model.ObjectMeta entity)
static String	getNewestApplicationPodName(io.fabric8.kubernetes.client.KubernetesClient client, String namespace, Collection<io.fabric8.kubernetes.api.model.HasMetadata> resources)
static io.fabric8.kubernetes.api.model.Pod	getNewestPod(Collection<io.fabric8.kubernetes.api.model.Pod> pods)
static Map<String,String>	getOrCreateAnnotations(io.fabric8.kubernetes.api.model.HasMetadata entity)
static Map<String,String>	getOrCreateLabels(io.fabric8.kubernetes.api.model.HasMetadata entity)
static io.fabric8.kubernetes.api.model.ObjectMeta	getOrCreateMetadata(io.fabric8.kubernetes.api.model.HasMetadata entity)
static String	getPodPhase(io.fabric8.kubernetes.api.model.Pod pod)
static Map<String,io.fabric8.kubernetes.api.model.Quantity>	getQuantityFromString(Map<String,String> quantity) Get requests or limit objects from string hashmaps
static File	getResourceFragmentFromSource(File resourceDirFinal, List<String> remotes, String resourceNameSuffix, KitLogger log) Get a specific resource fragment ending with some suffix in a specified directory
static String	getResourceVersion(io.fabric8.kubernetes.api.model.HasMetadata entity) Returns the resource version for the entity or null if it does not have one
static String	getServiceExposeUrl(io.fabric8.kubernetes.client.KubernetesClient kubernetes, Collection<io.fabric8.kubernetes.api.model.HasMetadata> resources, long serviceUrlWaitTimeSeconds, String exposeServiceAnnotationKey)
static void	handleKubernetesClientException(io.fabric8.kubernetes.client.KubernetesClientException e, KitLogger logger)
static boolean	isControllerResource(io.fabric8.kubernetes.api.model.HasMetadata h)
static boolean	isExposeService(io.fabric8.kubernetes.api.model.Service service)
static boolean	isNewerResource(io.fabric8.kubernetes.api.model.HasMetadata newer, io.fabric8.kubernetes.api.model.HasMetadata older)
static boolean	isPodReady(io.fabric8.kubernetes.api.model.Pod pod) Returns true if the pod is running and ready
static boolean	isPodRunning(io.fabric8.kubernetes.api.model.Pod pod) Returns true if the pod is running
static boolean	isPodWaiting(io.fabric8.kubernetes.api.model.Pod pod)
static File[]	listResourceFragments(File resourceDir)
static File[]	listResourceFragments(File localResourceDir, List<String> remotes, KitLogger log)
static List<io.fabric8.kubernetes.api.model.HasMetadata>	loadResources(File manifest)
static Date	parseDate(String text)
static void	printLogsAsync(io.fabric8.kubernetes.client.dsl.LogWatch logWatcher, String failureMessage, CountDownLatch terminateLatch, KitLogger log)
static boolean	removeEnvVar(List<io.fabric8.kubernetes.api.model.EnvVar> envVarList, String name)
static boolean	setEnvVar(List<io.fabric8.kubernetes.api.model.EnvVar> envVarList, String name, String value)
static List<io.fabric8.kubernetes.api.model.HasMetadata>	toItemList(Object entity) Loads the Kubernetes JSON and converts it to a list of entities
static String	validateKubernetesId(String currentValue, String description) Validates that the given value is valid according to the kubernetes ID parsing rules, throwing an exception if not.
static io.fabric8.kubernetes.client.dsl.FilterWatchListDeletable<io.fabric8.kubernetes.api.model.Pod,io.fabric8.kubernetes.api.model.PodList>	withSelector(io.fabric8.kubernetes.client.dsl.NonNamespaceOperation<io.fabric8.kubernetes.api.model.Pod,io.fabric8.kubernetes.api.model.PodList,io.fabric8.kubernetes.client.dsl.PodResource<io.fabric8.kubernetes.api.model.Pod>> pods, io.fabric8.kubernetes.api.model.LabelSelector selector, KitLogger log)

Methods inherited from class java.lang.Object

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

Field Detail

DATE_TIME_FORMAT

protected static final String DATE_TIME_FORMAT

See Also:

Constant Field Values

FILENAME_PATTERN

public static final Pattern FILENAME_PATTERN

PROFILES_PATTERN

public static final Pattern PROFILES_PATTERN

POD_CONTROLLER_KINDS

protected static final String[] POD_CONTROLLER_KINDS

Method Detail

validateKubernetesId

public static String validateKubernetesId(String currentValue,
                                          String description)

Validates that the given value is valid according to the kubernetes ID parsing rules, throwing an exception if not.

Parameters:

currentValue - current value

description - description

Returns:

valid value according to kubernetes ID parsing rules

toItemList

public static List<io.fabric8.kubernetes.api.model.HasMetadata> toItemList(Object entity)

Loads the Kubernetes JSON and converts it to a list of entities

Parameters:

entity - Kubernetes generic resource object

Returns:

list of objects of type HasMetadata

getOrCreateAnnotations

public static Map<String,String> getOrCreateAnnotations(io.fabric8.kubernetes.api.model.HasMetadata entity)

getOrCreateMetadata

public static io.fabric8.kubernetes.api.model.ObjectMeta getOrCreateMetadata(io.fabric8.kubernetes.api.model.HasMetadata entity)

getOrCreateLabels

public static Map<String,String> getOrCreateLabels(io.fabric8.kubernetes.api.model.HasMetadata entity)

getResourceVersion

public static String getResourceVersion(io.fabric8.kubernetes.api.model.HasMetadata entity)

Returns the resource version for the entity or null if it does not have one

Parameters:

entity - entity as HasMetadata object

Returns:

resource version as string value

getLabels

public static Map<String,String> getLabels(io.fabric8.kubernetes.api.model.HasMetadata entity)

getLabels

public static Map<String,String> getLabels(io.fabric8.kubernetes.api.model.ObjectMeta metadata)

Returns the labels of the given metadata object or an empty map if the metadata or labels are null

Parameters:

metadata - metadata object ObjectMeta

Returns:

labels in form of a hashmap

getName

public static String getName(io.fabric8.kubernetes.api.model.HasMetadata entity)

getName

public static String getName(io.fabric8.kubernetes.api.model.ObjectMeta entity)

getNamespace

public static String getNamespace(io.fabric8.kubernetes.api.model.ObjectMeta entity)

getNamespace

public static String getNamespace(io.fabric8.kubernetes.api.model.HasMetadata entity)

getKind

public static String getKind(io.fabric8.kubernetes.api.model.HasMetadata entity)

Returns the kind of the entity

Parameters:

entity - entity as HasMetadata

Returns:

kind of resource

createIntOrString

public static io.fabric8.kubernetes.api.model.IntOrString createIntOrString(int intVal)

Creates an IntOrString from the given string which could be a number or a name

Parameters:

intVal - integer as value

Returns:

wrapped object as IntOrString

createIntOrString

public static io.fabric8.kubernetes.api.model.IntOrString createIntOrString(String nameOrNumber)

Creates an IntOrString from the given string which could be a number or a name

Parameters:

nameOrNumber - String containing name or number

Returns:

IntOrString object

isPodRunning

public static boolean isPodRunning(io.fabric8.kubernetes.api.model.Pod pod)

Returns true if the pod is running

Parameters:

pod - Pod object

Returns:

boolean value indicating it's status

isPodWaiting

public static boolean isPodWaiting(io.fabric8.kubernetes.api.model.Pod pod)

isPodReady

public static boolean isPodReady(io.fabric8.kubernetes.api.model.Pod pod)

Returns true if the pod is running and ready

Parameters:

pod - Pod object

Returns:

boolean value indicating it's status

getPodPhase

public static String getPodPhase(io.fabric8.kubernetes.api.model.Pod pod)

getContainers

public static List<io.fabric8.kubernetes.api.model.Container> getContainers(io.fabric8.kubernetes.api.model.Pod pod)

getContainers

public static List<io.fabric8.kubernetes.api.model.Container> getContainers(io.fabric8.kubernetes.api.model.PodSpec podSpec)

getDefaultNamespace

public static String getDefaultNamespace()

currentUserName

public static String currentUserName()

handleKubernetesClientException

public static void handleKubernetesClientException(io.fabric8.kubernetes.client.KubernetesClientException e,
                                                   KitLogger logger)

loadResources

public static List<io.fabric8.kubernetes.api.model.HasMetadata> loadResources(File manifest)
                                                                       throws IOException

Throws:

IOException

getBuildStatusPhase

public static String getBuildStatusPhase(io.fabric8.openshift.api.model.Build build)

printLogsAsync

public static void printLogsAsync(io.fabric8.kubernetes.client.dsl.LogWatch logWatcher,
                                  String failureMessage,
                                  CountDownLatch terminateLatch,
                                  KitLogger log)

getBuildStatusReason

public static String getBuildStatusReason(io.fabric8.openshift.api.model.Build build)

withSelector

public static io.fabric8.kubernetes.client.dsl.FilterWatchListDeletable<io.fabric8.kubernetes.api.model.Pod,io.fabric8.kubernetes.api.model.PodList> withSelector(io.fabric8.kubernetes.client.dsl.NonNamespaceOperation<io.fabric8.kubernetes.api.model.Pod,io.fabric8.kubernetes.api.model.PodList,io.fabric8.kubernetes.client.dsl.PodResource<io.fabric8.kubernetes.api.model.Pod>> pods,
                                                                                                                                                                  io.fabric8.kubernetes.api.model.LabelSelector selector,
                                                                                                                                                                  KitLogger log)

extractPodLabelSelector

public static io.fabric8.kubernetes.api.model.LabelSelector extractPodLabelSelector(Collection<io.fabric8.kubernetes.api.model.HasMetadata> entities)

extractPodLabelSelector

public static io.fabric8.kubernetes.api.model.LabelSelector extractPodLabelSelector(io.fabric8.kubernetes.api.model.HasMetadata entity)

isNewerResource

public static boolean isNewerResource(io.fabric8.kubernetes.api.model.HasMetadata newer,
                                      io.fabric8.kubernetes.api.model.HasMetadata older)

getCreationTimestamp

public static Date getCreationTimestamp(io.fabric8.kubernetes.api.model.HasMetadata hasMetadata)

parseDate

public static Date parseDate(String text)

getNewestPod

public static io.fabric8.kubernetes.api.model.Pod getNewestPod(Collection<io.fabric8.kubernetes.api.model.Pod> pods)

convertToEnvVarList

public static List<io.fabric8.kubernetes.api.model.EnvVar> convertToEnvVarList(Map<String,String> envVars)

Convert a map of env vars to a list of K8s EnvVar objects.

Parameters:

envVars - the name-value map containing env vars

Returns:

list of converted env vars

setEnvVar

public static boolean setEnvVar(List<io.fabric8.kubernetes.api.model.EnvVar> envVarList,
                                String name,
                                String value)

getEnvVar

public static String getEnvVar(List<io.fabric8.kubernetes.api.model.EnvVar> envVarList,
                               String name,
                               String defaultValue)

removeEnvVar

public static boolean removeEnvVar(List<io.fabric8.kubernetes.api.model.EnvVar> envVarList,
                                   String name)

getResourceFragmentFromSource

public static File getResourceFragmentFromSource(File resourceDirFinal,
                                                 List<String> remotes,
                                                 String resourceNameSuffix,
                                                 KitLogger log)

Get a specific resource fragment ending with some suffix in a specified directory

Parameters:

resourceDirFinal - resource directory

remotes - list remote fragments if provided

resourceNameSuffix - resource name suffix

log - log object

Returns:

file if present or null

getQuantityFromString

public static Map<String,io.fabric8.kubernetes.api.model.Quantity> getQuantityFromString(Map<String,String> quantity)

Get requests or limit objects from string hashmaps

Parameters:

quantity - hashmap of strings

Returns:

hashmap of string to quantity

listResourceFragments

public static File[] listResourceFragments(File localResourceDir,
                                           List<String> remotes,
                                           KitLogger log)

listResourceFragments

public static File[] listResourceFragments(File resourceDir)

getFullyQualifiedApiGroupWithKind

public static String getFullyQualifiedApiGroupWithKind(io.fabric8.kubernetes.client.dsl.base.CustomResourceDefinitionContext crdContext)

getNewestApplicationPodName

public static String getNewestApplicationPodName(io.fabric8.kubernetes.client.KubernetesClient client,
                                                 String namespace,
                                                 Collection<io.fabric8.kubernetes.api.model.HasMetadata> resources)

isExposeService

public static boolean isExposeService(io.fabric8.kubernetes.api.model.Service service)

getServiceExposeUrl

public static String getServiceExposeUrl(io.fabric8.kubernetes.client.KubernetesClient kubernetes,
                                         Collection<io.fabric8.kubernetes.api.model.HasMetadata> resources,
                                         long serviceUrlWaitTimeSeconds,
                                         String exposeServiceAnnotationKey)
                                  throws InterruptedException

Throws:

InterruptedException

getAnnotationValue

public static String getAnnotationValue(io.fabric8.kubernetes.api.model.HasMetadata item,
                                        String annotationKey)

containsPort

public static boolean containsPort(List<io.fabric8.kubernetes.api.model.ContainerPort> ports,
                                   String portValue)

addPort

public static io.fabric8.kubernetes.api.model.ContainerPort addPort(String portNumberText,
                                                                    String portName,
                                                                    KitLogger log)

isControllerResource

public static boolean isControllerResource(io.fabric8.kubernetes.api.model.HasMetadata h)

getCrdContext

public static io.fabric8.kubernetes.client.dsl.base.CustomResourceDefinitionContext getCrdContext(io.fabric8.kubernetes.api.model.apiextensions.v1beta1.CustomResourceDefinitionList customResourceDefinitionList,
                                                                                                  GenericCustomResource customResource)

convertMapToHTTPHeaderList

public static List<io.fabric8.kubernetes.api.model.HTTPHeader> convertMapToHTTPHeaderList(Map<String,String> headers)