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 comprehensive CLI tool docs #23

Open
lucperkins opened this issue Nov 17, 2018 · 4 comments
Open

Add comprehensive CLI tool docs #23

lucperkins opened this issue Nov 17, 2018 · 4 comments

Comments

@lucperkins
Copy link
Contributor

At the moment, various CLI tools are mentioned in passing but not really documented. We should decide which tools require documentation and provide a simple YAML-based mechanism for generating those docs.

@mikebrow
Copy link
Member

I'd start with containerd (the daemon) and ctr (the containerd cli)
containerd: https://github.com/containerd/containerd/blob/master/docs/man/containerd.1.md
ctr: https://github.com/containerd/containerd/blob/master/docs/man/ctr.1.md

crictl also needs documenting but it's just for the kubernetes/cri use case. We have a crictl doc here: https://github.com/containerd/cri/blob/master/docs/crictl.md

@mikebrow
Copy link
Member

It's easy to generate toml from the configuration options as we already have something for that, but the command line options are all written up in golang to create urfave command line options and I don't know of a tool to generate yaml/md/toml from urfave yet. So we would probably have to refactor the code to get what you are asking for here. Or do a pr for this issue: urfave/cli#340

@lucperkins
Copy link
Contributor Author

@mikebrow If memory serves, I think that @estesp would prefer not to include ctr documentation in the https://containerd.io docs. Phil, let me know if I'm mistaken in that! Happy to include whatever.

As for urfave, it definitely would be nice to be able to generate YAML from that directly, but in the meantime I think that hand-written YAML could be a good medium-term solution.

@mikebrow
Copy link
Member

The issue says:

various CLI tools

As for:

@mikebrow If memory serves, I think that @estesp would prefer not to include ctr documentation in the https://containerd.io docs. Phil, let me know if I'm mistaken in that! Happy to include whatever.

that's a tough call..

ctr is used, may be necessary in certain debug/support situations and it is difficult to use it. Higher level tools that include containerd arguably should be documented elsewhere. Thus begging the question, if not ctr, which CLI tools should be documented here :-)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants