tag aws resources with v2 style tags to enable migration to v2

Author: M00nF1sh

internal/alb/generator/tag.go

@@ -1,6 +1,8 @@
 package generator
 
 import (
+	"fmt"
+
 	"github.com/kubernetes-sigs/aws-alb-ingress-controller/internal/alb/lb"
 	"github.com/kubernetes-sigs/aws-alb-ingress-controller/internal/alb/sg"
 	"github.com/kubernetes-sigs/aws-alb-ingress-controller/internal/alb/tg"
@@ -15,6 +17,16 @@ const (
 	TagKeyServicePort = "kubernetes.io/service-port"
 )
 
+// Additional Tags used to be forward-compatible with V2 version.
+const (
+	V2TagKeyClusterID  = "ingress.k8s.aws/cluster"
+	V2TagKeyStackID    = "ingress.k8s.aws/stack"
+	V2TagKeyResourceID = "ingress.k8s.aws/resource"
+
+	V2ResourceIDLoadBalancer           = "LoadBalancer"
+	V2ResourceIDManagedLBSecurityGroup = "ManagedLBSecurityGroup"
+)
+
 var _ tg.TagGenerator = (*TagGenerator)(nil)
 var _ lb.TagGenerator = (*TagGenerator)(nil)
 var _ sg.TagGenerator = (*TagGenerator)(nil)
@@ -25,22 +37,29 @@ type TagGenerator struct {
 }
 
 func (gen *TagGenerator) TagLB(namespace string, ingressName string) map[string]string {
-	return gen.tagIngressResources(namespace, ingressName)
+	resTags := gen.tagIngressResources(namespace, ingressName)
+	resTags[V2TagKeyResourceID] = V2ResourceIDLoadBalancer
+	return resTags
 }
 
 func (gen *TagGenerator) TagTGGroup(namespace string, ingressName string) map[string]string {
 	return gen.tagIngressResources(namespace, ingressName)
 }
 
-func (gen *TagGenerator) TagTG(serviceName string, servicePort string) map[string]string {
-	return map[string]string{
+func (gen *TagGenerator) TagTG(namespace string, ingressName string, serviceName string, servicePort string) map[string]string {
+	resTags := map[string]string{
 		TagKeyServiceName: serviceName,
 		TagKeyServicePort: servicePort,
 	}
+	resID := gen.buildV2TargetGroupID(namespace, ingressName, serviceName, servicePort)
+	resTags[V2TagKeyResourceID] = resID
+	return resTags
 }
 
 func (gen *TagGenerator) TagLBSG(namespace string, ingressName string) map[string]string {
-	return gen.tagSGs(namespace, ingressName)
+	resTags := gen.tagSGs(namespace, ingressName)
+	resTags[V2TagKeyResourceID] = V2ResourceIDManagedLBSecurityGroup
+	return resTags
 }
 
 func (gen *TagGenerator) TagInstanceSG(namespace string, ingressName string) map[string]string {
@@ -55,6 +74,11 @@ func (gen *TagGenerator) tagIngressResources(namespace string, ingressName strin
 	m["kubernetes.io/cluster/"+gen.ClusterName] = "owned"
 	m[TagKeyNamespace] = namespace
 	m[TagKeyIngressName] = ingressName
+
+	v2Tags := gen.tagIngressResourcesV2(namespace, ingressName)
+	for label, value := range v2Tags {
+		m[label] = value
+	}
 	return m
 }
 
@@ -76,5 +100,29 @@ func (gen *TagGenerator) tagSGs(namespace string, ingressName string) map[string
 
 	m[TagKeyNamespace] = namespace
 	m[TagKeyIngressName] = ingressName
+
+	v2Tags := gen.tagIngressResourcesV2(namespace, ingressName)
+	for label, value := range v2Tags {
+		m[label] = value
+	}
+
 	return m
 }
+
+func (gen *TagGenerator) tagIngressResourcesV2(namespace string, ingressName string) map[string]string {
+	m := make(map[string]string)
+	stackID := gen.buildV2StackID(namespace, ingressName)
+	m[V2TagKeyClusterID] = gen.ClusterName
+	m[V2TagKeyStackID] = stackID
+	return m
+}
+
+// buildV2StackID returns the stack ID that compatible with V2 version.
+func (gen *TagGenerator) buildV2StackID(namespace string, ingressName string) string {
+	return fmt.Sprintf("%s/%s", namespace, ingressName)
+}
+
+// buildV2TargetGroupID returns the targetGroup ResourceID that compatible with V2 version.
+func (gen *TagGenerator) buildV2TargetGroupID(namespace string, ingressName string, serviceName string, servicePort string) string {
+	return fmt.Sprintf("%s/%s-%s:%s", namespace, ingressName, serviceName, servicePort)
+}

internal/alb/generator/tag_test.go

@@ -6,7 +6,7 @@ import (
 	"github.com/stretchr/testify/assert"
 )
 
-func Test_TagIngress(t *testing.T) {
+func Test_TagLB(t *testing.T) {
 	gen := TagGenerator{
 		ClusterName: "cluster",
 		DefaultTags: map[string]string{
@@ -17,17 +17,42 @@ func Test_TagIngress(t *testing.T) {
 		"kubernetes.io/cluster/cluster": "owned",
 		TagKeyIngressName:               "ingress",
 		TagKeyNamespace:                 "namespace",
-		"key":                           "value",
+
+		"ingress.k8s.aws/cluster":  "cluster",
+		"ingress.k8s.aws/stack":    "namespace/ingress",
+		"ingress.k8s.aws/resource": "LoadBalancer",
+		"key":                      "value",
 	}
+
 	assert.Equal(t, gen.TagLB("namespace", "ingress"), expected)
+}
+
+func Test_TagTGGroup(t *testing.T) {
+	gen := TagGenerator{
+		ClusterName: "cluster",
+		DefaultTags: map[string]string{
+			"key": "value",
+		},
+	}
+	expected := map[string]string{
+		"kubernetes.io/cluster/cluster": "owned",
+		TagKeyIngressName:               "ingress",
+		TagKeyNamespace:                 "namespace",
+
+		"ingress.k8s.aws/cluster": "cluster",
+		"ingress.k8s.aws/stack":   "namespace/ingress",
+		"key":                     "value",
+	}
+
 	assert.Equal(t, gen.TagTGGroup("namespace", "ingress"), expected)
 }
 
 func Test_TagTG(t *testing.T) {
 	gen := TagGenerator{}
 	expected := map[string]string{
-		TagKeyServiceName: "service",
-		TagKeyServicePort: "port",
+		TagKeyServiceName:          "service",
+		TagKeyServicePort:          "port",
+		"ingress.k8s.aws/resource": "namespace/ingress-service:port",
 	}
-	assert.Equal(t, gen.TagTG("service", "port"), expected)
+	assert.Equal(t, gen.TagTG("namespace", "ingress", "service", "port"), expected)
 }

internal/alb/tg/mock_NameTagGenerator.go

@@ -233,7 +233,7 @@ func (controller *defaultController) buildTags(ingress *extensions.Ingress, back
 	for k, v := range controller.nameTagGen.TagTGGroup(ingress.Namespace, ingress.Name) {
 		tgTags[k] = v
 	}
-	for k, v := range controller.nameTagGen.TagTG(backend.ServiceName, backend.ServicePort.String()) {
+	for k, v := range controller.nameTagGen.TagTG(ingress.Namespace, ingress.Name, backend.ServiceName, backend.ServicePort.String()) {
 		tgTags[k] = v
 	}
 	for k, v := range ingressAnnos.Tags.LoadBalancer {

internal/alb/tg/targetgroup.go

@@ -1277,7 +1277,7 @@ func TestDefaultController_Reconcile(t *testing.T) {
 				mockNameTagGen.On("NameTG", tc.NameTGCall.Namespace, tc.NameTGCall.IngressName, tc.NameTGCall.ServiceName, tc.NameTGCall.ServicePort, tc.NameTGCall.TargetType, tc.NameTGCall.Protocol).Return(tc.NameTGCall.TGName)
 			}
 			if tc.TagTGCall != nil {
-				mockNameTagGen.On("TagTG", tc.TagTGCall.ServiceName, tc.TagTGCall.ServicePort).Return(tc.TagTGCall.Tags)
+				mockNameTagGen.On("TagTG", tc.TagTGGroupCall.Namespace, tc.TagTGGroupCall.IngressName, tc.TagTGCall.ServiceName, tc.TagTGCall.ServicePort).Return(tc.TagTGCall.Tags)
 			}
 			if tc.TagTGGroupCall != nil {
 				mockNameTagGen.On("TagTGGroup", tc.TagTGGroupCall.Namespace, tc.TagTGGroupCall.IngressName).Return(tc.TagTGGroupCall.Tags)

internal/alb/tg/targetgroup_test.go

@@ -33,7 +33,7 @@ type TagGenerator interface {
 
 	// TagTG generates tags for a targetGroup inside a TGGroup.
 	// NOTE: The final set of tags been applied to targetGroup is union of tags generated by TagTGs & TagTG.
-	TagTG(serviceName string, servicePort string) map[string]string
+	TagTG(namespace string, ingressName string, serviceName string, servicePort string) map[string]string
 }
 
 // NameTagGenerator is combination of NameGenerator and TagGenerator