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.

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

CRI API reference at Container Runtime page is stale #48257

Open
SergeyKanzhelev opened this issue Oct 8, 2024 · 8 comments · May be fixed by #48398
Open

CRI API reference at Container Runtime page is stale #48257

SergeyKanzhelev opened this issue Oct 8, 2024 · 8 comments · May be fixed by #48398
Assignees
@thisisharrsh
Labels
help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. kind/bug Categorizes issue or PR as related to a bug. priority/important-longterm Important over the long term, but may not be staffed and/or may need multiple releases to complete. sig/node Categorizes an issue or PR as relevant to SIG Node. triage/accepted Indicates an issue or PR is ready to be actively worked on.

Comments

@SergeyKanzhelev
Copy link
Member

SergeyKanzhelev commented Oct 8, 2024 •
edited
Loading

This is a Bug Report

/sig node
/kind bug
/priority important-soon
/help

Problem:
This page https://kubernetes.io/docs/setup/production-environment/container-runtimes/#cri-versions suggests that v1alpha2 is still supported. However it was not a case for a few versions now.

Also this page https://kubernetes.io/docs/concepts/architecture/cri/ links the quite old CRI API proto page. Simply pointing on master branch should be better unless we want to keep bumping the link for each release.

Proposed Solution:

Page to Update:
@SergeyKanzhelev SergeyKanzhelev added the kind/bug Categorizes issue or PR as related to a bug. label Oct 8, 2024
@k8s-ci-robot
Copy link
Contributor

@SergeyKanzhelev:
This request has been marked as needing help from a contributor.

Guidelines

Please ensure that the issue body includes answers to the following questions:

  • Why are we solving this issue?
  • To address this issue, are there any code changes? If there are code changes, what needs to be done in the code and what places can the assignee treat as reference points?
  • Does this issue have zero to low barrier of entry?
  • How can the assignee reach out to you for help?

For more details on the requirements of such an issue, please see here and ensure that they are met.

If this request no longer meets these requirements, the label can be removed
by commenting with the /remove-help command.

In response to this:

This is a Bug Report

/sig node
/kind bug
/priority important-soon
/help

Problem:

Proposed Solution:

Page to Update:
https://kubernetes.io/...

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-sigs/prow repository.

@k8s-ci-robot k8s-ci-robot added sig/node Categorizes an issue or PR as relevant to SIG Node. help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. priority/important-soon Must be staffed and worked on either currently, or very soon, ideally in time for the next release. labels Oct 8, 2024
@k8s-ci-robot k8s-ci-robot added the needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. label Oct 8, 2024
@tengqm
Copy link
Contributor

tengqm commented Oct 9, 2024

/triage accepted

@k8s-ci-robot k8s-ci-robot added triage/accepted Indicates an issue or PR is ready to be actively worked on. and removed needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels Oct 9, 2024
@SergeyKanzhelev SergeyKanzhelev moved this from Triage to Triaged in SIG Node Bugs Oct 9, 2024
@ayushpatil2122 ayushpatil2122 removed their assignment Oct 9, 2024
@thisisharrsh
Copy link
Contributor

I would like to work on this issue.

@thisisharrsh
Copy link
Contributor

/assign

@thisisharrsh
Copy link
Contributor

We need to correct both statements here, as they are misleading. They suggest that users can rely on v1alpha2, which is incorrect because v1alpha2 has been deprecated and should not be used as a fallback.

website/content/en/docs/setup/production-environment/container-runtimes.md

Lines 172 to 179 in 92fad83

## CRI version support {#cri-versions}
Your container runtime must support at least v1alpha2 of the container runtime interface.
Kubernetes [starting v1.26](/blog/2022/11/18/upcoming-changes-in-kubernetes-1-26/#cri-api-removal)
_only works_ with v1 of the CRI API. Earlier versions default
to v1 version, however if a container runtime does not support the v1 API, the kubelet falls back to
using the (deprecated) v1alpha2 API instead.

@sftim
Copy link
Contributor

sftim commented Oct 10, 2024

This is important, but:
/remove-priority important-soon
/priority important-longterm

The issues at https://github.com/kubernetes/website/issues?q=is%3Aissue+is%3Aopen+label%3Apriority%2Fimportant-soon are the ones we really want to focus on.

@k8s-ci-robot k8s-ci-robot added priority/important-longterm Important over the long term, but may not be staffed and/or may need multiple releases to complete. and removed priority/important-soon Must be staffed and worked on either currently, or very soon, ideally in time for the next release. labels Oct 10, 2024
@SergeyKanzhelev
Copy link
Member Author

sorry, didn't mean to hijack your prioritization. I was mostly thought from severity perspective as the info we give is incorrect for a few releases already.

@thisisharrsh thisisharrsh linked a pull request Oct 17, 2024 that will close this issue
Open
@thisisharrsh
Copy link
Contributor

The issue is fixed here: #48398

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@thisisharrsh thisisharrsh

Labels
help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. kind/bug Categorizes issue or PR as related to a bug. priority/important-longterm Important over the long term, but may not be staffed and/or may need multiple releases to complete. sig/node Categorizes an issue or PR as relevant to SIG Node. triage/accepted Indicates an issue or PR is ready to be actively worked on.
Projects
SIG Node Bugs
Status: Triaged
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

fixed the container runtime documentation thisisharrsh/website
6 participants
@tengqm @SergeyKanzhelev @k8s-ci-robot @sftim @thisisharrsh @ayushpatil2122