Use CustomValidator and CustomDefaulter instead of Validator and Defa…

…ulter

docs/book/src/cronjob-tutorial/testdata/project/api/v1/cronjob_webhook.go

@@ -18,6 +18,7 @@ limitations under the License.
 package v1
 
 import (
+	"context"
 	"github.com/robfig/cron"
 	apierrors "k8s.io/apimachinery/pkg/api/errors"
 	"k8s.io/apimachinery/pkg/runtime"
@@ -46,6 +47,8 @@ Then, we set up the webhook with the manager.
 func (r *CronJob) SetupWebhookWithManager(mgr ctrl.Manager) error {
 	return ctrl.NewWebhookManagedBy(mgr).
 		For(r).
+		WithValidator(r).
+		WithDefaulter(r).
 		Complete()
 }
 
@@ -59,16 +62,16 @@ The meaning of each marker can be found [here](/reference/markers/webhook.md).
 //+kubebuilder:webhook:path=/mutate-batch-tutorial-kubebuilder-io-v1-cronjob,mutating=true,failurePolicy=fail,groups=batch.tutorial.kubebuilder.io,resources=cronjobs,verbs=create;update,versions=v1,name=mcronjob.kb.io,sideEffects=None,admissionReviewVersions=v1
 
 /*
-We use the `webhook.Defaulter` interface to set defaults to our CRD.
+We use the `webhook.CustomDefaulter` interface to set defaults to our CRD.
 A webhook will automatically be served that calls this defaulting.
 
 The `Default` method is expected to mutate the receiver, setting the defaults.
 */
 
-var _ webhook.Defaulter = &CronJob{}
+var _ webhook.CustomDefaulter = &CronJob{}
 
-// Default implements webhook.Defaulter so a webhook will be registered for the type
-func (r *CronJob) Default() {
+// Default implements webhook.CustomDefaulter so a webhook will be registered for the type
+func (r *CronJob) Default(ctx context.Context, obj runtime.Object) error {
 	cronjoblog.Info("default", "name", r.Name)
 
 	if r.Spec.ConcurrencyPolicy == "" {
@@ -85,6 +88,8 @@ func (r *CronJob) Default() {
 		r.Spec.FailedJobsHistoryLimit = new(int32)
 		*r.Spec.FailedJobsHistoryLimit = 1
 	}
+
+	return nil
 }
 
 /*
@@ -115,24 +120,24 @@ Here, however, we just use the same shared validation for `ValidateCreate` and
 validate anything on deletion.
 */
 
-var _ webhook.Validator = &CronJob{}
+var _ webhook.CustomValidator = &CronJob{}
 
-// ValidateCreate implements webhook.Validator so a webhook will be registered for the type
-func (r *CronJob) ValidateCreate() (admission.Warnings, error) {
+// ValidateCreate implements webhook.CustomValidator so a webhook will be registered for the type
+func (r *CronJob) ValidateCreate(ctx context.Context, obj runtime.Object) (admission.Warnings, error) {
 	cronjoblog.Info("validate create", "name", r.Name)
 
 	return nil, r.validateCronJob()
 }
 
-// ValidateUpdate implements webhook.Validator so a webhook will be registered for the type
-func (r *CronJob) ValidateUpdate(old runtime.Object) (admission.Warnings, error) {
+// ValidateUpdate implements webhook.CustomValidator so a webhook will be registered for the type
+func (r *CronJob) ValidateUpdate(ctx context.Context, oldObj, newObj runtime.Object) (admission.Warnings, error) {
 	cronjoblog.Info("validate update", "name", r.Name)
 
 	return nil, r.validateCronJob()
 }
 
-// ValidateDelete implements webhook.Validator so a webhook will be registered for the type
-func (r *CronJob) ValidateDelete() (admission.Warnings, error) {
+// ValidateDelete implements webhook.CustomValidator so a webhook will be registered for the type
+func (r *CronJob) ValidateDelete(ctx context.Context, obj runtime.Object) (admission.Warnings, error) {
 	cronjoblog.Info("validate delete", "name", r.Name)
 
 	// TODO(user): fill in your validation logic upon object deletion.

docs/book/src/cronjob-tutorial/testdata/project/internal/controller/suite_test.go

@@ -22,7 +22,6 @@ Kubebuilder scaffolded a `internal/controller/suite_test.go` file that does the
 First, it will contain the necessary imports.
 */
 
-
 package controller
 
 import (

docs/book/src/cronjob-tutorial/webhook-implementation.md

@@ -1,8 +1,8 @@
 # Implementing defaulting/validating webhooks
 
 If you want to implement [admission webhooks](../reference/admission-webhook.md)
-for your CRD, the only thing you need to do is to implement the `Defaulter`
-and (or) the `Validator` interface.
+for your CRD, the only thing you need to do is to implement the `CustomDefaulter`
+and (or) the `CustomValidator` interface.
 
 Kubebuilder takes care of the rest for you, such as
 

hack/docs/internal/cronjob-tutorial/generate_cronjob.go

@@ -382,6 +382,8 @@ func updateWebhook(sp *Sample) {
 	err = pluginutil.ReplaceInFile(
 		filepath.Join(sp.ctx.Dir, "api/v1/cronjob_webhook.go"),
 		`import (
+	"context"
+
 	"k8s.io/apimachinery/pkg/runtime"
 	ctrl "sigs.k8s.io/controller-runtime"
 	logf "sigs.k8s.io/controller-runtime/pkg/log"
@@ -427,6 +429,7 @@ Then, we set up the webhook with the manager.
 		`cronjoblog.Info("default", "name", r.Name)
 
 	// TODO(user): fill in your defaulting logic.
+	return nil
 `, WebhookValidate)
 	CheckError("fixing cronjob_webhook.go by adding logic", err)
 
@@ -448,7 +451,7 @@ Then, we set up the webhook with the manager.
 
 	err = pluginutil.InsertCode(
 		filepath.Join(sp.ctx.Dir, "api/v1/cronjob_webhook.go"),
-		`func (r *CronJob) ValidateDelete() (admission.Warnings, error) {
+		`func (r *CronJob) ValidateDelete(ctx context.Context, obj runtime.Object) (admission.Warnings, error) {
 	cronjoblog.Info("validate delete", "name", r.Name)
 
 	// TODO(user): fill in your validation logic upon object deletion.
@@ -596,8 +599,8 @@ func updateExample(sp *Sample) {
 }
 
 func addControllerTest(sp *Sample) {
-	var fs = afero.NewOsFs()
-	err := afero.WriteFile(fs, filepath.Join(sp.ctx.Dir, "internal/controller/cronjob_controller_test.go"), []byte(ControllerTest), 0600)
+	fs := afero.NewOsFs()
+	err := afero.WriteFile(fs, filepath.Join(sp.ctx.Dir, "internal/controller/cronjob_controller_test.go"), []byte(ControllerTest), 0o600)
 	CheckError("adding cronjob_controller_test", err)
 }
 

hack/docs/internal/cronjob-tutorial/webhook_implementation.go

@@ -17,6 +17,7 @@ limitations under the License.
 package cronjob
 
 const WebhookIntro = `import (
+	"context"
 	"github.com/robfig/cron"
 	apierrors "k8s.io/apimachinery/pkg/api/errors"
 	"k8s.io/apimachinery/pkg/runtime"
@@ -47,7 +48,7 @@ The meaning of each marker can be found [here](/reference/markers/webhook.md).
 //+kubebuilder:webhook:path=/mutate-batch-tutorial-kubebuilder-io-v1-cronjob,mutating=true,failurePolicy=fail,groups=batch.tutorial.kubebuilder.io,resources=cronjobs,verbs=create;update,versions=v1,name=mcronjob.kb.io,sideEffects=None,admissionReviewVersions=v1
 
 /*
-We use the` + " `" + `webhook.Defaulter` + "`" + ` interface to set defaults to our CRD.
+We use the` + " `" + `webhook.CustomDefaulter` + "`" + ` interface to set defaults to our CRD.
 A webhook will automatically be served that calls this defaulting.
 
 The` + " `" + `Default` + "`" + ` method is expected to mutate the receiver, setting the defaults.
@@ -70,6 +71,8 @@ const WebhookValidate = `	cronjoblog.Info("default", "name", r.Name)
 		r.Spec.FailedJobsHistoryLimit = new(int32)
 		*r.Spec.FailedJobsHistoryLimit = 1
 	}
+
+	return nil
 }
 
 /*

pkg/plugin/util/util.go

@@ -152,8 +152,8 @@ func ImplementWebhooks(filename string) error {
 	str, err = EnsureExistAndReplace(
 		str,
 		"// TODO(user): fill in your defaulting logic.",
-		`if r.Spec.Count == 0 {
-		r.Spec.Count = 5
+		`if res.Spec.Count == 0 {
+		res.Spec.Count = 5
 	}`)
 	if err != nil {
 		return err
@@ -163,7 +163,7 @@ func ImplementWebhooks(filename string) error {
 	str, err = EnsureExistAndReplace(
 		str,
 		"// TODO(user): fill in your validation logic upon object creation.",
-		`if r.Spec.Count < 0 {
+		`if res.Spec.Count < 0 {
 		return nil, errors.New(".spec.count must >= 0")
 	}`)
 	if err != nil {
@@ -172,7 +172,7 @@ func ImplementWebhooks(filename string) error {
 	str, err = EnsureExistAndReplace(
 		str,
 		"// TODO(user): fill in your validation logic upon object update.",
-		`if r.Spec.Count < 0 {
+		`if newRes.Spec.Count < 0 {
 		return nil, errors.New(".spec.count must >= 0")
 	}`)
 	if err != nil {

pkg/plugins/golang/v4/scaffolds/internal/templates/api/webhook.go

@@ -85,13 +85,14 @@ package {{ .Resource.Version }}
 import (
 	ctrl "sigs.k8s.io/controller-runtime"
 	logf "sigs.k8s.io/controller-runtime/pkg/log"
-	{{- if .Resource.HasValidationWebhook }}
-	"k8s.io/apimachinery/pkg/runtime"
-	"sigs.k8s.io/controller-runtime/pkg/webhook/admission"
-	{{- end }}
 	{{- if or .Resource.HasValidationWebhook .Resource.HasDefaultingWebhook }}
+	"context"
+	"k8s.io/apimachinery/pkg/runtime"
 	"sigs.k8s.io/controller-runtime/pkg/webhook"
 	{{- end }}
+	{{- if .Resource.HasValidationWebhook }}
+	"sigs.k8s.io/controller-runtime/pkg/webhook/admission"
+	{{- end }}
 
 )
 
@@ -102,6 +103,12 @@ var {{ lower .Resource.Kind }}log = logf.Log.WithName("{{ lower .Resource.Kind }
 func (r *{{ .Resource.Kind }}) SetupWebhookWithManager(mgr ctrl.Manager) error {
 	return ctrl.NewWebhookManagedBy(mgr).
 		For(r).
+		{{- if .Resource.HasValidationWebhook }}
+		WithValidator(r).
+		{{- end }}
+		{{- if .Resource.HasDefaultingWebhook }}
+		WithDefaulter(r).
+		{{- end }}
 		Complete()
 }
 
@@ -112,13 +119,14 @@ func (r *{{ .Resource.Kind }}) SetupWebhookWithManager(mgr ctrl.Manager) error {
 	defaultingWebhookTemplate = `
 //+kubebuilder:webhook:{{ if ne .Resource.Webhooks.WebhookVersion "v1" }}webhookVersions={{"{"}}{{ .Resource.Webhooks.WebhookVersion }}{{"}"}},{{ end }}path=/mutate-{{ .QualifiedGroupWithDash }}-{{ .Resource.Version }}-{{ lower .Resource.Kind }},mutating=true,failurePolicy=fail,sideEffects=None,groups={{ .Resource.QualifiedGroup }},resources={{ .Resource.Plural }},verbs=create;update,versions={{ .Resource.Version }},name=m{{ lower .Resource.Kind }}.kb.io,admissionReviewVersions={{ .AdmissionReviewVersions }}
 
-var _ webhook.Defaulter = &{{ .Resource.Kind }}{}
+var _ webhook.CustomDefaulter = &{{ .Resource.Kind }}{}
 
-// Default implements webhook.Defaulter so a webhook will be registered for the type
-func (r *{{ .Resource.Kind }}) Default() {
+// Default implements webhook.CustomDefaulter so a webhook will be registered for the type
+func (r *{{ .Resource.Kind }}) Default(ctx context.Context, obj runtime.Object) error {
 	{{ lower .Resource.Kind }}log.Info("default", "name", r.Name)
 
 	// TODO(user): fill in your defaulting logic.
+	return nil
 }
 `
 
@@ -127,26 +135,26 @@ func (r *{{ .Resource.Kind }}) Default() {
 // TODO(user): change verbs to "verbs=create;update;delete" if you want to enable deletion validation.
 //+kubebuilder:webhook:{{ if ne .Resource.Webhooks.WebhookVersion "v1" }}webhookVersions={{"{"}}{{ .Resource.Webhooks.WebhookVersion }}{{"}"}},{{ end }}path=/validate-{{ .QualifiedGroupWithDash }}-{{ .Resource.Version }}-{{ lower .Resource.Kind }},mutating=false,failurePolicy=fail,sideEffects=None,groups={{ .Resource.QualifiedGroup }},resources={{ .Resource.Plural }},verbs=create;update,versions={{ .Resource.Version }},name=v{{ lower .Resource.Kind }}.kb.io,admissionReviewVersions={{ .AdmissionReviewVersions }}
 
-var _ webhook.Validator = &{{ .Resource.Kind }}{}
+var _ webhook.CustomValidator = &{{ .Resource.Kind }}{}
 
-// ValidateCreate implements webhook.Validator so a webhook will be registered for the type
-func (r *{{ .Resource.Kind }}) ValidateCreate() (admission.Warnings, error) {
+// ValidateCreate implements webhook.CustomValidator so a webhook will be registered for the type
+func (r *{{ .Resource.Kind }}) ValidateCreate(ctx context.Context, obj runtime.Object) (admission.Warnings, error) {
 	{{ lower .Resource.Kind }}log.Info("validate create", "name", r.Name)
 
 	// TODO(user): fill in your validation logic upon object creation.
 	return nil, nil
 }
 
-// ValidateUpdate implements webhook.Validator so a webhook will be registered for the type
-func (r *{{ .Resource.Kind }}) ValidateUpdate(old runtime.Object) (admission.Warnings, error) {
+// ValidateUpdate implements webhook.CustomValidator so a webhook will be registered for the type
+func (r *{{ .Resource.Kind }}) ValidateUpdate(ctx context.Context, oldObj, newObj runtime.Object) (admission.Warnings, error) {
 	{{ lower .Resource.Kind }}log.Info("validate update", "name", r.Name)
 
 	// TODO(user): fill in your validation logic upon object update.
 	return nil, nil
 }
 
-// ValidateDelete implements webhook.Validator so a webhook will be registered for the type
-func (r *{{ .Resource.Kind }}) ValidateDelete() (admission.Warnings, error) {
+// ValidateDelete implements webhook.CustomValidator so a webhook will be registered for the type
+func (r *{{ .Resource.Kind }}) ValidateDelete(ctx context.Context, obj runtime.Object) (admission.Warnings, error) {
 	{{ lower .Resource.Kind }}log.Info("validate delete", "name", r.Name)
 
 	// TODO(user): fill in your validation logic upon object deletion.

testdata/project-v4-multigroup-with-deploy-image/api/crew/v1/captain_webhook.go

@@ -17,6 +17,8 @@ limitations under the License.
 package v1
 
 import (
+	"context"
+
 	"k8s.io/apimachinery/pkg/runtime"
 	ctrl "sigs.k8s.io/controller-runtime"
 	logf "sigs.k8s.io/controller-runtime/pkg/log"
@@ -31,45 +33,48 @@ var captainlog = logf.Log.WithName("captain-resource")
 func (r *Captain) SetupWebhookWithManager(mgr ctrl.Manager) error {
 	return ctrl.NewWebhookManagedBy(mgr).
 		For(r).
+		WithValidator(r).
+		WithDefaulter(r).
 		Complete()
 }
 
 // TODO(user): EDIT THIS FILE!  THIS IS SCAFFOLDING FOR YOU TO OWN!
 
 //+kubebuilder:webhook:path=/mutate-crew-testproject-org-v1-captain,mutating=true,failurePolicy=fail,sideEffects=None,groups=crew.testproject.org,resources=captains,verbs=create;update,versions=v1,name=mcaptain.kb.io,admissionReviewVersions=v1
 
-var _ webhook.Defaulter = &Captain{}
+var _ webhook.CustomDefaulter = &Captain{}
 
-// Default implements webhook.Defaulter so a webhook will be registered for the type
-func (r *Captain) Default() {
+// Default implements webhook.CustomDefaulter so a webhook will be registered for the type
+func (r *Captain) Default(ctx context.Context, obj runtime.Object) error {
 	captainlog.Info("default", "name", r.Name)
 
 	// TODO(user): fill in your defaulting logic.
+	return nil
 }
 
 // TODO(user): change verbs to "verbs=create;update;delete" if you want to enable deletion validation.
 //+kubebuilder:webhook:path=/validate-crew-testproject-org-v1-captain,mutating=false,failurePolicy=fail,sideEffects=None,groups=crew.testproject.org,resources=captains,verbs=create;update,versions=v1,name=vcaptain.kb.io,admissionReviewVersions=v1
 
-var _ webhook.Validator = &Captain{}
+var _ webhook.CustomValidator = &Captain{}
 
-// ValidateCreate implements webhook.Validator so a webhook will be registered for the type
-func (r *Captain) ValidateCreate() (admission.Warnings, error) {
+// ValidateCreate implements webhook.CustomValidator so a webhook will be registered for the type
+func (r *Captain) ValidateCreate(ctx context.Context, obj runtime.Object) (admission.Warnings, error) {
 	captainlog.Info("validate create", "name", r.Name)
 
 	// TODO(user): fill in your validation logic upon object creation.
 	return nil, nil
 }
 
-// ValidateUpdate implements webhook.Validator so a webhook will be registered for the type
-func (r *Captain) ValidateUpdate(old runtime.Object) (admission.Warnings, error) {
+// ValidateUpdate implements webhook.CustomValidator so a webhook will be registered for the type
+func (r *Captain) ValidateUpdate(ctx context.Context, oldObj, newObj runtime.Object) (admission.Warnings, error) {
 	captainlog.Info("validate update", "name", r.Name)
 
 	// TODO(user): fill in your validation logic upon object update.
 	return nil, nil
 }
 
-// ValidateDelete implements webhook.Validator so a webhook will be registered for the type
-func (r *Captain) ValidateDelete() (admission.Warnings, error) {
+// ValidateDelete implements webhook.CustomValidator so a webhook will be registered for the type
+func (r *Captain) ValidateDelete(ctx context.Context, obj runtime.Object) (admission.Warnings, error) {
 	captainlog.Info("validate delete", "name", r.Name)
 
 	// TODO(user): fill in your validation logic upon object deletion.

testdata/project-v4-multigroup-with-deploy-image/api/ship/v1/destroyer_webhook.go

@@ -17,6 +17,9 @@ limitations under the License.
 package v1
 
 import (
+	"context"
+
+	"k8s.io/apimachinery/pkg/runtime"
 	ctrl "sigs.k8s.io/controller-runtime"
 	logf "sigs.k8s.io/controller-runtime/pkg/log"
 	"sigs.k8s.io/controller-runtime/pkg/webhook"
@@ -29,18 +32,20 @@ var destroyerlog = logf.Log.WithName("destroyer-resource")
 func (r *Destroyer) SetupWebhookWithManager(mgr ctrl.Manager) error {
 	return ctrl.NewWebhookManagedBy(mgr).
 		For(r).
+		WithDefaulter(r).
 		Complete()
 }
 
 // TODO(user): EDIT THIS FILE!  THIS IS SCAFFOLDING FOR YOU TO OWN!
 
 //+kubebuilder:webhook:path=/mutate-ship-testproject-org-v1-destroyer,mutating=true,failurePolicy=fail,sideEffects=None,groups=ship.testproject.org,resources=destroyers,verbs=create;update,versions=v1,name=mdestroyer.kb.io,admissionReviewVersions=v1
 
-var _ webhook.Defaulter = &Destroyer{}
+var _ webhook.CustomDefaulter = &Destroyer{}
 
-// Default implements webhook.Defaulter so a webhook will be registered for the type
-func (r *Destroyer) Default() {
+// Default implements webhook.CustomDefaulter so a webhook will be registered for the type
+func (r *Destroyer) Default(ctx context.Context, obj runtime.Object) error {
 	destroyerlog.Info("default", "name", r.Name)
 
 	// TODO(user): fill in your defaulting logic.
+	return nil
 }