Decouple full & delta snapshot backup ready conditions & Remove depre…

…cated fields in etcd.status
gardener · Aug 27, 2024 · b0b9725 · b0b9725
1 parent db00d1a
commit b0b9725
Show file tree

Hide file tree

Showing 20 changed files with 748 additions and 473 deletions.
diff --git a/api/v1alpha1/etcd.go b/api/v1alpha1/etcd.go
@@ -48,11 +48,12 @@ const (
 // +kubebuilder:printcolumn:name="Ready",type=string,JSONPath=`.status.ready`
 // +kubebuilder:printcolumn:name="Quorate",type=string,JSONPath=`.status.conditions[?(@.type=="Ready")].status`
 // +kubebuilder:printcolumn:name="All Members Ready",type=string,JSONPath=`.status.conditions[?(@.type=="AllMembersReady")].status`
-// +kubebuilder:printcolumn:name="Backup Ready",type=string,JSONPath=`.status.conditions[?(@.type=="BackupReady")].status`
 // +kubebuilder:printcolumn:name="Age",type=date,JSONPath=`.metadata.creationTimestamp`
-// +kubebuilder:printcolumn:name="Cluster Size",type=integer,JSONPath=`.spec.replicas`,priority=1
 // +kubebuilder:printcolumn:name="Current Replicas",type=integer,JSONPath=`.status.currentReplicas`,priority=1
 // +kubebuilder:printcolumn:name="Ready Replicas",type=integer,JSONPath=`.status.readyReplicas`,priority=1
+// +kubebuilder:printcolumn:name="Backup Ready",type=string,JSONPath=`.status.conditions[?(@.type=="BackupReady")].status`
+// +kubebuilder:printcolumn:name="Full Backup Ready",type=string,JSONPath=`.status.conditions[?(@.type=="FullSnapshotBackupReady")].status`
+// +kubebuilder:printcolumn:name="Delta Backup Ready",type=string,JSONPath=`.status.conditions[?(@.type=="DeltaSnapshotBackupReady")].status`
 
 // Etcd is the Schema for the etcds API
 type Etcd struct {
@@ -320,6 +321,10 @@ const (
 	ConditionTypeAllMembersReady ConditionType = "AllMembersReady"
 	// ConditionTypeBackupReady is a constant for a condition type indicating that the etcd backup is ready.
 	ConditionTypeBackupReady ConditionType = "BackupReady"
+	// ConditionTypeFullSnapshotBackupReady is a constant for a condition type indicating that the full snapshot backup is ready.
+	ConditionTypeFullSnapshotBackupReady ConditionType = "FullSnapshotBackupReady"
+	// ConditionTypeDeltaSnapshotBackupReady is a constant for a condition type indicating that the delta snapshot backup is ready.
+	ConditionTypeDeltaSnapshotBackupReady ConditionType = "DeltaSnapshotBackupReady"
 	// ConditionTypeDataVolumesReady is a constant for a condition type indicating that the etcd data volumes are ready.
 	ConditionTypeDataVolumesReady ConditionType = "DataVolumesReady"
 )
@@ -374,10 +379,6 @@ type EtcdStatus struct {
 	// Conditions represents the latest available observations of an etcd's current state.
 	// +optional
 	Conditions []Condition `json:"conditions,omitempty"`
-	// ServiceName is the name of the etcd service.
-	// Deprecated: this field will be removed in the future.
-	// +optional
-	ServiceName *string `json:"serviceName,omitempty"`
 	// LastError represents the last occurred error.
 	// Deprecated: Use LastErrors instead.
 	// +optional
@@ -388,10 +389,6 @@ type EtcdStatus struct {
 	// LastOperation indicates the last operation performed on this resource.
 	// +optional
 	LastOperation *LastOperation `json:"lastOperation,omitempty"`
-	// Cluster size is the current size of the etcd cluster.
-	// Deprecated: this field will not be populated with any value and will be removed in the future.
-	// +optional
-	ClusterSize *int32 `json:"clusterSize,omitempty"`
 	// CurrentReplicas is the current replica count for the etcd cluster.
 	// +optional
 	CurrentReplicas int32 `json:"currentReplicas,omitempty"`
@@ -404,15 +401,6 @@ type EtcdStatus struct {
 	// Ready is `true` if all etcd replicas are ready.
 	// +optional
 	Ready *bool `json:"ready,omitempty"`
-	// UpdatedReplicas is the count of updated replicas in the etcd cluster.
-	// Deprecated: this field will be removed in the future.
-	// +optional
-	UpdatedReplicas int32 `json:"updatedReplicas,omitempty"`
-	// LabelSelector is a label query over pods that should match the replica count.
-	// It must match the pod template's labels.
-	// Deprecated: this field will be removed in the future.
-	// +optional
-	LabelSelector *metav1.LabelSelector `json:"labelSelector,omitempty"`
 	// Members represents the members of the etcd cluster
 	// +optional
 	Members []EtcdMemberStatus `json:"members,omitempty"`

diff --git a/api/v1alpha1/zz_generated.deepcopy.go b/api/v1alpha1/zz_generated.deepcopy.go
diff --git a/charts/druid/charts/crds/templates/crd-druid.gardener.cloud_etcds.yaml b/charts/druid/charts/crds/templates/crd-druid.gardener.cloud_etcds.yaml
@@ -24,16 +24,9 @@ spec:
     - jsonPath: .status.conditions[?(@.type=="AllMembersReady")].status
       name: All Members Ready
       type: string
-    - jsonPath: .status.conditions[?(@.type=="BackupReady")].status
-      name: Backup Ready
-      type: string
     - jsonPath: .metadata.creationTimestamp
       name: Age
       type: date
-    - jsonPath: .spec.replicas
-      name: Cluster Size
-      priority: 1
-      type: integer
     - jsonPath: .status.currentReplicas
       name: Current Replicas
       priority: 1
@@ -42,6 +35,15 @@ spec:
       name: Ready Replicas
       priority: 1
       type: integer
+    - jsonPath: .status.conditions[?(@.type=="BackupReady")].status
+      name: Backup Ready
+      type: string
+    - jsonPath: .status.conditions[?(@.type=="FullSnapshotBackupReady")].status
+      name: Full Backup Ready
+      type: string
+    - jsonPath: .status.conditions[?(@.type=="DeltaSnapshotBackupReady")].status
+      name: Delta Backup Ready
+      type: string
     name: v1alpha1
     schema:
       openAPIV3Schema:
@@ -1785,12 +1787,6 @@ spec:
           status:
             description: EtcdStatus defines the observed state of Etcd.
             properties:
-              clusterSize:
-                description: |-
-                  Cluster size is the current size of the etcd cluster.
-                  Deprecated: this field will not be populated with any value and will be removed in the future.
-                format: int32
-                type: integer
               conditions:
                 description: Conditions represents the latest available observations
                   of an etcd's current state.
@@ -1848,53 +1844,6 @@ spec:
                     description: Name of the referent
                     type: string
                 type: object
-              labelSelector:
-                description: |-
-                  LabelSelector is a label query over pods that should match the replica count.
-                  It must match the pod template's labels.
-                  Deprecated: this field will be removed in the future.
-                properties:
-                  matchExpressions:
-                    description: matchExpressions is a list of label selector requirements.
-                      The requirements are ANDed.
-                    items:
-                      description: |-
-                        A label selector requirement is a selector that contains values, a key, and an operator that
-                        relates the key and values.
-                      properties:
-                        key:
-                          description: key is the label key that the selector applies
-                            to.
-                          type: string
-                        operator:
-                          description: |-
-                            operator represents a key's relationship to a set of values.
-                            Valid operators are In, NotIn, Exists and DoesNotExist.
-                          type: string
-                        values:
-                          description: |-
-                            values is an array of string values. If the operator is In or NotIn,
-                            the values array must be non-empty. If the operator is Exists or DoesNotExist,
-                            the values array must be empty. This array is replaced during a strategic
-                            merge patch.
-                          items:
-                            type: string
-                          type: array
-                      required:
-                      - key
-                      - operator
-                      type: object
-                    type: array
-                  matchLabels:
-                    additionalProperties:
-                      type: string
-                    description: |-
-                      matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
-                      map is equivalent to an element of matchExpressions, whose key field is "key", the
-                      operator is "In", and the values array contains only "value". The requirements are ANDed.
-                    type: object
-                type: object
-                x-kubernetes-map-type: atomic
               lastError:
                 description: |-
                   LastError represents the last occurred error.
@@ -2014,17 +1963,6 @@ spec:
                 description: Replicas is the replica count of the etcd cluster.
                 format: int32
                 type: integer
-              serviceName:
-                description: |-
-                  ServiceName is the name of the etcd service.
-                  Deprecated: this field will be removed in the future.
-                type: string
-              updatedReplicas:
-                description: |-
-                  UpdatedReplicas is the count of updated replicas in the etcd cluster.
-                  Deprecated: this field will be removed in the future.
-                format: int32
-                type: integer
             type: object
         type: object
     served: true

diff --git a/config/crd/bases/crd-druid.gardener.cloud_etcds.yaml b/config/crd/bases/crd-druid.gardener.cloud_etcds.yaml
@@ -24,16 +24,9 @@ spec:
     - jsonPath: .status.conditions[?(@.type=="AllMembersReady")].status
       name: All Members Ready
       type: string
-    - jsonPath: .status.conditions[?(@.type=="BackupReady")].status
-      name: Backup Ready
-      type: string
     - jsonPath: .metadata.creationTimestamp
       name: Age
       type: date
-    - jsonPath: .spec.replicas
-      name: Cluster Size
-      priority: 1
-      type: integer
     - jsonPath: .status.currentReplicas
       name: Current Replicas
       priority: 1
@@ -42,6 +35,15 @@ spec:
       name: Ready Replicas
       priority: 1
       type: integer
+    - jsonPath: .status.conditions[?(@.type=="BackupReady")].status
+      name: Backup Ready
+      type: string
+    - jsonPath: .status.conditions[?(@.type=="FullSnapshotBackupReady")].status
+      name: Full Backup Ready
+      type: string
+    - jsonPath: .status.conditions[?(@.type=="DeltaSnapshotBackupReady")].status
+      name: Delta Backup Ready
+      type: string
     name: v1alpha1
     schema:
       openAPIV3Schema:
@@ -1785,12 +1787,6 @@ spec:
           status:
             description: EtcdStatus defines the observed state of Etcd.
             properties:
-              clusterSize:
-                description: |-
-                  Cluster size is the current size of the etcd cluster.
-                  Deprecated: this field will not be populated with any value and will be removed in the future.
-                format: int32
-                type: integer
               conditions:
                 description: Conditions represents the latest available observations
                   of an etcd's current state.
@@ -1848,53 +1844,6 @@ spec:
                     description: Name of the referent
                     type: string
                 type: object
-              labelSelector:
-                description: |-
-                  LabelSelector is a label query over pods that should match the replica count.
-                  It must match the pod template's labels.
-                  Deprecated: this field will be removed in the future.
-                properties:
-                  matchExpressions:
-                    description: matchExpressions is a list of label selector requirements.
-                      The requirements are ANDed.
-                    items:
-                      description: |-
-                        A label selector requirement is a selector that contains values, a key, and an operator that
-                        relates the key and values.
-                      properties:
-                        key:
-                          description: key is the label key that the selector applies
-                            to.
-                          type: string
-                        operator:
-                          description: |-
-                            operator represents a key's relationship to a set of values.
-                            Valid operators are In, NotIn, Exists and DoesNotExist.
-                          type: string
-                        values:
-                          description: |-
-                            values is an array of string values. If the operator is In or NotIn,
-                            the values array must be non-empty. If the operator is Exists or DoesNotExist,
-                            the values array must be empty. This array is replaced during a strategic
-                            merge patch.
-                          items:
-                            type: string
-                          type: array
-                      required:
-                      - key
-                      - operator
-                      type: object
-                    type: array
-                  matchLabels:
-                    additionalProperties:
-                      type: string
-                    description: |-
-                      matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
-                      map is equivalent to an element of matchExpressions, whose key field is "key", the
-                      operator is "In", and the values array contains only "value". The requirements are ANDed.
-                    type: object
-                type: object
-                x-kubernetes-map-type: atomic
               lastError:
                 description: |-
                   LastError represents the last occurred error.
@@ -2014,17 +1963,6 @@ spec:
                 description: Replicas is the replica count of the etcd cluster.
                 format: int32
                 type: integer
-              serviceName:
-                description: |-
-                  ServiceName is the name of the etcd service.
-                  Deprecated: this field will be removed in the future.
-                type: string
-              updatedReplicas:
-                description: |-
-                  UpdatedReplicas is the count of updated replicas in the etcd cluster.
-                  Deprecated: this field will be removed in the future.
-                format: int32
-                type: integer
             type: object
         type: object
     served: true

diff --git a/docs/concepts/controllers.md b/docs/concepts/controllers.md
@@ -79,6 +79,8 @@ Status fields related to the etcd cluster itself, such as `Members`, `PeerUrlTLS
 - `AllMembersReady`: indicates readiness of all members of the etcd cluster.
 - `Ready`: indicates overall readiness of the etcd cluster in serving traffic.
 - `BackupReady`: indicates health of the etcd backups, i.e., whether etcd backups are being taken regularly as per schedule. This condition is applicable only when backups are enabled for the etcd cluster.
+- `FullSnapshotBackupReady`: indicates health of the full snapshot backups, i.e whether full snapshot backups are being taken regularly as per schedule. This condition is applicable only when backups are enabled for the etcd cluster.
+- `DeltaSnapshotBackupReady`: indicates health of the delta snapshot backups, i.e whether delta snapshot backups are being taken regularly as per schedule. This condition is applicable only when backups are enabled for the etcd cluster.
 - `DataVolumesReady`: indicates health of the persistent volumes containing the etcd data.
 
 ## Compaction Controller

diff --git a/docs/development/getting-started-locally.md b/docs/development/getting-started-locally.md
@@ -122,7 +122,7 @@ kubectl apply -f config/samples/druid_v1alpha1_etcd.yaml
 
 ### Verify the Etcd cluster
 
-To obtain information regarding the newly instantiated etcd cluster, perform the following step, which gives details such as the cluster size, readiness status of its members, and various other attributes.
+To obtain information regarding the newly instantiated etcd cluster, perform the following step, which gives details such as the current & ready replicas, readiness status of its members, Full and Delta backup status and various other attributes.
 
 ```sh
 kubectl get etcd -o=wide

diff --git a/docs/proposals/01-multi-node-etcd-clusters.md b/docs/proposals/01-multi-node-etcd-clusters.md
@@ -50,7 +50,6 @@ This document proposes an approach (along with some alternatives) to support pro
       - [Member name as the key](#member-name-as-the-key)
       - [Member Leases](#member-leases)
     - [Conditions](#conditions)
-    - [ClusterSize](#clustersize)
     - [Alternative](#alternative-4)
   - [Decision table for etcd-druid based on the status](#decision-table-for-etcd-druid-based-on-the-status)
     - [1. Pink of health](#1-pink-of-health)
@@ -563,8 +562,6 @@ status:
     lastTransitionTime:         "2020-11-10T12:48:01Z"
     reason: FullBackupSucceeded # FullBackupSucceeded|IncrementalBackupSucceeded|FullBackupFailed|IncrementalBackupFailed
   ...
-  clusterSize: 3
-  ...
   replicas: 3
   ...
   members:
@@ -647,15 +644,6 @@ The `BackupReady` condition will be maintained by the leading `etcd-backup-resto
 
 More condition types could be introduced in the future if specific purposes arise.
 
-### ClusterSize
-
-The `clusterSize` field contains the current size of the ETCD cluster. It will be actively kept up-to-date by `etcd-druid` in all scenarios.
-
-- Before [bootstrapping](#bootstrapping) the ETCD cluster (during cluster creation or later bootstrapping because of [quorum failure](#recommended-action-9)), `etcd-druid` will clear the `status.members` array and set `status.clusterSize` to be equal to `spec.replicas`.
-- While the ETCD cluster is quorate, `etcd-druid` will actively set `status.clusterSize` to be equal to length of the `status.members` whenever the length of the array changes (say, due to scaling of the ETCD cluster).
-
-Given that `clusterSize` reliably represents the size of the ETCD cluster, it can be used to calculate the `Ready` [condition](#conditions).
-
 ### Alternative
 
 The alternative is for `etcd-druid` to maintain the status in the `Etcd` status sub-resource.
@@ -1255,7 +1243,7 @@ The life-cycle of these work-flows is shown below.
 
 - Take [backups](#backup) (full and incremental) at configured regular intervals
 - [Defragment](#defragmentation) all the members sequentially at configured regular intervals
-- Cleanup superflous members from the ETCD cluster for which there is no corresponding pod (the [ordinal](https://kubernetes.io/docs/concepts/workloads/controllers/statefulset/#ordinal-index) in the pod name is greater than the [cluster size](#clustersize)) at regular intervals (or whenever the `Etcd` resource [status](#status) changes by watching it)
+- Cleanup superflous members from the ETCD cluster for which there is no corresponding pod (the [ordinal](https://kubernetes.io/docs/concepts/workloads/controllers/statefulset/#ordinal-index) in the pod name is greater than the cluster size) at regular intervals (or whenever the `Etcd` resource [status](#status) changes by watching it)
   - The cleanup of [superfluous entries in `status.members` array](#13-superfluous-member-entries-in-etcd-status) is already covered [here](#recommended-action-12)
 
 ## High Availability