Skip to content

Commit fbd8ab0

Browse files
committed
config.md: Rename ociVersion -> ociRuntimeVersion
Now that we have multiple OCI specs [1,2,3]. Also updates the state JSON key. Generated with: $ sed -i 's/ociVersion/ociRuntimeVersion/g' $(git grep -l ociVersion) [1]: https://github.com/opencontainers/image-spec [2]: https://github.com/opencontainers/runtime-spec [3]: https://github.com/opencontainers/image-spec/pull/6/files/bf5c3f6b30cf326ee3e64849c8eb4c953500dd25#r58699357 Reported-by: Jonathan Boulle <[email protected]> Signed-off-by: W. Trevor King <[email protected]>
1 parent 6728e66 commit fbd8ab0

File tree

5 files changed

+10
-10
lines changed

5 files changed

+10
-10
lines changed

config.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,15 +10,15 @@ Below is a detailed description of each field defined in the configuration forma
1010

1111
## Specification version
1212

13-
* **`ociVersion`** (string, required) must be in [SemVer v2.0.0](http://semver.org/spec/v2.0.0.html) format and specifies the version of the OpenContainer specification with which the bundle complies.
13+
* **`ociRuntimeVersion`** (string, required) must be in [SemVer v2.0.0](http://semver.org/spec/v2.0.0.html) format and specifies the version of the OpenContainer specification with which the bundle complies.
1414
The OpenContainer spec follows semantic versioning and retains forward and backward compatibility within major versions.
1515
For example, if an implementation is compliant with version 1.0.1 of the spec, it is compatible with the complete 1.x series.
1616
NOTE that there is no guarantee for forward or backward compatibility for version 0.x.
1717

1818
*Example*
1919

2020
```json
21-
"ociVersion": "0.1.0"
21+
"ociRuntimeVersion": "0.1.0"
2222
```
2323

2424
## Root Configuration
@@ -269,7 +269,7 @@ Here is a full example `config.json` for reference.
269269

270270
```json
271271
{
272-
"ociVersion": "0.3.0",
272+
"ociRuntimeVersion": "0.3.0",
273273
"platform": {
274274
"os": "linux",
275275
"arch": "amd64"

runtime.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Whether other entities using the same, or other, instance of the runtime can see
99

1010
The state of a container MUST include, at least, the following propeties:
1111

12-
* **`ociVersion`**: (string) is the OCI specification version used when creating the container.
12+
* **`ociRuntimeVersion`**: (string) is the OCI specification version used when creating the container.
1313
* **`id`**: (string) is the container's ID.
1414
This MUST be unique across all containers on this host.
1515
There is no requirement that it be unique across hosts.
@@ -22,7 +22,7 @@ This is provided so that consumers can find the container's configuration and ro
2222
When serialized in JSON, the format MUST adhere to the following pattern:
2323
```json
2424
{
25-
"ociVersion": "0.2.0",
25+
"ociRuntimeVersion": "0.2.0",
2626
"id": "oci-container1",
2727
"pid": 4422,
2828
"bundlePath": "/containers/redis"

schema/schema.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@
44
"id": "https://opencontainers.org/schema/bundle",
55
"type": "object",
66
"properties": {
7-
"ociVersion": {
7+
"ociRuntimeVersion": {
88
"description": "The version of OpenContainer specification configuration complies with",
9-
"id": "https://opencontainers.org/schema/bundle/ociVersion",
9+
"id": "https://opencontainers.org/schema/bundle/ociRuntimeVersion",
1010
"type": "string"
1111
},
1212
"hooks": {
@@ -147,7 +147,7 @@
147147
}
148148
},
149149
"required": [
150-
"ociVersion",
150+
"ociRuntimeVersion",
151151
"platform",
152152
"process",
153153
"root",

specs-go/config.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ import "os"
77
// bundle is packaged for distribution.
88
type Spec struct {
99
// Version is the version of the specification that is supported.
10-
Version string `json:"ociVersion"`
10+
Version string `json:"ociRuntimeVersion"`
1111
// Platform is the host information for OS and Arch.
1212
Platform Platform `json:"platform"`
1313
// Process is the container's main process.

specs-go/state.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ package specs
33
// State holds information about the runtime state of the container.
44
type State struct {
55
// Version is the version of the specification that is supported.
6-
Version string `json:"ociVersion"`
6+
Version string `json:"ociRuntimeVersion"`
77
// ID is the container ID
88
ID string `json:"id"`
99
// Pid is the process id for the container's main process.

0 commit comments

Comments
 (0)