Skip to content

Commit a78a538

Browse files
committed
config: Link platform:"..." JSON tags with protocol slugs
So that the semantics are clear. The platform/protocol disconnect is unfortunate. "Protocol" was chosen in de3f1af (Remove language around Solaris being optional as it is covered in compliance language, 2016-08-17, opencontainers#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]: opencontainers#527 (comment) Signed-off-by: W. Trevor King <wking@tremily.us>
1 parent 6586d19 commit a78a538

File tree

2 files changed

+3
-0
lines changed

2 files changed

+3
-0
lines changed

config.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22

33
The container's top-level directory MUST contain a configuration file called `config.json`.
44
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).
5+
For properties that are only defined for some [protocols](spec.md#protocols), the Go property has a `platform` tag listing those protocols (e.g. `platform:"linux,solaris"`).
56

67
The configuration file contains metadata necessary to implement standard operations against the container.
78
This includes the process to run, environment variables to inject, sandboxing features to use, etc.

spec.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
The [Open Container Initiative](http://www.opencontainers.org/) develops specifications for standards on Operating System process and application containers.
44

5+
# Protocols
6+
57
Protocols defined by this specification are:
68

79
* `linux`: [runtime.md](runtime.md), [config.md](config.md), [config-linux.md](config-linux.md), and [runtime-linux.md](runtime-linux.md).

0 commit comments

Comments
 (0)