engine: instructions on using alternative container runtimes #17517
Conversation
✅ Deploy Preview for docsdocker ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
dvdksn
force-pushed
the
engine/alternative-runtimes
branch
2 times, most recently
from
72c50f8
to
af937c4
Compare
|
/cc @utam0k |
dvdksn
force-pushed
the
engine/alternative-runtimes
branch
2 times, most recently
from
c489d76
to
5457f59
Compare
There was a problem hiding this comment.
Is there going to be a separate PR to update the engine reference docs?
engine/alternative-runtimes.md
Outdated
|
|
||
| ### Use containerd shims | ||
|
|
||
| Docker Engine supports the use of containerd runtime shims. |
There was a problem hiding this comment.
Technically, use of containerd runtime shims is mandatory. It's just that a few alternative runtimes support (or require) runC's containerd shim when used with containerd. Docker transparently handles this as an implementation detail when using a runtime registered with a path instead of a runtimeType. I don't think this necessarily needs to be fully explained in the user-facing documentation, though.
engine/alternative-runtimes.md
Outdated
| $ docker run --runtime io.containerd.kata.v2 hello-world | ||
| ``` | ||
|
|
||
| #### Configure shims |
There was a problem hiding this comment.
When runtimeType is io.containerd.runc.v1 or io.containerd.runc.v2, these are the available options. Though most users of the runC shim would be best served by letting the daemon configure the runC shim options automatically by configuring a runtime using "path" instead of "runtimeType" so it's probably better not to mention it here, and only document those options in reference documentation for advanced users, or not document it at all.
engine/alternative-runtimes.md
Outdated
|
|
||
| Examples of alternative container runtimes that you can use include: | ||
|
|
||
| - [youki](https://github.com/containers/youki){: target="blank" rel="noopener"} |
There was a problem hiding this comment.
It might also be worth mentioning crun since it's production-quality, unlike youki
I am very happy to have youki mentioned here. We are vendor-neutral. That's why it's hard for us to appeal. We are very happy to have this opportunity. |
dvdksn
force-pushed
the
engine/alternative-runtimes
branch
10 times, most recently
from
cce4a96
to
e8f4090
Compare
|
I've just pushed some changes to the dockerd reference page: docker/cli#4344 I've moved some bits from this PR there, as not to duplicate information. These changes deemphasize the legacy |
dvdksn
force-pushed
the
engine/alternative-runtimes
branch
2 times, most recently
from
334ea5c
to
73820ba
Compare
dvdksn
force-pushed
the
engine/alternative-runtimes
branch
4 times, most recently
from
c8eb6f6
to
135fc2d
Compare
|
@corhere I tried to add back some more context on the difference in configuring runc-compatible binaries and runtimes with their own shims: |
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
dvdksn
force-pushed
the
engine/alternative-runtimes
branch
from
135fc2d
to
15303cf
Compare
dvdksn
added
the
status/do-not-merge
|
holding the merge until cli reference has been merged and backported. |
Signed-off-by: David Karlsson 35727626+dvdksn@users.noreply.github.com
Proposed changes
This PR adds information about how to use alternative container runtimes with Docker Engine.
It includes both the legacy runtime configuration, and the new shimv2 option.
Related issues (optional)
Closes #17247