Move kubebuilder annotations to YAML comments

Author: cbandy

config/crd/bases/postgres-operator.crunchydata.com_crunchybridgeclusters.yaml

@@ -1,9 +1,8 @@
 ---
+# controller-gen.kubebuilder.io/version: v0.17.3
 apiVersion: apiextensions.k8s.io/v1
 kind: CustomResourceDefinition
 metadata:
-  annotations:
-    controller-gen.kubebuilder.io/version: v0.17.3
   name: crunchybridgeclusters.postgres-operator.crunchydata.com
 spec:
   group: postgres-operator.crunchydata.com

config/crd/bases/postgres-operator.crunchydata.com_pgadmins.yaml

@@ -1,9 +1,8 @@
 ---
+# controller-gen.kubebuilder.io/version: v0.17.3
 apiVersion: apiextensions.k8s.io/v1
 kind: CustomResourceDefinition
 metadata:
-  annotations:
-    controller-gen.kubebuilder.io/version: v0.17.3
   name: pgadmins.postgres-operator.crunchydata.com
 spec:
   group: postgres-operator.crunchydata.com

config/crd/bases/postgres-operator.crunchydata.com_pgupgrades.yaml

@@ -1,9 +1,8 @@
 ---
+# controller-gen.kubebuilder.io/version: v0.17.3
 apiVersion: apiextensions.k8s.io/v1
 kind: CustomResourceDefinition
 metadata:
-  annotations:
-    controller-gen.kubebuilder.io/version: v0.17.3
   name: pgupgrades.postgres-operator.crunchydata.com
 spec:
   group: postgres-operator.crunchydata.com

config/crd/bases/postgres-operator.crunchydata.com_postgresclusters.yaml

@@ -1,9 +1,8 @@
 ---
+# controller-gen.kubebuilder.io/version: v0.17.3
 apiVersion: apiextensions.k8s.io/v1
 kind: CustomResourceDefinition
 metadata:
-  annotations:
-    controller-gen.kubebuilder.io/version: v0.17.3
   name: postgresclusters.postgres-operator.crunchydata.com
 spec:
   group: postgres-operator.crunchydata.com

internal/crd/post-process.go

@@ -12,6 +12,7 @@ import (
 	"log/slog"
 	"os"
 	"path/filepath"
+	"regexp"
 
 	"github.com/itchyny/gojq"
 	"sigs.k8s.io/yaml"
@@ -44,8 +45,12 @@ func main() {
 				panic(err)
 			}
 
+			// Turn top-level strings that start with octothorpe U+0023 into YAML comments by removing their quotes.
+			yamlData := need(yaml.Marshal(v))
+			yamlData = regexp.MustCompile(`(?m)^'(#[^']*)'(.*)$`).ReplaceAll(yamlData, []byte("$1$2"))
+
 			slog.Info("Writing", "file", yamlName)
-			must(os.WriteFile(yamlPath, append([]byte("---\n"), need(yaml.Marshal(v))...), 0o644))
+			must(os.WriteFile(yamlPath, append([]byte("---\n"), yamlData...), 0o644))
 		}
 
 		if _, ok := result.Next(); ok {

internal/crd/post-process.jq

@@ -64,4 +64,22 @@ reduce paths(try .["x-kubernetes-int-or-string"] == true) as $path (.;
   end
 ) |
 
+# Rename Kubebuilder annotations and move them to the top-level.
+# The caller can turn these into YAML comments.
+. += (.metadata.annotations | with_entries(select(.key | startswith("controller-gen.kubebuilder")) | .key = "# \(.key)")) |
+.metadata.annotations |= with_entries(select(.key | startswith("controller-gen.kubebuilder") | not)) |
+
+# Remove nulls and empty objects from metadata.
+# Some very old generators would set a null creationTimestamp.
+#
+# https://github.com/kubernetes-sigs/controller-tools/issues/402
+# https://issue.k8s.io/67610
+del(.metadata | .. | select(length == 0)) |
+
+# Remove status to avoid conflicts with the CRD controller.
+# Some very old generators would set this field.
+#
+# https://github.com/kubernetes-sigs/controller-tools/issues/456
+del(.status) |
+
 .