Skip to content

[release/1.7] Add cri-api v1alpha2 usage warning to all api calls #9479

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.

Sign up for GitHub

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

Jump to bottom
Merged
dmcgowan merged 1 commit into from
Dec 6, 2023
Merged

[release/1.7] Add cri-api v1alpha2 usage warning to all api calls #9479

dmcgowan merged 1 commit into from
Dec 6, 2023

Conversation

@ruiwen-zhao
Copy link
Member

@ruiwen-zhao ruiwen-zhao commented Dec 6, 2023

Previous #9336 added warnings for the usage of cri-api Status and Version.

There are some use cases where clients might use cri-apis without calling those two apis. For example,

  1. client uses crictl to pre-pull container images,
  2. client uses ContainerStatus to find the container for a certain pid for monitoring purposes.

Therefore, this PR adds warning to all cri-api v1alpha2 apis.

@ruiwen-zhao
Add cri-api v1alpha2 usage warning to all api calls
dc45bc8 
Signed-off-by: ruiwen-zhao <ruiwen@google.com>
@samuelkarp samuelkarp added the area/cri Container Runtime Interface (CRI) label Dec 6, 2023
@samuelkarp samuelkarp changed the title Add cri-api v1alpha2 usage warning to all api calls [release/1.7] Add cri-api v1alpha2 usage warning to all api calls Dec 6, 2023
SergeyKanzhelev
SergeyKanzhelev reviewed Dec 6, 2023
View reviewed changes
pkg/cri/instrument/instrumented_service.go
// emitUsageWarning emits a warning when v1alpha2 cri-api is called.
func (in *instrumentedAlphaService) emitUsageWarning(ctx context.Context) {
// Only emit the warning the first time an v1alpha2 api is called
in.emitWarning.Do(func() {
Copy link
Contributor

@SergeyKanzhelev SergeyKanzhelev Dec 6, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this LGTM. I don't know how big this problem will be for the end user - it may be interesting to log the specific call that was called. This way customers received this warning may understand who called it

@dmcgowan dmcgowan merged commit 8e06899 into containerd:release/1.7 Dec 6, 2023
@samuelkarp
Copy link
Member

samuelkarp commented Dec 6, 2023

/cherrypick release/1.6

@k8s-infra-cherrypick-robot
Copy link

k8s-infra-cherrypick-robot commented Dec 6, 2023

@samuelkarp: #9479 failed to apply on top of branch "release/1.6":

Applying: Add cri-api v1alpha2 usage warning to all api calls
Using index info to reconstruct a base tree...
A	pkg/cri/instrument/instrumented_service.go
Falling back to patching base and 3-way merge...
Auto-merging pkg/cri/server/instrumented_service.go
CONFLICT (content): Merge conflict in pkg/cri/server/instrumented_service.go
error: Failed to merge in the changes.
hint: Use 'git am --show-current-patch=diff' to see the failed patch
Patch failed at 0001 Add cri-api v1alpha2 usage warning to all api calls
When you have resolved this problem, run "git am --continue".
If you prefer to skip this patch, run "git am --skip" instead.
To restore the original branch and stop patching, run "git am --abort".
Details

In response to this:

/cherrypick release/1.6

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@ruiwen-zhao ruiwen-zhao mentioned this pull request Dec 7, 2023
Merged
@samuelkarp samuelkarp added cherry-picked/1.6.x PR commits are cherry-picked into release/1.6 branch and removed cherry-pick/1.6.x labels Dec 7, 2023
@dmcgowan dmcgowan mentioned this pull request Dec 7, 2023
Merged
@mfahlandt mfahlandt mentioned this pull request Dec 12, 2023
Closed
9 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@dmcgowan dmcgowan dmcgowan approved these changes

@samuelkarp samuelkarp samuelkarp approved these changes

+1 more reviewer

@SergeyKanzhelev SergeyKanzhelev SergeyKanzhelev approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

area/cri Container Runtime Interface (CRI) cherry-picked/1.6.x PR commits are cherry-picked into release/1.6 branch size/M

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

6 participants

@ruiwen-zhao @samuelkarp @k8s-infra-cherrypick-robot @dmcgowan @SergeyKanzhelev @k8s-ci-robot