add support for adding annotations to kubernetes transform

Signed-off-by: Alex Price <[email protected]>

Author: awprice

docs/api.md

@@ -265,7 +265,8 @@ Following is the supported API format for network transformations:
                      macField: entry MAC input field
                      output: entry output field
                      assignee: value needs to assign to output field
-                     labels_prefix: labels prefix to use to copy input lables, if empty labels will not be copied
+                     labels_prefix: labels prefix to use to copy input labels, if empty labels will not be copied
+                     annotations_prefix: annotations prefix to use to copy input annotations, if empty annotations will not be copied
                      add_zone: if true the rule will add the zone
                  add_subnet: Add subnet rule configuration
                      input: entry input field

pkg/api/transform_network.go

@@ -98,15 +98,16 @@ type K8sReference struct {
 }
 
 type K8sRule struct {
-	IPField         string        `yaml:"ipField,omitempty" json:"ipField,omitempty" doc:"entry IP input field"`
-	InterfacesField string        `yaml:"interfacesField,omitempty" json:"interfacesField,omitempty" doc:"entry Interfaces input field"`
-	UDNsField       string        `yaml:"udnsField,omitempty" json:"udnsField,omitempty" doc:"entry UDNs input field"`
-	MACField        string        `yaml:"macField,omitempty" json:"macField,omitempty" doc:"entry MAC input field"`
-	Output          string        `yaml:"output,omitempty" json:"output,omitempty" doc:"entry output field"`
-	Assignee        string        `yaml:"assignee,omitempty" json:"assignee,omitempty" doc:"value needs to assign to output field"`
-	LabelsPrefix    string        `yaml:"labels_prefix,omitempty" json:"labels_prefix,omitempty" doc:"labels prefix to use to copy input lables, if empty labels will not be copied"`
-	AddZone         bool          `yaml:"add_zone,omitempty" json:"add_zone,omitempty" doc:"if true the rule will add the zone"`
-	OutputKeys      K8SOutputKeys `yaml:"-" json:"-"`
+	IPField           string        `yaml:"ipField,omitempty" json:"ipField,omitempty" doc:"entry IP input field"`
+	InterfacesField   string        `yaml:"interfacesField,omitempty" json:"interfacesField,omitempty" doc:"entry Interfaces input field"`
+	UDNsField         string        `yaml:"udnsField,omitempty" json:"udnsField,omitempty" doc:"entry UDNs input field"`
+	MACField          string        `yaml:"macField,omitempty" json:"macField,omitempty" doc:"entry MAC input field"`
+	Output            string        `yaml:"output,omitempty" json:"output,omitempty" doc:"entry output field"`
+	Assignee          string        `yaml:"assignee,omitempty" json:"assignee,omitempty" doc:"value needs to assign to output field"`
+	LabelsPrefix      string        `yaml:"labels_prefix,omitempty" json:"labels_prefix,omitempty" doc:"labels prefix to use to copy input labels, if empty labels will not be copied"`
+	AnnotationsPrefix string        `yaml:"annotations_prefix,omitempty" json:"annotations_prefix,omitempty" doc:"annotations prefix to use to copy input annotations, if empty annotations will not be copied"`
+	AddZone           bool          `yaml:"add_zone,omitempty" json:"add_zone,omitempty" doc:"if true the rule will add the zone"`
+	OutputKeys        K8SOutputKeys `yaml:"-" json:"-"`
 }
 
 type K8SOutputKeys struct {

pkg/pipeline/transform/kubernetes/enrich.go

@@ -57,6 +57,11 @@ func Enrich(outputEntry config.GenericMap, rule *api.K8sRule) {
 			outputEntry[rule.LabelsPrefix+"_"+labelKey] = labelValue
 		}
 	}
+	if rule.AnnotationsPrefix != "" {
+		for annotationKey, annotationValue := range kubeInfo.Annotations {
+			outputEntry[rule.AnnotationsPrefix+"_"+annotationKey] = annotationValue
+		}
+	}
 	if kubeInfo.HostIP != "" {
 		outputEntry[rule.OutputKeys.HostIP] = kubeInfo.HostIP
 		if kubeInfo.HostName != "" {

pkg/pipeline/transform/kubernetes/enrich_test.go

@@ -581,3 +581,85 @@ func TestEnrichUsingUDN(t *testing.T) {
 		"DstK8s_NetworkName": "ns-2/primary-udn",
 	}, entry)
 }
+
+func TestEnrich_LabelsAndAnnotationsPrefixes(t *testing.T) {
+	testData := map[string]*model.ResourceMetaData{
+		"10.0.0.10": {
+			ObjectMeta: v1.ObjectMeta{
+				Name:      "test-pod",
+				Namespace: "test-ns",
+				Labels:    map[string]string{"app": "web", "tier": "backend"},
+				Annotations: map[string]string{
+					"owner":                "team-a",
+					"prometheus.io/scrape": "true",
+				},
+			},
+			Kind: "Pod",
+		},
+	}
+	setupStubs(testData, nil, nodes)
+
+	tests := []struct {
+		name              string
+		labelsPrefix      string
+		annotationsPrefix string
+		expectLabels      map[string]string
+		expectAnnotations map[string]string
+		notExpect         []string
+	}{
+		{
+			name:              "both prefixes",
+			labelsPrefix:      "K8s_Labels",
+			annotationsPrefix: "K8s_Annotations",
+			expectLabels:      map[string]string{"K8s_Labels_app": "web", "K8s_Labels_tier": "backend"},
+			expectAnnotations: map[string]string{"K8s_Annotations_owner": "team-a", "K8s_Annotations_prometheus.io/scrape": "true"},
+		},
+		{
+			name:         "labels only",
+			labelsPrefix: "K8s_Labels",
+			expectLabels: map[string]string{"K8s_Labels_app": "web"},
+			notExpect:    []string{"K8s_Annotations_owner"},
+		},
+		{
+			name:              "annotations only",
+			annotationsPrefix: "K8s_Annotations",
+			expectAnnotations: map[string]string{"K8s_Annotations_owner": "team-a"},
+			notExpect:         []string{"K8s_Labels_app"},
+		},
+		{
+			name:      "no prefixes",
+			notExpect: []string{"K8s_Labels_app", "K8s_Annotations_owner"},
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			rule := api.TransformNetwork{
+				Rules: api.NetworkTransformRules{{
+					Type: api.NetworkAddKubernetes,
+					Kubernetes: &api.K8sRule{
+						IPField:           "SrcAddr",
+						Output:            "K8s",
+						LabelsPrefix:      tt.labelsPrefix,
+						AnnotationsPrefix: tt.annotationsPrefix,
+					},
+				}},
+			}
+			rule.Preprocess()
+
+			entry := config.GenericMap{"SrcAddr": "10.0.0.10"}
+			Enrich(entry, rule.Rules[0].Kubernetes)
+
+			assert.Equal(t, "test-pod", entry["K8s_Name"])
+			for k, v := range tt.expectLabels {
+				assert.Equal(t, v, entry[k])
+			}
+			for k, v := range tt.expectAnnotations {
+				assert.Equal(t, v, entry[k])
+			}
+			for _, k := range tt.notExpect {
+				assert.NotContains(t, entry, k)
+			}
+		})
+	}
+}