[sdk-stamps] Remove addition of sdk labels from crd

Author: varshaprasad96

changelog/fragments/add-sdk-stamps.yaml

@@ -1,3 +1,3 @@
 entries:
-    - description: Add sdk annotations to bundle resources (CRDs, CSVs, `annotations.yaml` and `bundle.dockerfile`).
+    - description: Add sdk annotations to bundle resources (CSVs, `annotations.yaml` and `bundle.dockerfile`).
       kind: "addition"

cmd/operator-sdk/add/api.go

@@ -197,7 +197,7 @@ func doAnsibleAPIScaffold() error {
 	if err != nil {
 		return fmt.Errorf("new ansible api scaffold failed: %v", err)
 	}
-	if err = genutil.GenerateCRDNonGo("", *r, apiFlags.CrdVersion, projutil.OperatorTypeAnsible); err != nil {
+	if err = genutil.GenerateCRDNonGo("", *r, apiFlags.CrdVersion); err != nil {
 		return err
 	}
 

cmd/operator-sdk/bundle/create.go

@@ -341,12 +341,12 @@ func copyScorecardConfig() error {
 }
 
 func addLabelsToDockerfile(filename string, metricAnnotation map[string]string) error {
-	var sdkMetricContent string
+	var sdkMetricContent strings.Builder
 	for key, value := range metricAnnotation {
-		sdkMetricContent += fmt.Sprintf("LABEL %s=%s\n", key, value)
+		sdkMetricContent.WriteString(fmt.Sprintf("LABEL %s=%s\n", key, value))
 	}
 
-	err := projutil.RewriteFileContents(filename, "LABEL", sdkMetricContent)
+	err := projutil.RewriteFileContents(filename, "LABEL", sdkMetricContent.String())
 	if err != nil {
 		return fmt.Errorf("error rewriting dockerfile with metric labels, %v", err)
 	}
@@ -366,7 +366,7 @@ func rewriteBundleImageContents(rootDir string) error {
 		return fmt.Errorf("error writing metric labels to annotations.yaml: %v", err)
 	}
 
-	// CopyScorecardConfig to bundle.Dockerfile
+	// Add a COPY for the scorecard config to bundle.Dockerfile.
 	if err := copyScorecardConfig(); err != nil {
 		return fmt.Errorf("error copying scorecardConfig to bundle image, %v", err)
 	}

cmd/operator-sdk/new/cmd.go

@@ -268,8 +268,7 @@ func doAnsibleScaffold() error {
 		return fmt.Errorf("new ansible scaffold failed: %v", err)
 	}
 
-	if err = genutil.GenerateCRDNonGo(projectName, *resource,
-		apiFlags.CrdVersion, projutil.OperatorTypeAnsible); err != nil {
+	if err = genutil.GenerateCRDNonGo(projectName, *resource, apiFlags.CrdVersion); err != nil {
 		return err
 	}
 

hack/generate/test-framework/gen-test-framework.sh

@@ -22,9 +22,3 @@ go mod tidy
 # Run gen commands
 ../../build/operator-sdk generate k8s
 ../../build/operator-sdk generate crds
-
-# Remove sdk labels/annotations from crds
-sed -i "/annotations/d" deploy/crds/cache.example.com_memcacheds_crd.yaml
-sed -i "/operators.operatorframework.io/d" deploy/crds/cache.example.com_memcacheds_crd.yaml
-sed -i "/annotations/d" deploy/crds/cache.example.com_memcachedrs_crd.yaml
-sed -i "/operators.operatorframework.io/d" deploy/crds/cache.example.com_memcachedrs_crd.yaml

internal/generate/clusterserviceversion/bases/clusterserviceversion.go

@@ -70,9 +70,6 @@ func (b ClusterServiceVersion) GetBase() (base *v1alpha1.ClusterServiceVersion,
 		base = b.makeNewBase()
 	}
 
-	// Add sdk labels to csv
-	setSDKAnnotations(base)
-
 	// Interactively fill in UI metadata.
 	if b.Interactive {
 		meta := &uiMetadata{}
@@ -92,22 +89,6 @@ func (b ClusterServiceVersion) GetBase() (base *v1alpha1.ClusterServiceVersion,
 	return base, nil
 }
 
-// setSDKAnnotations adds SDK metric labels to the base if they do not exist. It assumes that
-// if sdk Builder annotation is not present, then all sdk labels are also not populated in csv.
-func setSDKAnnotations(csv *v1alpha1.ClusterServiceVersion) {
-	annotations := csv.GetAnnotations()
-	if annotations == nil {
-		annotations = make(map[string]string)
-	}
-
-	if _, exist := annotations[projutil.OperatorBuilder]; !exist {
-		for key, value := range projutil.MakeOperatorMetricLabels() {
-			annotations[key] = value
-		}
-	}
-	csv.SetAnnotations(annotations)
-}
-
 // setDefaults sets default values in b using b's existing values.
 func (b *ClusterServiceVersion) setDefaults() {
 	if b.DisplayName == "" {

internal/generate/clusterserviceversion/clusterserviceversion.go

@@ -21,6 +21,7 @@ import (
 	"strings"
 
 	"github.com/blang/semver"
+	"github.com/operator-framework/api/pkg/operators/v1alpha1"
 	operatorsv1alpha1 "github.com/operator-framework/api/pkg/operators/v1alpha1"
 	"github.com/operator-framework/operator-registry/pkg/lib/bundle"
 	"k8s.io/apimachinery/pkg/runtime/schema"
@@ -160,13 +161,29 @@ func (g *Generator) Generate(cfg *config.Config, opts ...Option) (err error) {
 		return err
 	}
 
+	// Add sdk labels to csv
+	setSDKAnnotations(csv)
+
 	w, err := g.getWriter()
 	if err != nil {
 		return err
 	}
 	return genutil.WriteObject(w, csv)
 }
 
+// setSDKAnnotations adds SDK metric labels to the base if they do not exist.
+func setSDKAnnotations(csv *v1alpha1.ClusterServiceVersion) {
+	annotations := csv.GetAnnotations()
+	if annotations == nil {
+		annotations = make(map[string]string)
+	}
+
+	for key, value := range projutil.MakeOperatorMetricLabels() {
+		annotations[key] = value
+	}
+	csv.SetAnnotations(annotations)
+}
+
 // LegacyOption is a function that modifies a Generator for legacy project layouts.
 type LegacyOption Option
 
@@ -204,6 +221,9 @@ func (g *Generator) GenerateLegacy(opts ...LegacyOption) (err error) {
 		return err
 	}
 
+	// Add sdk labels to csv
+	setSDKAnnotations(csv)
+
 	w, err := g.getWriter()
 	if err != nil {
 		return err

internal/generate/clusterserviceversion/clusterserviceversion_test.go

@@ -141,7 +141,7 @@ var _ = Describe("Generating a ClusterServiceVersion", func() {
 				}
 				Expect(g.Generate(cfg, opts...)).ToNot(HaveOccurred())
 				outputFile := filepath.Join(tmp, "bases", makeCSVFileName(operatorName))
-				outputFileContents := removeSDKLabelsFromCSVString(string(readFileHelper(outputFile)))
+				outputFileContents := readFileHelper(outputFile)
 				Expect(outputFile).To(BeAnExistingFile())
 				Expect(outputFileContents).To(MatchYAML(baseCSVUIMetaStr))
 			})
@@ -178,7 +178,7 @@ var _ = Describe("Generating a ClusterServiceVersion", func() {
 				}
 				Expect(g.Generate(cfg, opts...)).ToNot(HaveOccurred())
 				outputFile := filepath.Join(tmp, bundle.ManifestsDir, makeCSVFileName(operatorName))
-				outputFileContents := removeSDKLabelsFromCSVString(string(readFileHelper(outputFile)))
+				outputFileContents := readFileHelper(outputFile)
 				Expect(outputFile).To(BeAnExistingFile())
 				Expect(outputFileContents).To(MatchYAML(newCSVStr))
 			})
@@ -195,8 +195,9 @@ var _ = Describe("Generating a ClusterServiceVersion", func() {
 				}
 				Expect(g.Generate(cfg, opts...)).ToNot(HaveOccurred())
 				outputFile := filepath.Join(tmp, g.Version, makeCSVFileName(operatorName))
+				outputFileContents := readFileHelper(outputFile)
 				Expect(outputFile).To(BeAnExistingFile())
-				Expect(string(readFileHelper(outputFile))).To(MatchYAML(newCSVStr))
+				Expect(outputFileContents).To(MatchYAML(newCSVStr))
 			})
 
 			It("should write a ClusterServiceVersion manifest to a legacy bundle file", func() {
@@ -212,7 +213,7 @@ var _ = Describe("Generating a ClusterServiceVersion", func() {
 				}
 				Expect(g.GenerateLegacy(opts...)).ToNot(HaveOccurred())
 				outputFile := filepath.Join(tmp, bundle.ManifestsDir, makeCSVFileName(operatorName))
-				outputFileContents := removeSDKLabelsFromCSVString(string(readFileHelper(outputFile)))
+				outputFileContents := readFileHelper(outputFile)
 				Expect(outputFile).To(BeAnExistingFile())
 				Expect(outputFileContents).To(MatchYAML(newCSVStr))
 			})
@@ -280,46 +281,28 @@ var _ = Describe("Generating a ClusterServiceVersion", func() {
 			})
 		})
 
-		Context("to create a new", func() {
-
-			Context("bundle base", func() {
-				It("should return the default base object", func() {
-					g = Generator{
-						OperatorName: operatorName,
-						OperatorType: operatorType,
-						config:       cfg,
-						getBase:      makeBaseGetter(baseCSV),
-					}
-					csv, err := g.generate()
-					Expect(err).ToNot(HaveOccurred())
-					Expect(csv).To(Equal(baseCSV))
-				})
-				It("should return a base object with customresourcedefinitions", func() {
-					g = Generator{
-						OperatorName: operatorName,
-						OperatorType: operatorType,
-						config:       cfg,
-						getBase:      makeBaseGetter(baseCSVUIMeta),
-					}
-					csv, err := g.generate()
-					Expect(err).ToNot(HaveOccurred())
-					Expect(csv).To(Equal(baseCSVUIMeta))
-				})
+		Context("to create a new base ClusterServiceVersion", func() {
+			It("should return the default base object", func() {
+				g = Generator{
+					OperatorName: operatorName,
+					OperatorType: operatorType,
+					config:       cfg,
+					getBase:      makeBaseGetter(baseCSV),
+				}
+				csv, err := g.generate()
+				Expect(err).ToNot(HaveOccurred())
+				Expect(csv).To(Equal(baseCSV))
 			})
-			Context("bundle", func() {
-				It("should return the expected object", func() {
-					g = Generator{
-						OperatorName: operatorName,
-						OperatorType: operatorType,
-						Version:      version,
-						Collector:    col,
-						config:       cfg,
-						getBase:      makeBaseGetter(baseCSVUIMeta),
-					}
-					csv, err := g.generate()
-					Expect(err).ToNot(HaveOccurred())
-					Expect(csv).To(Equal(newCSV))
-				})
+			It("should return a base object with customresourcedefinitions", func() {
+				g = Generator{
+					OperatorName: operatorName,
+					OperatorType: operatorType,
+					config:       cfg,
+					getBase:      makeBaseGetter(baseCSVUIMeta),
+				}
+				csv, err := g.generate()
+				Expect(err).ToNot(HaveOccurred())
+				Expect(csv).To(Equal(baseCSVUIMeta))
 			})
 		})
 
@@ -380,7 +363,6 @@ var _ = Describe("Generating a ClusterServiceVersion", func() {
 				Expect(csv).To(Equal(upgradeCSV(newCSV, g.OperatorName, g.Version)))
 			})
 		})
-
 	})
 
 })
@@ -445,10 +427,10 @@ func initTestCSVsHelper() {
 	ExpectWithOffset(1, err).ToNot(HaveOccurred())
 }
 
-func readFileHelper(path string) []byte {
+func readFileHelper(path string) string {
 	b, err := ioutil.ReadFile(path)
 	ExpectWithOffset(1, err).ToNot(HaveOccurred())
-	return b
+	return removeSDKLabelsFromCSVString(string(b))
 }
 
 func modifyCSVDepImageHelper(tag string) func(csv *v1alpha1.ClusterServiceVersion) {

internal/generate/crd/crd.go

@@ -40,7 +40,6 @@ import (
 	"github.com/operator-framework/operator-sdk/internal/scaffold"
 	"github.com/operator-framework/operator-sdk/internal/util/fileutil"
 	"github.com/operator-framework/operator-sdk/internal/util/k8sutil"
-	"github.com/operator-framework/operator-sdk/internal/util/projutil"
 )
 
 const DefaultCRDVersion = "v1"
@@ -68,8 +67,6 @@ type Generator struct {
 	// ApisDir is for the location of the API types directory e.g "pkg/apis"
 	// The CSV annotation comments will be parsed from the types under this path.
 	ApisDir string
-	// OperatorType refers to the type of operator (go/ansible/helm)
-	OperatorType string
 }
 
 func (g Generator) validate() error {
@@ -188,8 +185,9 @@ func (g Generator) generateGo() (map[string][]byte, error) {
 			// just remove it.
 			annotations := crd.GetAnnotations()
 			delete(annotations, "controller-gen.kubebuilder.io/version")
-			// Add sdk related labels to the cached annotations
-			g.addSDKLabelsToAnnotations(annotations)
+			if len(annotations) == 0 {
+				annotations = nil
+			}
 			crd.SetAnnotations(annotations)
 			b, err := k8sutil.GetObjectBytes(&crd, yaml.Marshal)
 			if err != nil {
@@ -275,7 +273,6 @@ func (g Generator) generateNonGo() (map[string][]byte, error) {
 
 	sort.Sort(k8sutil.CRDVersions(crd.Spec.Versions))
 	setCRDStorageVersion(crd)
-	g.setSDKLabels(crd)
 	if err := checkCRDVersions(crd); err != nil {
 		return nil, fmt.Errorf("invalid version in CRD %s: %w", crd.GetName(), err)
 	}
@@ -374,26 +371,6 @@ func setCRDStorageVersion(crd *apiextv1beta1.CustomResourceDefinition) {
 	crd.Spec.Versions[0].Storage = true
 }
 
-func (g Generator) setSDKLabels(crd *apiextv1beta1.CustomResourceDefinition) {
-	annotations := crd.GetAnnotations()
-	if annotations == nil {
-		annotations = make(map[string]string)
-	}
-	g.addSDKLabelsToAnnotations(annotations)
-	crd.SetAnnotations(annotations)
-}
-
-func (g Generator) addSDKLabelsToAnnotations(mapAnnotations map[string]string) {
-	for label, value := range projutil.MakeOperatorMetricLabels() {
-		mapAnnotations[label] = value
-	}
-	// Modifying operator type for ansible and helm legacy operators, as during
-	// scaffolding the project directories are not written on disk
-	if g.OperatorType != projutil.OperatorTypeGo {
-		mapAnnotations[projutil.OperatorLayout] = g.OperatorType
-	}
-}
-
 // checkCRDVersions ensures version(s) generated for a CRD are in valid format.
 // From the Kubernetes CRD docs:
 //

internal/generate/crd/crd_test.go

@@ -132,13 +132,9 @@ func TestGenerate(t *testing.T) {
 }
 
 func TestCRDGo(t *testing.T) {
-	// Setting the OperatorType to be "unknown", so that it is propagated in the
-	// sdk labels. The project layout cannot be inferred here as the entire
-	// project scaffolding is not done.
 	g := Generator{
 		IsOperatorGo: true,
 		ApisDir:      filepath.Join(testGoDataDir, scaffold.ApisDir),
-		OperatorType: "unknown",
 	}
 
 	r, err := scaffold.NewResource(testAPIVersion, testKind)
@@ -216,7 +212,6 @@ func TestCRDNonGo(t *testing.T) {
 				Resource:     *r,
 				CRDVersion:   c.crdVersion,
 				IsOperatorGo: false,
-				OperatorType: "unknown",
 			}
 			fileMap, err := g.generateNonGo()
 			if err != nil {
@@ -236,9 +231,6 @@ func TestCRDNonGo(t *testing.T) {
 const crdNonGoDefaultExpV1beta1 = `apiVersion: apiextensions.k8s.io/v1beta1
 kind: CustomResourceDefinition
 metadata:
-  annotations:
-    operators.operatorframework.io/builder: operator-sdk-unknown
-    operators.operatorframework.io/project_layout: unknown
   name: memcacheds.cache.example.com
 spec:
   group: cache.example.com
@@ -265,9 +257,6 @@ spec:
 const crdNonGoDefaultExpV1 = `apiVersion: apiextensions.k8s.io/v1
 kind: CustomResourceDefinition
 metadata:
-  annotations:
-    operators.operatorframework.io/builder: operator-sdk-unknown
-    operators.operatorframework.io/project_layout: unknown
   name: memcacheds.cache.example.com
 spec:
   group: cache.example.com
@@ -294,9 +283,6 @@ spec:
 const crdCustomExpV1beta1 = `apiVersion: apiextensions.k8s.io/v1beta1
 kind: CustomResourceDefinition
 metadata:
-  annotations:
-    operators.operatorframework.io/builder: operator-sdk-unknown
-    operators.operatorframework.io/project_layout: unknown
   name: memcacheds.cache.example.com
 spec:
   group: cache.example.com
@@ -358,9 +344,6 @@ spec:
 const crdCustomExpV1 = `apiVersion: apiextensions.k8s.io/v1
 kind: CustomResourceDefinition
 metadata:
-  annotations:
-    operators.operatorframework.io/builder: operator-sdk-unknown
-    operators.operatorframework.io/project_layout: unknown
   name: memcacheds.cache.example.com
 spec:
   group: cache.example.com