Skip to content

Add new status conditions to replication status #826

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jul 10, 2025
Merged

Add new status conditions to replication status #826

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0882071
vendor: update csi-addons/spec pkg
Nikhil-Ladha Jun 26, 2025
7d6de84
proto: update GetVolumeReplicationInfo RPC proto definition
Nikhil-Ladha Jun 26, 2025
2769399
add conditions for replication status
Nikhil-Ladha Jun 26, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 23 additions & 15 deletions api/replication.storage/v1alpha1/volumereplication_types.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,25 +30,29 @@ const (
// "ConditionDegraded" means the condition is not fulfilled.
// "ConditionResyncing" means the condition is resyncing.
const (
ConditionCompleted = "Completed"
ConditionDegraded = "Degraded"
ConditionResyncing = "Resyncing"
ConditionValidated = "Validated"
ConditionCompleted = "Completed"
ConditionDegraded = "Degraded"
ConditionResyncing = "Resyncing"
ConditionValidated = "Validated"
ConditionReplicating = "Replicating"
)

// These are valid messages for various conditions and states of volume replication.
const (
MessagePromoted = "is promoted to primary and replicating to secondary"
MessageHealthy = "is healthy"
MessageNotResyncing = "is not resyncing"
MessageValidated = "is validated and met all prerequisites"
MessageFailedPromoted = "failed to promote"
MessageFailedDemoted = "failed to demote"
MessageFailedPreCondition = "failed to meet prerequisite"
MessageDemoted = "is demoted to secondary"
MessageDegraded = "is degraded"
MessageResyncTriggered = "is resyncing changes from primary to secondary"
MessageResyncFailed = "failed to resync"
MessagePromoted = "is promoted to primary and replicating to secondary"
MessageHealthy = "is healthy"
MessageNotResyncing = "is not resyncing"
MessageValidated = "is validated and met all prerequisites"
MessageFailedPromoted = "failed to promote"
MessageFailedDemoted = "failed to demote"
MessageFailedPreCondition = "failed to meet prerequisite"
MessageDemoted = "is demoted to secondary"
MessageDegraded = "is degraded"
MessageResyncTriggered = "is resyncing changes from primary to secondary"
MessageResyncFailed = "failed to resync"
MessageReplicating = "is replicating"
MessageNotReplicating = "is not replicating"
MessageUnknownReplicationState = "replication status is unknown"
)

type Source string
Expand Down Expand Up @@ -87,6 +91,10 @@ const (
PrerequisiteMet = "PrerequisiteMet"
// PrerequisiteNotMet condition represents that the prerequisite is not met.
PrerequisiteNotMet = "PrerequisiteNotMet"
// Replicating condition represents that the volume/group is replicating.
Replicating = "Replicating"
// NotReplicating condition represents that the volume/group is not replicating.
NotReplicating = "NotReplicating"
)

// ReplicationState represents the replication operations to be performed on the volume.
Expand Down
2 changes: 1 addition & 1 deletion go.mod
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ go 1.24.0

require (
github.com/container-storage-interface/spec v1.11.0
github.com/csi-addons/spec v0.2.1-0.20241104111131-27825f744db5
github.com/csi-addons/spec v0.2.1-0.20250610152019-b5a7205f6a79
github.com/go-logr/logr v1.4.3
github.com/kubernetes-csi/csi-lib-utils v0.22.0
github.com/onsi/ginkgo/v2 v2.23.4
Expand Down
4 changes: 2 additions & 2 deletions go.sum
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@ github.com/cespare/xxhash/v2 v2.3.0/go.mod h1:VGX0DQ3Q6kWi7AoAeZDth3/j3BFtOZR5XL
github.com/container-storage-interface/spec v1.11.0 h1:H/YKTOeUZwHtyPOr9raR+HgFmGluGCklulxDYxSdVNM=
github.com/container-storage-interface/spec v1.11.0/go.mod h1:DtUvaQszPml1YJfIK7c00mlv6/g4wNMLanLgiUbKFRI=
github.com/cpuguy83/go-md2man/v2 v2.0.4/go.mod h1:tgQtvFlXSQOSOSIRvRPT7W67SCa46tRHOmNcaadrF8o=
github.com/csi-addons/spec v0.2.1-0.20241104111131-27825f744db5 h1:j9NaWj5KmzEVarmsjxS/NDAhes6Uzq1qhkUGHvDlVBk=
github.com/csi-addons/spec v0.2.1-0.20241104111131-27825f744db5/go.mod h1:Mwq4iLiUV4s+K1bszcWU6aMsR5KPsbIYzzszJ6+56vI=
github.com/csi-addons/spec v0.2.1-0.20250610152019-b5a7205f6a79 h1:ditFTa+wl7DLanGQHSS/AwuITGuWeBXyl7syPO4n+4s=
github.com/csi-addons/spec v0.2.1-0.20250610152019-b5a7205f6a79/go.mod h1:Mwq4iLiUV4s+K1bszcWU6aMsR5KPsbIYzzszJ6+56vI=
github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
github.com/davecgh/go-spew v1.1.2-0.20180830191138-d8f796af33cc h1:U9qPSI2PIWSS1VwoXQT9A3Wy9MM3WgvqSxFWenqJduM=
Expand Down
36 changes: 36 additions & 0 deletions internal/controller/replication.storage/status.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -250,6 +250,42 @@ func setFailedResyncCondition(conditions *[]metav1.Condition, observedGeneration
})
}

// sets ConditionUnknown for ConditionReplicating condition in VR status.Conditions.
func setUnknownReplicationCondition(conditions *[]metav1.Condition, observedGeneration int64, dataSource, statusMessage string) {
source := getSource(dataSource)
setStatusCondition(conditions, &metav1.Condition{
Message: fmt.Sprintf("%s %s: %s", source, v1alpha1.MessageUnknownReplicationState, statusMessage),
Type: v1alpha1.ConditionReplicating,
Reason: v1alpha1.Replicating,
ObservedGeneration: observedGeneration,
Status: metav1.ConditionUnknown,
})
}

// sets ConditionTrue for ConditionReplicating condition in VR status.Conditions
func setHealthyReplicationCondition(conditions *[]metav1.Condition, observedGeneration int64, dataSource, statusMessage string) {
source := getSource(dataSource)
setStatusCondition(conditions, &metav1.Condition{
Message: fmt.Sprintf("%s %s: %s", source, v1alpha1.MessageReplicating, statusMessage),
Type: v1alpha1.ConditionReplicating,
Reason: v1alpha1.Replicating,
ObservedGeneration: observedGeneration,
Status: metav1.ConditionTrue,
})
}

// sets ConditionFalse for ConditionReplicating condition in VR status.Conditions
func setDegradedReplicationCondition(conditions *[]metav1.Condition, observedGeneration int64, dataSource, statusMessage string) {
source := getSource(dataSource)
setStatusCondition(conditions, &metav1.Condition{
Message: fmt.Sprintf("%s %s: %s", source, v1alpha1.MessageNotReplicating, statusMessage),
Type: v1alpha1.ConditionReplicating,
Reason: v1alpha1.NotReplicating,
ObservedGeneration: observedGeneration,
Status: metav1.ConditionFalse,
})
}

func setStatusCondition(existingConditions *[]metav1.Condition, newCondition *metav1.Condition) {
if existingConditions == nil {
existingConditions = &[]metav1.Condition{}
Expand Down
17 changes: 17 additions & 0 deletions internal/controller/replication.storage/volumereplication_controller.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -449,6 +449,11 @@ func (r *VolumeReplicationReconciler) Reconcile(ctx context.Context, req ctrl.Re
instance.Status.LastSyncBytes = &tb
}
}
// Check for nil, as info might be nil for knownGRPCErrors.
if info != nil {
// We set Replicating condition only for primary state and not for secondary state.
setReplicationCondition(vr.instance, vr.instance.Spec.DataSource.Kind, info.StatusMessage, info.Status)
}
requeueForInfo = true
} else if !util.IsUnimplementedError(err) {
logger.Error(err, "Failed to get volume replication info")
Expand Down Expand Up @@ -772,6 +777,18 @@ func setFailureCondition(instance *replicationv1alpha1.VolumeReplication, errMes
}
}

// setReplicationCondition sets the replication condition in VR's status.Conditions for the PVC/VolumeGroup dataSource based on the replicationStatus value.
func setReplicationCondition(instance *replicationv1alpha1.VolumeReplication, dataSource, statusMessage string, replicationStatus proto.GetVolumeReplicationInfoResponse_Status) {
switch replicationStatus {
case proto.GetVolumeReplicationInfoResponse_UNKNOWN:
setUnknownReplicationCondition(&instance.Status.Conditions, instance.Generation, dataSource, statusMessage)
case proto.GetVolumeReplicationInfoResponse_HEALTHY:
setHealthyReplicationCondition(&instance.Status.Conditions, instance.Generation, dataSource, statusMessage)
case proto.GetVolumeReplicationInfoResponse_DEGRADED, proto.GetVolumeReplicationInfoResponse_ERROR:
setDegradedReplicationCondition(&instance.Status.Conditions, instance.Generation, dataSource, statusMessage)
}
}

func getCurrentTime() *metav1.Time {
metav1NowTime := metav1.NewTime(time.Now())

Expand Down
Loading