Skip to content

Commit 0952dd8

Browse files
committed
config: Lead off with the purpose of the config
Instead of leading off with links to a bunch of other places, notes on the Go tags, etc., make things more inviting by leading off with a big-picture summary of what the configuration is about. Signed-off-by: W. Trevor King <wking@tremily.us>
1 parent e8a0d3d commit 0952dd8

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

config.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
# <a name="containerConfigurationFile" />Container Configuration file
22

3+
This configuration file contains metadata necessary to implement standard operations against the container.
4+
This includes the process to run, environment variables to inject, sandboxing features to use, etc.
5+
36
The container's top-level directory MUST contain a configuration file called `config.json`.
47
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).
58
[Platform](spec.md#platforms)-specific configuration schema are defined in the [platform-specific documents](#platform-specific-configuration) linked below.
69
For properties that are only defined for some [platforms](spec.md#platforms), the Go property has a `platform` tag listing those protocols (e.g. `platform:"linux,solaris"`).
710

8-
The configuration file contains metadata necessary to implement standard operations against the container.
9-
This includes the process to run, environment variables to inject, sandboxing features to use, etc.
10-
1111
Below is a detailed description of each field defined in the configuration format and valid values are specified.
1212
Platform-specific fields are identified as such.
1313
For all platform-specific configuration values, the scope defined below in the [Platform-specific configuration](#platform-specific-configuration) section applies.

0 commit comments

Comments
 (0)