Add support for annotations on Deployment/StatefulSet resources in Dr…

…uidNodeSpec (#145)

* Add support for annotations on Deployment/StatefulSet resources

* Support setting ReplicationControllerAnnotations at the cluster-level

* rename replicationControllerAnnotations to workloadAnnotations

* suggestions from code review

apis/druid/v1alpha1/druid_types.go

@@ -180,6 +180,11 @@ type DruidSpec struct {
  // +optional
  PodAnnotations map[string]string `json:"podAnnotations,omitempty"`
 
+ // 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.
+ // +optional
+ WorkloadAnnotations map[string]string `json:"workloadAnnotations,omitempty"`
+
  // PodManagementPolicy
  // +optional
  // +kubebuilder:default:="Parallel"
@@ -433,6 +438,10 @@ type DruidNodeSpec struct {
  // +optional
  IngressAnnotations map[string]string `json:"ingressAnnotations,omitempty"`
 
+ // WorkloadAnnotations annotations to be populated in StatefulSet or Deployment spec.
+ // +optional
+ WorkloadAnnotations map[string]string `json:"workloadAnnotations,omitempty"`
+
  // Ingress Kubernetes Native `Ingress` specification.
  // +optional
  Ingress *networkingv1.IngressSpec `json:"ingress,omitempty"`

chart/templates/crds/druid.apache.org_druids.yaml

@@ -9025,6 +9025,12 @@ spec:
  - name
  type: object
  type: array
+ workloadAnnotations:
+ additionalProperties:
+ type: string
+ description: WorkloadAnnotations annotations to be populated
+ in StatefulSet or Deployment spec.
+ type: object
  required:
  - druid.port
  - nodeConfigMountPath
@@ -12094,6 +12100,14 @@ spec:
  - name
  type: object
  type: array
+ workloadAnnotations:
+ additionalProperties:
+ type: string
+ description: 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.
+ type: object
  zookeeper:
  description: 'Zookeeper IGNORED (Future API): In order to make Druid
  dependency setup extensible from within Druid operator.'

config/crd/bases/druid.apache.org_druids.yaml

@@ -9025,6 +9025,12 @@ spec:
  - name
  type: object
  type: array
+ workloadAnnotations:
+ additionalProperties:
+ type: string
+ description: WorkloadAnnotations annotations to be populated
+ in StatefulSet or Deployment spec.
+ type: object
  required:
  - druid.port
  - nodeConfigMountPath
@@ -12094,6 +12100,14 @@ spec:
  - name
  type: object
  type: array
+ workloadAnnotations:
+ additionalProperties:
+ type: string
+ description: 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.
+ type: object
  zookeeper:
  description: 'Zookeeper IGNORED (Future API): In order to make Druid
  dependency setup extensible from within Druid operator.'

controllers/druid/handler.go

@@ -998,9 +998,10 @@ func makeStatefulSet(nodeSpec *v1alpha1.DruidNodeSpec, m *v1alpha1.Druid, ls map
  APIVersion: "apps/v1",
  },
  ObjectMeta: metav1.ObjectMeta{
- Name: fmt.Sprintf("%s", nodeSpecUniqueStr),
- Namespace: m.Namespace,
- Labels: ls,
+ Name: fmt.Sprintf("%s", nodeSpecUniqueStr),
+ Annotations: makeAnnotationsForWorkload(nodeSpec, m),
+ Namespace: m.Namespace,
+ Labels: ls,
  },
  Spec: makeStatefulSetSpec(nodeSpec, m, ls, nodeSpecUniqueStr, configMapSHA, serviceName),
  }, nil
@@ -1022,9 +1023,10 @@ func makeDeployment(nodeSpec *v1alpha1.DruidNodeSpec, m *v1alpha1.Druid, ls map[
  APIVersion: "apps/v1",
  },
  ObjectMeta: metav1.ObjectMeta{
- Name: fmt.Sprintf("%s", nodeSpecUniqueStr),
- Namespace: m.Namespace,
- Labels: ls,
+ Name: fmt.Sprintf("%s", nodeSpecUniqueStr),
+ Annotations: makeAnnotationsForWorkload(nodeSpec, m),
+ Namespace: m.Namespace,
+ Labels: ls,
  },
  Spec: makeDeploymentSpec(nodeSpec, m, ls, nodeSpecUniqueStr, configMapSHA, serviceName),
  }, nil
@@ -1287,6 +1289,22 @@ func makeLabelsForNodeSpec(nodeSpec *v1alpha1.DruidNodeSpec, m *v1alpha1.Druid,
  return labels
 }
 
+// makeAnnotationsForWorkload returns the annotations for a Deployment or StatefulSet
+// If a given key is set in both the DruidSpec and DruidNodeSpec, the node-scoped value will take precedence.
+func makeAnnotationsForWorkload(nodeSpec *v1alpha1.DruidNodeSpec, m *v1alpha1.Druid) map[string]string {
+ var annotations = map[string]string{}
+
+ if m.Spec.WorkloadAnnotations != nil {
+ annotations = m.Spec.WorkloadAnnotations
+ }
+
+ for k, v := range nodeSpec.WorkloadAnnotations {
+ annotations[k] = v
+ }
+
+ return annotations
+}
+
 // addOwnerRefToObject appends the desired OwnerReference to the object
 func addOwnerRefToObject(obj metav1.Object, ownerRef metav1.OwnerReference) {
  obj.SetOwnerReferences(append(obj.GetOwnerReferences(), ownerRef))

controllers/druid/testdata/broker-deployment.yaml

@@ -9,7 +9,10 @@ metadata:
  nodeSpecUniqueStr: druid-druid-test-brokers
  component: broker
  annotations:
- druidOpResourceHash: DYdfEwwDlLKgjTSZeuJb5nloe/w=
+ druidOpResourceHash: nQv/LmxctTSRsI5dtBe3jvN5WM8=
+ kubernetes.io/cluster-scoped-annotation: "cluster"
+ kubernetes.io/node-scoped-annotation: "broker"
+ kubernetes.io/override-annotation: "node-scoped-annotation"
 spec:
  replicas: 2
  selector:

controllers/druid/testdata/broker-statefulset.yaml

@@ -9,7 +9,10 @@ metadata:
  nodeSpecUniqueStr: druid-druid-test-brokers
  component: broker
  annotations:
- druidOpResourceHash: lTyDduvMnbQ7O2Glf57R9c5bFtA=
+ druidOpResourceHash: LXsKmbxQkX+94LkevlKDy4wemRQ=
+ kubernetes.io/cluster-scoped-annotation: "cluster"
+ kubernetes.io/node-scoped-annotation: "broker"
+ kubernetes.io/override-annotation: "node-scoped-annotation"
 spec:
  podManagementPolicy: Parallel
  replicas: 2

controllers/druid/testdata/druid-test-cr.yaml

@@ -7,6 +7,9 @@ spec:
  image: himanshu01/druid:druid-0.12.0-1
  defaultProbes: true
  priorityClassName: high-priority
+ workloadAnnotations:
+ kubernetes.io/cluster-scoped-annotation: "cluster"
+ kubernetes.io/override-annotation: "cluster-scoped-annotation"
  podAnnotations:
  key1: value1
  key2: value2
@@ -109,6 +112,9 @@ spec:
  nodes:
  brokers:
  nodeType: "broker"
+ workloadAnnotations:
+ kubernetes.io/node-scoped-annotation: "broker"
+ kubernetes.io/override-annotation: "node-scoped-annotation"
  services:
  - spec:
  type: ClusterIP