docs: add docs about verify pouch cri #493
Conversation
Codecov Report
@@ Coverage Diff @@
## master #493 +/- ##
=======================================
Coverage 19.12% 19.12%
=======================================
Files 34 34
Lines 1689 1689
=======================================
Hits 323 323
Misses 1331 1331
Partials 35 35Continue to review full report at Codecov.
|
|
LGTM |
pouchrobot
added
the
LGTM
docs/verify_cri.md
Outdated
| @@ -0,0 +1,100 @@ | |||
| # Verify pouch CRI by the cri-tools | |||
There was a problem hiding this comment.
Could you change the file name to be pouch_with_cri_verification.go to keep consistent?
And also change the head title of this file.
docs/verify_cri.md
Outdated
| @@ -0,0 +1,100 @@ | |||
| # Verify pouch CRI by the cri-tools | |||
|
|
|||
| [cri-tools](https://github.com/kubernetes-incubator/cri-tools) provides a CLI([crictl](https://github.com/kubernetes-incubator/cri-tools/blob/master/docs/crictl.md)) for CRI-compatible container runtimes. This is an easy way to verify pouch CRI without needing to set up Kubernetes components. | |||
There was a problem hiding this comment.
I think we had better use pouch CRI implementation rather than pouch CRI. As a result, the sentence could be This is an easy way to verify CRI implementation in pouch without setting up all Kubernetes components.
docs/verify_cri.md
Outdated
| - `logs`: Fetch the logs of a container | ||
| - `help`: Shows a list of commands or help for one command | ||
|
|
||
| ## Config runtime endpoint |
There was a problem hiding this comment.
Actually I cannot follow what does Config runtime endpoint mean. Could you explain more under this line about what this does and what is the necessity of doing this?
docs/verify_cri.md
Outdated
| ``` | ||
| ## Examples | ||
|
|
||
| ### Run sandbox with config file |
There was a problem hiding this comment.
As a verification case, we should provide successful case as the crictl runs sandbox-config.json command below. While I think we still need to provide some unsuccessful cases which show users what happens if CRI implementation misses something.
docs/verify_cri.md
Outdated
| ``` | ||
|
|
||
|
|
||
|
|
There was a problem hiding this comment.
Please remove these blank line please, but keep a wrap line at the end of this file.
docs/verify_cri.md
Outdated
| ### Pull image | ||
|
|
||
| ```bash | ||
| # crictl pull docker.io/library/redis:alpine |
There was a problem hiding this comment.
In bash format, # is the beigining of a command's comment? Could you change a form of this, maybe $ or some others?
liyanyanli
force-pushed
the
leo
branch
2 times, most recently
from
7e5d44b to
ab3d217
Compare
docs/pouch_with_cri_verification.md
Outdated
| If CRI implemention what features do not support or misses something | ||
| ``` | ||
| #crictl ps | ||
| FATA[0000] listing containers failed: rpc error: code = Unknown desc = ListContainers Not Implemented Yet |
docs/pouch_with_cri_verification.md
Outdated
| } | ||
| } | ||
|
|
||
| #crictl runs sandbox-config.json |
There was a problem hiding this comment.
Please add a white space between # and crictl.
docs/pouch_with_cri_verification.md
Outdated
|
|
||
| If CRI implemention what features do not support or misses something | ||
| ``` | ||
| #crictl ps |
There was a problem hiding this comment.
Please add a white space between # and crictl.
docs/pouch_with_cri_verification.md
Outdated
| ``` | ||
| ### unsuccessful cases | ||
|
|
||
| If CRI implemention what features do not support or misses something |
There was a problem hiding this comment.
If pouch has not fully or correctly implemented some interfaces in CRI, crictl command execution would fail:
|
LGTM, if some nits are fixed. |
Signed-off-by: yanli <[email protected]>
|
In the future, we will find a better folder place to locate cri-raleted docs. |
1.Describe what this PR did
This PR adds pouch cri validation details
2.Does this pull request fix one issue?
This is related to #474
3.Describe how you did it
NONE
4.Describe how to verify it
NONE
5.Special notes for reviews
NONE