Allow csv tags

Author: mtougeron

README.md

@@ -10,7 +10,8 @@ The `k8s-aws-ebs-tagger` watches for new PersistentVolumeClaims and when new AWS
 
 #### cmdline args
 
-`--default-tags` - A json encoded key/value map of the tags to set by default on EBS Volumes. Values can be overwritten by the `aws-ebs-tagger/tags` annotation.
+`--default-tags` - A json or csv encoded key/value map of the tags to set by default on EBS Volumes. Values can be overwritten by the `aws-ebs-tagger/tags` annotation.
+`--tag-format` - Either `json` or `csv` for the format the `aws-ebs-tagger/tags` and `--default-tags` are in.
 
 #### Annotations
 
@@ -52,9 +53,6 @@ helm install k8s-aws-ebs-tagger mtougeron/k8s-aws-ebs-tagger
 
 Images are available on the [GitHub Container Registry](https://github.com/users/mtougeron/packages/container/k8s-aws-ebs-tagger/versions) and [DockerHub](https://hub.docker.com/repository/docker/mtougeron/k8s-aws-ebs-tagger). Containers are published for `linux/amd64` & `linux/arm64`.
 
-### Known Issues
-
-It is currently only possible ([#9](https://github.com/mtougeron/k8s-aws-ebs-tagger/issues/9)) to watch all namespaces or a single namespace. This will be addressed in a future version of the app.
 
 ### Licensing
 

go.sum

@@ -792,6 +792,7 @@ k8s.io/api v0.20.1/go.mod h1:KqwcCVogGxQY3nBlRpwt+wpAMF/KjaCc7RpywacvqUo=
 k8s.io/apimachinery v0.0.0-20190817020851-f2f3a405f61d/go.mod h1:3jediapYqJ2w1BFw7lAZPCx7scubsTfosqHkhXCWJKw=
 k8s.io/apimachinery v0.20.1 h1:LAhz8pKbgR8tUwn7boK+b2HZdt7MiTu2mkYtFMUjTRQ=
 k8s.io/apimachinery v0.20.1/go.mod h1:WlLqWAHZGg07AeltaI0MV5uk1Omp8xaN0JGLY6gkRpU=
+k8s.io/apimachinery v0.20.2 h1:hFx6Sbt1oG0n6DZ+g4bFt5f6BoMkOjKWsQFu077M3Vg=
 k8s.io/client-go v0.0.0-20190819141724-e14f31a72a77 h1:w1BoabVnPpPqQCY3sHK4qVwa12Lk8ip1pKMR1C+qbdo=
 k8s.io/client-go v0.0.0-20190819141724-e14f31a72a77/go.mod h1:DmkJD5UDP87MVqUQ5VJ6Tj9Oen8WzXPhk3la4qpyG4g=
 k8s.io/client-go v0.20.1 h1:Qquik0xNFbK9aUG92pxHYsyfea5/RPO9o9bSywNor+M=

kubernetes.go

@@ -189,9 +189,13 @@ func buildTags(pvc *corev1.PersistentVolumeClaim) map[string]string {
 		log.Debugln("Does not have " + annotationPrefix + "/tags annotation")
 		return tags
 	}
-	err := json.Unmarshal([]byte(tagString), &customTags)
-	if err != nil {
-		log.Errorln("Failed to Unmarshal JSON:", err)
+	if tagFormat == "csv" {
+		customTags = parseCsv(tagString)
+	} else {
+		err := json.Unmarshal([]byte(tagString), &customTags)
+		if err != nil {
+			log.Errorln("Failed to Unmarshal JSON:", err)
+		}
 	}
 
 	for k, v := range customTags {
@@ -235,6 +239,7 @@ func provisionedByAwsEbs(pvc *corev1.PersistentVolumeClaim) bool {
 
 func processPersistentVolumeClaim(pvc *corev1.PersistentVolumeClaim) (string, map[string]string, error) {
 	tags := buildTags(pvc)
+
 	log.WithFields(log.Fields{"namespace": pvc.GetNamespace(), "pvc": pvc.GetName(), "tags": tags}).Debugln("PVC Tags")
 
 	pv, err := k8sClient.CoreV1().PersistentVolumes().Get(context.TODO(), pvc.Spec.VolumeName, metav1.GetOptions{})

kubernetes_test.go

@@ -150,6 +150,7 @@ func Test_buildTags(t *testing.T) {
 		defaultTags map[string]string
 		annotations map[string]string
 		want        map[string]string
+		tagFormat   string
 	}{
 		{
 			name:        "ignore annotation set",
@@ -229,14 +230,57 @@ func Test_buildTags(t *testing.T) {
 			annotations: map[string]string{"aws-ebs-tagger/tags": "{\"something\": \"else\"}"},
 			want:        map[string]string{"something": "else"},
 		},
+		{
+			name:        "tags annotation not set with default tags - csv",
+			defaultTags: map[string]string{"foo": "bar", "something": "else"},
+			annotations: map[string]string{},
+			want:        map[string]string{"foo": "bar", "something": "else"},
+			tagFormat:   "csv",
+		},
+		{
+			name:        "tags annotation not set with no default tags - csv",
+			defaultTags: map[string]string{},
+			annotations: map[string]string{},
+			want:        map[string]string{},
+			tagFormat:   "csv",
+		},
+		{
+			name:        "tags annotation set with default tags - csv",
+			defaultTags: map[string]string{"foo": "bar"},
+			annotations: map[string]string{"aws-ebs-tagger/tags": "something=else"},
+			want:        map[string]string{"foo": "bar", "something": "else"},
+			tagFormat:   "csv",
+		},
+		{
+			name:        "tags annotation set with default tags with override - csv",
+			defaultTags: map[string]string{"foo": "foo"},
+			annotations: map[string]string{"aws-ebs-tagger/tags": "foo=bar,something=else"},
+			want:        map[string]string{"foo": "bar", "something": "else"},
+			tagFormat:   "csv",
+		},
+		{
+			name:        "tags annotation set with invalid tags - csv",
+			defaultTags: map[string]string{},
+			annotations: map[string]string{"aws-ebs-tagger/tags": "{\"foo\": \"bar\"}"},
+			want:        map[string]string{},
+			tagFormat:   "csv",
+		},
+
+		// foo=bar,something=else
 	}
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
 			pvc.SetAnnotations(tt.annotations)
 			defaultTags = tt.defaultTags
+			if tt.tagFormat != "" {
+				tagFormat = tt.tagFormat
+			} else {
+				tagFormat = "json"
+			}
 			if got := buildTags(pvc); !reflect.DeepEqual(got, tt.want) {
 				t.Errorf("buildTags() = %v, want %v", got, tt.want)
 			}
+			tagFormat = "json"
 		})
 	}
 }

main.go

@@ -51,6 +51,7 @@ var (
 	defaultTags      map[string]string
 	annotationPrefix string = "aws-ebs-tagger"
 	watchNamespace   string
+	tagFormat        string = "json"
 
 	promActionsTotal = promauto.NewCounterVec(prometheus.CounterOpts{
 		Name: "k8s_aws_ebs_tagger_actions_total",
@@ -108,6 +109,7 @@ func main() {
 	flag.StringVar(&leaseLockName, "lease-lock-name", "k8s-aws-ebs-tagger", "the lease lock resource name")
 	flag.StringVar(&leaseLockNamespace, "lease-lock-namespace", os.Getenv("NAMESPACE"), "the lease lock resource namespace")
 	flag.StringVar(&defaultTagsString, "default-tags", "", "Default tags to add to EBS volume")
+	flag.StringVar(&tagFormat, "tag-format", "json", "Whether the tags are in json or csv format. Default: json")
 	flag.StringVar(&annotationPrefix, "annotation-prefix", "aws-ebs-tagger", "Annotation prefix to check")
 	flag.StringVar(&watchNamespace, "watch-namespace", os.Getenv("WATCH_NAMESPACE"), "A specific namespace to watch (default is all namespaces)")
 	flag.StringVar(&statusPort, "status-port", "8000", "The healthz port")
@@ -124,11 +126,16 @@ func main() {
 		}
 	}
 
+	defaultTags = make(map[string]string)
 	if defaultTagsString != "" {
 		log.Debugln("defaultTagsString:", defaultTagsString)
-		err := json.Unmarshal([]byte(defaultTagsString), &defaultTags)
-		if err != nil {
-			log.Fatalln("default-tags are not valid json key/value pairs:", err)
+		if tagFormat == "csv" {
+			defaultTags = parseCsv(defaultTagsString)
+		} else {
+			err := json.Unmarshal([]byte(defaultTagsString), &defaultTags)
+			if err != nil {
+				log.Fatalln("default-tags are not valid json key/value pairs:", err)
+			}
 		}
 	}
 	log.WithFields(log.Fields{"tags": defaultTags}).Infoln("Default Tags")
@@ -278,3 +285,27 @@ func runWatchNamespaceTask(ctx context.Context, namespace string) {
 	<-ctx.Done()
 	close(ch)
 }
+
+func parseCsv(value string) map[string]string {
+
+	tags := make(map[string]string)
+	for _, s := range strings.Split(value, ",") {
+		if len(s) == 0 {
+			continue
+		}
+		pairs := strings.SplitN(s, "=", 2)
+		if len(pairs) != 2 {
+			log.Errorln("invalid csv key/value pair. Skipping...")
+			continue
+		}
+		k := strings.TrimSpace(pairs[0])
+		v := strings.TrimSpace(pairs[1])
+		if k == "" || v == "" {
+			log.Errorln("invalid csv key/value pair. Skipping...")
+			continue
+		}
+		tags[k] = v
+	}
+
+	return tags
+}

main_test.go

@@ -0,0 +1,75 @@
+// Licensed to Michael Tougeron <[email protected]> under
+// one or more contributor license agreements. See the LICENSE
+// file distributed with this work for additional information
+// regarding copyright ownership.
+// Michael Tougeron <[email protected]> licenses this file
+// to you under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied.  See the License for the
+// specific language governing permissions and limitations
+// under the License.
+
+package main
+
+import (
+	"reflect"
+	"testing"
+)
+
+func Test_parseCsv(t *testing.T) {
+	tests := []struct {
+		name string
+		csv  string
+		want map[string]string
+	}{
+		{
+			name: "empty string",
+			csv:  "",
+			want: map[string]string{},
+		},
+		{
+			name: "single key/value string",
+			csv:  "touge=me",
+			want: map[string]string{"touge": "me"},
+		},
+		{
+			name: "multiple key/value string",
+			csv:  "touge=me,foo=bar",
+			want: map[string]string{"touge": "me", "foo": "bar"},
+		},
+		{
+			name: "invalid string",
+			csv:  "foo",
+			want: map[string]string{},
+		},
+		{
+			name: "invalid key string",
+			csv:  "=foo",
+			want: map[string]string{},
+		},
+		{
+			name: "invalid value string",
+			csv:  "foo=",
+			want: map[string]string{},
+		},
+		{
+			name: "double delim",
+			csv:  "foo=bar,,touge=me",
+			want: map[string]string{"touge": "me", "foo": "bar"},
+		},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			if got := parseCsv(tt.csv); !reflect.DeepEqual(got, tt.want) {
+				t.Errorf("parseCsv() = %v, want %v", got, tt.want)
+			}
+		})
+	}
+}