Skip to content

Commit 43c2154

Browse files
Merge pull request #737 from wking/config-lead-in
config: Lead off with the purpose of the config
2 parents a6d839b + ff071cc commit 43c2154

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,12 +1,12 @@
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 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).
47
[Platform](spec.md#platforms)-specific configuration schema are defined in the [platform-specific documents](#platform-specific-configuration) linked below.
58
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"`).
69

7-
The configuration file contains metadata necessary to implement standard operations against the container.
8-
This includes the process to run, environment variables to inject, sandboxing features to use, etc.
9-
1010
Below is a detailed description of each field defined in the configuration format and valid values are specified.
1111
Platform-specific fields are identified as such.
1212
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)