-
Notifications
You must be signed in to change notification settings - Fork 5.3k
Add Beta and Internal metric stability levels, update deprecation timelines #8708
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
base: master
Are you sure you want to change the base?
Conversation
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: richabanker The full list of commands accepted by this bot can be found here. The pull request process is described here DetailsNeeds approval from an approver in each of these files:
Approvers can indicate their approval by writing |
| Name: "some_beta_metric", | ||
| Help: "some description", | ||
| StabilityLevel: kubemetrics.BETA, | ||
| DeprecatedVersion: "1.15", // this is a custom metadata field |
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 don't think we want to include DeprecatedVersion in the beta example?
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.
We do have it in the STABLE example too below, I guess its to emphasize that a metric can be deprecated irrespective of its level but there's a deprecation policy that will be followed based on the stability level of the metric to ensure the more stable metrics are not deleted suddenly without enough prior notice.
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 would create a separate section for deprecation independent to stages.
|
|
||
| By the beta stability contract, we mean: | ||
|
|
||
| 1. the metric will not be deleted without graduating to stable first or being deprecated |
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.
Maybe include the number of releases it needs to be deprecated for?
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.
Done
| ```` | ||
|
|
||
| __Deprecated__ metrics will have their description text prefixed with a deprecation notice string '(Deprecated from x.y)' and a warning log will be emitted during metric registration (in the spirit of the official [Kubernetes deprecation policy](https://kubernetes.io/docs/reference/using-api/deprecation-policy/#deprecating-a-flag-or-cli)). | ||
| __Deprecated__ metrics will have their description text prefixed with a deprecation notice string '(Deprecated since x.y.z)' and a warning log will be emitted during metric registration (in the spirit of the official [Kubernetes deprecation policy](https://kubernetes.io/docs/reference/using-api/deprecation-policy/#deprecating-a-flag-or-cli)). |
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.
the deprecation version normally only has a major and minor version
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.
Done
95da98c to
c5c4403
Compare
|
Apologies for the late follow up here. |
|
Not blocking, but I would suggest extending the documentation (for both contributors and users) to explicitly describe the expectations for metric quality, usefulness, and production experience at each level. Similar to the Kubernetes feature lifecycle, metric levels like Alpha, Beta, and GA should reflect whether a metric has been validated in a real-world production environment. For me that would be:
|
…elines Co-authored-by: David Ashpole <[email protected]>
c5c4403 to
addcb4b
Compare
I think thats a great addition. Included your suggestion in description for each level. Thanks!! |
|
Any more suggestions / comments / concerns for this? |
Which issue(s) this PR fixes:
Issue #kubernetes/kubernetes#133429