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

Add a mapping table from docker cli to crictl in crictl debugging doc #25109

Merged
merged 3 commits into from
Dec 8, 2020

Conversation

qiutongs
Copy link
Contributor

Signed-off-by: Qiutong Song songqt01@gmail.com

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.

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Nov 19, 2020
@k8s-ci-robot k8s-ci-robot added language/en Issues or PRs related to English language size/M Denotes a PR that changes 30-99 lines, ignoring generated files. sig/docs Categorizes an issue or PR as relevant to SIG Docs. labels Nov 19, 2020
@netlify
Copy link

netlify bot commented Nov 19, 2020

Deploy preview for kubernetes-io-master-staging ready!

Built with commit aa88030

https://deploy-preview-25109--kubernetes-io-master-staging.netlify.app

Copy link
Contributor

@sftim sftim left a 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:

  1. could these tables actually live inside https://github.com/kubernetes-sigs/cri-tools/tree/master/docs instead?
  2. alternatively, could these tables live inside https://kubernetes.io/docs/reference/
  3. if keeping the doc on this site, please add captions to each table for improved accessibility.
  4. I would use code style for items such as --disable-content-trust

@derekwaynecarr
Copy link
Member

this looks great, and is a nice location for the material.

@derekwaynecarr
Copy link
Member

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Dec 3, 2020
@k8s-ci-robot
Copy link
Contributor

LGTM label has been added.

Git tree hash: 4f083c663ecbb7144844e3713489b9ff4170b439

@SergeyKanzhelev
Copy link
Member

@qiutongs
Copy link
Contributor Author

qiutongs commented Dec 8, 2020

I like the idea of these tables @qiutongs

However, I have some thoughts / questions:

  1. could these tables actually live inside https://github.com/kubernetes-sigs/cri-tools/tree/master/docs instead?
  2. alternatively, could these tables live inside https://kubernetes.io/docs/reference/
  3. if keeping the doc on this site, please add captions to each table for improved accessibility.
  4. I would use code style for items such as --disable-content-trust

@sftim Hi Tim, thank you for the feedback.

Signed-off-by: Qiutong Song <songqt01@gmail.com>
@qiutongs
Copy link
Contributor Author

qiutongs commented Dec 8, 2020

/lgtm
@qiutongs can you please link to this cheat sheet from the deprecation FAQ here: https://kubernetes.io/blog/2020/12/02/dockershim-faq/#what-should-i-look-out-for-when-changing-cri-implementations:~:text=For%20the%20former%2C%20you%20can%20use%20the%20crictl%20tool%20as%20a%20drop%2Din%20replacement and address the styling and accessibility comments from @sftim

@SergeyKanzhelev Yes, I will add it.

Signed-off-by: Qiutong Song <songqt01@gmail.com>
@k8s-ci-robot k8s-ci-robot added area/blog Issues or PRs related to the Kubernetes Blog subproject and removed lgtm "Looks good to me", indicates that a PR is ready to be merged. labels Dec 8, 2020
@qiutongs qiutongs requested a review from sftim December 8, 2020 20:55
Copy link
Contributor

@sftim sftim left a comment

Choose a reason for hiding this comment

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

/approve

Comment on lines 370 to 378
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 |  
Copy link
Contributor

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

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sure. Let me update.

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Dec 8, 2020
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 |  
Copy link
Contributor

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?

Copy link
Contributor Author

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 <songqt01@gmail.com>
@sftim
Copy link
Contributor

sftim commented Dec 8, 2020

/lgtm
/sig node
/approve

@k8s-ci-robot k8s-ci-robot added the sig/node Categorizes an issue or PR as relevant to SIG Node. label Dec 8, 2020
@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Dec 8, 2020
@k8s-ci-robot
Copy link
Contributor

LGTM label has been added.

Git tree hash: 0e5357f875c8795f2d4bdfd314b8cdd92e2fd700

@k8s-ci-robot
Copy link
Contributor

[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 /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot merged commit 620ba6d into kubernetes:master Dec 8, 2020
@sftim
Copy link
Contributor

sftim commented Dec 8, 2020

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. area/blog Issues or PRs related to the Kubernetes Blog subproject cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. language/en Issues or PRs related to English language lgtm "Looks good to me", indicates that a PR is ready to be merged. sig/docs Categorizes an issue or PR as relevant to SIG Docs. sig/node Categorizes an issue or PR as relevant to SIG Node. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants