docs: Rename Size to ClusterSize in RedisClusterSpec and update related comments (#1475)

drivebyer · web-flow · commit 88d688acc5df · 2025-08-07T19:43:43.000+08:00
Signed-off-by: yangw &lt;wuyangmuc@gmail.com&gt;
diff --git a/api/common/v1beta2/common_types.go b/api/common/v1beta2/common_types.go
@@ -199,6 +199,7 @@ type Sidecar struct {
 // RedisLeader interface will have the redis leader configuration
 // +k8s:deepcopy-gen=true
 type RedisLeader struct {
+	// Replicas overrides clusterSize for leader nodes count. If not set, uses clusterSize value
 	Replicas                  *int32                            `json:"replicas,omitempty"`
 	RedisConfig               *RedisConfig                      `json:"redisConfig,omitempty"`
 	Affinity                  *corev1.Affinity                  `json:"affinity,omitempty"`
@@ -213,6 +214,7 @@ type RedisLeader struct {
 // RedisFollower interface will have the redis follower configuration
 // +k8s:deepcopy-gen=true
 type RedisFollower struct {
+	// Replicas overrides clusterSize for follower nodes count. If not set, uses clusterSize value
 	Replicas                  *int32                            `json:"replicas,omitempty"`
 	RedisConfig               *RedisConfig                      `json:"redisConfig,omitempty"`
 	Affinity                  *corev1.Affinity                  `json:"affinity,omitempty"`
diff --git a/api/rediscluster/v1beta2/rediscluster_types.go b/api/rediscluster/v1beta2/rediscluster_types.go
@@ -24,7 +24,8 @@ import (
 
 // RedisClusterSpec defines the desired state of RedisCluster
 type RedisClusterSpec struct {
-	Size             *int32                  `json:"clusterSize"`
+	// ClusterSize defines the default number of replicas for both leader and follower when not explicitly set
+	ClusterSize      *int32                  `json:"clusterSize"`
 	KubernetesConfig common.KubernetesConfig `json:"kubernetesConfig"`
 	HostNetwork      bool                    `json:"hostNetwork,omitempty"`
 	// +kubebuilder:default:=6379
@@ -58,7 +59,7 @@ type ClusterStorage struct {
 }
 
 func (cr *RedisClusterSpec) GetReplicaCounts(t string) int32 {
-	replica := cr.Size
+	replica := cr.ClusterSize
 	if t == "leader" && cr.RedisLeader.Replicas != nil {
 		replica = cr.RedisLeader.Replicas
 	} else if t == "follower" && cr.RedisFollower.Replicas != nil {
diff --git a/api/rediscluster/v1beta2/rediscluster_webhook.go b/api/rediscluster/v1beta2/rediscluster_webhook.go
@@ -71,15 +71,15 @@ func (r *RedisCluster) validate(_ *RedisCluster) (admission.Warnings, error) {
 	var errors field.ErrorList
 	var warnings admission.Warnings
 
-	if r.Spec.Size == nil {
+	if r.Spec.ClusterSize == nil {
 		return warnings, nil
 	}
 
 	// Check if the Size is at least 3 for proper cluster operation
-	if *r.Spec.Size < 3 {
+	if *r.Spec.ClusterSize < 3 {
 		errors = append(errors, field.Invalid(
 			field.NewPath("spec").Child("clusterSize"),
-			*r.Spec.Size,
+			*r.Spec.ClusterSize,
 			"Redis cluster must have at least 3 shards",
 		))
 	}
diff --git a/api/rediscluster/v1beta2/rediscluster_webhook_test.go b/api/rediscluster/v1beta2/rediscluster_webhook_test.go
@@ -22,7 +22,7 @@ func TestRedisClusterWebhook(t *testing.T) {
 			Object: func(t *testing.T, uid string) []byte {
 				t.Helper()
 				cluster := mkRedisCluster(uid)
-				cluster.Spec.Size = ptr.To(int32(3))
+				cluster.Spec.ClusterSize = ptr.To(int32(3))
 				return marshal(t, cluster)
 			},
 			Check: webhook.ValidationWebhookSucceeded,
@@ -33,7 +33,7 @@ func TestRedisClusterWebhook(t *testing.T) {
 			Object: func(t *testing.T, uid string) []byte {
 				t.Helper()
 				cluster := mkRedisCluster(uid)
-				cluster.Spec.Size = ptr.To(int32(2))
+				cluster.Spec.ClusterSize = ptr.To(int32(2))
 				return marshal(t, cluster)
 			},
 			Check: webhook.ValidationWebhookFailed("Redis cluster must have at least 3 shards"),
diff --git a/api/rediscluster/v1beta2/zz_generated.deepcopy.go b/api/rediscluster/v1beta2/zz_generated.deepcopy.go
diff --git a/charts/redis-cluster/README.md b/charts/redis-cluster/README.md
@@ -68,7 +68,7 @@ helm delete <my-release> --namespace <namespace>
 | podSecurityContext.fsGroup | int | `1000` |  |
 | podSecurityContext.runAsUser | int | `1000` |  |
 | priorityClassName | string | `""` |  |
-| redisCluster.clusterSize | int | `3` |  |
+| redisCluster.clusterSize | int | `3` | Default number of replicas for both leader and follower when not explicitly set |
 | redisCluster.clusterVersion | string | `"v7"` |  |
 | redisCluster.enableMasterSlaveAntiAffinity | bool | `false` | Enable pod anti-affinity between leader and follower pods by adding the appropriate label. Notice that this requires the operator to have its mutating webhook enabled, otherwise it will only add an annotation to the RedisCluster CR. Default is false. |
 | redisCluster.follower.affinity | string | `nil` |  |
@@ -78,7 +78,7 @@ helm delete <my-release> --namespace <namespace>
 | redisCluster.follower.pdb.maxUnavailable | int | `1` |  |
 | redisCluster.follower.pdb.minAvailable | int | `1` |  |
 | redisCluster.follower.readinessProbe | object | `{}` |  |
-| redisCluster.follower.replicas | int | `3` |  |
+| redisCluster.follower.replicas | int | `3` | Number of Redis follower (slave) nodes. If not set, uses clusterSize value |
 | redisCluster.follower.securityContext | object | `{}` |  |
 | redisCluster.follower.serviceType | string | `"ClusterIP"` |  |
 | redisCluster.follower.tolerations | list | `[]` |  |
@@ -92,7 +92,7 @@ helm delete <my-release> --namespace <namespace>
 | redisCluster.leader.pdb.maxUnavailable | int | `1` |  |
 | redisCluster.leader.pdb.minAvailable | int | `1` |  |
 | redisCluster.leader.readinessProbe | object | `{}` |  |
-| redisCluster.leader.replicas | int | `3` |  |
+| redisCluster.leader.replicas | int | `3` | Number of Redis leader (master) nodes. If not set, uses clusterSize value |
 | redisCluster.leader.securityContext | object | `{}` |  |
 | redisCluster.leader.serviceType | string | `"ClusterIP"` |  |
 | redisCluster.leader.tolerations | list | `[]` |  |
diff --git a/charts/redis-cluster/values.yaml b/charts/redis-cluster/values.yaml
@@ -1,6 +1,7 @@
 ---
 redisCluster:
   name: ""
+  # -- Default number of replicas for both leader and follower when not explicitly set
   clusterSize: 3
   clusterVersion: v7
   persistenceEnabled: true
@@ -28,6 +29,7 @@ redisCluster:
   # otherwise it will only add an annotation to the RedisCluster CR. Default is false.
   enableMasterSlaveAntiAffinity: false
   leader:
+    # -- Number of Redis leader (master) nodes. If not set, uses clusterSize value
     replicas: 3
     serviceType: ClusterIP
     affinity: {}
@@ -65,6 +67,7 @@ redisCluster:
       # initialDelaySeconds: 15
     
   follower:
+    # -- Number of Redis follower (slave) nodes. If not set, uses clusterSize value
     replicas: 3
     serviceType: ClusterIP
     affinity: null
diff --git a/charts/redis-operator/crds/crds.yaml b/charts/redis-operator/crds/crds.yaml
@@ -5601,6 +5601,8 @@ spec:
                     type: object
                 type: object
               clusterSize:
+                description: ClusterSize defines the default number of replicas for
+                  both leader and follower when not explicitly set
                 format: int32
                 type: integer
               clusterVersion:
@@ -8084,6 +8086,8 @@ spec:
                         type: integer
                     type: object
                   replicas:
+                    description: Replicas overrides clusterSize for follower nodes
+                      count. If not set, uses clusterSize value
                     format: int32
                     type: integer
                   resources:
@@ -9761,6 +9765,8 @@ spec:
                         type: integer
                     type: object
                   replicas:
+                    description: Replicas overrides clusterSize for leader nodes count.
+                      If not set, uses clusterSize value
                     format: int32
                     type: integer
                   resources:
diff --git a/config/crd/bases/redis.redis.opstreelabs.in_redisclusters.yaml b/config/crd/bases/redis.redis.opstreelabs.in_redisclusters.yaml
@@ -210,6 +210,8 @@ spec:
                     type: object
                 type: object
               clusterSize:
+                description: ClusterSize defines the default number of replicas for
+                  both leader and follower when not explicitly set
                 format: int32
                 type: integer
               clusterVersion:
@@ -2693,6 +2695,8 @@ spec:
                         type: integer
                     type: object
                   replicas:
+                    description: Replicas overrides clusterSize for follower nodes
+                      count. If not set, uses clusterSize value
                     format: int32
                     type: integer
                   resources:
@@ -4370,6 +4374,8 @@ spec:
                         type: integer
                     type: object
                   replicas:
+                    description: Replicas overrides clusterSize for leader nodes count.
+                      If not set, uses clusterSize value
                     format: int32
                     type: integer
                   resources:
diff --git a/docs/content/en/docs/CRD Reference/API Reference/_index.md b/docs/content/en/docs/CRD Reference/API Reference/_index.md
@@ -204,7 +204,7 @@ _Appears in:_
 
 | Field | Description | Default | Validation |
 | --- | --- | --- | --- |
-| `clusterSize` _integer_ |  |  |  |
+| `clusterSize` _integer_ | ClusterSize defines the default number of replicas for both leader and follower when not explicitly set |  |  |
 | `kubernetesConfig` _[KubernetesConfig](#kubernetesconfig)_ |  |  |  |
 | `hostNetwork` _boolean_ |  |  |  |
 | `port` _integer_ |  | 6379 |  |
@@ -291,7 +291,7 @@ _Appears in:_
 
 | Field | Description | Default | Validation |
 | --- | --- | --- | --- |
-| `replicas` _integer_ |  |  |  |
+| `replicas` _integer_ | Replicas overrides clusterSize for follower nodes count. If not set, uses clusterSize value |  |  |
 | `redisConfig` _[RedisConfig](#redisconfig)_ |  |  |  |
 | `affinity` _[Affinity](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.31/#affinity-v1-core)_ |  |  |  |
 | `pdb` _[RedisPodDisruptionBudget](#redispoddisruptionbudget)_ |  |  |  |
@@ -318,7 +318,7 @@ _Appears in:_
 
 | Field | Description | Default | Validation |
 | --- | --- | --- | --- |
-| `replicas` _integer_ |  |  |  |
+| `replicas` _integer_ | Replicas overrides clusterSize for leader nodes count. If not set, uses clusterSize value |  |  |
 | `redisConfig` _[RedisConfig](#redisconfig)_ |  |  |  |
 | `affinity` _[Affinity](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.31/#affinity-v1-core)_ |  |  |  |
 | `pdb` _[RedisPodDisruptionBudget](#redispoddisruptionbudget)_ |  |  |  |
diff --git a/internal/controller/rediscluster/rediscluster_controller_test.go b/internal/controller/rediscluster/rediscluster_controller_test.go
@@ -135,7 +135,7 @@ var _ = Describe("Redis Cluster Controller", func() {
 				Object: &rcvb2.RedisCluster{
 					ObjectMeta: testutil.CreateTestObject("redis-cluster-skip-test", ns, nil),
 					Spec: rcvb2.RedisClusterSpec{
-						Size: ptr.To(int32(3)),
+						ClusterSize: ptr.To(int32(3)),
 						KubernetesConfig: common.KubernetesConfig{
 							Image: testutil.DefaultRedisImage,
 						},
diff --git a/internal/k8sutils/poddisruption.go b/internal/k8sutils/poddisruption.go
@@ -105,7 +105,7 @@ func generatePodDisruptionBudgetDef(ctx context.Context, cr *rcvb2.RedisCluster,
 	}
 	// If we don't have a value for either, assume quorum: (N/2)+1
 	if pdbTemplate.Spec.MaxUnavailable == nil && pdbTemplate.Spec.MinAvailable == nil {
-		pdbTemplate.Spec.MinAvailable = &intstr.IntOrString{Type: intstr.Int, IntVal: (*cr.Spec.Size / 2) + 1}
+		pdbTemplate.Spec.MinAvailable = &intstr.IntOrString{Type: intstr.Int, IntVal: (*cr.Spec.ClusterSize / 2) + 1}
 	}
 	AddOwnerRefToObject(pdbTemplate, redisClusterAsOwner(cr))
 	return pdbTemplate
diff --git a/internal/k8sutils/redis-cluster_test.go b/internal/k8sutils/redis-cluster_test.go
@@ -165,7 +165,7 @@ func Test_generateRedisClusterParams(t *testing.T) {
 		t.Fatalf("Failed to unmarshal file %s: %v", path, err)
 	}
 
-	actualLeaderSTS := generateRedisClusterParams(context.TODO(), input, *input.Spec.Size, input.Spec.RedisLeader.RedisConfig.AdditionalRedisConfig, RedisClusterSTS{
+	actualLeaderSTS := generateRedisClusterParams(context.TODO(), input, *input.Spec.ClusterSize, input.Spec.RedisLeader.RedisConfig.AdditionalRedisConfig, RedisClusterSTS{
 		RedisStateFulType:             "leader",
 		ExternalConfig:                input.Spec.RedisLeader.RedisConfig.AdditionalRedisConfig,
 		SecurityContext:               input.Spec.RedisLeader.SecurityContext,
@@ -179,7 +179,7 @@ func Test_generateRedisClusterParams(t *testing.T) {
 	})
 	assert.EqualValues(t, expectedLeaderSTS, actualLeaderSTS, "Expected %+v, got %+v", expectedLeaderSTS, actualLeaderSTS)
 
-	actualFollowerSTS := generateRedisClusterParams(context.TODO(), input, *input.Spec.Size, input.Spec.RedisFollower.RedisConfig.AdditionalRedisConfig, RedisClusterSTS{
+	actualFollowerSTS := generateRedisClusterParams(context.TODO(), input, *input.Spec.ClusterSize, input.Spec.RedisFollower.RedisConfig.AdditionalRedisConfig, RedisClusterSTS{
 		RedisStateFulType:             "follower",
 		ExternalConfig:                input.Spec.RedisFollower.RedisConfig.AdditionalRedisConfig,
 		SecurityContext:               input.Spec.RedisFollower.SecurityContext,
diff --git a/internal/k8sutils/redis_test.go b/internal/k8sutils/redis_test.go
@@ -365,7 +365,7 @@ func TestCreateMultipleLeaderRedisCommand(t *testing.T) {
 					Namespace: "default",
 				},
 				Spec: rcvb2.RedisClusterSpec{
-					Size:           ptr.To(int32(3)),
+					ClusterSize:    ptr.To(int32(3)),
 					ClusterVersion: ptr.To("v7"),
 					Port:           ptr.To(6379),
 				},
@@ -386,8 +386,8 @@ func TestCreateMultipleLeaderRedisCommand(t *testing.T) {
 					Namespace: "default",
 				},
 				Spec: rcvb2.RedisClusterSpec{
-					Size: ptr.To(int32(3)),
-					Port: ptr.To(6379),
+					ClusterSize: ptr.To(int32(3)),
+					Port:        ptr.To(6379),
 				},
 			},
 			expectedCommands: []string{
@@ -466,7 +466,7 @@ func TestCreateRedisReplicationCommand(t *testing.T) {
 					Namespace: "default",
 				},
 				Spec: rcvb2.RedisClusterSpec{
-					Size: ptr.To(int32(3)),
+					ClusterSize: ptr.To(int32(3)),
 					KubernetesConfig: common.KubernetesConfig{
 						ExistingPasswordSecret: &common.ExistingPasswordSecret{
 							Name: ptr.To("redis-password-secret"),
@@ -506,7 +506,7 @@ func TestCreateRedisReplicationCommand(t *testing.T) {
 					Namespace: "default",
 				},
 				Spec: rcvb2.RedisClusterSpec{
-					Size: ptr.To(int32(3)),
+					ClusterSize: ptr.To(int32(3)),
 					KubernetesConfig: common.KubernetesConfig{
 						ExistingPasswordSecret: &common.ExistingPasswordSecret{
 							Name: ptr.To("redis-password-secret"),
@@ -540,8 +540,8 @@ func TestCreateRedisReplicationCommand(t *testing.T) {
 					Namespace: "default",
 				},
 				Spec: rcvb2.RedisClusterSpec{
-					Size: ptr.To(int32(3)),
-					Port: ptr.To(6379),
+					ClusterSize: ptr.To(int32(3)),
+					Port:        ptr.To(6379),
 				},
 			},
 			leaderPod: RedisDetails{
diff --git a/internal/testutil/factories/rediscluster/rediscluster.go b/internal/testutil/factories/rediscluster/rediscluster.go
@@ -37,8 +37,8 @@ func New(name string, options ...customFieldOption) *v1beta2.RedisCluster {
 			Namespace: "default",
 		},
 		Spec: v1beta2.RedisClusterSpec{
-			Size:    &size,
-			Storage: &v1beta2.ClusterStorage{},
+			ClusterSize: &size,
+			Storage:     &v1beta2.ClusterStorage{},
 		},
 	}
 	for _, option := range options {
