Labels for OneAgent CR

CHANGELOG.md

@@ -7,6 +7,7 @@
 * Add OpenAPI V3 Schema to CRD objects ([#171](https://github.com/Dynatrace/dynatrace-oneagent-operator/pull/171))
 * Operator log entries now use ISO-8601 timestamps (e.g., `"2019-10-30T12:59:43.717+0100"`) ([#159](https://github.com/Dynatrace/dynatrace-oneagent-operator/pull/159))
 * The service account for pods can now be customized ([#182](https://github.com/Dynatrace/dynatrace-oneagent-operator/pull/182))
+* Custom labels can be added to pods ([#183](https://github.com/Dynatrace/dynatrace-oneagent-operator/pull/183))
 
 ### Bug fixes
 

README.md

@@ -128,6 +128,11 @@ spec:
   # DNS Policy for OneAgent pods (optional.) Empty for default (ClusterFirst), more at
   # https://kubernetes.io/docs/concepts/services-networking/dns-pod-service/#pod-s-dns-policy
   #dnsPolicy: ""
+  # Labels are customer defined labels for oneagent pods to structure workloads as desired
+  #labels: 
+  #  dynatrace : value1
+  #  one-agent : value2
+  #  tenant-id : value3
 ```
 Save the snippet to a file or use [./deploy/cr.yaml](https://raw.githubusercontent.com/Dynatrace/dynatrace-oneagent-operator/master/deploy/cr.yaml) from this repository and adjust its values accordingly.
 A secret holding tokens for authenticating to the Dynatrace cluster needs to be created upfront.

deploy/cr.yaml

@@ -52,3 +52,8 @@ spec:
   # DNS Policy for OneAgent pods (optional.) Empty for default (ClusterFirst), more at
   # https://kubernetes.io/docs/concepts/services-networking/dns-pod-service/#pod-s-dns-policy
   #dnsPolicy: ""
+  # Labels are customer defined labels for oneagent pods to structure workloads as desired
+  #labels: 
+  #  dynatrace : value1
+  #  one-agent : value2
+  #  tenant-id : value3

deploy/crds/dynatrace.com_oneagents_crd.yaml

@@ -169,6 +169,11 @@ spec:
             image:
               description: Installer image Defaults to docker.io/dynatrace/oneagent:latest
               type: string
+            labels:
+              additionalProperties:
+                type: string
+              description: Labels for the OneAgent pods
+              type: object
             nodeSelector:
               additionalProperties:
                 type: string

deploy/kubernetes.yaml

@@ -433,6 +433,11 @@ spec:
             serviceAccountName:
               description: Name of the service account for the OneAgent
               type: string
+            labels:
+              additionalProperties:
+                type: string
+              description: Labels for the OneAgent pods
+              type: object
             skipCertCheck:
               description:
                 Disable certificate validation checks for installer download

deploy/openshift.yaml

@@ -373,6 +373,11 @@ spec:
             serviceAccountName:
               description: Name of the service account for the OneAgent
               type: string
+            labels:
+              additionalProperties:
+                type: string
+              description: Labels for the OneAgent pods
+              type: object
             skipCertCheck:
               description:
                 Disable certificate validation checks for installer download

pkg/apis/dynatrace/v1alpha1/oneagent_types.go

@@ -47,6 +47,8 @@ type OneAgentSpec struct {
 	DNSPolicy corev1.DNSPolicy `json:"dnsPolicy,omitempty"`
 	// Name of the service account for the OneAgent
 	ServiceAccountName string `json:"serviceAccountName,omitempty"`
+	// Labels for the OneAgent pods
+	Labels map[string]string `json:"labels,omitempty"`
 }
 
 type OneAgentConditionType string

pkg/apis/dynatrace/v1alpha1/zz_generated.openapi.go

@@ -215,6 +215,21 @@ func schema_pkg_apis_dynatrace_v1alpha1_OneAgentSpec(ref common.ReferenceCallbac
 							Format:      "",
 						},
 					},
+					"labels": {
+						SchemaProps: spec.SchemaProps{
+							Description: "Labels for the OneAgent pods",
+							Type:        []string{"object"},
+							AdditionalProperties: &spec.SchemaOrBool{
+								Allows: true,
+								Schema: &spec.Schema{
+									SchemaProps: spec.SchemaProps{
+										Type:   []string{"string"},
+										Format: "",
+									},
+								},
+							},
+						},
+					},
 				},
 				Required: []string{"apiUrl"},
 			},

pkg/controller/oneagent/oneagent_controller.go

@@ -131,6 +131,12 @@ func (r *ReconcileOneAgent) Reconcile(request reconcile.Request) (reconcile.Resu
 	}
 	r.scheme.Default(instance)
 
+	if instance.Spec.Labels == nil {
+		instance.Spec.Labels = mergeLabels(buildLabels(instance.Name))
+	} else {
+		instance.Spec.Labels = mergeLabels(buildLabels(instance.Name), instance.Spec.Labels)
+	}
+
 	if err := validate(instance); err != nil {
 		return reconcile.Result{}, err
 	}
@@ -383,19 +389,19 @@ func (r *ReconcileOneAgent) updateCR(instance *dynatracev1alpha1.OneAgent) error
 }
 
 func newDaemonSetForCR(instance *dynatracev1alpha1.OneAgent) *appsv1.DaemonSet {
-	selector := buildLabels(instance.Name)
+
 	podSpec := newPodSpecForCR(instance)
 
 	return &appsv1.DaemonSet{
 		ObjectMeta: metav1.ObjectMeta{
 			Name:      instance.Name,
 			Namespace: instance.Namespace,
-			Labels:    selector,
+			Labels:    instance.Spec.Labels,
 		},
 		Spec: appsv1.DaemonSetSpec{
-			Selector: &metav1.LabelSelector{MatchLabels: selector},
+			Selector: &metav1.LabelSelector{MatchLabels: instance.Spec.Labels},
 			Template: corev1.PodTemplateSpec{
-				ObjectMeta: metav1.ObjectMeta{Labels: selector},
+				ObjectMeta: metav1.ObjectMeta{Labels: instance.Spec.Labels},
 				Spec:       podSpec,
 			},
 		},

pkg/controller/oneagent/oneagent_controller_test.go

@@ -35,6 +35,9 @@ func TestReconcileOneAgent_ReconcileOnEmptyEnvironmentAndDNSPolicy(t *testing.T)
 		ApiUrl:    "https://ENVIRONMENTID.live.dynatrace.com/api",
 		DNSPolicy: corev1.DNSClusterFirstWithHostNet,
 		Tokens:    oaName,
+		Labels: map[string]string{
+			"label_key": "label_value",
+		},
 	}
 	dynatracev1alpha1.SetDefaults_OneAgentSpec(&oaSpec)
 

pkg/controller/oneagent/oneagent_utils.go

@@ -12,6 +12,18 @@ import (
 	corev1 "k8s.io/api/core/v1"
 )
 
+func mergeLabels(labels ...map[string]string) map[string]string {
+
+	res := map[string]string{}
+	for _, m := range labels {
+		for k, v := range m {
+			res[k] = v
+		}
+	}
+
+	return res
+}
+
 // BuildLabels returns generic labels based on the name given for a Dynatrace OneAgent
 func buildLabels(name string) map[string]string {
 	return map[string]string{
@@ -68,6 +80,7 @@ func hasSpecChanged(dsSpec *appsv1.DaemonSetSpec, crSpec *dynatracev1alpha1.OneA
 // value is missing in the daemonset as well.
 func copyDaemonSetSpecToOneAgentSpec(dsSpec *appsv1.DaemonSetSpec, crSpec *dynatracev1alpha1.OneAgentSpec) {
 	crSpec.NodeSelector = nil
+
 	if dsSpec.Template.Spec.NodeSelector != nil {
 		in, out := &dsSpec.Template.Spec.NodeSelector, &crSpec.NodeSelector
 		*out = make(map[string]string, len(*in))
@@ -87,6 +100,7 @@ func copyDaemonSetSpecToOneAgentSpec(dsSpec *appsv1.DaemonSetSpec, crSpec *dynat
 	crSpec.ServiceAccountName = dsSpec.Template.Spec.ServiceAccountName
 	crSpec.PriorityClassName = dsSpec.Template.Spec.PriorityClassName
 	crSpec.DNSPolicy = dsSpec.Template.Spec.DNSPolicy
+	crSpec.Labels = dsSpec.Template.Labels
 	crSpec.Image = ""
 	if len(dsSpec.Template.Spec.Containers) == 1 {
 		crSpec.Image = dsSpec.Template.Spec.Containers[0].Image