Skip to content

Commit

Permalink
config: Link platform:"..." JSON tags with protocol slugs
Browse files Browse the repository at this point in the history
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, #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]: #527 (comment)

Signed-off-by: W. Trevor King <wking@tremily.us>
  • Loading branch information
wking committed Jan 11, 2017
1 parent 6586d19 commit a78a538
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 0 deletions.
1 change: 1 addition & 0 deletions config.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +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 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"`).

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.
Expand Down
2 changes: 2 additions & 0 deletions spec.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

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

# Protocols

Protocols defined by this specification are:

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

0 comments on commit a78a538

Please sign in to comment.