Skip to content

Commit 55fd90e

Browse files
committed
*: rename serialization.md -> config.md
Closes: #283 Signed-off-by: Vincent Batts <[email protected]>
1 parent e566f16 commit 55fd90e

File tree

8 files changed

+15
-15
lines changed

8 files changed

+15
-15
lines changed

Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ DOC_FILES := \
2828
descriptor.md \
2929
image-layout.md \
3030
layer.md \
31-
serialization.md \
31+
config.md \
3232
manifest.md
3333

3434
FIGURE_FILES := \

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22

33
The OCI Image Format project creates and maintains the software shipping container image format spec (OCI Image Format). The goal of this specification is to enable the creation of interoperable tools for building, transporting, and preparing a container image to run.
44

5-
This specification defines how to create an OCI Image, which will generally be done by a build system, and output an [image manifest](manifest.md), a set of [filesystem layers](layer.md), and an [image configuration](serialization.md).
5+
This specification defines how to create an OCI Image, which will generally be done by a build system, and output an [image manifest](manifest.md), a set of [filesystem layers](layer.md), and an [image configuration](config.md).
66
At a high level the image manifest contains metadata about the contents and dependencies of the image including the content-addressable identity of one or more filesystem serialization archives that will be unpacked to make up the final runnable filesystem.
77
The image configuration includes information such as application arguments, environments, etc.
8-
The combination of the image manifest, image configuration, and one or more filesystem serializations is called the "OCI Image".
8+
The combination of the image manifest, image configuration, and one or more filesystem layers is called the "OCI Image".
99

1010
The keywords "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" are to be interpreted as described in [RFC 2119](http://tools.ietf.org/html/rfc2119) (Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC 2119, March 1997).
1111

@@ -21,7 +21,7 @@ The [Media Types](media-types.md) document is a starting point to understanding
2121

2222
The high level components of the spec include:
2323

24-
* An [image manifest](manifest.md), a set of [filesystem layers](layer.md), and [image configuration](serialization.md) (base layer)
24+
* An [image manifest](manifest.md), a set of [filesystem layers](layer.md), and [image configuration](config.md) (base layer)
2525
* A process of hashing the image format for integrity and content-addressing (base layer)
2626
* Signatures that are based on signing image content address (optional layer)
2727
* Naming that is federated based on DNS and can be delegated (optional layer)

serialization.md renamed to config.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ This specification uses the following terms:
6161
Here is an example image JSON file:
6262

6363
```json,title=Image%20JSON&mediatype=application/vnd.oci.image.config.v1%2Bjson
64-
{
64+
{
6565
"created": "2015-10-31T22:22:56.015925234Z",
6666
"author": "Alyssa P. Hacker <[email protected]>",
6767
"architecture": "amd64",
@@ -71,10 +71,10 @@ Here is an example image JSON file:
7171
"Memory": 2048,
7272
"MemorySwap": 4096,
7373
"CpuShares": 8,
74-
"ExposedPorts": {
74+
"ExposedPorts": {
7575
"8080/tcp": {}
7676
},
77-
"Env": [
77+
"Env": [
7878
"PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin",
7979
"FOO=oci_is_a",
8080
"BAR=well_written_spec"

image-layout.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
The OCI Image Layout is a slash separated layout of OCI content-addressable blobs and [location-addressable](https://en.wikipedia.org/wiki/Content-addressable_storage#Content-addressed_vs._location-addressed) references (refs).
44
This layout MAY be used in a variety of different transport mechanisms: archive formats (e.g. tar, zip), shared filesystem environments (e.g. nfs), or networked file fetching (e.g. http, ftp, rsync).
5-
Given an image layout a tool can convert a given ref into a runnable OCI Image Format by finding an appropriate manifest from the manifest list, unpacking the filesystem serializations in the correct order, and then converting the image configuration into an OCI Runtime config.json.
5+
Given an image layout a tool can convert a given ref into a runnable OCI Image Format by finding an appropriate manifest from the manifest list, unpacking the [filesystem layers](layer.md) in the correct order, and then converting the image configuration into an OCI Runtime config.json.
66

77
The image layout has two top level directories:
88

manifest.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,7 @@ Unlike the [Manifest List](#manifest-list), which contains information about a s
135135
- **`config`** *[descriptor](descriptor.md)*
136136

137137
This REQUIRED property references a configuration object for a container, by digest.
138-
The referenced configuration object is a JSON blob that the runtime uses to set up the container, see [Image JSON Description](serialization.md#image-json-description).
138+
The referenced configuration object is a JSON blob that the runtime uses to set up the container, see [Image JSON Description](config.md).
139139

140140
- **`layers`** *array*
141141

media-types.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ The following media types identify the formats described here and their referenc
55
- `application/vnd.oci.descriptor.v1+json`: [Content Descriptor](descriptor.md)
66
- `application/vnd.oci.image.manifest.list.v1+json`: [Manifest list](manifest.md#manifest-list)
77
- `application/vnd.oci.image.manifest.v1+json`: [Image manifest format](manifest.md#image-manifest)
8-
- `application/vnd.oci.image.config.v1+json`: [Container config JSON](serialization.md)
8+
- `application/vnd.oci.image.config.v1+json`: [Container config JSON](config.md)
99
- `application/vnd.oci.image.layer.tar+gzip`: ["Layer", as a gzipped tar archive](layer.md)
1010
- `application/vnd.oci.image.layer.nondistributable.tar+gzip`: ["Layer", as a gzipped tar that has distribution restrictions](layer.md#non-distributable-layers)
1111

schema/manifest_test.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ func TestManifest(t *testing.T) {
4444
"schemaVersion": 2,
4545
"mediaType": "application/vnd.oci.image.manifest.v1+json",
4646
"config": {
47-
"mediaType": "application/vnd.oci.image.serialization.v1+json",
47+
"mediaType": "application/vnd.oci.image.config.v1+json",
4848
"size": "1470",
4949
"digest": "sha256:c86f7763873b6c0aae22d963bab59b4f5debbed6685761b5951584f6efb0633b"
5050
}
@@ -60,7 +60,7 @@ func TestManifest(t *testing.T) {
6060
"schemaVersion": 2,
6161
"mediaType": "application/vnd.oci.image.manifest.v1+json",
6262
"config": {
63-
"mediaType": "application/vnd.oci.image.serialization.v1+json",
63+
"mediaType": "application/vnd.oci.image.config.v1+json",
6464
"size": 1470,
6565
"digest": "sha256:c86f7763873b6c0aae22d963bab59b4f5debbed6685761b5951584f6efb0633b"
6666
},
@@ -82,7 +82,7 @@ func TestManifest(t *testing.T) {
8282
"schemaVersion": 2,
8383
"mediaType": "application/vnd.oci.image.manifest.v1+json",
8484
"config": {
85-
"mediaType": "application/vnd.oci.image.serialization.v1+json",
85+
"mediaType": "application/vnd.oci.image.config.v1+json",
8686
"size": 1470,
8787
"digest": "sha256:c86f7763873b6c0aae22d963bab59b4f5debbed6685761b5951584f6efb0633b"
8888
},

schema/spec_test.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,8 +41,8 @@ func TestValidateManifest(t *testing.T) {
4141
validate(t, "../manifest.md")
4242
}
4343

44-
func TestValidateSerialization(t *testing.T) {
45-
validate(t, "../serialization.md")
44+
func TestValidateConfig(t *testing.T) {
45+
validate(t, "../config.md")
4646
}
4747

4848
// TODO(sur): include examples from all specification files

0 commit comments

Comments
 (0)