Merge pull request #4915 from camilamacedo86/update-getting-started-sample-comply-k8s-api-convetions

📖 Update Getting Started sample to comply with K8s API conventions

Author: k8s-ci-robot

docs/book/src/getting-started/testdata/project/api/v1alpha1/memcached_types.go

@@ -33,13 +33,14 @@ type MemcachedSpec struct {
 	// The following markers will use OpenAPI v3 schema to validate the value
 	// More info: https://book.kubebuilder.io/reference/markers/crd-validation.html
 
-	// Size defines the number of Memcached instances
+	// size defines the number of Memcached instances
 	// The following markers will use OpenAPI v3 schema to validate the value
 	// More info: https://book.kubebuilder.io/reference/markers/crd-validation.html
 	// +kubebuilder:validation:Minimum=1
 	// +kubebuilder:validation:Maximum=3
 	// +kubebuilder:validation:ExclusiveMaximum=false
-	Size int32 `json:"size,omitempty"`
+	// +optional
+	Size *int32 `json:"size,omitempty"`
 }
 
 // MemcachedStatus defines the observed state of Memcached.

docs/book/src/getting-started/testdata/project/api/v1alpha1/zz_generated.deepcopy.go

@@ -41,7 +41,7 @@ spec:
             properties:
               size:
                 description: |-
-                  Size defines the number of Memcached instances
+                  size defines the number of Memcached instances
                   The following markers will use OpenAPI v3 schema to validate the value
                   More info: https://book.kubebuilder.io/reference/markers/crd-validation.html
                 format: int32

docs/book/src/getting-started/testdata/project/config/crd/bases/cache.example.com_memcacheds.yaml

@@ -47,7 +47,7 @@ spec:
             properties:
               size:
                 description: |-
-                  Size defines the number of Memcached instances
+                  size defines the number of Memcached instances
                   The following markers will use OpenAPI v3 schema to validate the value
                   More info: https://book.kubebuilder.io/reference/markers/crd-validation.html
                 format: int32

docs/book/src/getting-started/testdata/project/dist/chart/templates/crd/cache.example.com_memcacheds.yaml

@@ -49,7 +49,7 @@ spec:
             properties:
               size:
                 description: |-
-                  Size defines the number of Memcached instances
+                  size defines the number of Memcached instances
                   The following markers will use OpenAPI v3 schema to validate the value
                   More info: https://book.kubebuilder.io/reference/markers/crd-validation.html
                 format: int32

docs/book/src/getting-started/testdata/project/dist/install.yaml

@@ -19,7 +19,6 @@ package controller
 import (
 	"context"
 	"fmt"
-
 	"time"
 
 	appsv1 "k8s.io/api/apps/v1"
@@ -149,13 +148,18 @@ func (r *MemcachedReconciler) Reconcile(ctx context.Context, req ctrl.Request) (
 		return ctrl.Result{}, err
 	}
 
+	// If the size is not defined in the Custom Resource then we will set the desired replicas to 0
+	var desiredReplicas int32 = 0
+	if memcached.Spec.Size != nil {
+		desiredReplicas = *memcached.Spec.Size
+	}
+
 	// The CRD API defines that the Memcached type have a MemcachedSpec.Size field
 	// to set the quantity of Deployment instances to the desired state on the cluster.
 	// Therefore, the following code will ensure the Deployment size is the same as defined
 	// via the Size spec of the Custom Resource which we are reconciling.
-	size := memcached.Spec.Size
-	if *found.Spec.Replicas != size {
-		found.Spec.Replicas = &size
+	if found.Spec.Replicas == nil || *found.Spec.Replicas != desiredReplicas {
+		found.Spec.Replicas = ptr.To(desiredReplicas)
 		if err = r.Update(ctx, found); err != nil {
 			log.Error(err, "Failed to update Deployment",
 				"Deployment.Namespace", found.Namespace, "Deployment.Name", found.Name)
@@ -191,7 +195,7 @@ func (r *MemcachedReconciler) Reconcile(ctx context.Context, req ctrl.Request) (
 	// The following implementation will update the status
 	meta.SetStatusCondition(&memcached.Status.Conditions, metav1.Condition{Type: typeAvailableMemcached,
 		Status: metav1.ConditionTrue, Reason: "Reconciling",
-		Message: fmt.Sprintf("Deployment for custom resource (%s) with %d replicas created successfully", memcached.Name, size)})
+		Message: fmt.Sprintf("Deployment for custom resource (%s) with %d replicas created successfully", memcached.Name, desiredReplicas)})
 
 	if err := r.Status().Update(ctx, memcached); err != nil {
 		log.Error(err, "Failed to update Memcached status")
@@ -213,7 +217,6 @@ func (r *MemcachedReconciler) SetupWithManager(mgr ctrl.Manager) error {
 // deploymentForMemcached returns a Memcached Deployment object
 func (r *MemcachedReconciler) deploymentForMemcached(
 	memcached *cachev1alpha1.Memcached) (*appsv1.Deployment, error) {
-	replicas := memcached.Spec.Size
 	image := "memcached:1.6.26-alpine3.19"
 
 	dep := &appsv1.Deployment{
@@ -222,7 +225,7 @@ func (r *MemcachedReconciler) deploymentForMemcached(
 			Namespace: memcached.Namespace,
 		},
 		Spec: appsv1.DeploymentSpec{
-			Replicas: &replicas,
+			Replicas: memcached.Spec.Size,
 			Selector: &metav1.LabelSelector{
 				MatchLabels: map[string]string{"app.kubernetes.io/name": "project"},
 			},

docs/book/src/getting-started/testdata/project/internal/controller/memcached_controller.go

@@ -21,9 +21,11 @@ import (
 
 	. "github.com/onsi/ginkgo/v2"
 	. "github.com/onsi/gomega"
+
 	appsv1 "k8s.io/api/apps/v1"
 	"k8s.io/apimachinery/pkg/api/errors"
 	"k8s.io/apimachinery/pkg/types"
+	"k8s.io/utils/ptr"
 	"sigs.k8s.io/controller-runtime/pkg/reconcile"
 
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
@@ -53,7 +55,7 @@ var _ = Describe("Memcached Controller", func() {
 						Namespace: "default",
 					},
 					Spec: cachev1alpha1.MemcachedSpec{
-						Size: 1,
+						Size: ptr.To(int32(1)),
 					},
 				}
 				Expect(k8sClient.Create(ctx, resource)).To(Succeed())

docs/book/src/getting-started/testdata/project/internal/controller/memcached_controller_test.go

@@ -54,6 +54,8 @@ func (sp *Sample) updateControllerTest() {
 		filepath.Join(sp.ctx.Dir, file),
 		". \"github.com/onsi/gomega\"",
 		`. "github.com/onsi/gomega"
+
+	"k8s.io/utils/ptr"
 	appsv1 "k8s.io/api/apps/v1"`,
 	)
 	hackutils.CheckError("add imports apis", err)
@@ -62,7 +64,7 @@ func (sp *Sample) updateControllerTest() {
 		filepath.Join(sp.ctx.Dir, file),
 		"// TODO(user): Specify other spec details if needed.",
 		`Spec: cachev1alpha1.MemcachedSpec{
-						Size: 1,
+						Size: ptr.To(int32(1)),
 					},`,
 	)
 	hackutils.CheckError("add spec apis", err)
@@ -244,13 +246,14 @@ func (sp *Sample) CodeGen() {
 
 const (
 	oldSpecAPI = "// foo is an example field of Memcached. Edit memcached_types.go to remove/update\n\t// +optional\n\tFoo *string `json:\"foo,omitempty\"`"
-	newSpecAPI = `// Size defines the number of Memcached instances
+	newSpecAPI = `// size defines the number of Memcached instances
 	// The following markers will use OpenAPI v3 schema to validate the value
 	// More info: https://book.kubebuilder.io/reference/markers/crd-validation.html
 	// +kubebuilder:validation:Minimum=1
 	// +kubebuilder:validation:Maximum=3
 	// +kubebuilder:validation:ExclusiveMaximum=false
-	Size int32 ` + "`json:\"size,omitempty\"`"
+	// +optional
+	Size *int32 ` + "`json:\"size,omitempty\"`"
 )
 
 const oldStatusAPI = `// INSERT ADDITIONAL STATUS FIELD - define observed state of cluster
@@ -278,7 +281,6 @@ const sampleSizeFragment = `# TODO(user): edit the following value to ensure the
 
 const controllerImports = `"context"
 	"fmt"
-
 	"time"
 
 	appsv1 "k8s.io/api/apps/v1"
@@ -387,13 +389,18 @@ const controllerReconcileImplementation = `// Fetch the Memcached instance
 		return ctrl.Result{}, err
 	}
 
+	// If the size is not defined in the Custom Resource then we will set the desired replicas to 0
+	var desiredReplicas int32 = 0
+	if memcached.Spec.Size != nil {
+		desiredReplicas = *memcached.Spec.Size
+	}
+
 	// The CRD API defines that the Memcached type have a MemcachedSpec.Size field
 	// to set the quantity of Deployment instances to the desired state on the cluster.
 	// Therefore, the following code will ensure the Deployment size is the same as defined
 	// via the Size spec of the Custom Resource which we are reconciling.
-	size := memcached.Spec.Size
-	if *found.Spec.Replicas != size {
-		found.Spec.Replicas = &size
+	if found.Spec.Replicas == nil || *found.Spec.Replicas != desiredReplicas {
+		found.Spec.Replicas = ptr.To(desiredReplicas)
 		if err = r.Update(ctx, found); err != nil {
 			log.Error(err, "Failed to update Deployment",
 				"Deployment.Namespace", found.Namespace, "Deployment.Name", found.Name)
@@ -429,7 +436,7 @@ const controllerReconcileImplementation = `// Fetch the Memcached instance
 	// The following implementation will update the status
 	meta.SetStatusCondition(&memcached.Status.Conditions, metav1.Condition{Type: typeAvailableMemcached,
 		Status: metav1.ConditionTrue, Reason: "Reconciling",
-		Message: fmt.Sprintf("Deployment for custom resource (%s) with %d replicas created successfully", memcached.Name, size)})
+		Message: fmt.Sprintf("Deployment for custom resource (%s) with %d replicas created successfully", memcached.Name, desiredReplicas)})
 
 	if err := r.Status().Update(ctx, memcached); err != nil {
 		log.Error(err, "Failed to update Memcached status")
@@ -439,7 +446,6 @@ const controllerReconcileImplementation = `// Fetch the Memcached instance
 const controllerDeploymentFunc = `// deploymentForMemcached returns a Memcached Deployment object
 func (r *MemcachedReconciler) deploymentForMemcached(
 	memcached *cachev1alpha1.Memcached) (*appsv1.Deployment, error) {
-	replicas := memcached.Spec.Size
 	image := "memcached:1.6.26-alpine3.19"
 
 	dep := &appsv1.Deployment{
@@ -448,7 +454,7 @@ func (r *MemcachedReconciler) deploymentForMemcached(
 			Namespace: memcached.Namespace,
 		},
 		Spec: appsv1.DeploymentSpec{
-			Replicas: &replicas,
+			Replicas: memcached.Spec.Size,
 			Selector: &metav1.LabelSelector{
 				MatchLabels: map[string]string{"app.kubernetes.io/name": "project"},
 			},