(docs/tutorials): ensure all fields follow Kubernetes API conventions

Author: camilamacedo86

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

@@ -81,14 +81,17 @@ type CronJobSpec struct {
 	// - "Forbid": forbids concurrent runs, skipping next run if previous run hasn't finished yet;
 	// - "Replace": cancels currently running job and replaces it with a new one
 	// +optional
-	ConcurrencyPolicy ConcurrencyPolicy `json:"concurrencyPolicy,omitempty"`
+	// +kubebuilder:validation:Enum=Allow;Forbid;Replace
+	// +kubebuilder:default:=Allow
+	ConcurrencyPolicy *ConcurrencyPolicy `json:"concurrencyPolicy,omitempty"`
 
 	// suspend tells the controller to suspend subsequent executions, it does
 	// not apply to already started executions.  Defaults to false.
 	// +optional
 	Suspend *bool `json:"suspend,omitempty"`
 
 	// jobTemplate defines the job that will be created when executing a CronJob.
+	// +required
 	JobTemplate batchv1.JobTemplateSpec `json:"jobTemplate"`
 
 	// successfulJobsHistoryLimit defines the number of successful finished jobs to retain.
@@ -146,6 +149,9 @@ type CronJobStatus struct {
 
 	// active defines a list of pointers to currently running jobs.
 	// +optional
+	// +listType=atomic
+	// +kubebuilder:validation:MinItems=0
+	// +kubebuilder:validation:MaxItems=10
 	Active []corev1.ObjectReference `json:"active,omitempty"`
 
 	// lastScheduleTime defines when was the last time the job was successfully scheduled.

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

@@ -27,10 +27,16 @@ spec:
           spec:
             properties:
               concurrencyPolicy:
-                enum:
-                - Allow
-                - Forbid
-                - Replace
+                allOf:
+                - enum:
+                  - Allow
+                  - Forbid
+                  - Replace
+                - enum:
+                  - Allow
+                  - Forbid
+                  - Replace
+                default: Allow
                 type: string
               failedJobsHistoryLimit:
                 format: int32
@@ -3835,7 +3841,10 @@ spec:
                       type: string
                   type: object
                   x-kubernetes-map-type: atomic
+                maxItems: 10
+                minItems: 0
                 type: array
+                x-kubernetes-list-type: atomic
               conditions:
                 items:
                   properties:

docs/book/src/cronjob-tutorial/testdata/project/config/crd/bases/batch.tutorial.kubebuilder.io_cronjobs.yaml

@@ -33,10 +33,16 @@ spec:
           spec:
             properties:
               concurrencyPolicy:
-                enum:
-                - Allow
-                - Forbid
-                - Replace
+                allOf:
+                - enum:
+                  - Allow
+                  - Forbid
+                  - Replace
+                - enum:
+                  - Allow
+                  - Forbid
+                  - Replace
+                default: Allow
                 type: string
               failedJobsHistoryLimit:
                 format: int32
@@ -3841,7 +3847,10 @@ spec:
                       type: string
                   type: object
                   x-kubernetes-map-type: atomic
+                maxItems: 10
+                minItems: 0
                 type: array
+                x-kubernetes-list-type: atomic
               conditions:
                 items:
                   properties:

docs/book/src/cronjob-tutorial/testdata/project/dist/chart/templates/crd/batch.tutorial.kubebuilder.io_cronjobs.yaml

@@ -35,10 +35,16 @@ spec:
           spec:
             properties:
               concurrencyPolicy:
-                enum:
-                - Allow
-                - Forbid
-                - Replace
+                allOf:
+                - enum:
+                  - Allow
+                  - Forbid
+                  - Replace
+                - enum:
+                  - Allow
+                  - Forbid
+                  - Replace
+                default: Allow
                 type: string
               failedJobsHistoryLimit:
                 format: int32
@@ -3843,7 +3849,10 @@ spec:
                       type: string
                   type: object
                   x-kubernetes-map-type: atomic
+                maxItems: 10
+                minItems: 0
                 type: array
+                x-kubernetes-list-type: atomic
               conditions:
                 items:
                   properties:

docs/book/src/cronjob-tutorial/testdata/project/dist/install.yaml

@@ -9,6 +9,7 @@ require (
 	k8s.io/api v0.33.0
 	k8s.io/apimachinery v0.33.0
 	k8s.io/client-go v0.33.0
+	k8s.io/utils v0.0.0-20241104100929-3ea5e8cea738
 	sigs.k8s.io/controller-runtime v0.21.0
 )
 
@@ -89,7 +90,6 @@ require (
 	k8s.io/component-base v0.33.0 // indirect
 	k8s.io/klog/v2 v2.130.1 // indirect
 	k8s.io/kube-openapi v0.0.0-20250318190949-c8a335a9a2ff // indirect
-	k8s.io/utils v0.0.0-20241104100929-3ea5e8cea738 // indirect
 	sigs.k8s.io/apiserver-network-proxy/konnectivity-client v0.31.2 // indirect
 	sigs.k8s.io/json v0.0.0-20241010143419-9aa6b5e7a4b3 // indirect
 	sigs.k8s.io/randfill v1.0.0 // indirect

docs/book/src/cronjob-tutorial/testdata/project/go.mod

@@ -441,13 +441,13 @@ func (r *CronJobReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ct
 	*/
 	// figure out how to run this job -- concurrency policy might forbid us from running
 	// multiple at the same time...
-	if cronJob.Spec.ConcurrencyPolicy == batchv1.ForbidConcurrent && len(activeJobs) > 0 {
+	if cronJob.Spec.ConcurrencyPolicy != nil && *cronJob.Spec.ConcurrencyPolicy == batchv1.ForbidConcurrent && len(activeJobs) > 0 {
 		log.V(1).Info("concurrency policy blocks concurrent runs, skipping", "num active", len(activeJobs))
 		return scheduledResult, nil
 	}
 
 	// ...or instruct us to replace existing ones...
-	if cronJob.Spec.ConcurrencyPolicy == batchv1.ReplaceConcurrent {
+	if cronJob.Spec.ConcurrencyPolicy != nil && *cronJob.Spec.ConcurrencyPolicy == batchv1.ReplaceConcurrent {
 		for _, activeJob := range activeJobs {
 			// we don't care if the job was already deleted
 			if err := r.Delete(ctx, activeJob, client.PropagationPolicy(metav1.DeletePropagationBackground)); client.IgnoreNotFound(err) != nil {

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

@@ -113,8 +113,8 @@ func (d *CronJobCustomDefaulter) Default(_ context.Context, obj runtime.Object)
 
 // applyDefaults applies default values to CronJob fields.
 func (d *CronJobCustomDefaulter) applyDefaults(cronJob *batchv1.CronJob) {
-	if cronJob.Spec.ConcurrencyPolicy == "" {
-		cronJob.Spec.ConcurrencyPolicy = d.DefaultConcurrencyPolicy
+	if cronJob.Spec.ConcurrencyPolicy == nil || *cronJob.Spec.ConcurrencyPolicy == "" {
+		cronJob.Spec.ConcurrencyPolicy = &d.DefaultConcurrencyPolicy
 	}
 	if cronJob.Spec.Suspend == nil {
 		cronJob.Spec.Suspend = new(bool)

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

@@ -22,6 +22,7 @@ import (
 
 	batchv1 "tutorial.kubebuilder.io/project/api/v1"
 	// TODO (user): Add any additional imports if needed
+	"k8s.io/utils/ptr"
 )
 
 var _ = Describe("CronJob Webhook", func() {
@@ -39,9 +40,9 @@ var _ = Describe("CronJob Webhook", func() {
 		obj = &batchv1.CronJob{
 			Spec: batchv1.CronJobSpec{
 				Schedule:                   schedule,
-				ConcurrencyPolicy:          batchv1.AllowConcurrent,
-				SuccessfulJobsHistoryLimit: new(int32),
-				FailedJobsHistoryLimit:     new(int32),
+				ConcurrencyPolicy:          ptr.To(batchv1.AllowConcurrent),
+				SuccessfulJobsHistoryLimit: ptr.To(int32(3)),
+				FailedJobsHistoryLimit:     ptr.To(int32(1)),
 			},
 		}
 		*obj.Spec.SuccessfulJobsHistoryLimit = 3
@@ -50,9 +51,9 @@ var _ = Describe("CronJob Webhook", func() {
 		oldObj = &batchv1.CronJob{
 			Spec: batchv1.CronJobSpec{
 				Schedule:                   schedule,
-				ConcurrencyPolicy:          batchv1.AllowConcurrent,
-				SuccessfulJobsHistoryLimit: new(int32),
-				FailedJobsHistoryLimit:     new(int32),
+				ConcurrencyPolicy:          ptr.To(batchv1.AllowConcurrent),
+				SuccessfulJobsHistoryLimit: ptr.To(int32(3)),
+				FailedJobsHistoryLimit:     ptr.To(int32(1)),
 			},
 		}
 		*oldObj.Spec.SuccessfulJobsHistoryLimit = 3
@@ -77,7 +78,7 @@ var _ = Describe("CronJob Webhook", func() {
 	Context("When creating CronJob under Defaulting Webhook", func() {
 		It("Should apply defaults when a required field is empty", func() {
 			By("simulating a scenario where defaults should be applied")
-			obj.Spec.ConcurrencyPolicy = ""           // This should default to AllowConcurrent
+			obj.Spec.ConcurrencyPolicy = nil          // This should default to AllowConcurrent
 			obj.Spec.Suspend = nil                    // This should default to false
 			obj.Spec.SuccessfulJobsHistoryLimit = nil // This should default to 3
 			obj.Spec.FailedJobsHistoryLimit = nil     // This should default to 1
@@ -86,15 +87,16 @@ var _ = Describe("CronJob Webhook", func() {
 			_ = defaulter.Default(ctx, obj)
 
 			By("checking that the default values are set")
-			Expect(obj.Spec.ConcurrencyPolicy).To(Equal(batchv1.AllowConcurrent), "Expected ConcurrencyPolicy to default to AllowConcurrent")
+			Expect(obj.Spec.ConcurrencyPolicy).NotTo(BeNil(), "ConcurrencyPolicy should not be nil after defaulting")
+			Expect(*obj.Spec.ConcurrencyPolicy).To(Equal(batchv1.AllowConcurrent), "Expected ConcurrencyPolicy to default to AllowConcurrent")
 			Expect(*obj.Spec.Suspend).To(BeFalse(), "Expected Suspend to default to false")
 			Expect(*obj.Spec.SuccessfulJobsHistoryLimit).To(Equal(int32(3)), "Expected SuccessfulJobsHistoryLimit to default to 3")
 			Expect(*obj.Spec.FailedJobsHistoryLimit).To(Equal(int32(1)), "Expected FailedJobsHistoryLimit to default to 1")
 		})
 
 		It("Should not overwrite fields that are already set", func() {
 			By("setting fields that would normally get a default")
-			obj.Spec.ConcurrencyPolicy = batchv1.ForbidConcurrent
+			obj.Spec.ConcurrencyPolicy = ptr.To(batchv1.ForbidConcurrent)
 			obj.Spec.Suspend = new(bool)
 			*obj.Spec.Suspend = true
 			obj.Spec.SuccessfulJobsHistoryLimit = new(int32)

docs/book/src/cronjob-tutorial/testdata/project/internal/webhook/v1/cronjob_webhook_test.go

@@ -83,6 +83,8 @@ we will allow configuring the number of instances with the following:
 ```go
 type MemcachedSpec struct {
 	...
+	// +kubebuilder:validation:Minimum=0
+	// +required
 	Size int32 `json:"size,omitempty"`
 }
 ```