update for default resource tags (#87)

Issue #, if available: aws-controllers-k8s/community#1261

Description of changes:
* This PR changes the default ACK resource tags from empty list to []string{"services.k8s.aws/controller-version=%CONTROLLER_VERSION%" ,"services.k8s.aws/namespace=%K8S_NAMESPACE%"}.

* Instead of statically passing the controller release version from release artifacts, i made it a dynamic `%CONTROLLER_VERSION%` variable. The dynamic variable will allow customers to use this variable in their custom tags as well.

* I refactored the various service controller metadata fields into a new `ServiceControllerMetadata` type as well.

Tested locally that the resource tags get resolved as expected.

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

Author: vijtrip2

mocks/pkg/types/service_controller.go

@@ -41,6 +41,13 @@ const (
 	envVarAWSRegion          = "AWS_REGION"
 )
 
+var (
+	defaultResourceTags = []string{
+		"services.k8s.aws/controller-version=%CONTROLLER_VERSION%",
+		"services.k8s.aws/namespace=%K8S_NAMESPACE%",
+	}
+)
+
 // Config contains configuration otpions for ACK service controllers
 type Config struct {
 	MetricsAddr              string
@@ -104,7 +111,7 @@ func (cfg *Config) BindFlags() {
 	)
 	flag.StringSliceVar(
 		&cfg.ResourceTags, flagResourceTags,
-		[]string{},
+		defaultResourceTags,
 		"Configures the ACK service controller to always set key/value pairs tags on resources that it manages.",
 	)
 	flag.StringVar(

pkg/config/config.go

@@ -33,30 +33,11 @@ import (
 	acktypes "github.com/aws-controllers-k8s/runtime/pkg/types"
 )
 
-// VersionInfo contains information about the version of the runtime and
-// service controller in use
-type VersionInfo struct {
-	// GitCommit is the SHA1 commit for the service controller's code
-	GitCommit string
-	// GitVersion is the latest Git tag from the service controller's code
-	GitVersion string
-	// BuildDate is a timestamp of when the code was built
-	BuildDate string
-}
-
 // serviceController wraps a number of `controller-runtime.Reconciler` that are
 // related to a specific AWS service API.
 type serviceController struct {
+	acktypes.ServiceControllerMetadata
 	metaLock sync.RWMutex
-	// ServiceAlias is a string with the alias of the service API, e.g. "s3"
-	ServiceAlias string
-	// ServiceAPIGroup is a string with the full DNS-correct API group that
-	// this service controller manages, e.g. "s3.services.k8s.aws"
-	ServiceAPIGroup string
-	// ServiceEndpointsID is a string with the service API's EndpointsID, e.g. "api.sagemaker"
-	ServiceEndpointsID string
-	// VersionInfo describes the service controller's built code
-	VersionInfo VersionInfo
 	// rmFactories is a map of resource manager factories, keyed by the
 	// GroupKind of the resource managed by the resource manager produced by
 	// that factory
@@ -258,18 +239,25 @@ func (c *serviceController) BindControllerManager(mgr ctrlrt.Manager, cfg ackcfg
 	return nil
 }
 
+// GetMetadata returns the metadata associated with the service controller.
+func (c *serviceController) GetMetadata() acktypes.ServiceControllerMetadata {
+	return c.ServiceControllerMetadata
+}
+
 // NewServiceController returns a new serviceController instance
 func NewServiceController(
 	svcAlias string,
 	svcAPIGroup string,
 	svcEndpointsID string,
-	versionInfo VersionInfo,
+	versionInfo acktypes.VersionInfo,
 ) acktypes.ServiceController {
 	return &serviceController{
-		ServiceAlias:       svcAlias,
-		ServiceAPIGroup:    svcAPIGroup,
-		ServiceEndpointsID: svcEndpointsID,
-		VersionInfo:        versionInfo,
-		metrics:            ackmetrics.NewMetrics(svcAlias),
+		ServiceControllerMetadata: acktypes.ServiceControllerMetadata{
+			VersionInfo:        versionInfo,
+			ServiceAlias:       svcAlias,
+			ServiceAPIGroup:    svcAPIGroup,
+			ServiceEndpointsID: svcEndpointsID,
+		},
+		metrics: ackmetrics.NewMetrics(svcAlias),
 	}
 }

pkg/runtime/service_controller.go

@@ -40,10 +40,10 @@ import (
 	"sigs.k8s.io/controller-runtime/pkg/webhook"
 
 	ackv1alpha1 "github.com/aws-controllers-k8s/runtime/apis/core/v1alpha1"
+	mocks "github.com/aws-controllers-k8s/runtime/mocks/pkg/types"
 	ackcfg "github.com/aws-controllers-k8s/runtime/pkg/config"
 	ackrt "github.com/aws-controllers-k8s/runtime/pkg/runtime"
-
-	mocks "github.com/aws-controllers-k8s/runtime/mocks/pkg/types"
+	acktypes "github.com/aws-controllers-k8s/runtime/pkg/types"
 )
 
 var (
@@ -147,7 +147,7 @@ func TestServiceController(t *testing.T) {
 	reg := ackrt.NewRegistry()
 	reg.RegisterResourceManagerFactory(rmf)
 
-	vi := ackrt.VersionInfo{
+	vi := acktypes.VersionInfo{
 		GitCommit:  "test-commit",
 		GitVersion: "test-version",
 		BuildDate:  "now",

pkg/runtime/service_controller_test.go

@@ -14,33 +14,42 @@
 package runtime
 
 import (
+	"fmt"
 	"strings"
-	"time"
 
-	ackconfig "github.com/aws-controllers-k8s/runtime/pkg/config"
 	rtclient "sigs.k8s.io/controller-runtime/pkg/client"
+
+	ackconfig "github.com/aws-controllers-k8s/runtime/pkg/config"
+	acktypes "github.com/aws-controllers-k8s/runtime/pkg/types"
+)
+
+const (
+	// MissingImageTagValue is the placeholder value when ACK controller
+	// image tag(release semver) cannot be determined.
+	MissingImageTagValue = "unknown"
 )
 
 // GetDefaultTags provides Default tags (key value pairs) for given resource
 func GetDefaultTags(
 	config *ackconfig.Config,
 	object rtclient.Object,
+	md acktypes.ServiceControllerMetadata,
 ) map[string]string {
 	if object == nil || config == nil || len(config.ResourceTags) == 0 {
 		return nil
 	}
 	var populatedTags = make(map[string]string)
 	for _, tagKeyVal := range config.ResourceTags {
 		keyVal := strings.Split(tagKeyVal, "=")
-		if keyVal == nil && len(keyVal) != 2 {
+		if keyVal == nil || len(keyVal) != 2 {
 			continue
 		}
 		key := strings.TrimSpace(keyVal[0])
 		val := strings.TrimSpace(keyVal[1])
 		if key == "" || val == "" {
 			continue
 		}
-		populatedValue := expandTagValue(&val, object)
+		populatedValue := expandTagValue(&val, object, md)
 		populatedTags[key] = *populatedValue
 	}
 	if len(populatedTags) == 0 {
@@ -52,18 +61,34 @@ func GetDefaultTags(
 func expandTagValue(
 	value *string,
 	obj rtclient.Object,
+	md acktypes.ServiceControllerMetadata,
 ) *string {
 	if value == nil || obj == nil {
 		return nil
 	}
 	var expandedValue string = ""
 	switch *value {
-	case "%UTCNOW%":
-		expandedValue = time.Now().UTC().String()
-	case "%KUBERNETES_NAMESPACE%":
+	case "%CONTROLLER_VERSION%":
+		expandedValue = generateControllerVersion(md)
+	case "%K8S_NAMESPACE%":
 		expandedValue = obj.GetNamespace()
 	default:
 		expandedValue = *value
 	}
 	return &expandedValue
 }
+
+// generateControllerVersion creates the tag value for key
+// "services.k8s.aws/controller-version". The value for this tag is in the
+// format "<service-name>-<controller-image-tag>". Ex: s3-v0.0.10
+func generateControllerVersion(md acktypes.ServiceControllerMetadata) string {
+	controllerImageTag := md.GitVersion
+	// ACK controller released from the ACK CD pipeline will have the correct
+	// GitVersion. But this value can be empty when manually building ACK
+	// controller image locally and not passing the go ldflags.
+	// Add a placeholder value when git tag is found missing.
+	if controllerImageTag == "" {
+		controllerImageTag = MissingImageTagValue
+	}
+	return fmt.Sprintf("%s-%s", md.ServiceAlias, controllerImageTag)
+}

pkg/runtime/tags.go

@@ -24,6 +24,28 @@ import (
 	ackcfg "github.com/aws-controllers-k8s/runtime/pkg/config"
 )
 
+// VersionInfo contains information about the version of the runtime and
+// service controller in use
+type VersionInfo struct {
+	// GitCommit is the SHA1 commit for the service controller's code
+	GitCommit string
+	// GitVersion is the latest Git tag from the service controller's code
+	GitVersion string
+	// BuildDate is a timestamp of when the code was built
+	BuildDate string
+}
+
+type ServiceControllerMetadata struct {
+	VersionInfo
+	// ServiceAlias is a string with the alias of the service API, e.g. "s3"
+	ServiceAlias string
+	// ServiceAPIGroup is a string with the full DNS-correct API group that
+	// this service controller manages, e.g. "s3.services.k8s.aws"
+	ServiceAPIGroup string
+	// ServiceEndpointsID is a string with the service API's EndpointsID, e.g. "api.sagemaker"
+	ServiceEndpointsID string
+}
+
 // ServiceController wraps one or more reconcilers (for individual resources in
 // an AWS API) with the upstream common controller-runtime machinery.
 type ServiceController interface {
@@ -64,4 +86,7 @@ type ServiceController interface {
 		ackv1alpha1.AWSResourceName,
 		schema.GroupVersionKind,
 	) (*session.Session, error)
+
+	// GetMetadata returns the metadata associated with the service controller.
+	GetMetadata() ServiceControllerMetadata
 }