org.apache.camel.component.kubernetes.cluster

Class KubernetesClusterService

java.lang.Object

org.apache.camel.support.ServiceSupport

org.apache.camel.impl.cluster.AbstractCamelClusterService<KubernetesClusterView>

org.apache.camel.component.kubernetes.cluster.KubernetesClusterService

All Implemented Interfaces:

org.apache.camel.CamelContextAware, org.apache.camel.cluster.CamelClusterService, org.apache.camel.Ordered, org.apache.camel.Service, org.apache.camel.ShutdownableService, org.apache.camel.spi.HasId, org.apache.camel.spi.IdAware, org.apache.camel.StatefulService, org.apache.camel.SuspendableService

public class KubernetesClusterService
extends org.apache.camel.impl.cluster.AbstractCamelClusterService<KubernetesClusterView>

A Kubernetes based cluster service leveraging Kubernetes optimistic locks on resources (specifically ConfigMaps).

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.camel.cluster.CamelClusterService

org.apache.camel.cluster.CamelClusterService.Selector

Field Summary

Fields inherited from class org.apache.camel.support.ServiceSupport

shutdown, shuttingdown, started, starting, stopped, stopping, suspended, suspending

Fields inherited from interface org.apache.camel.Ordered

HIGHEST, LOWEST

Constructor Summary

Constructors

Constructor and Description
KubernetesClusterService()
KubernetesClusterService(org.apache.camel.CamelContext camelContext, KubernetesConfiguration configuration)
KubernetesClusterService(KubernetesConfiguration configuration)

Method Summary

Modifier and Type	Method and Description
void	addToClusterLabels(String key, String value)
protected KubernetesClusterView	createView(String namespace)
Map<String,String>	getClusterLabels()
String	getConfigMapName()
Integer	getConnectionTimeoutMillis()
double	getJitterFactor()
String	getKubernetesNamespace()
long	getLeaseDurationMillis()
String	getMasterUrl()
String	getPodName()
long	getRenewDeadlineMillis()
long	getRetryPeriodMillis()
protected KubernetesLockConfiguration	lockConfigWithGroupNameAndDefaults(String groupName)
void	setClusterLabels(Map<String,String> clusterLabels) Set the labels used to identify the pods composing the cluster.
protected KubernetesConfiguration	setConfigDefaults(KubernetesConfiguration configuration, KubernetesLockConfiguration lockConfiguration)
void	setConfigMapName(String configMapName) Set the name of the ConfigMap used to do optimistic locking (defaults to 'leaders').
void	setConnectionTimeoutMillis(Integer connectionTimeout) Connection timeout in milliseconds to use when making requests to the Kubernetes API server.
void	setJitterFactor(double jitterFactor) A jitter factor to apply in order to prevent all pods to call Kubernetes APIs in the same instant.
void	setKubernetesNamespace(String kubernetesNamespace) Set the name of the Kubernetes namespace containing the pods and the configmap (autodetected by default)
void	setLeaseDurationMillis(long leaseDurationMillis) The default duration of the lease for the current leader.
void	setMasterUrl(String masterUrl) Set the URL of the Kubernetes master (read from Kubernetes client properties by default).
void	setPodName(String podName) Set the name of the current pod (autodetected from container host name by default).
void	setRenewDeadlineMillis(long renewDeadlineMillis) The deadline after which the leader must stop its services because it may have lost the leadership.
void	setRetryPeriodMillis(long retryPeriodMillis) The time between two subsequent attempts to check and acquire the leadership.

Methods inherited from class org.apache.camel.impl.cluster.AbstractCamelClusterService

doStart, doStop, getAttributes, getCamelContext, getId, getNamespaces, getOrder, getView, isLeader, releaseView, setAttribute, setAttributes, setCamelContext, setId, setOrder, startView, stopView

Methods inherited from class org.apache.camel.support.ServiceSupport

doResume, doShutdown, doSuspend, getStatus, getVersion, isRunAllowed, isStarted, isStarting, isStopped, isStopping, isStoppingOrStopped, isSuspended, isSuspending, isSuspendingOrSuspended, resume, shutdown, start, stop, suspend

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.camel.cluster.CamelClusterService

unwrap

Methods inherited from interface org.apache.camel.Service

start, stop

Constructor Detail

KubernetesClusterService

public KubernetesClusterService()

KubernetesClusterService

public KubernetesClusterService(KubernetesConfiguration configuration)

KubernetesClusterService

public KubernetesClusterService(org.apache.camel.CamelContext camelContext,
                                KubernetesConfiguration configuration)

Method Detail

createView

protected KubernetesClusterView createView(String namespace)
                                    throws Exception

Specified by:

createView in class org.apache.camel.impl.cluster.AbstractCamelClusterService<KubernetesClusterView>

Throws:

Exception

setConfigDefaults

protected KubernetesConfiguration setConfigDefaults(KubernetesConfiguration configuration,
                                                    KubernetesLockConfiguration lockConfiguration)

lockConfigWithGroupNameAndDefaults

protected KubernetesLockConfiguration lockConfigWithGroupNameAndDefaults(String groupName)

getMasterUrl

public String getMasterUrl()

setMasterUrl

public void setMasterUrl(String masterUrl)

Set the URL of the Kubernetes master (read from Kubernetes client properties by default).

getConnectionTimeoutMillis

public Integer getConnectionTimeoutMillis()

setConnectionTimeoutMillis

public void setConnectionTimeoutMillis(Integer connectionTimeout)

Connection timeout in milliseconds to use when making requests to the Kubernetes API server.

getKubernetesNamespace

public String getKubernetesNamespace()

setKubernetesNamespace

public void setKubernetesNamespace(String kubernetesNamespace)

Set the name of the Kubernetes namespace containing the pods and the configmap (autodetected by default)

getConfigMapName

public String getConfigMapName()

setConfigMapName

public void setConfigMapName(String configMapName)

Set the name of the ConfigMap used to do optimistic locking (defaults to 'leaders').

getPodName

public String getPodName()

setPodName

public void setPodName(String podName)

Set the name of the current pod (autodetected from container host name by default).

getClusterLabels

public Map<String,String> getClusterLabels()

setClusterLabels

public void setClusterLabels(Map<String,String> clusterLabels)

Set the labels used to identify the pods composing the cluster.

addToClusterLabels

public void addToClusterLabels(String key,
                               String value)

getJitterFactor

public double getJitterFactor()

setJitterFactor

public void setJitterFactor(double jitterFactor)

A jitter factor to apply in order to prevent all pods to call Kubernetes APIs in the same instant.

getLeaseDurationMillis

public long getLeaseDurationMillis()

setLeaseDurationMillis

public void setLeaseDurationMillis(long leaseDurationMillis)

The default duration of the lease for the current leader.

getRenewDeadlineMillis

public long getRenewDeadlineMillis()

setRenewDeadlineMillis

public void setRenewDeadlineMillis(long renewDeadlineMillis)

The deadline after which the leader must stop its services because it may have lost the leadership.

getRetryPeriodMillis

public long getRetryPeriodMillis()

setRetryPeriodMillis

public void setRetryPeriodMillis(long retryPeriodMillis)

The time between two subsequent attempts to check and acquire the leadership. It is randomized using the jitter factor.