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

docs: manual of container labels and annotaions under cri #2672

Closed

Conversation

zhuangqh
Copy link
Contributor

Signed-off-by: zhuangqh zhuangqhc@gmail.com

Ⅰ. Describe what this PR did

  • add missing document for vm pass through config annotation
  • explain the container label rule under CRI implement

Ⅱ. Does this pull request fix one issue?

Ⅲ. Why don't you add test cases (unit test/integration test)? (你真的觉得不需要加测试吗?)

Ⅳ. Describe how to verify it

Ⅴ. Special notes for reviews

@codecov
Copy link

codecov bot commented Jan 16, 2019

Codecov Report

Merging #2672 into master will increase coverage by 0.04%.
The diff coverage is 0%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #2672      +/-   ##
==========================================
+ Coverage   69.34%   69.38%   +0.04%     
==========================================
  Files         278      278              
  Lines       17428    17428              
==========================================
+ Hits        12085    12093       +8     
+ Misses       3994     3989       -5     
+ Partials     1349     1346       -3
Flag Coverage Δ
#criv1alpha2_test 39.23% <0%> (ø) ⬆️
#integration_test_0 36.56% <0%> (ø) ⬆️
#integration_test_1 35.34% <0%> (ø) ⬆️
#integration_test_2 36.49% <0%> (-0.05%) ⬇️
#integration_test_3 35.4% <0%> (+0.02%) ⬆️
#node_e2e_test 35.02% <0%> (+0.02%) ⬆️
#unittest 28.78% <0%> (ø) ⬆️
Impacted Files Coverage Δ
cri/v1alpha2/cri.go 70.97% <0%> (+0.38%) ⬆️
daemon/logger/jsonfile/utils.go 71.54% <0%> (-1.63%) ⬇️
ctrd/client.go 69.72% <0%> (-1.63%) ⬇️
pkg/meta/store.go 67.44% <0%> (-1.56%) ⬇️
daemon/mgr/container_utils.go 82.38% <0%> (-1.14%) ⬇️
ctrd/container.go 54.64% <0%> (+0.37%) ⬆️
daemon/mgr/container.go 60.04% <0%> (+0.63%) ⬆️
cri/ocicni/cni_manager.go 70.58% <0%> (+11.76%) ⬆️

* [Make runtime choosing supported](#make-runtime-choosing-supported "Make runtime choosing supported")
* [Make lxcfs configurable supported](#make-lxcfs-configurable-supported "Make lxcfs configurable supported")
* [Pull Request](#pull-request "Pull Request")
* [Runtime choosing](#runtime-choosing "Runtime choosing")
Copy link
Collaborator

Choose a reason for hiding this comment

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

Can we use RuntimeClass in Kubernetes to support runv/Kata which is described in #2314? @starnop @zhuangqh

Copy link
Contributor Author

Choose a reason for hiding this comment

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

We use annotations to support runtime choosing for legacy kubernetes. RuntimeHandler of kubernetes 1.12 is also supported

Copy link
Collaborator

@allencloud allencloud Mar 14, 2019

Choose a reason for hiding this comment

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

If that, I think we should add detailed instructions in this document.

< 1.12, suggest using annotation;
>= 1.12, use runtime class

In addition, we should have a plan whether to deprecate the annotation for future.

Signed-off-by: zhuangqh <zhuangqhc@gmail.com>
@CLAassistant
Copy link

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

@cardyok cardyok requested a review from cxz66666 July 7, 2022 12:16

NOTES: The way to specify runtime using **KubernetesRuntime annotation is Deprecated**. It is recommended to use [RuntimeClass](https://v1-12.docs.kubernetes.io/docs/concepts/containers/runtime-class) which is an alpha feature for selecting the container runtime configuration to use to run a pod’s containers.
NOTES: **Specify runtimes using `io.kubernetes.runtime` annotation is Deprecated**. It is recommended to use [RuntimeClass](https://v1-12.docs.kubernetes.io/docs/concepts/containers/runtime-class) which is an alpha feature for selecting the container runtime configuration to use to run a pod’s containers.
Copy link
Collaborator

Choose a reason for hiding this comment

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

RuntimeClass is a stable feature and the url is deprecated, could you help to fix them? Also there have a merge conflict, thanks to rebase it!

* [Pull Request](#pull-request "Pull Request")
* [Runtime choosing](#runtime-choosing "Runtime choosing")
* [LXCFS switcher](#lxcfs-switcher "LXCFS switcher")
* [VM passthrough config](#vm-passthrough "VM passthrough config")
Copy link
Collaborator

Choose a reason for hiding this comment

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

Maybe we need set correctly markdown anchor point here and follows, e.g. VM passthrough config (#vm-passthrough-config "VM passthrough config") 👍

Copy link
Collaborator

@cxz66666 cxz66666 left a comment

Choose a reason for hiding this comment

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

Hope you can fix these questions

@cxz66666
Copy link
Collaborator

Thank you for your contribution! because you don't response for a long time, I will close this PR and reopen another one. ❤️

@cxz66666 cxz66666 closed this Jul 18, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants