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
[release/1.6] deprecation: new package for deprecations #9329
Merged
samuelkarp
merged 8 commits into
containerd:release/1.6
from
samuelkarp:deprecation-warning-1.6
Nov 9, 2023
Merged
[release/1.6] deprecation: new package for deprecations #9329
samuelkarp
merged 8 commits into
containerd:release/1.6
from
samuelkarp:deprecation-warning-1.6
Nov 9, 2023
Conversation
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
samuelkarp
force-pushed
the
deprecation-warning-1.6
branch
from
November 3, 2023 06:51
26b485c
to
f6c9b03
Compare
Opened #9334 for the flake |
This package enumerates the known deprecations in the current version of containerd. New deprecations should be added here, and old ones removed. Signed-off-by: Samuel Karp <samuelkarp@google.com> (cherry picked from commit aff5b80) Signed-off-by: Samuel Karp <samuelkarp@google.com>
Signed-off-by: Samuel Karp <samuelkarp@google.com> (cherry picked from commit 240733c) Signed-off-by: Samuel Karp <samuelkarp@google.com>
The Server rpc in introspection service is extended to expose deprecation warnings based on observed feature use in containerd. Signed-off-by: Samuel Karp <samuelkarp@google.com> (cherry picked from commit 57c897f) Signed-off-by: Samuel Karp <samuelkarp@google.com>
Deprecation warnings are retrieved from the warning service and returned via the Server RPC. Signed-off-by: Samuel Karp <samuelkarp@google.com> (cherry picked from commit 9aab446) Signed-off-by: Samuel Karp <samuelkarp@google.com>
Signed-off-by: Samuel Karp <samuelkarp@google.com> (cherry picked from commit bc861b6) Signed-off-by: Samuel Karp <samuelkarp@google.com>
Signed-off-by: Samuel Karp <samuelkarp@google.com> (cherry picked from commit 260e71a) Signed-off-by: Samuel Karp <samuelkarp@google.com>
Signed-off-by: Samuel Karp <samuelkarp@google.com> (cherry picked from commit 079383d) Signed-off-by: Samuel Karp <samuelkarp@google.com>
Signed-off-by: Samuel Karp <samuelkarp@google.com> (cherry picked from commit 3fff8b4) Signed-off-by: Samuel Karp <samuelkarp@google.com>
samuelkarp
force-pushed
the
deprecation-warning-1.6
branch
from
November 4, 2023 05:35
f6c9b03
to
477b7d6
Compare
ruiwen-zhao
approved these changes
Nov 8, 2023
/retest |
kzys
approved these changes
Nov 9, 2023
1 task
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.
This series of commits adds support for recording and querying deprecated feature usage. We currently document our deprecations in the RELEASES.md file and have some warnings emitted into the log, but determining whether any of those features are in use requires understanding the config and call patterns of clients and/or log scanning. A service that records deprecated feature usage will make it possible to surface warnings to administrators who may not be the regular end-user of containerd (such as a Kubernetes cluster admin).
This was implemented for containerd 2.0, but since the goal is helping with significant deprecations for 2.0 I am backporting to 1.6 (1.7 is already done), adding warnings as necessary.
The series as-is adds the basic infrastructure and warnings for 1 current deprecation that exists in
release/1.7
and one that exists inmain
:main
soon)Subsequent PRs will cover the other deprecations tracked in #9312.
The implementation is as follows:
warning
service has been implemented which plugins can call to emit deprecation warnings.Server
RPC now returns deprecation warnings, retrieved from thewarning
service.Server
RPC response by the number of deprecations and bounds the memory usage of thewarning
service.ctr deprecations list
can be used to query recorded warnings and output either for human consumption or in jsonSample output:
It may be easiest to review this PR commit-by-commit, as the overall size is somewhat large but each individual commit is scoped to a single piece.