From 9e6d012e9c44e20ea4ea30c641a707208cd54173 Mon Sep 17 00:00:00 2001 From: Akihiro Suda Date: Sun, 15 Oct 2023 23:51:11 +0900 Subject: [PATCH] docker info: expose runtime features ("rro" mount mode, etc.) Fix issue 46580 ```console $ curl -s --unix-socket /var/run/docker.sock http://docker/v1.44/info | jq .Runtimes { "crun": { "path": "/usr/local/bin/crun", "status": { "org.opencontainers.runtime-spec.features": "{\"ociVersionMin\":\"1.0.0\",...}" } }, "io.containerd.runc.v2": { "path": "runc", "status": { "org.opencontainers.runtime-spec.features": "{\"ociVersionMin\":\"1.0.0\",...}" } }, "runc": { "path": "runc", "status": { "org.opencontainers.runtime-spec.features": "{\"ociVersionMin\":\"1.0.0\",...}" } }, "runsc": { "path": "/usr/local/bin/runsc" } } ``` Co-authored-by: Sebastiaan van Stijn Signed-off-by: Akihiro Suda --- api/server/router/system/system_routes.go | 6 ++++ api/swagger.yaml | 22 +++++++++++++ api/types/system/info.go | 2 +- api/types/system/runtime.go | 6 ++++ daemon/info_unix.go | 40 ++++++++++++++++++++--- docs/api/version-history.md | 1 + 6 files changed, 71 insertions(+), 6 deletions(-) diff --git a/api/server/router/system/system_routes.go b/api/server/router/system/system_routes.go index 613b04322f..ab91247d7e 100644 --- a/api/server/router/system/system_routes.go +++ b/api/server/router/system/system_routes.go @@ -91,6 +91,12 @@ func (s *systemRouter) getInfo(ctx context.Context, w http.ResponseWriter, r *ht info.OperatingSystem = "" } } + if versions.LessThan(version, "1.44") { + for k, rt := range info.Runtimes { + // Status field introduced inl API v1.44. + info.Runtimes[k] = system.RuntimeWithStatus{Runtime: rt.Runtime} + } + } if versions.GreaterThanOrEqualTo(version, "1.42") { info.KernelMemory = false } diff --git a/api/swagger.yaml b/api/swagger.yaml index a24cc758d2..8bc11103b2 100644 --- a/api/swagger.yaml +++ b/api/swagger.yaml @@ -5618,6 +5618,28 @@ definitions: items: type: "string" example: ["--debug", "--systemd-cgroup=false"] + status: + description: | + Information specific to the runtime. + + While this API specification does not define data provided by runtimes, + the following well-known properties may be provided by runtimes: + + `org.opencontainers.runtime-spec.features`: features structure as defined + in the [OCI Runtime Specification](https://github.com/opencontainers/runtime-spec/blob/main/features.md), + in a JSON string representation. + +


+ + > **Note**: The information returned in this field, including the + > formatting of values and labels, should not be considered stable, + > and may change without notice. + type: "object" + x-nullable: true + additionalProperties: + type: "string" + example: + "org.opencontainers.runtime-spec.features": "{\"ociVersionMin\":\"1.0.0\",\"ociVersionMax\":\"1.1.0\",\"...\":\"...\"}" Commit: description: | diff --git a/api/types/system/info.go b/api/types/system/info.go index 09dbbd0926..89d4a0098e 100644 --- a/api/types/system/info.go +++ b/api/types/system/info.go @@ -58,7 +58,7 @@ type Info struct { Labels []string ExperimentalBuild bool ServerVersion string - Runtimes map[string]Runtime + Runtimes map[string]RuntimeWithStatus DefaultRuntime string Swarm swarm.Info // LiveRestoreEnabled determines whether containers should be kept diff --git a/api/types/system/runtime.go b/api/types/system/runtime.go index 83433acf92..d077295a0d 100644 --- a/api/types/system/runtime.go +++ b/api/types/system/runtime.go @@ -12,3 +12,9 @@ type Runtime struct { Type string `json:"runtimeType,omitempty"` Options map[string]interface{} `json:"options,omitempty"` } + +// RuntimeWithStatus extends [Runtime] to hold [RuntimeStatus]. +type RuntimeWithStatus struct { + Runtime + Status map[string]string `json:"status,omitempty"` +} diff --git a/daemon/info_unix.go b/daemon/info_unix.go index 57c6601c05..cd7f55faac 100644 --- a/daemon/info_unix.go +++ b/daemon/info_unix.go @@ -4,6 +4,7 @@ package daemon // import "github.com/docker/docker/daemon" import ( "context" + "encoding/json" "fmt" "os" "os/exec" @@ -43,14 +44,22 @@ func (daemon *Daemon) fillPlatformInfo(ctx context.Context, v *system.Info, sysI v.CPUSet = sysInfo.Cpuset v.PidsLimit = sysInfo.PidsLimit } - v.Runtimes = make(map[string]system.Runtime) + v.Runtimes = make(map[string]system.RuntimeWithStatus) for n, p := range stockRuntimes() { - v.Runtimes[n] = system.Runtime{Path: p} + v.Runtimes[n] = system.RuntimeWithStatus{ + Runtime: system.Runtime{ + Path: p, + }, + Status: daemon.runtimeStatus(ctx, cfg, n), + } } for n, r := range cfg.Config.Runtimes { - v.Runtimes[n] = system.Runtime{ - Path: r.Path, - Args: append([]string(nil), r.Args...), + v.Runtimes[n] = system.RuntimeWithStatus{ + Runtime: system.Runtime{ + Path: r.Path, + Args: append([]string(nil), r.Args...), + }, + Status: daemon.runtimeStatus(ctx, cfg, n), } } v.DefaultRuntime = cfg.Runtimes.Default @@ -486,3 +495,24 @@ func populateInitVersion(ctx context.Context, cfg *configStore, v *types.Version }) return nil } + +// ociRuntimeFeaturesKey is the "well-known" used for including the +// OCI runtime spec "features" struct. +// +// see https://github.com/opencontainers/runtime-spec/blob/main/features.md +const ociRuntimeFeaturesKey = "org.opencontainers.runtime-spec.features" + +func (daemon *Daemon) runtimeStatus(ctx context.Context, cfg *configStore, runtimeName string) map[string]string { + m := make(map[string]string) + if runtimeName == "" { + runtimeName = cfg.Runtimes.Default + } + if features := cfg.Runtimes.Features(runtimeName); features != nil { + if j, err := json.Marshal(features); err == nil { + m[ociRuntimeFeaturesKey] = string(j) + } else { + log.G(ctx).WithFields(log.Fields{"error": err, "runtime": runtimeName}).Warn("Failed to call json.Marshal for the OCI features struct of runtime") + } + } + return m +} diff --git a/docs/api/version-history.md b/docs/api/version-history.md index f1a0bc2a64..4dcff253f2 100644 --- a/docs/api/version-history.md +++ b/docs/api/version-history.md @@ -67,6 +67,7 @@ keywords: "API, Docker, rcli, REST, documentation" requests is now deprecated. You should instead use the field `TaskTemplate.Networks`. * The `Container` and `ContainerConfig` fields in the `GET /images/{name}/json` response are deprecated and will no longer be included in API v1.45. +* `GET /info` now includes `status` properties in `Runtimes`. ## v1.43 API changes