[main] Add new method to track originating cluster of Backup #613
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,109 @@ | ||
| package backup | ||
|
|
||
| import ( | ||
| v1 "github.com/rancher/backup-restore-operator/pkg/apis/resources.cattle.io/v1" | ||
| "github.com/rancher/wrangler/v3/pkg/condition" | ||
| ) | ||
|
|
||
| type backupClusterOriginConditionMeta struct { | ||
| backupName string | ||
| hasClusterOriginID bool | ||
| clusterOriginID string | ||
| hasCurrentOriginCondition bool | ||
| currentOriginCondition bool | ||
| canInPlaceRestore bool | ||
| hasInPlaceRestoreCondition bool | ||
| currentInPlaceRestoreCondition bool | ||
|
Comment on lines
+9
to
+16
There was a problem hiding this comment. Instead of having boolean fields injected during construction, could encapsulate type backupClusterMdChecker struct{
backupName string
clusterOrigin string
b *backupv1.Backup
// Any controllers or client runtime needed for methods, if any
}
func (b backupClusterMd) hasClusterOriginID() bool {
// ...
}
func (b backupClusterMd) hasCurrentOriginCondition() bool {
// ...
}This allows us to isolate some more complicated logic, as well as allowing for testing if we make these methods or struct public, which we probably should - because we should be focused on stability. If making them public, could consider moving them to sub-package, Also greatly simplifies the if statements below IMO. |
||
| } | ||
|
|
||
| func newBackupClusterOriginConditionMeta(controllerClusterID string, backup *v1.Backup) backupClusterOriginConditionMeta { | ||
| conditionMeta := backupClusterOriginConditionMeta{ | ||
| backupName: backup.Name, | ||
| hasClusterOriginID: false, | ||
| hasCurrentOriginCondition: false, | ||
| currentOriginCondition: false, | ||
| canInPlaceRestore: false, | ||
| hasInPlaceRestoreCondition: false, | ||
| currentInPlaceRestoreCondition: false, | ||
| } | ||
|
|
||
| originalValue := backup.Status.OriginCluster | ||
| conditionMeta.hasClusterOriginID = originalValue != "" | ||
| if conditionMeta.hasClusterOriginID { | ||
| conditionMeta.clusterOriginID = originalValue | ||
| } | ||
|
|
||
| currentOriginConditionString := condition.Cond(v1.BackupConditionClusterOrigin).GetStatus(backup) | ||
| conditionMeta.hasCurrentOriginCondition = currentOriginConditionString != "" | ||
| if !conditionMeta.hasCurrentOriginCondition { | ||
| conditionMeta.currentOriginCondition = currentOriginConditionString == "True" | ||
| } | ||
|
|
||
| if conditionMeta.hasClusterOriginID { | ||
| conditionMeta.canInPlaceRestore = conditionMeta.clusterOriginID == controllerClusterID | ||
| } | ||
|
|
||
| currentInPlaceRestoreString := condition.Cond(v1.BackupConditionInPlaceRestore).GetStatus(backup) | ||
| conditionMeta.hasInPlaceRestoreCondition = currentInPlaceRestoreString != "" | ||
| if !conditionMeta.hasInPlaceRestoreCondition { | ||
| conditionMeta.currentInPlaceRestoreCondition = currentInPlaceRestoreString == "True" | ||
| } | ||
|
|
||
| return conditionMeta | ||
| } | ||
|
|
||
| // prepareClusterOriginConditions helps set the cluster origin conditions and reports if anything changed in this part of status. | ||
| func (h *handler) prepareClusterOriginConditions(backup *v1.Backup) bool { | ||
|
There was a problem hiding this comment. I think a lot of this logic in this function can also be simplified/more readable if we encapsulate most of it in struct methods |
||
| conditionChanged := false | ||
| if !h.canUseClusterOriginStatus { | ||
| currentOriginConditionString := condition.Cond(v1.BackupConditionClusterOrigin).GetStatus(backup) | ||
| if currentOriginConditionString != "False" { | ||
| condition.Cond(v1.BackupConditionClusterOrigin).SetStatusBool(backup, false) | ||
| condition.Cond(v1.BackupConditionClusterOrigin).Message(backup, "CRD not updated to include cluster UID yet.") | ||
|
There was a problem hiding this comment. When would this realistically happen? There was a problem hiding this comment. Yeah, at least I think so. Granted it was during devworkflows, but I did run into it myself. Maybe not as big a concern in prod, but I think could still happen - in a chart like BRO if they don't also update the CRDs. I.e. Installed via helm CLI directly. |
||
| conditionChanged = true | ||
| } | ||
| currentInPlaceRestoreString := condition.Cond(v1.BackupConditionInPlaceRestore).GetStatus(backup) | ||
| if currentInPlaceRestoreString != "False" { | ||
| condition.Cond(v1.BackupConditionInPlaceRestore).SetStatusBool(backup, false) | ||
| condition.Cond(v1.BackupConditionInPlaceRestore).Message(backup, "Cannot determine if in-place Restore is viable.") | ||
| conditionChanged = true | ||
| } | ||
|
|
||
| return conditionChanged | ||
| } | ||
|
|
||
| // TODO: We could add a fallback mode that uses filenames (and/or the annotation) when the CRD is not updated | ||
| conditionMeta := newBackupClusterOriginConditionMeta(h.kubeSystemNS, backup) | ||
|
|
||
| // Fist pass we only care to set BackupConditionClusterOrigin based on if the context is there | ||
| if !conditionMeta.hasCurrentOriginCondition || conditionMeta.currentOriginCondition != conditionMeta.hasClusterOriginID { | ||
| conditionChanged = true | ||
| condition.Cond(v1.BackupConditionClusterOrigin).SetStatusBool(backup, conditionMeta.hasClusterOriginID) | ||
|
|
||
| if conditionMeta.hasClusterOriginID { | ||
| condition.Cond(v1.BackupConditionClusterOrigin).Message(backup, "Backup has cluster UID attached.") | ||
| } else { | ||
| condition.Cond(v1.BackupConditionClusterOrigin).Message(backup, "No cluster UID attached to backup.") | ||
| } | ||
| } | ||
|
|
||
| // Second pass, we care about the specifics of the ClusterOrigin to set the InPlaceRestore condition | ||
| if !conditionMeta.hasClusterOriginID { | ||
| // When annotation is missing, we'll mark as unable to determine | ||
| condition.Cond(v1.BackupConditionInPlaceRestore).SetStatusBool(backup, false) | ||
| condition.Cond(v1.BackupConditionInPlaceRestore).Message(backup, "Unable to determine if in-place Restore is viable.") | ||
| } | ||
|
|
||
| if !conditionMeta.hasInPlaceRestoreCondition || conditionMeta.canInPlaceRestore != conditionMeta.currentInPlaceRestoreCondition { | ||
| conditionChanged = true | ||
| condition.Cond(v1.BackupConditionInPlaceRestore).SetStatusBool(backup, conditionMeta.canInPlaceRestore) | ||
| if conditionMeta.canInPlaceRestore { | ||
| condition.Cond(v1.BackupConditionInPlaceRestore).Message(backup, "In-place Restore appears viable.") | ||
| } else { | ||
| condition.Cond(v1.BackupConditionInPlaceRestore).Message(backup, "In-place Restore does not appear viable.") | ||
| } | ||
| } | ||
|
|
||
| // When the annotation is present and not changed | ||
| return conditionChanged | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not convinced the origin cluster metadata should be stored in the Status field.
I can see from the original CRD definition that the semantic difference between spec (the desired state of the object) and the status (what is the current state of the object) is a little bit muddied in this operator.
IMO, the origin cluster (and additional metadata) could be set in the Spec and be fully managed by the operator
In any case, the backup CRD's status should be the one surfacing whether or not a backup is viable for sure 👍