Add docs for CRI validation test suites #725
Conversation
k8s-ci-robot
added
the
cncf-cla: yes
|
/cc @Random-Liu @mrunalp @kubernetes/sig-node-pr-reviews |
contributors/devel/cri-validation.md
Outdated
| @@ -0,0 +1,50 @@ | |||
| # CRI Validation Testing | |||
|
|
|||
| CRI validation testing provides a serial of common validation test suites for Kubelet CRI (_Container Runtime Interface_). | |||
There was a problem hiding this comment.
@mrunalp Thanks. Fixed.
contributors/devel/cri-validation.md
Outdated
| @@ -0,0 +1,50 @@ | |||
| # CRI Validation Testing | |||
There was a problem hiding this comment.
Spell out the full name at the title:
Container Runtime Interface (CRI)
contributors/devel/cri-validation.md
Outdated
| @@ -0,0 +1,50 @@ | |||
| # CRI Validation Testing | |||
|
|
|||
| CRI validation testing provides a series of common validation test suites for Kubelet CRI (_Container Runtime Interface_). | |||
There was a problem hiding this comment.
"provides a test framework and a suite of tests to validate that the Container Runtime Interface (CRI) server implementation meets all the requirements. This allows the CRI runtime developers to verify that their runtime conforms to CRI, without needing to set up Kubernetes components or run Kubernetes end-to-end tests."
contributors/devel/cri-validation.md
Outdated
|
|
||
| CRI validation testing provides a series of common validation test suites for Kubelet CRI (_Container Runtime Interface_). | ||
|
|
||
| It helps container runtime maintainers to validate their runtime when integrating with kubelet CRI. |
contributors/devel/cri-validation.md
Outdated
|
|
||
| It helps container runtime maintainers to validate their runtime when integrating with kubelet CRI. | ||
|
|
||
| *Note: No kubelet is running. The test suites run directly targeting the shim of container runtime.* |
There was a problem hiding this comment.
Remove. I think this will be covered by the paragraph in my comment.
contributors/devel/cri-validation.md
Outdated
|
|
||
| *Note: No kubelet is running. The test suites run directly targeting the shim of container runtime.* | ||
|
|
||
| *Note: CRI validation testing is alpha and maintained at [cri-tools](https://github.com/kubernetes-incubator/cri-tools) repo.* |
There was a problem hiding this comment.
Remove *Note
Suggestion:
"CRI validation testing is currently Alpha and is hosted at the cri-tools repository. We encourage the CRI developers to report bugs or help extend the test coverage by adding more tests."
Please modify it according to your knowledge on the current test coverage and the limitation of the test suite.
There was a problem hiding this comment.
Maybe mention that performance benchmarking will be added in the future?
contributors/devel/cri-validation.md
Outdated
|
|
||
| ## Install | ||
|
|
||
| The test suites could be installed easily via `go get` command: |
contributors/devel/cri-validation.md
Outdated
|
|
||
| ## Running tests | ||
|
|
||
| Before running the tests, ensure the shim of CRI container runtime is running and kubelet is stopped. |
There was a problem hiding this comment.
Suggestion:
"
Prerequisite
Before running the test, you need to ensure that the CRI server under test is running and listening on a Unix
socket. Because the validation tests are designed to request changes (e.g., create/delete) to the containers and verify that correct status is reported, it expects to be the only user of the CRI server. Please make sure that 1) there are no existing CRI-managed containers running on the node, and 2) no other processes (e.g., Kubelet) will interfere with the tests.
"
|
@yujuhong Thanks. Addressed comments, PTAL. |
yujuhong
added
lgtm
|
@feiskyer the content LGTM, but I just noticed that this is in the community repository. Shouldn't we move the doc to cri-tools instead? |
contributors/devel/cri-validation.md
Outdated
|
|
||
| CRI validation testing provides a test framework and a suite of tests to validate that the Container Runtime Interface (CRI) server implementation meets all the requirements. This allows the CRI runtime developers to verify that their runtime conforms to CRI, without needing to set up Kubernetes components or run Kubernetes end-to-end tests. | ||
|
|
||
| CRI validation testing is currently Alpha and is hosted at the [cri-tools](https://github.com/kubernetes-incubator/cri-tools) repository. And performance benchmarking will be added in the future. We encourage the CRI developers to report bugs or help extend the test coverage by adding more tests. |
There was a problem hiding this comment.
Remove "And": "...repository. Performance benchmarking..."
contributors/devel/cri-validation.md
Outdated
| go get github.com/kubernetes-incubator/cri-tools/cmd/critest | ||
| ``` | ||
|
|
||
| Then `critest` binary could be found in `$GOPATH/bin`. |
contributors/devel/cri-validation.md
Outdated
|
|
||
| ### Prerequisite | ||
|
|
||
| Before running the test, you need to ensure that the CRI server under test is running and listening on a Unix socket. Because the validation tests are designed to request changes (e.g., create/delete) to the containers and verify that correct status is reported, it expects to be the only user of the CRI server. Please make sure that 1) there are no existing CRI-managed containers running on the node, and 2) no other processes (e.g., Kubelet) will interfere with the tests. |
There was a problem hiding this comment.
Are you referring to a specific test when you say, "...ensure that the CRI server under test is running and listening..."? If so, you might want to italicize it.
contributors/devel/cri-validation.md
Outdated
| - Run the tests using `ginkgo` | ||
| - Output the test results to STDOUT | ||
|
|
||
| critest connects to `/var/run/dockershim.sock` by default. For other runtimes, the endpoint could be set in two ways: |
Signed-off-by: Pengfei Ni <feiskyer@gmail.com>
A doc in community repository could help for a wide scope. We will also add more detailed docs in cri-tools repository. |
Reference features: kubernetes/enhancements#292.