Skip to content
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.

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

[Doc] Deprecate ServiceUnhealthySecondThreshold and DeploymentUnhealthySecondThreshold #1685

Open
rueian opened this issue Nov 23, 2023 · 0 comments
Assignees
Labels
docs Improvements or additions to documentation

Comments

@rueian
Copy link
Contributor

rueian commented Nov 23, 2023

As per #1664 and #1665, the latest kuberay operator will not respect DeploymentUnhealthySecondThreshold and ServiceUnhealthySecondThreshold fields at all.

Ideally, we should inform users that these fields are deprecated, and we thought that the kubebuilder could do this for us by using the +kubebuilder:deprecatedversion marker. However, it turns out that this marker doesn't work for us because it only works at the CRD root level, and no similar marker works at the field level.

Here, in this issue, I'd like to discuss alternatives to kubebuilder code generation:

  1. Deprecate these fields in our go source code.
  2. Deprecate or hide these fields in the generated document.
  3. Emit warning messages as kubernetes event when these fields are set by users.
  4. Use validation webhook to return warnings. This will introduce new complexity for installing and maintaining the webhook.

I believe the first option is trivial, and the second option is a must.

How about the third and the fourth? Are they good to have?

cc @kevin85421

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants