chore(crd): use conventional paths and update controller-gen to v0.17.2 (#5287)

mloiseleur · web-flow · commit 2481c07e95a2 · 2025-05-04T12:53:56.000-07:00
* chore(crd): update controller-gen to v0.17.2

* review: only one crd manifest

* set crd in expected paths
diff --git a/Makefile b/Makefile
@@ -32,10 +32,6 @@ else
 CONTROLLER_GEN=$(shell which controller-gen)
 endif
 
-#? controller-gen-install: download controller-gen if necessary
-controller-gen-install:
-	@scripts/install-tools.sh --generator
-
 #? golangci-lint-install: Install golangci-lint tool
 golangci-lint-install:
 	@scripts/install-tools.sh --golangci
@@ -67,10 +63,11 @@ oas-lint:
 .PHONY: lint
 lint: licensecheck go-lint oas-lint
 
-#? crd: Generates CRD using controller-gen
+#? crd: Generates CRD using controller-gen and copy it into chart
 .PHONY: crd
 crd: controller-gen-install
-	${CONTROLLER_GEN} crd:crdVersions=v1 paths="./endpoint/..." output:crd:stdout > docs/contributing/crd-source/crd-manifest.yaml
+	${CONTROLLER_GEN} crd:crdVersions=v1 paths="./endpoint/..." output:crd:stdout > config/crd/standard/dnsendpoint.yaml
+	cp -f config/crd/standard/dnsendpoint.yaml charts/external-dns/crds/dnsendpoint.yaml
 
 #? test: The verify target runs tasks similar to the CI tasks, but without code coverage
 .PHONY: test
diff --git a/charts/external-dns/crds/dnsendpoint.yaml b/charts/external-dns/crds/dnsendpoint.yaml
@@ -1,9 +1,11 @@
+---
 apiVersion: apiextensions.k8s.io/v1
 kind: CustomResourceDefinition
 metadata:
-  name: dnsendpoints.externaldns.k8s.io
   annotations:
     api-approved.kubernetes.io: https://github.com/kubernetes-sigs/external-dns/pull/2007
+    controller-gen.kubebuilder.io/version: v0.17.2
+  name: dnsendpoints.externaldns.k8s.io
 spec:
   group: externaldns.k8s.io
   names:
@@ -13,90 +15,86 @@ spec:
     singular: dnsendpoint
   scope: Namespaced
   versions:
-    - name: v1alpha1
-      schema:
-        openAPIV3Schema:
-          properties:
-            apiVersion:
-              description: |-
-                APIVersion defines the versioned schema of this representation of an object.
-                Servers should convert recognized schemas to the latest internal value, and
-                may reject unrecognized values.
-                More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
-              type: string
-            kind:
-              description: |-
-                Kind is a string value representing the REST resource this object represents.
-                Servers may infer this from the endpoint the client submits requests to.
-                Cannot be updated.
-                In CamelCase.
-                More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
-              type: string
-            metadata:
-              type: object
-            spec:
-              description: DNSEndpointSpec defines the desired state of DNSEndpoint
-              properties:
-                endpoints:
-                  items:
-                    description:
-                      Endpoint is a high-level way of a connection between
-                      a service and an IP
-                    properties:
-                      dnsName:
-                        description: The hostname of the DNS record
+  - name: v1alpha1
+    schema:
+      openAPIV3Schema:
+        properties:
+          apiVersion:
+            description: |-
+              APIVersion defines the versioned schema of this representation of an object.
+              Servers should convert recognized schemas to the latest internal value, and
+              may reject unrecognized values.
+              More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
+            type: string
+          kind:
+            description: |-
+              Kind is a string value representing the REST resource this object represents.
+              Servers may infer this from the endpoint the client submits requests to.
+              Cannot be updated.
+              In CamelCase.
+              More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
+            type: string
+          metadata:
+            type: object
+          spec:
+            description: DNSEndpointSpec defines the desired state of DNSEndpoint
+            properties:
+              endpoints:
+                items:
+                  description: Endpoint is a high-level way of a connection between
+                    a service and an IP
+                  properties:
+                    dnsName:
+                      description: The hostname of the DNS record
+                      type: string
+                    labels:
+                      additionalProperties:
                         type: string
-                      labels:
-                        additionalProperties:
-                          type: string
-                        description: Labels stores labels defined for the Endpoint
+                      description: Labels stores labels defined for the Endpoint
+                      type: object
+                    providerSpecific:
+                      description: ProviderSpecific stores provider specific config
+                      items:
+                        description: ProviderSpecificProperty holds the name and value
+                          of a configuration which is specific to individual DNS providers
+                        properties:
+                          name:
+                            type: string
+                          value:
+                            type: string
                         type: object
-                      providerSpecific:
-                        description: ProviderSpecific stores provider specific config
-                        items:
-                          description:
-                            ProviderSpecificProperty holds the name and value
-                            of a configuration which is specific to individual DNS providers
-                          properties:
-                            name:
-                              type: string
-                            value:
-                              type: string
-                          type: object
-                        type: array
-                      recordTTL:
-                        description: TTL for the record
-                        format: int64
-                        type: integer
-                      recordType:
-                        description:
-                          RecordType type of record, e.g. CNAME, A, AAAA,
-                          SRV, TXT etc
-                        type: string
-                      setIdentifier:
-                        description:
-                          Identifier to distinguish multiple records with
-                          the same name and type (e.g. Route53 records with routing
-                          policies other than 'simple')
+                      type: array
+                    recordTTL:
+                      description: TTL for the record
+                      format: int64
+                      type: integer
+                    recordType:
+                      description: RecordType type of record, e.g. CNAME, A, AAAA,
+                        SRV, TXT etc
+                      type: string
+                    setIdentifier:
+                      description: Identifier to distinguish multiple records with
+                        the same name and type (e.g. Route53 records with routing
+                        policies other than 'simple')
+                      type: string
+                    targets:
+                      description: The targets the DNS record points to
+                      items:
                         type: string
-                      targets:
-                        description: The targets the DNS record points to
-                        items:
-                          type: string
-                        type: array
-                    type: object
-                  type: array
-              type: object
-            status:
-              description: DNSEndpointStatus defines the observed state of DNSEndpoint
-              properties:
-                observedGeneration:
-                  description: The generation observed by the external-dns controller.
-                  format: int64
-                  type: integer
-              type: object
-          type: object
-      served: true
-      storage: true
-      subresources:
-        status: {}
+                      type: array
+                  type: object
+                type: array
+            type: object
+          status:
+            description: DNSEndpointStatus defines the observed state of DNSEndpoint
+            properties:
+              observedGeneration:
+                description: The generation observed by the external-dns controller.
+                format: int64
+                type: integer
+            type: object
+        type: object
+    served: true
+    storage: true
+    subresources:
+      status: {}
diff --git a/config/crd/standard/dnsendpoint.yaml b/config/crd/standard/dnsendpoint.yaml
@@ -4,7 +4,7 @@ kind: CustomResourceDefinition
 metadata:
   annotations:
     api-approved.kubernetes.io: https://github.com/kubernetes-sigs/external-dns/pull/2007
-    controller-gen.kubebuilder.io/version: v0.15.0
+    controller-gen.kubebuilder.io/version: v0.17.2
   name: dnsendpoints.externaldns.k8s.io
 spec:
   group: externaldns.k8s.io
diff --git a/docs/sources/crd.md b/docs/sources/crd.md
@@ -81,11 +81,11 @@ Create the objects of CRD type by filling in the fields of CRD and DNS record wo
 
 ### Example
 
-Here is an example [CRD manifest](crd/crd-manifest.yaml) generated by kubebuilder.
+Here is an example [CRD manifest](https://github.com/kubernetes-sigs/external-dns/blob/HEAD/charts/external-dns/crds/dnsendpoint.yaml) generated by kubebuilder.
 Apply this to register the CRD
 
 ```sh
-$ kubectl apply --validate=false -f docs/sources/crd/crd-manifest.yaml
+$ kubectl apply --server-side=true -f "https://raw.githubusercontent.com/kubernetes-sigs/external-dns/master/config/crd/standard/dnsendpoint.yaml"
 customresourcedefinition.apiextensions.k8s.io "dnsendpoints.externaldns.k8s.io" created
 ```
 
diff --git a/endpoint/endpoint.go b/endpoint/endpoint.go
@@ -204,6 +204,7 @@ type EndpointKey struct {
 }
 
 // Endpoint is a high-level way of a connection between a service and an IP
+// +kubebuilder:object:generate=true
 type Endpoint struct {
 	// The hostname of the DNS record
 	DNSName string `json:"dnsName,omitempty"`
@@ -337,6 +338,7 @@ func FilterEndpointsByOwnerID(ownerID string, eps []*Endpoint) []*Endpoint {
 }
 
 // DNSEndpointSpec defines the desired state of DNSEndpoint
+// +kubebuilder:object:generate=true
 type DNSEndpointSpec struct {
 	Endpoints []*Endpoint `json:"endpoints,omitempty"`
 }
diff --git a/endpoint/zz_generated.deepcopy.go b/endpoint/zz_generated.deepcopy.go
diff --git a/scripts/install-tools.sh b/scripts/install-tools.sh

Original file line number	Diff line number	Diff line change
`@@ -204,6 +204,7 @@ type EndpointKey struct {`
`204`	`204`	`}`
`205`	`205`
`206`	`206`	`// Endpoint is a high-level way of a connection between a service and an IP`
	`207`	`+// +kubebuilder:object:generate=true`
`207`	`208`	`type Endpoint struct {`
`208`	`209`	`// The hostname of the DNS record`
`209`	`210`	DNSName string `json:"dnsName,omitempty"`
`@@ -337,6 +338,7 @@ func FilterEndpointsByOwnerID(ownerID string, eps []Endpoint) []Endpoint {`
`337`	`338`	`}`
`338`	`339`
`339`	`340`	`// DNSEndpointSpec defines the desired state of DNSEndpoint`
	`341`	`+// +kubebuilder:object:generate=true`
`340`	`342`	`type DNSEndpointSpec struct {`
`341`	`343`	Endpoints []*Endpoint `json:"endpoints,omitempty"`
`342`	`344`	`}`