io.fabric8.maven.core.util

Class KubernetesResourceUtil

java.lang.Object

io.fabric8.maven.core.util.KubernetesResourceUtil

public class KubernetesResourceUtil
extends Object

Utility class for handling Kubernetes resource descriptors

Since:

02/05/16

Author:

roland

Field Summary

Fields

Modifier and Type	Field and Description
static String	API_APPS_VERSION
static String	API_EXTENSIONS_VERSION
static String	API_VERSION
protected static String	DATE_TIME_FORMAT
static ResourceVersioning	DEFAULT_RESOURCE_VERSIONING
static HashSet<Class<?>>	SIMPLE_FIELD_TYPES

Constructor Summary

Constructors

Constructor and Description
KubernetesResourceUtil()

Method Summary

Modifier and Type	Method and Description
static boolean	addPort(List<io.fabric8.kubernetes.api.model.ContainerPort> ports, String portNumberText, String portName, io.fabric8.maven.docker.util.Logger log)
static boolean	checkForKind(io.fabric8.kubernetes.api.model.KubernetesListBuilder builder, String... kinds)
static String	extractContainerName(org.apache.maven.project.MavenProject project, io.fabric8.maven.docker.config.ImageConfiguration imageConfig)
static <T> T	findResourceByName(Iterable<io.fabric8.kubernetes.api.model.HasMetadata> entities, Class<T> clazz, String name) Returns the resource of the given kind and name from the collection or null
static String	getBuildStatusPhase(io.fabric8.openshift.api.model.Build build)
static String	getBuildStatusReason(io.fabric8.openshift.api.model.Build build)
static Date	getCreationTimestamp(io.fabric8.kubernetes.api.model.HasMetadata hasMetadata)
static String	getDockerContainerID(io.fabric8.kubernetes.api.model.Pod pod)
static String	getEnvVar(List<io.fabric8.kubernetes.api.model.EnvVar> envVarList, String name, String defaultValue)
static String	getNameWithSuffix(String name, String kind)
static io.fabric8.kubernetes.api.model.Pod	getNewestPod(Collection<io.fabric8.kubernetes.api.model.Pod> pods)
static io.fabric8.kubernetes.api.model.LabelSelector	getPodLabelSelector(io.fabric8.kubernetes.api.model.HasMetadata entity)
static io.fabric8.kubernetes.api.model.LabelSelector	getPodLabelSelector(Set<io.fabric8.kubernetes.api.model.HasMetadata> entities)
static io.fabric8.kubernetes.api.model.HasMetadata	getResource(ResourceVersioning apiVersions, File file, String appName) Read a Kubernetes resource fragment and add meta information extracted from the filename to the resource descriptor.
static String	getSourceUrlAnnotation(io.fabric8.kubernetes.api.model.HasMetadata item)
static void	handleKubernetesClientException(io.fabric8.kubernetes.client.KubernetesClientException e, io.fabric8.maven.docker.util.Logger logger)
static boolean	isAppCatalogResource(io.fabric8.kubernetes.api.model.HasMetadata templateOrConfigMap)
static boolean	isNewerResource(io.fabric8.kubernetes.api.model.HasMetadata newer, io.fabric8.kubernetes.api.model.HasMetadata older)
static File[]	listResourceFragments(File resourceDir)
static Set<io.fabric8.kubernetes.api.model.HasMetadata>	loadResources(File manifest)
static void	mergePodSpec(io.fabric8.kubernetes.api.model.PodSpecBuilder builder, io.fabric8.kubernetes.api.model.PodSpec defaultPodSpec, String defaultName)
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 Date	parseDate(String text)
static boolean	podHasContainerImage(io.fabric8.kubernetes.api.model.Pod pod, String imageName)
static io.fabric8.kubernetes.api.model.KubernetesListBuilder	readResourceFragmentsFrom(ResourceVersioning apiVersions, String defaultName, File[] resourceFiles) Read all Kubernetes resource fragments from a directory and create a KubernetesListBuilder which can be adapted later.
static Map<String,String>	removeVersionSelector(Map<String,String> selector)
static boolean	setEnvVar(List<io.fabric8.kubernetes.api.model.EnvVar> envVarList, String name, String value)
static io.fabric8.kubernetes.api.model.EnvVar	setEnvVarNoOverride(List<io.fabric8.kubernetes.api.model.EnvVar> envVarList, String name, String value) Try to set an environment variable in the list or return the old value if present and different from the current one.
static void	setSourceUrlAnnotationIfNotSet(io.fabric8.kubernetes.api.model.HasMetadata item, String sourceUrl)
static String	toJson(Object resource)
static String	toYaml(Object resource)
static void	validateKubernetesMasterUrl(URL masterUrl)
static File	writeResource(Object resource, File target, ResourceFileType resourceFileType)
static File	writeResourceFile(Object resource, File outputFile, ResourceFileType resourceFileType)

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

API_EXTENSIONS_VERSION

public static final String API_EXTENSIONS_VERSION

See Also:

Constant Field Values

API_APPS_VERSION

public static final String API_APPS_VERSION

See Also:

Constant Field Values

DEFAULT_RESOURCE_VERSIONING

public static final ResourceVersioning DEFAULT_RESOURCE_VERSIONING

SIMPLE_FIELD_TYPES

public static final HashSet<Class<?>> SIMPLE_FIELD_TYPES

DATE_TIME_FORMAT

protected static final String DATE_TIME_FORMAT

See Also:

Constant Field Values

Constructor Detail

KubernetesResourceUtil

public KubernetesResourceUtil()

Method Detail

readResourceFragmentsFrom

public static io.fabric8.kubernetes.api.model.KubernetesListBuilder readResourceFragmentsFrom(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:

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

getResource

public static io.fabric8.kubernetes.api.model.HasMetadata getResource(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:

apiVersions - the API versions to add if not given.

file - file to read, whose name must match FILENAME_PATTERN. @return map holding the fragment

appName - resource name specifying resources belonging to this application

Throws:

IOException

toYaml

public static String toYaml(Object resource)
                     throws com.fasterxml.jackson.core.JsonProcessingException

Throws:

com.fasterxml.jackson.core.JsonProcessingException

toJson

public static String toJson(Object resource)
                     throws com.fasterxml.jackson.core.JsonProcessingException

Throws:

com.fasterxml.jackson.core.JsonProcessingException

writeResource

public static File writeResource(Object resource,
                                 File target,
                                 ResourceFileType resourceFileType)
                          throws IOException

Throws:

IOException

writeResourceFile

public static File writeResourceFile(Object resource,
                                     File outputFile,
                                     ResourceFileType resourceFileType)
                              throws IOException

Throws:

IOException

listResourceFragments

public static File[] listResourceFragments(File resourceDir)

getNameWithSuffix

public static String getNameWithSuffix(String name,
                                       String kind)

extractContainerName

public static String extractContainerName(org.apache.maven.project.MavenProject project,
                                          io.fabric8.maven.docker.config.ImageConfiguration imageConfig)

removeVersionSelector

public static Map<String,String> removeVersionSelector(Map<String,String> selector)

checkForKind

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

addPort

public static boolean addPort(List<io.fabric8.kubernetes.api.model.ContainerPort> ports,
                              String portNumberText,
                              String portName,
                              io.fabric8.maven.docker.util.Logger log)

setEnvVarNoOverride

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

Try to set an environment variable in the list or return the old value if present and different from the current one. Environment variables will not be overridden.

Parameters:

envVarList - the list of environment variables

name - the environment variable

value - the value to set

Returns:

the old value, if present, or null

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)

validateKubernetesMasterUrl

public static void validateKubernetesMasterUrl(URL masterUrl)
                                        throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

handleKubernetesClientException

public static void handleKubernetesClientException(io.fabric8.kubernetes.client.KubernetesClientException e,
                                                   io.fabric8.maven.docker.util.Logger logger)
                                            throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

findResourceByName

public static <T> T findResourceByName(Iterable<io.fabric8.kubernetes.api.model.HasMetadata> entities,
                                       Class<T> clazz,
                                       String name)

Returns the resource of the given kind and name from the collection or null

getBuildStatusPhase

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

getBuildStatusReason

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

getNewestPod

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

getCreationTimestamp

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

parseDate

public static Date parseDate(String text)

podHasContainerImage

public static boolean podHasContainerImage(io.fabric8.kubernetes.api.model.Pod pod,
                                           String imageName)

getDockerContainerID

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

isNewerResource

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

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 -

defaultValues -

mergePodSpec

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

getSourceUrlAnnotation

public static String getSourceUrlAnnotation(io.fabric8.kubernetes.api.model.HasMetadata item)

setSourceUrlAnnotationIfNotSet

public static void setSourceUrlAnnotationIfNotSet(io.fabric8.kubernetes.api.model.HasMetadata item,
                                                  String sourceUrl)

isAppCatalogResource

public static boolean isAppCatalogResource(io.fabric8.kubernetes.api.model.HasMetadata templateOrConfigMap)

loadResources

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

Throws:

IOException

getPodLabelSelector

public static io.fabric8.kubernetes.api.model.LabelSelector getPodLabelSelector(Set<io.fabric8.kubernetes.api.model.HasMetadata> entities)

getPodLabelSelector

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