interface: experimental: status back-reporting #255
Conversation
This file contains hidden or 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
Signed-off-by: michaelawyu <[email protected]>
michaelawyu
changed the title
michaelawyu
changed the title
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
Signed-off-by: michaelawyu <[email protected]>
Signed-off-by: michaelawyu <[email protected]>
Signed-off-by: michaelawyu <[email protected]>
Comment on lines
1487
to
1531
| type ReportBackStrategyType string | ||
|
|
||
| const ( | ||
| // ReportBackStrategyTypeDisabled disables status back-reporting from the member clusters. | ||
| ReportBackStrategyTypeDisabled ReportBackStrategyType = "Disabled" | ||
|
|
||
| // ReportBackStrategyTypeMirror enables status back-reporting by | ||
| // copying the status fields verbatim to the corresponding objects on the hub cluster side. This is | ||
| // only performed when the placement object has a scheduling policy that selects exactly one | ||
| // member cluster (i.e., a pickFixed scheduling policy with exactly one cluster name, or | ||
| // a pickN scheduling policy with the numberOfClusters field set to 1). If multiple member clusters | ||
| // are selected, KubeFleet will fall back to the ReplicatePerCluster strategy, as described below. | ||
| ReportBackStrategyTypeMirror ReportBackStrategyType = "Mirror" | ||
|
|
||
| // ReportBackStrategyTypeReplicatePerCluster enables status back-reporting by copying | ||
| // the status fields verbatim via the Work API on the hub cluster side. Users may look up | ||
| // the status of a specific resource applied to a specific member cluster by inspecting the | ||
| // corresponding Work object on the hub cluster side. | ||
| ReportBackStrategyTypeReplicatePerCluster ReportBackStrategyType = "ReplicatePerCluster" | ||
| ) | ||
|
|
||
| // ReportBackStrategy describes how to report back the resource status from member clusters. | ||
| type ReportBackStrategy struct { | ||
| // Type dictates the type of the report back strategy to use. | ||
| // | ||
| // Available options include: | ||
| // | ||
| // * Disabled: status back-reporting is disabled. This is the default behavior. | ||
| // | ||
| // * Mirror: status back-reporting is enabled by copying the status fields verbatim to | ||
| // the corresponding objects on the hub cluster side. This is only performed when the placement | ||
| // object has a scheduling policy that selects exactly one member cluster (i.e., a pickFixed | ||
| // scheduling policy with exactly one cluster name, or a pickN scheduling policy with the | ||
| // numberOfClusters field set to 1). If multiple member clusters are selected, KubeFleet will | ||
| // fall back to the ReplicatePerCluster strategy. | ||
| // | ||
| // * ReplicatePerCluster: status back-reporting is enabled by copying the status fields verbatim via the Work API | ||
| // on the hub cluster side. Users may look up the status of a specific resource applied to a | ||
| // specific member cluster by inspecting the corresponding Work object on the hub cluster side. | ||
| // | ||
| // +kubebuilder:default=Disabled | ||
| // +kubebuilder:validation:Enum=Disabled;Mirror;ReplicatePerCluster | ||
| // +kubebuilder:validation:Required | ||
| Type ReportBackStrategyType `json:"type"` | ||
| } |
There was a problem hiding this comment.
can this be spread out in a different way
const (
// ReportBackStrategyTypeDisabled disables status back-reporting from the member clusters.
ReportBackStrategyTypeDisabled ReportBackType = "Disabled"
// will copy the status back
ReportBackStrategyTypeMirror ReportBackType = "Copy"
)
(
// Propagate to the original resource
ReportBackPropagateTypeOriginal ReportBackPropagateType = "Original"
// Propagate to work only
ReportBackPropagateTypeWork ReportBackPropagateType = "Work"
)
// ReportBackStrategy describes how to report back the resource status from member clusters.
type ReportBackStrategy struct {
// Type dictates the type of the report back type to use.
Type ReportBackType `json:"type"`
// Type dictates the type of the report back strategy to use.
Type ReportBackPropagateType `json:"type"`
}
There was a problem hiding this comment.
Yeah, that sounds great; let me make the edits
…o api/experimental-status-backport-support
Signed-off-by: michaelawyu <[email protected]>
Signed-off-by: michaelawyu <[email protected]>
Signed-off-by: michaelawyu <[email protected]>
| // the status of a specific resource applied to a specific member cluster by inspecting the corresponding Work object | ||
| // on the hub cluster side. This is the default behavior. | ||
| // | ||
| // +kubebuilder:validation:Enum=OriginalResource;WorkAPI |
There was a problem hiding this comment.
What's the default if user doesn't set it?
There was a problem hiding this comment.
Hi Ryan! I changed it to a pointer field so that when the Type is Disabled, the Destination part does not need to be set. We could add a CEL expression on the topper level to make sure that Destination cannot be empty when Type is Mirror -> would this be alright?
There was a problem hiding this comment.
Or we could use a default value here but then Destination would be set even if Type is Disabled -> it should be just an appearance thing though, the actual behavior would be fine as I understand
There was a problem hiding this comment.
Sure, let me add the CEL expression
Signed-off-by: michaelawyu <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description of your changes
This PR adds some experimental API changes that allow status back-reporting.
I have:
make reviewableto ensure this PR is ready for review.How has this code been tested
N/A
Special notes for your reviewer
N/A