docs: add doc about cri-annotation-support

[starnop]

Signed-off-by: Starnop [email protected]

Ⅰ. Describe what this PR did

Currently, PouchContainer has lots of advantages over other container runtimes. Kubernetes has a hiden way to support this: make user-defined parameters in annotations field in pod's definition.

When CRI manager deals the annotation details, it could pass these parameters to container manager, and container manager definitely implement these features very well.

Now we have supported some fields, such as :

• Make runtime choosing supported
• Make lxcfs configurable supported

So a detailed documentation is needed to cover the annotations supported.

Ⅱ. Does this pull request fix one issue?

None.

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

None.

Ⅳ. Describe how to verify it

Ⅴ. Special notes for reviews

[allencloud]

Please check the CI failure:

./docs/kubernetes/pouch_cri_annotation_support.md:5: MD007 Unordered list indentation
./docs/kubernetes/pouch_cri_annotation_support.md:1: MD009 Trailing spaces
./docs/kubernetes/pouch_cri_annotation_support.md:2: MD009 Trailing spaces
./docs/kubernetes/pouch_cri_annotation_support.md:3: MD009 Trailing spaces
./docs/kubernetes/pouch_cri_annotation_support.md:4: MD009 Trailing spaces
./docs/kubernetes/pouch_cri_annotation_support.md:5: MD009 Trailing spaces
./docs/kubernetes/pouch_cri_annotation_support.md:6: MD009 Trailing spaces
./docs/kubernetes/pouch_cri_annotation_support.md:7: MD009 Trailing spaces
./docs/kubernetes/pouch_cri_annotation_support.md:8: MD009 Trailing spaces
./docs/kubernetes/pouch_cri_annotation_support.md:9: MD009 Trailing spaces
......

For more details, you should check https://github.com/markdownlint/markdownlint/blob/master/docs/RULES.md @starnop

[codecov-io]

Codecov Report

Merging #2216 into master will increase coverage by 0.05%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master    #2216      +/-   ##
==========================================
+ Coverage   66.56%   66.62%   +0.05%     
==========================================
  Files         208      208              
  Lines       16756    16756              
==========================================
+ Hits        11153    11163      +10     
+ Misses       4276     4274       -2     
+ Partials     1327     1319       -8

Flag	Coverage Δ
#criv1alpha1test	32.97% <ø> (+0.02%)	⬆️
#criv1alpha2test	33.61% <ø> (+0.14%)	⬆️
#integrationtest	39.93% <ø> (+0.01%)	⬆️
#nodee2etest	33.77% <ø> (+0.08%)	⬆️
#unittest	23.85% <ø> (ø)	⬆️

Impacted Files	Coverage Δ
daemon/mgr/snapshot.go	89.85% <0%> (-4.35%)	⬇️
daemon/containerio/cri_log_file.go	84.31% <0%> (-3.93%)	⬇️
daemon/logger/jsonfile/utils.go	71.54% <0%> (-1.63%)	⬇️
daemon/containerio/container_io.go	74.58% <0%> (-1.11%)	⬇️
daemon/mgr/container.go	57.59% <0%> (-0.21%)	⬇️
ctrd/container.go	60.23% <0%> (+0.47%)	⬆️
cri/v1alpha2/cri.go	72.52% <0%> (+0.63%)	⬆️
daemon/mgr/container_utils.go	84.33% <0%> (+1.2%)	⬆️
daemon/mgr/spec_linux.go	75.97% <0%> (+1.5%)	⬆️
pkg/meta/store.go	64.06% <0%> (+1.56%)	⬆️
... and 1 more

[allencloud]

In this part, you said to support runtime choosing. Thus, this line is incorrect. This is about lxcfs.

[allencloud]

If this is about runtime choosing, I suggest to delete other unrelated parts in yml file. Only covered what we wish, and that is enough.

[allencloud]

you can specify the yml file's name to pouch-runtime.yml to make it more clear.
Or use pouch-lxcfs.yml to classify.

[allencloud]

Please add more validation details to help user know whether it is successful. More specific, please. Thanks a lot.

[allencloud]

pouch-lxcfs.yml?

[allencloud]

More details to be specific if you see what, it means success.

[CLAassistant]

All committers have signed the CLA.

[allencloud]

CI fails with ci/circleci: markdownlint-misspell-shellcheck . @starnop

[allencloud]

LGTM