[Feature][RayCluster]: Deprecate the RayCluster .Status.State field #2288
Conversation
The field is replaced by the new .Status.Conditions field. Signed-off-by: Rueian <[email protected]>
Signed-off-by: Rueian <[email protected]>
| @@ -1,3 +1,5 @@ | |||
| //nolint:SA1019 | |||
There was a problem hiding this comment.
Skip the deprecation usage lints.
Signed-off-by: Rueian <[email protected]>
| @@ -121,6 +121,8 @@ type RayClusterStatus struct { | |||
| // INSERT ADDITIONAL STATUS FIELD - define observed state of cluster | |||
| // Important: Run "make" to regenerate code after modifying this file | |||
| // Status reflects the status of the cluster | |||
| // | |||
| // Deprecated: the State field is replaced by the Conditions field. | |||
There was a problem hiding this comment.
Should we include the name of the conditions that replace the existing states here?
There was a problem hiding this comment.
Or will there be public docs on the new conditions? If so we can just link to that in a follow-up PR
There was a problem hiding this comment.
Yes, we plan to make a public doc to introduce the new conditions and changes to the .status.state in the following weeks.
|
Sorry for the delay. I am still working on the linter issue. |
Signed-off-by: Rueian <[email protected]>
|
@rueian would you mind opening an issue to track the progress of the deprecation timeline of this field? (ex: add a comment, update doc, use condition instead of state in KubeRay codebase, delete the field ... etc) |
Why are these changes needed?
In the progress of ray-project/enhancements#54, we have added the new
.Status.Conditionsfield to replace the single.Status.Stateand we are planning not to make further changes to the.Status.Stateanymore. So mark it deprecated to prevent future changes on the field.Related issue number
Checks