Experimental configurations to override controller names (#494)

Since the early days of ACK, we've always relied on the `serviceID` to
name the controller repositories. The way names, go modules, import
paths, helm charts are named relied on this `serviceID`. Which was the
main reason why some controllers had a bit of odd names, like
`prometheusservice-controller` instead of `amp-controller`,
`acmpca-controller` instead of `pca-controller`. This patch introduces
experimental configurations that instructs the code generator to
override the serviceID/servicePackageName when it comes to import
paths/helm charts names etc...

Related issue: aws-controllers-k8s/community#1411

Signed-off-by: Amine Hilaly <[email protected]>

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

Author: a-hilaly

cmd/ack-generate/command/common.go

@@ -99,7 +99,6 @@ func getLatestAPIVersion(apiVersions []ackmetadata.ServiceVersion) (string, erro
 
 // getServiceAccountName gets the service account name from the optional flag passed into ack-generate
 func getServiceAccountName() (string, error) {
-
 	if optServiceAccountName != "" {
 		return optServiceAccountName, nil
 	}

cmd/ack-generate/command/controller.go

@@ -127,7 +127,7 @@ func FallBackFindServiceID(sdkDir, svcAlias string) (string, error) {
 			defer f.Close()
 			scanner := bufio.NewScanner(f)
 			for scanner.Scan() {
-				if strings.Contains(scanner.Text(), "serviceId") {
+				if strings.Contains(scanner.Text(), "serviceId") && !strings.Contains(scanner.Text(), "serviceIdentifier") {
 					getServiceID := strings.Split(scanner.Text(), ":")
 					re := regexp.MustCompile(`[," \t]`)
 					svcID := strings.ToLower(re.ReplaceAllString(getServiceID[1], ``))

pkg/config/config.go

@@ -44,6 +44,14 @@ type Config struct {
 	// only the service model name, but also the iface name to `PipesAPI`. See
 	// https://github.com/aws/aws-sdk-go/blob/main/service/pipes/pipesiface/interface.go#L62
 	SDKNames SDKNames `json:"sdk_names"`
+	// ControllerName lets you specify a service alias override. This can be
+	// used to only override the controller name exposed to the user. Meaning that
+	// it will only change the module name, the import paths, and the controller
+	// name. This is useful when the service identifier is not very user friendly
+	// and you want to expose a more user friendly name to the user. e.g docdb ->
+	// documentdb.
+	// This will also change the helm chart and image names.
+	ControllerName string `json:"controller_name,omitempty"`
 }
 
 // SDKNames contains information on the SDK Client package. More precisely
@@ -56,6 +64,14 @@ type SDKNames struct {
 	// model name is `opensearch` and the service package is called
 	// `opensearchservice`.
 	Model string `json:"model_name,omitempty"`
+	// Package let you define the package name of the service client. This field
+	// is optional and only needed for services such as documentdb where the service
+	// controller is called `documentdb` and the package is called `docdb`.
+	//
+	// You might be wondering why not just use the `model_name` field... well the
+	// answer is prometheusservice... the model name is `amp` and the service package
+	// is called `prometheusservice`. :shrug:
+	Package string `json:"package_name,omitempty"`
 	// ClientInterface is the name of the interface that defines the "shape" of
 	// the a sdk service client. e.g PipesAPI, LambdaAPI, etc...
 	ClientInterface string `json:"client_interface,omitempty"`

pkg/generate/ack/release.go

@@ -100,7 +100,7 @@ func Release(
 		templateBasePaths,
 		releaseIncludePaths,
 		releaseCopyPaths,
-		releaseFuncMap(m.MetaVars().ServicePackageName),
+		releaseFuncMap(m.MetaVars().ControllerName),
 	)
 	metaVars := m.MetaVars()
 

pkg/generate/templateset/vars.go

@@ -16,6 +16,10 @@ package templateset
 // MetaVars contains template variables that most templates need access to
 // that describe the service alias, its package name, etc
 type MetaVars struct {
+	// ControllerName contains the exact string used to identify the ACK
+	// controller in the aws-controllers-k8s project. This name is used as the
+	// name of the ACK controller's module, repository and helm chart.
+	ControllerName string
 	// ServiceModelName contains the exact string used to identify the AWS
 	// service API in the aws-sdk-go's models/apis/ directory. Note that some
 	// APIs this name does not match the ServiceID. e.g. The AWS Step Functions

pkg/model/model.go

@@ -52,8 +52,24 @@ type Model struct {
 // MetaVars returns a MetaVars struct populated with metadata about the AWS
 // service API
 func (m *Model) MetaVars() templateset.MetaVars {
+	controllerName := m.cfg.ControllerName
+	if controllerName == "" {
+		controllerName = m.servicePackageName
+	}
+	// NOTE(a-hilaly): I know this is a bit of a hack and it's confusing, but
+	// long time ago, we assumed that model_name is always equal to the service
+	// name. This is not the case anymore, prometheusservice and documentdb
+	// are examples of services that have different model names.
+	//
+	// TODO(a-hilaly): We should probably rework all this naming stuff to be
+	// more consistent. To whoever is reading this, I'm sorry.
+	servicePackageName := m.servicePackageName
+	if m.cfg.SDKNames.Package != "" {
+		servicePackageName = m.cfg.SDKNames.Package
+	}
 	return templateset.MetaVars{
-		ServicePackageName:      m.servicePackageName,
+		ControllerName:          controllerName,
+		ServicePackageName:      servicePackageName,
 		ServiceID:               m.SDKAPI.ServiceID(),
 		ServiceModelName:        m.cfg.SDKNames.Model,
 		APIGroup:                m.APIGroup(),
@@ -943,7 +959,11 @@ func (m *Model) APIGroup() string {
 	if m.SDKAPI.APIGroupSuffix != "" {
 		suffix = m.SDKAPI.APIGroupSuffix
 	}
-	return fmt.Sprintf("%s.%s", m.servicePackageName, suffix)
+	name := m.GetConfig().ControllerName
+	if name == "" {
+		name = m.servicePackageName
+	}
+	return fmt.Sprintf("%s.%s", name, suffix)
 }
 
 // ClientInterfaceTypeName returns the name of the aws-sdk-go primary API

templates/cmd/controller/main.go.tpl

@@ -25,26 +25,27 @@ import (
 If these referenced types are not added to scheme, this service controller will not be able to read
 resources across service controller. */ -}}
 {{- $servicePackageName := .ServicePackageName }}
+{{- $controllerName := .ControllerName }}
 {{- $apiVersion := .APIVersion }}
 {{- range $referencedServiceName := .ReferencedServiceNames }}
 {{- if not (eq $referencedServiceName $servicePackageName) }}
 	{{ $referencedServiceName }}apitypes "github.com/aws-controllers-k8s/{{ $referencedServiceName }}-controller/apis/{{ $apiVersion }}"
 {{- end }}
 {{- end }}
 
-	svcresource "github.com/aws-controllers-k8s/{{ .ServicePackageName }}-controller/pkg/resource"
+	svcresource "github.com/aws-controllers-k8s/{{ .ControllerName }}-controller/pkg/resource"
 	svcsdk "github.com/aws/aws-sdk-go/service/{{ .ServicePackageName }}"
-	svctypes "github.com/aws-controllers-k8s/{{ .ServicePackageName }}-controller/apis/{{ .APIVersion }}"
+	svctypes "github.com/aws-controllers-k8s/{{ .ControllerName }}-controller/apis/{{ .APIVersion }}"
 
 	{{/* TODO(a-hilaly): import apis/* packages to register webhooks */}}
-	{{range $crdName := .SnakeCasedCRDNames }}_ "github.com/aws-controllers-k8s/{{ $servicePackageName }}-controller/pkg/resource/{{ $crdName }}"
+	{{range $crdName := .SnakeCasedCRDNames }}_ "github.com/aws-controllers-k8s/{{ $controllerName }}-controller/pkg/resource/{{ $crdName }}"
 	{{end}}
-	"github.com/aws-controllers-k8s/{{ .ServicePackageName }}-controller/pkg/version"
+	"github.com/aws-controllers-k8s/{{ .ControllerName }}-controller/pkg/version"
 )
 
 var (
 	awsServiceAPIGroup      = "{{ .APIGroup }}"
-	awsServiceAlias	        = "{{ .ServicePackageName }}"
+	awsServiceAlias	        = "{{ .ControllerName }}"
 	awsServiceEndpointsID   = svcsdk.EndpointsID
 	scheme			        = runtime.NewScheme()
 	setupLog		        = ctrlrt.Log.WithName("setup")

templates/config/controller/deployment.yaml.tpl

@@ -6,20 +6,20 @@ metadata:
 apiVersion: apps/v1
 kind: Deployment
 metadata:
-  name: ack-{{ .ServicePackageName }}-controller
+  name: ack-{{ .ControllerName }}-controller
   namespace: ack-system
   labels:
-    app.kubernetes.io/name: ack-{{ .ServicePackageName }}-controller
+    app.kubernetes.io/name: ack-{{ .ControllerName }}-controller
     app.kubernetes.io/part-of: ack-system
 spec:
   selector:
     matchLabels:
-      app.kubernetes.io/name: ack-{{ .ServicePackageName }}-controller
+      app.kubernetes.io/name: ack-{{ .ControllerName }}-controller
   replicas: 1
   template:
     metadata:
       labels:
-        app.kubernetes.io/name: ack-{{ .ServicePackageName }}-controller
+        app.kubernetes.io/name: ack-{{ .ControllerName }}-controller
     spec:
       containers:
       - command:

templates/config/controller/olm-kustomization.yaml.tpl

@@ -15,6 +15,6 @@ patches:
   target:
     group: apps
     kind: Deployment
-    name: ack-{{ .ServicePackageName }}-controller
+    name: ack-{{ .ControllerName }}-controller
     version: v1
 - path: user-env.yaml

templates/config/controller/service.yaml.tpl

@@ -1,11 +1,11 @@
 apiVersion: v1
 kind: Service
 metadata:
-  name: ack-{{ .ServicePackageName }}-metrics-service
+  name: ack-{{ .ControllerName }}-metrics-service
   namespace: ack-system
 spec:
   selector:
-    app.kubernetes.io/name: ack-{{ .ServicePackageName }}-controller
+    app.kubernetes.io/name: ack-{{ .ControllerName }}-controller
   ports:
     - name: metricsport
       port: 8080