io.fabric8.kubernetes.api

Class KubernetesHelper

java.lang.Object

io.fabric8.kubernetes.api.KubernetesHelper

public class KubernetesHelper
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_DOCKER_HOST

Constructor Summary

Constructors

Constructor and Description
KubernetesHelper()

Method Summary

Methods

Modifier and Type	Method and Description
protected static void	addObjectsToItemArray(com.fasterxml.jackson.databind.node.ArrayNode itemArray, Object object)
static com.fasterxml.jackson.databind.JsonNode	combineJson(Object... objects) Combines the JSON objects into a config object
static String	containerNameToPodId(String containerName) Returns the pod id for the given container id
protected static com.fasterxml.jackson.databind.node.JsonNodeFactory	createNodeFactory()
static io.fabric8.utils.Filter<Pod>	createPodAnnotationFilter(Map<String,String> annotationSelector) Creates a filter on a pod annotations using the given set of attribute values
static io.fabric8.utils.Filter<Pod>	createPodFilter(Map<String,String> labelSelector) Creates a filter on a pod using the given set of labels
static io.fabric8.utils.Filter<Pod>	createPodFilter(String textFilter) Creates a filter on a pod using the given text string
static io.fabric8.utils.Filter<ReplicationController>	createReplicationControllerFilter(Map<String,String> labelSelector) Creates a filter on a replicationController using the given text string
static io.fabric8.utils.Filter<ReplicationController>	createReplicationControllerFilter(String textFilter) Creates a filter on a replicationController using the given text string
static io.fabric8.utils.Filter<Service>	createServiceFilter(Map<String,String> labelSelector) Creates a filter on a service using the given text string
static io.fabric8.utils.Filter<Service>	createServiceFilter(String textFilter) Creates a filter on a service using the given text string
static boolean	filterLabels(Map<String,String> filterLabels, Map<String,String> labels) Returns true if the given filterLabels matches the actual labels
static boolean	filterMatchesIdOrLabels(String textFilter, String id, Map<String,String> labels) Returns true if the given textFilter matches either the id or the labels
static Port	findContainerPort(Pod pod, Integer portNumber) Returns the port for the given port number on the pod
static Port	findContainerPortByName(Pod pod, String name) Returns the port for the given port name
static Port	findContainerPortByNumberOrName(Pod pod, String numberOrName) Returns the port for the given port number or name
protected static com.fasterxml.jackson.databind.JsonNode	findOrCreateConfig(Object[] objects)
protected static Object	getAdditionalProperty(Map<String,Object> additionalProperties, String name)
protected static String	getAdditionalPropertyText(Map<String,Object> additionalProperties, String name)
static int	getContainerPort(Service service) Returns the container port number for the given service
static List<Container>	getContainers(ContainerManifest manifest)
static List<Container>	getContainers(Pod pod) Returns all the containers from the given pod
static List<Container>	getContainers(PodState desiredState) Returns all the manifest containers from the given desiredState
static List<Container>	getContainers(PodTemplate podTemplate)
static List<Container>	getContainers(ReplicationController replicationController) Returns all the containers from the given Replication Controller
static List<Container>	getContainers(ReplicationControllerState desiredState) Returns all the containers from the given Replication Controller's desiredState
static Map<String,ContainerStatus>	getCurrentContainers(Pod pod) Returns all the current containers from the given currentState
static Map<String,ContainerStatus>	getCurrentContainers(PodState currentState) Returns all the current containers from the given currentState
static List<Container>	getCurrentContainers(ReplicationController replicationController) Returns all the containers from the given Replication Controller
static String	getDockerIp()
static List<Object>	getEntities(Config config) Returns the items inside the config as a list of Entity objects
static Object	getEntity(com.fasterxml.jackson.databind.JsonNode item) Loads the entity for the given item
static String	getHost(Pod pod) Returns the host of the pod
static String	getId(Pod entity)
static String	getId(ReplicationController entity)
static String	getId(Service entity)
static String	getName(Service entity)
static Map<String,Pod>	getPodMap(Kubernetes kubernetes)
static Map<String,Pod>	getPodMap(Kubernetes kubernetes, String selector)
static List<Pod>	getPodsForReplicationController(ReplicationController replicationController, Iterable<Pod> pods) Returns the pods for the given replication controller
static List<Pod>	getPodsForService(Service service, Iterable<Pod> pods) Returns the pods for the given service
static PodState	getPodState(ReplicationController replicationController)
static PodState	getPodState(ReplicationControllerState desiredState)
static PodStatus	getPodStatus(Pod pod)
static String	getPodStatusText(Pod pod)
static Integer	getPort(Service entity)
static String	getPortalIP(Service entity)
static Map<String,ReplicationController>	getReplicationControllerMap(Kubernetes kubernetes)
static Map<String,ReplicationController>	getReplicationControllerMap(Kubernetes kubernetes, String selector)
static Map<String,String>	getSelector(Service entity)
static Map<String,Service>	getServiceMap(Kubernetes kubernetes)
static String	getServiceURL(Service service) Returns the URL to access the service; using the service portalIP and port
static boolean	isPodRunning(Pod pod) Returns true if the pod is running
protected static Config	loadConfig(byte[] data)
protected static Object	loadEntity(byte[] json, String kind, Object defaultValue)
static Object	loadJson(byte[] json) Returns the given json data as a DTO such as Pod, ReplicationController or Service from the Kubernetes REST API or JsonNode if it cannot be recognised.
static Object	loadJson(File file) Returns the given json data as a DTO such as Pod, ReplicationController or Service from the Kubernetes REST API or JsonNode if it cannot be recognised.
static Object	loadJson(InputStream in) Returns the given json data as a DTO such as Pod, ReplicationController or Service from the Kubernetes REST API or JsonNode if it cannot be recognised.
static Object	loadJson(String json)
static void	removeEmptyPods(PodList podSchema) Removes empty pods returned by Kubernetes
static String	resolveDockerHost()
static void	saveJson(File json, Object object) Saves the json object to the given file
static String	toJson(Object dto)
static com.fasterxml.jackson.databind.JsonNode	toJsonNode(Object object) Converts the DTO to a JsonNode
static Map<String,String>	toLabelsMap(String labels)
static String	toLabelsString(Map<String,String> labelMap) Returns a string for the labels using "," to separate values
protected static Integer	toOptionalNumber(String text) Returns the number if it can be parsed or null
static Map<String,Pod>	toPodMap(List<Pod> pods) Returns a map indexed by pod id of the pods
static Map<String,Pod>	toPodMap(PodList podSchema) Returns a map indexed by pod id of the pods
static Map<String,Pod>	toPodMap(PodList podSchema, String selector) Returns a map indexed by pod id of the pods
static String	toPositiveNonZeroText(Integer port) For positive non-zero values return the text of the number or return blank
static Map<String,ReplicationController>	toReplicationControllerMap(List<ReplicationController> replicationControllers) Returns a map indexed by replicationController id of the replicationControllers
static Map<String,ReplicationController>	toReplicationControllerMap(ReplicationControllerList replicationControllerSchema) Returns a map indexed by replicationController id of the replicationControllers
static Map<String,Service>	toServiceMap(List<Service> services) Returns a map indexed by service id of the services
static Map<String,Service>	toServiceMap(ServiceList serviceSchema) Returns a map indexed by service id of the services

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_DOCKER_HOST

public static final String DEFAULT_DOCKER_HOST

See Also:

Constant Field Values

Constructor Detail

KubernetesHelper

public KubernetesHelper()

Method Detail

getId

public static String getId(Pod entity)

getId

public static String getId(ReplicationController entity)

getId

public static String getId(Service entity)

getName

public static String getName(Service entity)

getPortalIP

public static String getPortalIP(Service entity)

getSelector

public static Map<String,String> getSelector(Service entity)

getPort

public static Integer getPort(Service entity)

getAdditionalProperty

protected static Object getAdditionalProperty(Map<String,Object> additionalProperties,
                           String name)

getAdditionalPropertyText

protected static String getAdditionalPropertyText(Map<String,Object> additionalProperties,
                               String name)

getDockerIp

public static String getDockerIp()

resolveDockerHost

public static String resolveDockerHost()

toJson

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

Throws:

com.fasterxml.jackson.core.JsonProcessingException

loadJson

public static Object loadJson(File file)
                       throws IOException

Returns the given json data as a DTO such as Pod, ReplicationController or Service from the Kubernetes REST API or JsonNode if it cannot be recognised.

Throws:

IOException

loadJson

public static Object loadJson(InputStream in)
                       throws IOException

Returns the given json data as a DTO such as Pod, ReplicationController or Service from the Kubernetes REST API or JsonNode if it cannot be recognised.

Throws:

IOException

loadJson

public static Object loadJson(String json)
                       throws IOException

Throws:

IOException

loadJson

public static Object loadJson(byte[] json)
                       throws IOException

Returns the given json data as a DTO such as Pod, ReplicationController or Service from the Kubernetes REST API or JsonNode if it cannot be recognised.

Throws:

IOException

loadEntity

protected static Object loadEntity(byte[] json,
                String kind,
                Object defaultValue)
                            throws IOException

Throws:

IOException

loadConfig

protected static Config loadConfig(byte[] data)
                            throws IOException

Throws:

IOException

getEntity

public static Object getEntity(com.fasterxml.jackson.databind.JsonNode item)
                        throws IOException

Loads the entity for the given item

Throws:

IOException

getEntities

public static List<Object> getEntities(Config config)
                                throws IOException

Returns the items inside the config as a list of Entity objects

Throws:

IOException

saveJson

public static void saveJson(File json,
            Object object)
                     throws IOException

Saves the json object to the given file

Throws:

IOException

toPodMap

public static Map<String,Pod> toPodMap(PodList podSchema)

Returns a map indexed by pod id of the pods

toPodMap

public static Map<String,Pod> toPodMap(PodList podSchema,
                       String selector)

Returns a map indexed by pod id of the pods

toPodMap

public static Map<String,Pod> toPodMap(List<Pod> pods)

Returns a map indexed by pod id of the pods

toServiceMap

public static Map<String,Service> toServiceMap(ServiceList serviceSchema)

Returns a map indexed by service id of the services

toServiceMap

public static Map<String,Service> toServiceMap(List<Service> services)

Returns a map indexed by service id of the services

toReplicationControllerMap

public static Map<String,ReplicationController> toReplicationControllerMap(ReplicationControllerList replicationControllerSchema)

Returns a map indexed by replicationController id of the replicationControllers

toReplicationControllerMap

public static Map<String,ReplicationController> toReplicationControllerMap(List<ReplicationController> replicationControllers)

Returns a map indexed by replicationController id of the replicationControllers

getPodMap

public static Map<String,Pod> getPodMap(Kubernetes kubernetes)

getPodMap

public static Map<String,Pod> getPodMap(Kubernetes kubernetes,
                        String selector)

getServiceMap

public static Map<String,Service> getServiceMap(Kubernetes kubernetes)

getReplicationControllerMap

public static Map<String,ReplicationController> getReplicationControllerMap(Kubernetes kubernetes)

getReplicationControllerMap

public static Map<String,ReplicationController> getReplicationControllerMap(Kubernetes kubernetes,
                                                            String selector)

removeEmptyPods

public static void removeEmptyPods(PodList podSchema)

Removes empty pods returned by Kubernetes

containerNameToPodId

public static String containerNameToPodId(String containerName)

Returns the pod id for the given container id

toLabelsString

public static String toLabelsString(Map<String,String> labelMap)

Returns a string for the labels using "," to separate values

toLabelsMap

public static Map<String,String> toLabelsMap(String labels)

createPodFilter

public static io.fabric8.utils.Filter<Pod> createPodFilter(String textFilter)

Creates a filter on a pod using the given text string

createPodFilter

public static io.fabric8.utils.Filter<Pod> createPodFilter(Map<String,String> labelSelector)

Creates a filter on a pod using the given set of labels

createPodAnnotationFilter

public static io.fabric8.utils.Filter<Pod> createPodAnnotationFilter(Map<String,String> annotationSelector)

Creates a filter on a pod annotations using the given set of attribute values

createServiceFilter

public static io.fabric8.utils.Filter<Service> createServiceFilter(String textFilter)

Creates a filter on a service using the given text string

createServiceFilter

public static io.fabric8.utils.Filter<Service> createServiceFilter(Map<String,String> labelSelector)

Creates a filter on a service using the given text string

createReplicationControllerFilter

public static io.fabric8.utils.Filter<ReplicationController> createReplicationControllerFilter(String textFilter)

Creates a filter on a replicationController using the given text string

createReplicationControllerFilter

public static io.fabric8.utils.Filter<ReplicationController> createReplicationControllerFilter(Map<String,String> labelSelector)

Creates a filter on a replicationController using the given text string

filterMatchesIdOrLabels

public static boolean filterMatchesIdOrLabels(String textFilter,
                              String id,
                              Map<String,String> labels)

Returns true if the given textFilter matches either the id or the labels

filterLabels

public static boolean filterLabels(Map<String,String> filterLabels,
                   Map<String,String> labels)

Returns true if the given filterLabels matches the actual labels

toPositiveNonZeroText

public static String toPositiveNonZeroText(Integer port)

For positive non-zero values return the text of the number or return blank

getContainers

public static List<Container> getContainers(Pod pod)

Returns all the containers from the given pod

getContainers

public static List<Container> getContainers(ReplicationController replicationController)

Returns all the containers from the given Replication Controller

getContainers

public static List<Container> getContainers(ReplicationControllerState desiredState)

Returns all the containers from the given Replication Controller's desiredState

getContainers

public static List<Container> getContainers(PodTemplate podTemplate)

getContainers

public static List<Container> getContainers(ContainerManifest manifest)

getCurrentContainers

public static List<Container> getCurrentContainers(ReplicationController replicationController)

Returns all the containers from the given Replication Controller

getContainers

public static List<Container> getContainers(PodState desiredState)

Returns all the manifest containers from the given desiredState

getCurrentContainers

public static Map<String,ContainerStatus> getCurrentContainers(Pod pod)

Returns all the current containers from the given currentState

getCurrentContainers

public static Map<String,ContainerStatus> getCurrentContainers(PodState currentState)

Returns all the current containers from the given currentState

getHost

public static String getHost(Pod pod)

Returns the host of the pod

getContainerPort

public static int getContainerPort(Service service)

Returns the container port number for the given service

combineJson

public static com.fasterxml.jackson.databind.JsonNode combineJson(Object... objects)
                                                           throws IOException

Combines the JSON objects into a config object

Throws:

IOException

addObjectsToItemArray

protected static void addObjectsToItemArray(com.fasterxml.jackson.databind.node.ArrayNode itemArray,
                         Object object)
                                     throws IOException

Throws:

IOException

createNodeFactory

protected static com.fasterxml.jackson.databind.node.JsonNodeFactory createNodeFactory()

findOrCreateConfig

protected static com.fasterxml.jackson.databind.JsonNode findOrCreateConfig(Object[] objects)

toJsonNode

public static com.fasterxml.jackson.databind.JsonNode toJsonNode(Object object)
                                                          throws IOException

Converts the DTO to a JsonNode

Throws:

IOException

getServiceURL

public static String getServiceURL(Service service)

Returns the URL to access the service; using the service portalIP and port

findContainerPort

public static Port findContainerPort(Pod pod,
                     Integer portNumber)

Returns the port for the given port number on the pod

findContainerPortByName

public static Port findContainerPortByName(Pod pod,
                           String name)

Returns the port for the given port name

findContainerPortByNumberOrName

public static Port findContainerPortByNumberOrName(Pod pod,
                                   String numberOrName)

Returns the port for the given port number or name

toOptionalNumber

protected static Integer toOptionalNumber(String text)

Returns the number if it can be parsed or null

getPodState

public static PodState getPodState(ReplicationController replicationController)

getPodState

public static PodState getPodState(ReplicationControllerState desiredState)

getPodStatus

public static PodStatus getPodStatus(Pod pod)

isPodRunning

public static boolean isPodRunning(Pod pod)

Returns true if the pod is running

getPodStatusText

public static String getPodStatusText(Pod pod)

getPodsForReplicationController

public static List<Pod> getPodsForReplicationController(ReplicationController replicationController,
                                        Iterable<Pod> pods)

Returns the pods for the given replication controller

getPodsForService

public static List<Pod> getPodsForService(Service service,
                          Iterable<Pod> pods)

Returns the pods for the given service