Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions config.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,15 @@ Below is a detailed description of each field defined in the configuration forma

## Specification version

* **`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.
* **`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.
The OpenContainer spec follows semantic versioning and retains forward and backward compatibility within major versions.
For example, if an implementation is compliant with version 1.0.1 of the spec, it is compatible with the complete 1.x series.
NOTE that there is no guarantee for forward or backward compatibility for version 0.x.

*Example*

```json
"ociVersion": "0.1.0"
"ociRuntimeVersion": "0.1.0"
```

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

```json
{
"ociVersion": "0.3.0",
"ociRuntimeVersion": "0.3.0",
"platform": {
"os": "linux",
"arch": "amd64"
Expand Down
4 changes: 2 additions & 2 deletions runtime.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Whether other entities using the same, or other, instance of the runtime can see

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

* **`ociVersion`**: (string) is the OCI specification version used when creating the container.
* **`ociRuntimeVersion`**: (string) is the OCI specification version used when creating the container.
* **`id`**: (string) is the container's ID.
This MUST be unique across all containers on this host.
There is no requirement that it be unique across hosts.
Expand All @@ -22,7 +22,7 @@ This is provided so that consumers can find the container's configuration and ro
When serialized in JSON, the format MUST adhere to the following pattern:
```json
{
"ociVersion": "0.2.0",
"ociRuntimeVersion": "0.2.0",
"id": "oci-container1",
"pid": 4422,
"bundlePath": "/containers/redis"
Expand Down
6 changes: 3 additions & 3 deletions schema/schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@
"id": "https://opencontainers.org/schema/bundle",
"type": "object",
"properties": {
"ociVersion": {
"ociRuntimeVersion": {
"description": "The version of OpenContainer specification configuration complies with",
"id": "https://opencontainers.org/schema/bundle/ociVersion",
"id": "https://opencontainers.org/schema/bundle/ociRuntimeVersion",
"type": "string"
},
"hooks": {
Expand Down Expand Up @@ -147,7 +147,7 @@
}
},
"required": [
"ociVersion",
"ociRuntimeVersion",
"platform",
"process",
"root",
Expand Down
2 changes: 1 addition & 1 deletion specs-go/config.go
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import "os"
// bundle is packaged for distribution.
type Spec struct {
// Version is the version of the specification that is supported.
Version string `json:"ociVersion"`
Version string `json:"ociRuntimeVersion"`
// Platform is the host information for OS and Arch.
Platform Platform `json:"platform"`
// Process is the container's main process.
Expand Down
2 changes: 1 addition & 1 deletion specs-go/state.go
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ package specs
// State holds information about the runtime state of the container.
type State struct {
// Version is the version of the specification that is supported.
Version string `json:"version"`
Version string `json:"ociRuntimeVersion"`
// ID is the container ID
ID string `json:"id"`
// Pid is the process id for the container's main process.
Expand Down