-
Notifications
You must be signed in to change notification settings - Fork 14.5k
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
Add a mapping table from docker cli to crictl in crictl debugging doc #25109
Conversation
Deploy preview for kubernetes-io-master-staging ready! Built with commit aa88030 https://deploy-preview-25109--kubernetes-io-master-staging.netlify.app |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I like the idea of these tables @qiutongs
However, I have some thoughts / questions:
- could these tables actually live inside https://github.com/kubernetes-sigs/cri-tools/tree/master/docs instead?
- alternatively, could these tables live inside https://kubernetes.io/docs/reference/
- if keeping the doc on this site, please add captions to each table for improved accessibility.
- I would use code style for items such as
--disable-content-trust
this looks great, and is a nice location for the material. |
/lgtm |
LGTM label has been added. Git tree hash: 4f083c663ecbb7144844e3713489b9ff4170b439
|
/lgtm |
@sftim Hi Tim, thank you for the feedback.
|
Signed-off-by: Qiutong Song <[email protected]>
@SergeyKanzhelev Yes, I will add it. |
Signed-off-by: Qiutong Song <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
/approve
attach | attach | Attach to a running container | `--detach-keys`, `--sig-proxy` | ||
exec | exec | Run a command in a running container | `--privileged`, `--user`, `--detach-keys` | ||
images | images | List images | | ||
info | info | Display system-wide information | | ||
inspect | inspectinspecti | Return low-level information on a container, image or task | | ||
logs | logs | Fetch the logs of a container | `--details` | ||
ps | ps | List containers | | ||
stats | stats | Display a live stream of container(s) resource usage statistics | Column: NET/BLOCK I/O, PIDs | ||
version | version | Show the runtime (Docker, ContainerD, or others) version information | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Aside: the first two columns could go in backticks
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sure. Let me update.
exec | exec | Run a command in a running container | `--privileged`, `--user`, `--detach-keys` | ||
images | images | List images | | ||
info | info | Display system-wide information | | ||
inspect | inspectinspecti | Return low-level information on a container, image or task | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Oh actually, is inspectinspecti
a bug?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Oops, missed a separator. Let me fix
Signed-off-by: Qiutong Song <[email protected]>
/lgtm |
LGTM label has been added. Git tree hash: 0e5357f875c8795f2d4bdfd314b8cdd92e2fd700
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: sftim The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
Future code change spelunkers: this kind of table does usually have a better home in the reference section; however, in the interests of expediency I'm happy to see the PR merge as-is. |
Signed-off-by: Qiutong Song [email protected]
Add a mapping table from docker cli to crictl in crictl debugging doc. This table serves as a convenient reference when users want to use crictl. This is important especially if users are going to use ContainerD as the container runtime.