From fd0b8a01abef29c5d0ce24886b00fcb2648767fd Mon Sep 17 00:00:00 2001 From: "W. Trevor King" Date: Thu, 15 Sep 2016 08:57:02 -0700 Subject: [PATCH] config: Link platform:"..." JSON tags with protocol slugs So that the semantics are clear. The platform/protocol disconnect is unfortunate. "Protocol" was chosen in de3f1af6 (Remove language around Solaris being optional as it is covered in compliance language, 2016-08-17, #527) because we may have compliance subsets that aren't linked to platforms [2]. I'd be open to renaming the JSON tag from platform:"..." -> protocol:"...", but that's probably more change than it's worth. [1]: https://github.com/opencontainers/runtime-spec/pull/527#issuecomment-238979250 Signed-off-by: W. Trevor King --- config.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/config.md b/config.md index 6da1d0142..5af076a13 100644 --- a/config.md +++ b/config.md @@ -2,7 +2,7 @@ The container's top-level directory MUST contain a configuration file called `config.json`. The canonical schema is defined in this document, but there is a JSON Schema in [`schema/config-schema.json`](schema/config-schema.json) and Go bindings in [`specs-go/config.go`](specs-go/config.go). -For fields that are only defined on some platforms, the Go property has a `platform` tag listing those platforms. +For properties that are only defined for some [protocols](README.md#compliance), the Go property has a `platform` tag listing those protocols (e.g. `platform:"linux,solaris"`). The configuration file contains metadata necessary to implement standard operations against the container. This includes the process to run, environment variables to inject, sandboxing features to use, etc.