-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
daemon: support other containerd runtimes (MVP)
Contrary to popular belief, the OCI Runtime specification does not
specify the command-line API for runtimes. Looking at containerd's
architecture from the lens of the OCI Runtime spec, the _shim_ is the
OCI Runtime and runC is "just" an implementation detail of the
io.containerd.runc.v2 runtime. When one configures a non-default runtime
in Docker, what they're really doing is instructing Docker to create
containers using the io.containerd.runc.v2 runtime with a configuration
option telling the runtime that the runC binary is at some non-default
path. Consequently, only OCI runtimes which are compatible with the
io.containerd.runc.v2 shim, such as crun, can be used in this manner.
Other OCI runtimes, including kata-containers v2, come with their own
containerd shim and are not compatible with io.containerd.runc.v2.
As Docker has not historically provided a way to select a non-default
runtime which requires its own shim, runtimes such as kata-containers v2
could not be used with Docker.
Allow other containerd shims to be used with Docker; no daemon
configuration required. If the daemon is instructed to create a
container with a runtime name which does not match any of the configured
or stock runtimes, it passes the name along to containerd verbatim. A
user can start a container with the kata-containers runtime, for
example, simply by calling
docker run --runtime io.containerd.kata.v2
Runtime names which containerd would interpret as a path to an arbitrary
binary are disallowed. While handy for development and testing it is not
strictly necessary and would allow anyone with Engine API access to
trivially execute any binary on the host as root, so we have decided it
would be safest for our users if it was not allowed.
It is not yet possible to set an alternative containerd shim as the
default runtime; it can only be configured per-container.
Signed-off-by: Cory Snider <csnider@mirantis.com>- Loading branch information
Showing
29 changed files
with
10,504 additions
and
16 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,107 @@ | ||
| //go:build !windows | ||
| // +build !windows | ||
|
|
||
| package daemon | ||
|
|
||
| import ( | ||
| "os" | ||
| "path/filepath" | ||
| "testing" | ||
|
|
||
| v2runcoptions "github.com/containerd/containerd/runtime/v2/runc/options" | ||
| "gotest.tools/v3/assert" | ||
| is "gotest.tools/v3/assert/cmp" | ||
|
|
||
| "github.com/docker/docker/api/types" | ||
| "github.com/docker/docker/daemon/config" | ||
| "github.com/docker/docker/errdefs" | ||
| ) | ||
|
|
||
| func TestGetRuntime(t *testing.T) { | ||
| // Configured runtimes can have any arbitrary name, including names | ||
| // which would not be allowed as implicit runtime names. Explicit takes | ||
| // precedence over implicit. | ||
| const configuredRtName = "my/custom.shim.v1" | ||
| configuredRuntime := types.Runtime{Path: "/bin/true"} | ||
|
|
||
| d := &Daemon{configStore: config.New()} | ||
| d.configStore.Root = t.TempDir() | ||
| assert.Assert(t, os.Mkdir(filepath.Join(d.configStore.Root, "runtimes"), 0700)) | ||
| d.configStore.Runtimes = map[string]types.Runtime{ | ||
| configuredRtName: configuredRuntime, | ||
| } | ||
| configureRuntimes(d.configStore) | ||
| assert.Assert(t, d.loadRuntimes()) | ||
|
|
||
| stockRuntime, ok := d.configStore.Runtimes[config.StockRuntimeName] | ||
| assert.Assert(t, ok, "stock runtime could not be found (test needs to be updated)") | ||
|
|
||
| configdOpts := *stockRuntime.Shim.Opts.(*v2runcoptions.Options) | ||
| configdOpts.BinaryName = configuredRuntime.Path | ||
| wantConfigdRuntime := configuredRuntime | ||
| wantConfigdRuntime.Shim = &types.ShimConfig{ | ||
| Binary: stockRuntime.Shim.Binary, | ||
| Opts: &configdOpts, | ||
| } | ||
|
|
||
| for _, tt := range []struct { | ||
| name, runtime string | ||
| want *types.Runtime | ||
| }{ | ||
| { | ||
| name: "StockRuntime", | ||
| runtime: config.StockRuntimeName, | ||
| want: &stockRuntime, | ||
| }, | ||
| { | ||
| name: "ShimName", | ||
| runtime: "io.containerd.my-shim.v42", | ||
| want: &types.Runtime{Shim: &types.ShimConfig{Binary: "io.containerd.my-shim.v42"}}, | ||
| }, | ||
| { | ||
| // containerd is pretty loose about the format of runtime names. Perhaps too | ||
| // loose. The only requirements are that the name contain a dot and (depending | ||
| // on the containerd version) not start with a dot. It does not enforce any | ||
| // particular format of the dot-delimited components of the name. | ||
| name: "VersionlessShimName", | ||
| runtime: "io.containerd.my-shim", | ||
| want: &types.Runtime{Shim: &types.ShimConfig{Binary: "io.containerd.my-shim"}}, | ||
| }, | ||
| { | ||
| name: "IllformedShimName", | ||
| runtime: "myshim", | ||
| }, | ||
| { | ||
| name: "EmptyString", | ||
| runtime: "", | ||
| }, | ||
| { | ||
| name: "PathToShim", | ||
| runtime: "/path/to/runc", | ||
| }, | ||
| { | ||
| name: "PathToShimName", | ||
| runtime: "/path/to/io.containerd.runc.v2", | ||
| }, | ||
| { | ||
| name: "RelPathToShim", | ||
| runtime: "my/io.containerd.runc.v2", | ||
| }, | ||
| { | ||
| name: "ConfiguredRuntime", | ||
| runtime: configuredRtName, | ||
| want: &wantConfigdRuntime, | ||
| }, | ||
| } { | ||
| tt := tt | ||
| t.Run(tt.name, func(t *testing.T) { | ||
| got, err := d.getRuntime(tt.runtime) | ||
| assert.Check(t, is.DeepEqual(got, tt.want)) | ||
| if tt.want != nil { | ||
| assert.Check(t, err) | ||
| } else { | ||
| assert.Check(t, errdefs.IsInvalidParameter(err)) | ||
| } | ||
| }) | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.