druid/docs/development/extensions-core/kubernetes.md

4.0 KiB

id title
druid-kubernetes Kubernetes

Consider this an EXPERIMENTAL feature mostly because it has not been tested yet on a wide variety of long running Druid clusters.

Apache Druid Extension to enable using Kubernetes API Server for node discovery and leader election. This extension allows Druid cluster deployment on Kubernetes without Zookeeper. It allows running multiple Druid clusters within same Kubernetes Cluster, See clusterIdentifier config below.

Configuration

To use this extension please make sure to include druid-kubernetes-extensions as an extension.

This extension works together with HTTP based segment and task management in Druid. Consequently, following configurations must be set on all Druid nodes.

druid.zk.service.enabled=false druid.serverview.type=http druid.coordinator.loadqueuepeon.type=http druid.indexer.runner.type=httpRemote druid.discovery.type=k8s

For Node Discovery, Each Druid process running inside a pod "announces" itself by adding few "labels" and "annotations" in the pod spec. So, to add those...

  • Druid process needs to be aware of pod name and namespace which it reads from environment variables POD_NAME and POD_NAMESPACE. These variable names can be changed, see configuration below. But in the end, each pod needs to have pod name and namespace added as environment variables.
  • Label/Annotation path in the pod spec must exist, which is easily satisfied if there is at least one label/annotation in the pod spec already. This limitation may be removed in future.

Additionally, this extension has following configuration.

Properties

Property Possible Values Description Default required
druid.discovery.k8s.clusterIdentifier string that matches [a-z0-9][a-z0-9-]*[a-z0-9] Unique identifier for this Druid cluster in Kubernetes e.g. us-west-prod-druid. None Yes
druid.discovery.k8s.podNameEnvKey Pod Env Variable Pod Env variable whose value is that pod's name. POD_NAME No
druid.discovery.k8s.podNamespaceEnvKey Pod Env Variable Pod Env variable whose value is that pod's kubernetes namespace. POD_NAMESPACE No
druid.discovery.k8s.coordinatorLeaderElectionConfigMapNamespace k8s namespace Leader election algorithm requires creating a ConfigMap resource in a namespace. This MUST only be provided if different coordinator pods run in different namespaces, such setup is discouraged however. coordinator pod's namespace No
druid.discovery.k8s.overlordLeaderElectionConfigMapNamespace k8s namespace Leader election algorithm requires creating a ConfigMap resource in a namespace. This MUST only be provided if different overlord pods run in different namespaces, such setup is discouraged however. overlord pod's namespace No
druid.discovery.k8s.leaseDuration Duration Lease duration used by Leader Election algorithm. Candidates wait for this time before taking over previous Leader. PT60S No
druid.discovery.k8s.renewDeadline Duration Lease renewal period used by Leader. PT17S No
druid.discovery.k8s.retryPeriod Duration Retry wait used by Leader Election algorithm on failed operations. PT5S No