druid.md

Druid API reference

Packages:

• druid.apache.org/v1alpha1

druid.apache.org/v1alpha1

Resource Types:

AdditionalContainer

(Appears on: DruidNodeSpec, DruidSpec)

AdditionalContainer defines additional sidecar containers to be deployed with the Druid pods. (will be part of Kubernetes native in the future: https://github.com/kubernetes/enhancements/blob/master/keps/sig-node/753-sidecar-containers/README.md#summary).

Field	Description
runAsInit bool	(Optional) RunAsInit indicate whether this should be an init container.
image string	Image Image of the additional container.
containerName string	ContainerName name of the additional container.
command []string	Command command for the additional container.
imagePullPolicy Kubernetes core/v1.PullPolicy	(Optional) ImagePullPolicy If not present, will be taken from top level spec.
args []string	(Optional) Args Arguments to call the command.
securityContext Kubernetes core/v1.SecurityContext	(Optional) ContainerSecurityContext If not present, will be taken from top level pod.
resources Kubernetes core/v1.ResourceRequirements	(Optional) Resources Kubernetes Native resources specification.
volumeMounts []Kubernetes core/v1.VolumeMount	(Optional) VolumeMounts Kubernetes Native VolumeMount specification.
env []Kubernetes core/v1.EnvVar	(Optional) Env Environment variables for the additional container.
envFrom []Kubernetes core/v1.EnvFromSource	(Optional) EnvFrom Extra environment variables from remote source (ConfigMaps, Secrets…).

Auth

(Appears on: DruidIngestionSpec)

Field	Description
type AuthType
secretRef Kubernetes core/v1.SecretReference

AuthType (string alias)

(Appears on: Auth)

DeepStorageSpec

(Appears on: DruidSpec)

DeepStorageSpec IGNORED (Future API): In order to make Druid dependency setup extensible from within Druid operator.

Field	Description
type string
spec encoding/json.RawMessage

Druid

Druid is the Schema for the druids API.

Field	Description
metadata Kubernetes meta/v1.ObjectMeta	Refer to the Kubernetes API documentation for the fields of the metadata field.
spec DruidSpec	ignored bool (Optional) Ignored is now deprecated API. In order to avoid reconciliation of objects use the druid.apache.org/ignored: "true" annotation. common.runtime.properties string CommonRuntimeProperties Content fo the common.runtime.properties configuration file. extraCommonConfig []*k8s.io/api/core/v1.ObjectReference (Optional) ExtraCommonConfig References to ConfigMaps holding more configuration files to mount to the common configuration path. forceDeleteStsPodOnError bool (Optional) ForceDeleteStsPodOnError Delete the StatefulSet’s pods if the StatefulSet is set to ordered ready. issue: kubernetes/kubernetes#67250 doc: https://kubernetes.io/docs/concepts/workloads/controllers/statefulset/#forced-rollback scalePvcSts bool (Optional) ScalePvcSts When enabled, operator will allow volume expansion of StatefulSet’s PVCs. commonConfigMountPath string (Optional) CommonConfigMountPath In-container directory to mount the Druid common configuration disablePVCDeletionFinalizer bool (Optional) DisablePVCDeletionFinalizer Whether PVCs shall be deleted on the deletion of the Druid cluster. deleteOrphanPvc bool (Optional) DeleteOrphanPvc Orphaned (unmounted PVCs) shall be cleaned up by the operator. startScript string (Optional) StartScript Path to Druid’s start script to be run on start. image string (Optional) Image Required here or at the NodeSpec level. serviceAccount string (Optional) ServiceAccount imagePullSecrets []Kubernetes core/v1.LocalObjectReference (Optional) ImagePullSecrets imagePullPolicy Kubernetes core/v1.PullPolicy (Optional) ImagePullPolicy env []Kubernetes core/v1.EnvVar (Optional) Env Environment variables for druid containers. envFrom []Kubernetes core/v1.EnvFromSource (Optional) EnvFrom Extra environment variables from remote source (ConfigMaps, Secrets…). jvm.options string (Optional) JvmOptions Contents of the shared jvm.options configuration file for druid JVM processes. log4j.config string (Optional) Log4jConfig contents log4j.config configuration file. securityContext Kubernetes core/v1.PodSecurityContext (Optional) PodSecurityContext containerSecurityContext Kubernetes core/v1.SecurityContext (Optional) ContainerSecurityContext volumeClaimTemplates []Kubernetes core/v1.PersistentVolumeClaim (Optional) VolumeClaimTemplates Kubernetes Native VolumeClaimTemplate specification. volumeMounts []Kubernetes core/v1.VolumeMount (Optional) VolumeMounts Kubernetes Native VolumeMount specification. volumes []Kubernetes core/v1.Volume (Optional) Volumes Kubernetes Native Volumes specification. podAnnotations map[string]string (Optional) PodAnnotations Custom annotations to be populated in Druid pods. workloadAnnotations map[string]string (Optional) WorkloadAnnotations annotations to be populated in StatefulSet or Deployment spec. if the same key is specified at both the DruidNodeSpec level and DruidSpec level, the DruidNodeSpec WorkloadAnnotations will take precedence. podManagementPolicy Kubernetes apps/v1.PodManagementPolicyType (Optional) PodManagementPolicy podLabels map[string]string (Optional) PodLabels Custom labels to be populated in Druid pods. priorityClassName string (Optional) PriorityClassName Kubernetes native priorityClassName specification. updateStrategy Kubernetes apps/v1.StatefulSetUpdateStrategy (Optional) UpdateStrategy livenessProbe Kubernetes core/v1.Probe (Optional) LivenessProbe Port is set to druid.port if not specified with httpGet handler. readinessProbe Kubernetes core/v1.Probe (Optional) ReadinessProbe Port is set to druid.port if not specified with httpGet handler. startUpProbe Kubernetes core/v1.Probe (Optional) StartUpProbe services []Kubernetes core/v1.Service (Optional) Services Kubernetes services to be created for each workload. nodeSelector map[string]string (Optional) NodeSelector Kubernetes native nodeSelector specification. tolerations []Kubernetes core/v1.Toleration (Optional) Tolerations Kubernetes native tolerations specification. affinity Kubernetes core/v1.Affinity (Optional) Affinity Kubernetes native affinity specification. nodes map[string]./apis/druid/v1alpha1.DruidNodeSpec Nodes a list of Druid Node types and their configurations. DruidSpec is used to create Kubernetes workload specs. Many of the fields above can be overridden at the specific NodeSpec level. additionalContainer []AdditionalContainer (Optional) AdditionalContainer defines additional sidecar containers to be deployed with the Druid pods. rollingDeploy bool (Optional) RollingDeploy Whether to deploy the components in a rolling update as described in the documentation: https://druid.apache.org/docs/latest/operations/rolling-updates.html If set to true then operator checks the rollout status of previous version workloads before updating the next. This will be done only for update actions. defaultProbes bool (Optional) DefaultProbes If set to true this will add default probes (liveness / readiness / startup) for all druid components but it won’t override existing probes zookeeper ZookeeperSpec (Optional) Zookeeper IGNORED (Future API): In order to make Druid dependency setup extensible from within Druid operator. metadataStore MetadataStoreSpec (Optional) MetadataStore IGNORED (Future API): In order to make Druid dependency setup extensible from within Druid operator. deepStorage DeepStorageSpec (Optional) DeepStorage IGNORED (Future API): In order to make Druid dependency setup extensible from within Druid operator. metricDimensions.json string (Optional) DimensionsMapPath Custom Dimension Map Path for statsd emitter. stastd documentation is described in the following documentation: https://druid.apache.org/docs/latest/development/extensions-contrib/statsd.html hdfs-site.xml string (Optional) HdfsSite Contents of hdfs-site.xml. core-site.xml string (Optional) CoreSite Contents of core-site.xml.
status DruidClusterStatus

DruidClusterStatus

(Appears on: Druid)

DruidClusterStatus Defines the observed state of Druid.

Field	Description
druidNodeStatus DruidNodeTypeStatus	INSERT ADDITIONAL STATUS FIELD - define observed state of cluster Important: Run “make” to regenerate code after modifying this file
statefulSets []string
deployments []string
services []string
configMaps []string
podDisruptionBudgets []string
ingress []string
hpAutoscalers []string
pods []string
persistentVolumeClaims []string

DruidIngestion

Ingestion is the Schema for the Ingestion API

Field	Description
metadata Kubernetes meta/v1.ObjectMeta	Refer to the Kubernetes API documentation for the fields of the metadata field.
spec DruidIngestionSpec	suspend bool (Optional) druidCluster string ingestion IngestionSpec auth Auth (Optional)
status DruidIngestionStatus

DruidIngestionMethod (string alias)

(Appears on: IngestionSpec)

DruidIngestionSpec

(Appears on: DruidIngestion)

Field	Description
suspend bool	(Optional)
druidCluster string
ingestion IngestionSpec
auth Auth	(Optional)

DruidIngestionStatus

(Appears on: DruidIngestion)

Field	Description
taskId string
type string
status Kubernetes core/v1.ConditionStatus
reason string
message string
lastUpdateTime Kubernetes meta/v1.Time
currentIngestionSpec.json string

DruidNodeConditionType (string alias)

(Appears on: DruidNodeTypeStatus)

DruidNodeSpec

(Appears on: DruidSpec)

DruidNodeSpec Specification of Druid Node type and its configurations. The key in following map can be arbitrary string that helps you identify resources for a specific nodeSpec. It is used in the Kubernetes resources’ names, so it must be compliant with restrictions placed on Kubernetes resource names: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/

Field	Description
nodeType string	NodeDruid Druid node type.
druid.port int32	DruidPort Used by the Druid process.
kind string	(Optional) Kind Can be StatefulSet or Deployment. Note: volumeClaimTemplates are ignored when kind=Deployment
replicas int32	(Optional) Replicas replica of the workload
podLabels map[string]string	(Optional) PodLabels Custom labels to be populated in the workload’s pods.
podDisruptionBudgetSpec Kubernetes policy/v1.PodDisruptionBudgetSpec	(Optional) PodDisruptionBudgetSpec Kubernetes native podDisruptionBudget specification.
priorityClassName string	(Optional) PriorityClassName Kubernetes native priorityClassName specification.
runtime.properties string	RuntimeProperties Additional runtime configuration for the specific workload.
jvm.options string	(Optional) JvmOptions overrides JvmOptions at top level.
extra.jvm.options string	(Optional) ExtraJvmOptions Appends extra jvm options to the JvmOptions field.
log4j.config string	(Optional) Log4jConfig Overrides Log4jConfig at top level.
nodeConfigMountPath string	NodeConfigMountPath in-container directory to mount with runtime.properties, jvm.config, log4j2.xml files.
services []Kubernetes core/v1.Service	(Optional) Services Overrides services at top level.
tolerations []Kubernetes core/v1.Toleration	(Optional) Tolerations Kubernetes native tolerations specification.
affinity Kubernetes core/v1.Affinity	(Optional) Affinity Kubernetes native affinity specification.
nodeSelector map[string]string	(Optional) NodeSelector Kubernetes native nodeSelector specification.
terminationGracePeriodSeconds int64	(Optional) TerminationGracePeriodSeconds
ports []Kubernetes core/v1.ContainerPort	(Optional) Ports Extra ports to be added to pod spec.
image string	(Optional) Image Overrides image from top level, Required if no image specified at top level.
imagePullSecrets []Kubernetes core/v1.LocalObjectReference	(Optional) ImagePullSecrets Overrides imagePullSecrets from top level.
imagePullPolicy Kubernetes core/v1.PullPolicy	(Optional) ImagePullPolicy Overrides imagePullPolicy from top level.
env []Kubernetes core/v1.EnvVar	(Optional) Env Environment variables for druid containers.
envFrom []Kubernetes core/v1.EnvFromSource	(Optional) EnvFrom Extra environment variables from remote source (ConfigMaps, Secrets…).
resources Kubernetes core/v1.ResourceRequirements	(Optional) Resources Kubernetes Native resources specification.
securityContext Kubernetes core/v1.PodSecurityContext	(Optional) PodSecurityContext Overrides securityContext at top level.
containerSecurityContext Kubernetes core/v1.SecurityContext	(Optional) ContainerSecurityContext
podAnnotations map[string]string	(Optional) PodAnnotations Custom annotation to be populated in the workload’s pods.
podManagementPolicy Kubernetes apps/v1.PodManagementPolicyType	(Optional) PodManagementPolicy
maxSurge int32	(Optional) MaxSurge For Deployment object only. Set to 25% by default.
maxUnavailable int32	(Optional) MaxUnavailable For deployment object only. Set to 25% by default
updateStrategy Kubernetes apps/v1.StatefulSetUpdateStrategy	(Optional) UpdateStrategy
livenessProbe Kubernetes core/v1.Probe	(Optional) LivenessProbe Port is set to druid.port if not specified with httpGet handler.
readinessProbe Kubernetes core/v1.Probe	(Optional) ReadinessProbe Port is set to druid.port if not specified with httpGet handler.
startUpProbe Kubernetes core/v1.Probe	(Optional) StartUpProbe
ingressAnnotations map[string]string	(Optional) IngressAnnotations Ingress annotations to be populated in ingress spec.
workloadAnnotations map[string]string	(Optional) WorkloadAnnotations annotations to be populated in StatefulSet or Deployment spec.
ingress Kubernetes networking/v1.IngressSpec	(Optional) Ingress Kubernetes Native Ingress specification.
persistentVolumeClaim []Kubernetes core/v1.PersistentVolumeClaim	(Optional) VolumeClaimTemplates Kubernetes Native VolumeClaimTemplate specification.
lifecycle Kubernetes core/v1.Lifecycle	(Optional) Lifecycle
hpAutoscaler Kubernetes autoscaling/v2.HorizontalPodAutoscalerSpec	(Optional) HPAutoScaler Kubernetes Native HorizontalPodAutoscaler specification.
topologySpreadConstraints []Kubernetes core/v1.TopologySpreadConstraint	(Optional) TopologySpreadConstraints Kubernetes Native topologySpreadConstraints specification.
volumeClaimTemplates []Kubernetes core/v1.PersistentVolumeClaim	(Optional) VolumeClaimTemplates Kubernetes Native volumeClaimTemplates specification.
volumeMounts []Kubernetes core/v1.VolumeMount	(Optional) VolumeMounts Kubernetes Native volumeMounts specification.
volumes []Kubernetes core/v1.Volume	(Optional) Volumes Kubernetes Native volumes specification.
additionalContainer []AdditionalContainer	(Optional) Operator deploys the sidecar container based on these properties.

DruidNodeTypeStatus

(Appears on: DruidClusterStatus)

Field	Description
druidNode string
druidNodeConditionStatus Kubernetes core/v1.ConditionStatus
druidNodeConditionType DruidNodeConditionType
reason string

DruidSpec

(Appears on: Druid)

DruidSpec defines the desired state of the Druid cluster.

Field	Description
ignored bool	(Optional) Ignored is now deprecated API. In order to avoid reconciliation of objects use the druid.apache.org/ignored: "true" annotation.
common.runtime.properties string	CommonRuntimeProperties Content fo the common.runtime.properties configuration file.
extraCommonConfig []*k8s.io/api/core/v1.ObjectReference	(Optional) ExtraCommonConfig References to ConfigMaps holding more configuration files to mount to the common configuration path.
forceDeleteStsPodOnError bool	(Optional) ForceDeleteStsPodOnError Delete the StatefulSet’s pods if the StatefulSet is set to ordered ready. issue: kubernetes/kubernetes#67250 doc: https://kubernetes.io/docs/concepts/workloads/controllers/statefulset/#forced-rollback
scalePvcSts bool	(Optional) ScalePvcSts When enabled, operator will allow volume expansion of StatefulSet’s PVCs.
commonConfigMountPath string	(Optional) CommonConfigMountPath In-container directory to mount the Druid common configuration
disablePVCDeletionFinalizer bool	(Optional) DisablePVCDeletionFinalizer Whether PVCs shall be deleted on the deletion of the Druid cluster.
deleteOrphanPvc bool	(Optional) DeleteOrphanPvc Orphaned (unmounted PVCs) shall be cleaned up by the operator.
startScript string	(Optional) StartScript Path to Druid’s start script to be run on start.
image string	(Optional) Image Required here or at the NodeSpec level.
serviceAccount string	(Optional) ServiceAccount
imagePullSecrets []Kubernetes core/v1.LocalObjectReference	(Optional) ImagePullSecrets
imagePullPolicy Kubernetes core/v1.PullPolicy	(Optional) ImagePullPolicy
env []Kubernetes core/v1.EnvVar	(Optional) Env Environment variables for druid containers.
envFrom []Kubernetes core/v1.EnvFromSource	(Optional) EnvFrom Extra environment variables from remote source (ConfigMaps, Secrets…).
jvm.options string	(Optional) JvmOptions Contents of the shared jvm.options configuration file for druid JVM processes.
log4j.config string	(Optional) Log4jConfig contents log4j.config configuration file.
securityContext Kubernetes core/v1.PodSecurityContext	(Optional) PodSecurityContext
containerSecurityContext Kubernetes core/v1.SecurityContext	(Optional) ContainerSecurityContext
volumeClaimTemplates []Kubernetes core/v1.PersistentVolumeClaim	(Optional) VolumeClaimTemplates Kubernetes Native VolumeClaimTemplate specification.
volumeMounts []Kubernetes core/v1.VolumeMount	(Optional) VolumeMounts Kubernetes Native VolumeMount specification.
volumes []Kubernetes core/v1.Volume	(Optional) Volumes Kubernetes Native Volumes specification.
podAnnotations map[string]string	(Optional) PodAnnotations Custom annotations to be populated in Druid pods.
workloadAnnotations map[string]string	(Optional) WorkloadAnnotations annotations to be populated in StatefulSet or Deployment spec. if the same key is specified at both the DruidNodeSpec level and DruidSpec level, the DruidNodeSpec WorkloadAnnotations will take precedence.
podManagementPolicy Kubernetes apps/v1.PodManagementPolicyType	(Optional) PodManagementPolicy
podLabels map[string]string	(Optional) PodLabels Custom labels to be populated in Druid pods.
priorityClassName string	(Optional) PriorityClassName Kubernetes native priorityClassName specification.
updateStrategy Kubernetes apps/v1.StatefulSetUpdateStrategy	(Optional) UpdateStrategy
livenessProbe Kubernetes core/v1.Probe	(Optional) LivenessProbe Port is set to druid.port if not specified with httpGet handler.
readinessProbe Kubernetes core/v1.Probe	(Optional) ReadinessProbe Port is set to druid.port if not specified with httpGet handler.
startUpProbe Kubernetes core/v1.Probe	(Optional) StartUpProbe
services []Kubernetes core/v1.Service	(Optional) Services Kubernetes services to be created for each workload.
nodeSelector map[string]string	(Optional) NodeSelector Kubernetes native nodeSelector specification.
tolerations []Kubernetes core/v1.Toleration	(Optional) Tolerations Kubernetes native tolerations specification.
affinity Kubernetes core/v1.Affinity	(Optional) Affinity Kubernetes native affinity specification.
nodes map[string]./apis/druid/v1alpha1.DruidNodeSpec	Nodes a list of Druid Node types and their configurations. DruidSpec is used to create Kubernetes workload specs. Many of the fields above can be overridden at the specific NodeSpec level.
additionalContainer []AdditionalContainer	(Optional) AdditionalContainer defines additional sidecar containers to be deployed with the Druid pods.
rollingDeploy bool	(Optional) RollingDeploy Whether to deploy the components in a rolling update as described in the documentation: https://druid.apache.org/docs/latest/operations/rolling-updates.html If set to true then operator checks the rollout status of previous version workloads before updating the next. This will be done only for update actions.
defaultProbes bool	(Optional) DefaultProbes If set to true this will add default probes (liveness / readiness / startup) for all druid components but it won’t override existing probes
zookeeper ZookeeperSpec	(Optional) Zookeeper IGNORED (Future API): In order to make Druid dependency setup extensible from within Druid operator.
metadataStore MetadataStoreSpec	(Optional) MetadataStore IGNORED (Future API): In order to make Druid dependency setup extensible from within Druid operator.
deepStorage DeepStorageSpec	(Optional) DeepStorage IGNORED (Future API): In order to make Druid dependency setup extensible from within Druid operator.
metricDimensions.json string	(Optional) DimensionsMapPath Custom Dimension Map Path for statsd emitter. stastd documentation is described in the following documentation: https://druid.apache.org/docs/latest/development/extensions-contrib/statsd.html
hdfs-site.xml string	(Optional) HdfsSite Contents of hdfs-site.xml.
core-site.xml string	(Optional) CoreSite Contents of core-site.xml.

IngestionSpec

(Appears on: DruidIngestionSpec)

Field	Description
type DruidIngestionMethod
spec string

MetadataStoreSpec

(Appears on: DruidSpec)

MetadataStoreSpec IGNORED (Future API): In order to make Druid dependency setup extensible from within Druid operator.

Field	Description
type string
spec encoding/json.RawMessage

ZookeeperSpec

(Appears on: DruidSpec)

ZookeeperSpec IGNORED (Future API): In order to make Druid dependency setup extensible from within Druid operator.

Field	Description
type string
spec encoding/json.RawMessage

This page was automatically generated with gen-crd-api-reference-docs