Add PGUpgrades to the controller-gen TODO hack

Issue: [sc-16347]

Author: cbandy

Makefile

@@ -252,7 +252,7 @@ clean: clean-deprecated
 	rm -f config/rbac/role.yaml
 	[ ! -d testing/kuttl/e2e-generated ] || rm -r testing/kuttl/e2e-generated
 	[ ! -d testing/kuttl/e2e-generated-other ] || rm -r testing/kuttl/e2e-generated-other
-	[ ! -d build/crd/generated ] || rm -r build/crd/generated
+	rm -rf build/crd/generated build/crd/*/generated
 	[ ! -f hack/tools/setup-envtest ] || hack/tools/setup-envtest --bin-dir=hack/tools/envtest cleanup
 	[ ! -f hack/tools/setup-envtest ] || rm hack/tools/setup-envtest
 	[ ! -d hack/tools/envtest ] || rm -r hack/tools/envtest

build/crd/pgupgrades/kustomization.yaml

@@ -17,6 +17,12 @@ patches:
   patch: |-
     - op: remove
       path: /status
+- target:
+    group: apiextensions.k8s.io
+    version: v1
+    kind: CustomResourceDefinition
+    name: pgupgrades.postgres-operator.crunchydata.com
+  path: todos.yaml
 - target:
     group: apiextensions.k8s.io
     version: v1

build/crd/pgupgrades/todos.yaml

@@ -0,0 +1,8 @@
+- op: add
+  path: /work
+  value: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names'
+- op: copy
+  from: /work
+  path: /spec/versions/0/schema/openAPIV3Schema/properties/spec/properties/imagePullSecrets/items/properties/name/description
+- op: remove
+  path: /work

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

@@ -880,8 +880,7 @@ spec:
                     let you locate the referenced object inside the same namespace.
                   properties:
                     name:
-                      description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
-                        TODO: Add other useful fields. apiVersion, kind, uid?'
+                      description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names'
                       type: string
                   type: object
                 type: array

docs/content/references/crd.md

@@ -14,7 +14,8 @@
 # limitations under the License.
 
 directory=$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )
-crd_build_dir="$directory"/../build/crd
+clusters_dir="${directory}/../build/crd/postgresclusters"
+upgrades_dir="${directory}/../build/crd/pgupgrades"
 
 # Generate a Kustomize patch file for removing any TODOs we inherit from the Kubernetes API.
 # Right now there is one TODO in our CRD. This script focuses on removing the specific TODO
@@ -33,7 +34,7 @@ echo "Generating Kustomize patch file for removing Kube API TODOs"
 name_desc_with_todo=$(
   python3 -m yq -r \
     .spec.versions[0].schema.openAPIV3Schema.properties.spec.properties.customTLSSecret.properties.name.description \
-    "${crd_build_dir}/generated/postgres-operator.crunchydata.com_postgresclusters.yaml"
+    "${clusters_dir}/generated/postgres-operator.crunchydata.com_postgresclusters.yaml"
 )
 name_desc_without_todo=$(sed 's/ TODO.*//g' <<< "${name_desc_with_todo}")
 
@@ -43,4 +44,11 @@ python3 -m yq -y --arg old "${name_desc_with_todo}" --arg new "${name_desc_witho
 	[paths(select(. == $old)) | { op: "copy", from: "/work", path: "/\(map(tostring) | join("/"))" }] +
 	[{ op: "remove", path: "/work" }]
 ' \
-	"${crd_build_dir}/generated/postgres-operator.crunchydata.com_postgresclusters.yaml" > "${crd_build_dir}/todos.yaml"
+	"${clusters_dir}/generated/postgres-operator.crunchydata.com_postgresclusters.yaml" > "${clusters_dir}/todos.yaml"
+
+python3 -m yq -y --arg old "${name_desc_with_todo}" --arg new "${name_desc_without_todo}" '
+	[{ op: "add", path: "/work", value: $new }] +
+	[paths(select(. == $old)) | { op: "copy", from: "/work", path: "/\(map(tostring) | join("/"))" }] +
+	[{ op: "remove", path: "/work" }]
+' \
+	"${upgrades_dir}/generated/postgres-operator.crunchydata.com_pgupgrades.yaml" > "${upgrades_dir}/todos.yaml"