feat: support to configure standalone replicas (#334)

Author: daviderli614

apis/v1alpha1/defaulting.go

@@ -414,6 +414,10 @@ func (in *GreptimeDBStandalone) defaultSpec() *GreptimeDBStandaloneSpec {
 		SlowQuery:       defaultSlowQuery(),
 	}
 
+	if in.Spec.Replicas == nil {
+		defaultSpec.Replicas = ptr.To(int32(DefaultReplicas))
+	}
+
 	return defaultSpec
 }
 

apis/v1alpha1/greptimedbstandalone_types.go

@@ -65,6 +65,11 @@ type GreptimeDBStandaloneSpec struct {
 	// +optional
 	Version string `json:"version,omitempty"`
 
+	// The number of replicas of the standalone.
+	// +optional
+	// +kubebuilder:validation:Enum:={0, 1}
+	Replicas *int32 `json:"replicas,omitempty"`
+
 	// Initializer is the init container to set up components configurations before running the container.
 	// +optional
 	Initializer *InitializerSpec `json:"initializer,omitempty"`
@@ -108,6 +113,12 @@ type GreptimeDBStandaloneSpec struct {
 
 // GreptimeDBStandaloneStatus defines the observed state of GreptimeDBStandalone
 type GreptimeDBStandaloneStatus struct {
+	// Replicas is the number of replicas of the standalone.
+	Replicas int32 `json:"replicas"`
+
+	// ReadyReplicas is the number of ready replicas of the standalone.
+	ReadyReplicas int32 `json:"readyReplicas"`
+
 	// Version is the version of the greptimedb.
 	// +optional
 	Version string `json:"version,omitempty"`
@@ -129,6 +140,7 @@ type GreptimeDBStandaloneStatus struct {
 // +kubebuilder:object:root=true
 // +kubebuilder:subresource:status
 // +kubebuilder:resource:shortName=gts
+// +kubebuilder:printcolumn:name="STANDALONE",type="integer",JSONPath=".status.readyReplicas"
 // +kubebuilder:printcolumn:name="PHASE",type=string,JSONPath=".status.standalonePhase"
 // +kubebuilder:printcolumn:name="VERSION",type=string,JSONPath=".status.version"
 // +kubebuilder:printcolumn:name="AGE",type=date,JSONPath=".metadata.creationTimestamp"

apis/v1alpha1/testdata/defaulting/greptimedbcluster/setdefaults/test03/expect.yaml

@@ -102,6 +102,7 @@ spec:
     enabled: true
     logsCollection: {}
     standalone:
+      replicas: 1
       base:
         main:
           image: greptime/greptimedb:latest

apis/v1alpha1/testdata/defaulting/greptimedbstandalone/test00/expect.yaml

@@ -9,6 +9,7 @@ spec:
   mysqlPort: 4002
   postgreSQLPort: 4003
   rpcPort: 4001
+  replicas: 1
   configMergeStrategy: ConfigMergeStrategyInjectedDataFirst
   base:
     main:

apis/v1alpha1/zz_generated.deepcopy.go

@@ -27340,6 +27340,12 @@ spec:
                         required:
                         - enabled
                         type: object
+                      replicas:
+                        enum:
+                        - 0
+                        - 1
+                        format: int32
+                        type: integer
                       rollingUpdate:
                         properties:
                           maxUnavailable:

config/crd/resources/greptime.io_greptimedbclusters.yaml

@@ -17,6 +17,9 @@ spec:
   scope: Namespaced
   versions:
   - additionalPrinterColumns:
+    - jsonPath: .status.readyReplicas
+      name: STANDALONE
+      type: integer
     - jsonPath: .status.standalonePhase
       name: PHASE
       type: string
@@ -3528,6 +3531,12 @@ spec:
                 required:
                 - enabled
                 type: object
+              replicas:
+                enum:
+                - 0
+                - 1
+                format: int32
+                type: integer
               rollingUpdate:
                 properties:
                   maxUnavailable:
@@ -3663,10 +3672,19 @@ spec:
               observedGeneration:
                 format: int64
                 type: integer
+              readyReplicas:
+                format: int32
+                type: integer
+              replicas:
+                format: int32
+                type: integer
               standalonePhase:
                 type: string
               version:
                 type: string
+            required:
+            - readyReplicas
+            - replicas
             type: object
         type: object
     served: true

config/crd/resources/greptime.io_greptimedbstandalones.yaml

@@ -25,7 +25,6 @@ import (
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/runtime"
 	"k8s.io/klog/v2"
-	"k8s.io/utils/ptr"
 	ctrl "sigs.k8s.io/controller-runtime"
 	"sigs.k8s.io/controller-runtime/pkg/client"
 
@@ -141,6 +140,12 @@ func (d *StandaloneDeployer) CheckAndUpdateStatus(ctx context.Context, crdObject
 		return false, err
 	}
 
+	standalone.Status.Replicas = *sts.Spec.Replicas
+	standalone.Status.ReadyReplicas = sts.Status.ReadyReplicas
+	if err = UpdateStatus(ctx, standalone, d.Client); err != nil {
+		klog.Errorf("Failed to update status: %s", err)
+	}
+
 	return k8sutil.IsStatefulSetReady(sts), nil
 }
 
@@ -251,7 +256,7 @@ func (b *standaloneBuilder) BuildStatefulSet() deployer.Builder {
 		},
 		Spec: appsv1.StatefulSetSpec{
 			// Always set replicas to 1 for standalone mode.
-			Replicas: ptr.To(int32(1)),
+			Replicas: b.standalone.Spec.Replicas,
 			Selector: &metav1.LabelSelector{
 				MatchLabels: map[string]string{
 					constant.GreptimeDBComponentName: common.ResourceName(b.standalone.Name, v1alpha1.StandaloneRoleKind),

controllers/greptimedbstandalone/deployer.go

@@ -495,6 +495,7 @@ _Appears in:_
 | `postgreSQLPort` _integer_ | PostgreSQLPort is the port of the greptimedb postgresql service. |  | Maximum: 65535 <br />Minimum: 0 <br /> |
 | `prometheusMonitor` _[PrometheusMonitorSpec](#prometheusmonitorspec)_ | PrometheusMonitor is the specification for creating PodMonitor or ServiceMonitor. |  |  |
 | `version` _string_ | Version is the version of the greptimedb. |  |  |
+| `replicas` _integer_ | The number of replicas of the standalone. |  | Enum: [0 1] <br /> |
 | `initializer` _[InitializerSpec](#initializerspec)_ | Initializer is the init container to set up components configurations before running the container. |  |  |
 | `objectStorage` _[ObjectStorageProviderSpec](#objectstorageproviderspec)_ | ObjectStorageProvider is the storage provider for the greptimedb cluster. |  |  |
 | `datanodeStorage` _[DatanodeStorageSpec](#datanodestoragespec)_ | DatanodeStorage is the default file storage of the datanode. For example, WAL, cache, index etc. |  |  |

docs/api-references/docs.md

@@ -27346,6 +27346,12 @@ spec:
                         required:
                         - enabled
                         type: object
+                      replicas:
+                        enum:
+                        - 0
+                        - 1
+                        format: int32
+                        type: integer
                       rollingUpdate:
                         properties:
                           maxUnavailable:
@@ -27794,6 +27800,9 @@ spec:
   scope: Namespaced
   versions:
   - additionalPrinterColumns:
+    - jsonPath: .status.readyReplicas
+      name: STANDALONE
+      type: integer
     - jsonPath: .status.standalonePhase
       name: PHASE
       type: string
@@ -31305,6 +31314,12 @@ spec:
                 required:
                 - enabled
                 type: object
+              replicas:
+                enum:
+                - 0
+                - 1
+                format: int32
+                type: integer
               rollingUpdate:
                 properties:
                   maxUnavailable:
@@ -31440,10 +31455,19 @@ spec:
               observedGeneration:
                 format: int64
                 type: integer
+              readyReplicas:
+                format: int32
+                type: integer
+              replicas:
+                format: int32
+                type: integer
               standalonePhase:
                 type: string
               version:
                 type: string
+            required:
+            - readyReplicas
+            - replicas
             type: object
         type: object
     served: true