Repository navigation
runc: add page - #24950
runc: add page#24950kennedys0 wants to merge 1 commit into
Conversation
paoValle
left a comment
There was a problem hiding this comment.
Read against runc's man page: spec, create --bundle, start, list, state, kill and delete --force all match the CLI, the approach section is right, and pages/linux/ is the correct directory for a Linux-only tool. Two gaps before merge:
runc execis missing. Running a command inside a container that is already up is the operation people reach for afterrun, and the page otherwise only covers the create/start/delete lifecycle.- Every example assumes root. That is accurate for the common case, but rootless runc needs its own state directory (
runc --root {{path/to/state_dir}} run {{container_id}}); a note or one example would cover the case that sends people looking for this page in the first place.
runc pause/resume would also fit if you want a seventh example, but the two above are the ones I would not ship without.
|
@paoValle both points addressed in a2c130d:
Dropped the |
paoValle
left a comment
There was a problem hiding this comment.
Both points are in: runc exec sits right after start, and the rootless note names --root. tldr-lint and markdownlint are clean on the page, the link matches more-info-links.txt, and 8 examples is inside the limit.
One optional nit: it is the only page in the corpus with a {{placeholder}} inside a > Note: line — --root bare there, or the path moved into an example, would match every other note. Either way this looks good to me.
| > Run applications packaged according to the Open Container Initiative (OCI) format. | ||
| > Note: Rootless containers can store their state in a custom directory with `--root {{path/to/state_dir}}`. | ||
| > See also: `ctr`, `nerdctl`. | ||
| > More information: <https://manpages.debian.org/latest/runc/runc.8.html>. |
There was a problem hiding this comment.
| > More information: <https://manpages.debian.org/latest/runc/runc.8.html>. | |
| > More information: <https://manned.org/man/runc>. |
Checklist
common,linux,osx,windows,sunos,android, etc.Additional details: