✨ (go/v4): Add Hub and Spoke for conversion webhooks (#4254)

(go/v4): Add hub and spoke implementation for conversion webhook This commit introduces support for the conversion webhook by adding a hub and spoke implementation.
kubernetes-sigs · Nov 30, 2024 · 781e93f · 781e93f
1 parent cbc6e38
commit 781e93f
Show file tree

Hide file tree

Showing 39 changed files with 890 additions and 240 deletions.
diff --git a/docs/book/src/multiversion-tutorial/conversion.md b/docs/book/src/multiversion-tutorial/conversion.md
@@ -1,8 +1,16 @@
 # Implementing conversion
 
 With our model for conversion in place, it's time to actually implement
-the conversion functions.  We'll put them in a file called
-`cronjob_conversion.go` next to our `cronjob_types.go` file, to avoid
+the conversion functions.  We'll create a conversion webhook
+for our CronJob API version `v1` (Hub) to Spoke our CronJob API version
+`v2` see:
+
+```go
+kubebuilder create webhook --group batch --version v1 --kind CronJob --conversion --spoke v2
+```
+
+The above command will generate the `cronjob_conversion.go` next to our
+`cronjob_types.go` file, to avoid
 cluttering up our main types file with extra functions.
 
 ## Hub...

diff --git a/docs/book/src/multiversion-tutorial/testdata/project/PROJECT b/docs/book/src/multiversion-tutorial/testdata/project/PROJECT
@@ -18,7 +18,10 @@ resources:
   path: tutorial.kubebuilder.io/project/api/v1
   version: v1
   webhooks:
+    conversion: true
     defaulting: true
+    spoke:
+    - v2
     validation: true
     webhookVersion: v1
 - api:
@@ -30,7 +33,6 @@ resources:
   path: tutorial.kubebuilder.io/project/api/v2
   version: v2
   webhooks:
-    conversion: true
     defaulting: true
     validation: true
     webhookVersion: v1

diff --git a/docs/book/src/multiversion-tutorial/testdata/project/api/v1/cronjob_conversion.go b/docs/book/src/multiversion-tutorial/testdata/project/api/v1/cronjob_conversion.go
@@ -1,4 +1,6 @@
 /*
+Copyright 2024 The Kubernetes authors.
+
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
 You may obtain a copy of the License at

diff --git a/docs/book/src/multiversion-tutorial/testdata/project/api/v1/cronjob_types.go b/docs/book/src/multiversion-tutorial/testdata/project/api/v1/cronjob_types.go
@@ -127,6 +127,8 @@ type CronJobStatus struct {
 */
 
 // +kubebuilder:object:root=true
+// +kubebuilder:storageversion
+// +kubebuilder:conversion:hub
 // +kubebuilder:subresource:status
 // +versionName=v1
 // +kubebuilder:storageversion

diff --git a/docs/book/src/multiversion-tutorial/testdata/project/api/v2/cronjob_conversion.go b/docs/book/src/multiversion-tutorial/testdata/project/api/v2/cronjob_conversion.go
@@ -1,4 +1,6 @@
 /*
+Copyright 2024 The Kubernetes authors.
+
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
 You may obtain a copy of the License at
@@ -21,16 +23,17 @@ For imports, we'll need the controller-runtime
 package, plus the API version for our hub type (v1), and finally some of the
 standard packages.
 */
+
 import (
 	"fmt"
 	"strings"
 
-	"sigs.k8s.io/controller-runtime/pkg/conversion"
+	"log"
 
-	v1 "tutorial.kubebuilder.io/project/api/v1"
-)
+	"sigs.k8s.io/controller-runtime/pkg/conversion"
 
-// +kubebuilder:docs-gen:collapse=Imports
+	batchv1 "tutorial.kubebuilder.io/project/api/v1"
+) // +kubebuilder:docs-gen:collapse=Imports
 
 /*
 Our "spoke" versions need to implement the
@@ -43,9 +46,12 @@ methods to convert to/from the hub version.
 ConvertTo is expected to modify its argument to contain the converted object.
 Most of the conversion is straightforward copying, except for converting our changed field.
 */
-// ConvertTo converts this CronJob to the Hub version (v1).
+
+// ConvertTo converts this CronJob (v2) to the Hub version (v1).
 func (src *CronJob) ConvertTo(dstRaw conversion.Hub) error {
-	dst := dstRaw.(*v1.CronJob)
+	dst := dstRaw.(*batchv1.CronJob)
+	log.Printf("ConvertTo: Converting CronJob from Spoke version v2 to Hub version v1;"+
+		"source: %s/%s, target: %s/%s", src.Namespace, src.Name, dst.Namespace, dst.Name)
 
 	sched := src.Spec.Schedule
 	scheduleParts := []string{"*", "*", "*", "*", "*"}
@@ -74,7 +80,7 @@ func (src *CronJob) ConvertTo(dstRaw conversion.Hub) error {
 
 	// Spec
 	dst.Spec.StartingDeadlineSeconds = src.Spec.StartingDeadlineSeconds
-	dst.Spec.ConcurrencyPolicy = v1.ConcurrencyPolicy(src.Spec.ConcurrencyPolicy)
+	dst.Spec.ConcurrencyPolicy = batchv1.ConcurrencyPolicy(src.Spec.ConcurrencyPolicy)
 	dst.Spec.Suspend = src.Spec.Suspend
 	dst.Spec.JobTemplate = src.Spec.JobTemplate
 	dst.Spec.SuccessfulJobsHistoryLimit = src.Spec.SuccessfulJobsHistoryLimit
@@ -93,9 +99,11 @@ ConvertFrom is expected to modify its receiver to contain the converted object.
 Most of the conversion is straightforward copying, except for converting our changed field.
 */
 
-// ConvertFrom converts from the Hub version (v1) to this version.
+// ConvertFrom converts the Hub version (v1) to this CronJob (v2).
 func (dst *CronJob) ConvertFrom(srcRaw conversion.Hub) error {
-	src := srcRaw.(*v1.CronJob)
+	src := srcRaw.(*batchv1.CronJob)
+	log.Printf("ConvertFrom: Converting CronJob from Hub version v1 to Spoke version v2;"+
+		"source: %s/%s, target: %s/%s", src.Namespace, src.Name, dst.Namespace, dst.Name)
 
 	schedParts := strings.Split(src.Spec.Schedule, " ")
 	if len(schedParts) != 5 {

diff --git a/docs/book/src/multiversion-tutorial/testdata/project/internal/webhook/v1/cronjob_webhook.go b/docs/book/src/multiversion-tutorial/testdata/project/internal/webhook/v1/cronjob_webhook.go
@@ -49,6 +49,7 @@ types implement the
 [Hub](https://pkg.go.dev/sigs.k8s.io/controller-runtime/pkg/conversion?tab=doc#Hub) and
 [Convertible](https://pkg.go.dev/sigs.k8s.io/controller-runtime/pkg/conversion?tab=doc#Convertible)
 interfaces, a conversion webhook will be registered.
+
 */
 
 // SetupCronJobWebhookWithManager registers the webhook for CronJob in the manager.

diff --git a/...ok/src/multiversion-tutorial/testdata/project/internal/webhook/v1/cronjob_webhook_test.go b/...ok/src/multiversion-tutorial/testdata/project/internal/webhook/v1/cronjob_webhook_test.go
@@ -164,4 +164,14 @@ var _ = Describe("CronJob Webhook", func() {
 		})
 	})
 
+	Context("When creating CronJob under Conversion Webhook", func() {
+		// TODO (user): Add logic to convert the object to the desired version and verify the conversion
+		// Example:
+		// It("Should convert the object correctly", func() {
+		//     convertedObj := &batchv1.CronJob{}
+		//     Expect(obj.ConvertTo(convertedObj)).To(Succeed())
+		//     Expect(convertedObj).ToNot(BeNil())
+		// })
+	})
+
 })
diff --git a/...ok/src/multiversion-tutorial/testdata/project/internal/webhook/v2/cronjob_webhook_test.go b/...ok/src/multiversion-tutorial/testdata/project/internal/webhook/v2/cronjob_webhook_test.go
@@ -84,14 +84,4 @@ var _ = Describe("CronJob Webhook", func() {
 		// })
 	})
 
-	Context("When creating CronJob under Conversion Webhook", func() {
-		// TODO (user): Add logic to convert the object to the desired version and verify the conversion
-		// Example:
-		// It("Should convert the object correctly", func() {
-		//     convertedObj := &batchv2.CronJob{}
-		//     Expect(obj.ConvertTo(convertedObj)).To(Succeed())
-		//     Expect(convertedObj).ToNot(BeNil())
-		// })
-	})
-
 })
diff --git a/docs/book/src/multiversion-tutorial/webhooks.md b/docs/book/src/multiversion-tutorial/webhooks.md
@@ -3,15 +3,6 @@
 Our conversion is in place, so all that's left is to tell
 controller-runtime about our conversion.
 
-Normally, we'd run
-
-```shell
-kubebuilder create webhook --group batch --version v1 --kind CronJob --conversion
-```
-
-to scaffold out the webhook setup.  However, we've already got webhook
-setup, from when we built our defaulting and validating webhooks!
-
 ## Webhook setup...
 
 {{#literatego ./testdata/project/internal/webhook/v1/cronjob_webhook.go}}

diff --git a/docs/book/src/reference/project-config.md b/docs/book/src/reference/project-config.md
@@ -150,6 +150,7 @@ Now let's check its layout fields definition:
 | `resources.core`                    | It is `true` when  the group used is from Kubernetes API and the API resource is not defined on the project.                                                                                                                                                                    |
 | `resources.external`                | It is `true` when  the flag `--external-api-path` was used to generated the scaffold for an [External Type][external-type].                                                                                                                                                     |
 | `resources.webhooks`                | Store the webhooks data when the sub-command `create webhook` is used.                                                                                                                                                                                                          |
+| `resources.webhooks.spoke`          | Store the API version that will act as the Spoke with the designated Hub version for conversion webhooks.                                                                                                                                                                       |
 | `resources.webhooks.webhookVersion` | The Kubernetes API version (`apiVersion`) used to scaffold the webhook resource.                                                                                                                                                                                                |
 | `resources.webhooks.conversion`     | It is `true` when the webhook was scaffold with the `--conversion` flag which means that is a conversion webhook.                                                                                                                                                               |
 | `resources.webhooks.defaulting`     | It is `true` when the webhook was scaffold with the `--defaulting` flag which means that is a defaulting webhook.                                                                                                                                                               |