Skip to content

Conversation

@vbatts
Copy link
Member

@vbatts vbatts commented Sep 13, 2016

Closes: #283

Signed-off-by: Vincent Batts [email protected]

validate(t, "../manifest.md")
}

func TestValidateSerialization(t *testing.T) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Config??

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fair

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

updated

@stevvooe
Copy link
Contributor

stevvooe commented Sep 13, 2016

LGTM

Thanks!

Approved with PullApprove

@stevvooe
Copy link
Contributor

@vbatts Looks like there are some whitespace problems.

@vbatts
Copy link
Member Author

vbatts commented Sep 13, 2016

fixed. Not sure why newer git is not detecting these. It's a bit frustrating. :-\

image-layout.md Outdated
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).
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).
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.
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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No need for ./, just use [filesystem layers](layer.md).

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we've been through this. This is for explicit relative path. It's not a rule, but many tools rely on such to determine that it is a relative path.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

whatever

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

On Tue, Sep 13, 2016 at 02:12:47PM -0700, Vincent Batts wrote:

-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.
+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 in the correct order, and then converting the image configuration into an OCI Runtime config.json.

we've been through this. This is for explicit relative path. It's
not a rule, but many tools rely on such to determine that it is a
relative path.

Can you point to such a tool? If we want to require explicit ./,
we'll want a new PR to update many existing links.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

go build

On Tue, Sep 13, 2016 at 5:23 PM W. Trevor King [email protected]
wrote:

In image-layout.md
#305 (comment)
:

@@ -2,7 +2,7 @@

The OCI Image Layout is a slash separated layout of OCI content-addressable blobs and location-addressable references (refs).
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).
-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.
+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 in the correct order, and then converting the image configuration into an OCI Runtime config.json.

On Tue, Sep 13, 2016 at 02:12:47PM -0700, Vincent Batts wrote: > -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. > +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 in the correct order, and then converting
the image configuration into an OCI Runtime config.json. we've been through
this. This is for explicit relative path. It's not a rule, but many tools
rely on such to determine that it is a relative path.
Can you point to such a tool? If we want to require explicit ./, we'll
want a new PR to update many existing links.


You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
https://github.com/opencontainers/image-spec/pull/305/files/7457e6cfb9e8a70e0c0823e7b2ffc24d5b0ca3ab#r78647065,
or mute the thread
https://github.com/notifications/unsubscribe-auth/AAEF6f8oGVRuL5XudyYAc_obJhwUnV2fks5qpxQ9gaJpZM4J8CpQ
.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

On Tue, Sep 13, 2016 at 02:24:45PM -0700, Vincent Batts wrote:

-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.
+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 in the correct order, and then converting the image configuration into an OCI Runtime config.json.

go build

‘go build’ parses this Markdown?

manifest.md Outdated

This REQUIRED property references a configuration object for a container, by digest.
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).
The referenced configuration object is a JSON blob that the runtime uses to set up the container, see [Image JSON Description](config.md#image-json-description).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Now that the files are split, we may want to drop the fragment here. If config.md is so big that you want to link to a subsection as the spec for the format, we should probably trim config.md ;).

config.md Outdated

## Image JSON Description

Here is an example image JSON file:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Update the title to:

Image Configuration

@vbatts vbatts force-pushed the rename branch 2 times, most recently from 678aac7 to 5f8edee Compare September 13, 2016 21:19
</dl>

## Image JSON Description
## Image Configuration
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I meant the H1 at the top of this file. This whole file is about that configuration, right?

@jonboulle
Copy link
Contributor

jonboulle commented Sep 14, 2016

LGTM, thank you

Approved with PullApprove

@stevvooe
Copy link
Contributor

stevvooe commented Sep 14, 2016

LGTM

Approved with PullApprove

@stevvooe stevvooe merged commit 55a3d9e into opencontainers:master Sep 14, 2016
wking added a commit to wking/image-spec that referenced this pull request Sep 14, 2016
This didn't make it into 17c1f00 (*: rename serialization.md ->
config.md, 2016-09-13, opencontainers#305), but I think we still want it [1,2,3].
While I was touching headers, I shifted the informative example
section down under the normative property definitions, and move the
normative whitespace rule up out of the example section.

[1]: opencontainers#255 (comment)
[2]: opencontainers#305 (comment)
[3]: opencontainers#305 (comment)

Signed-off-by: W. Trevor King <[email protected]>
@vbatts vbatts deleted the rename branch September 19, 2016 15:16
dattgoswami9lk5g added a commit to dattgoswami9lk5g/bremlinr that referenced this pull request Jun 6, 2022
This didn't make it into 17c1f000 (*: rename serialization.md ->
config.md, 2016-09-13, #305), but I think we still want it [1,2,3].
While I was touching headers, I shifted the informative example
section down under the normative property definitions, and move the
normative whitespace rule up out of the example section.

[1]: opencontainers/image-spec#255 (comment)
[2]: opencontainers/image-spec#305 (comment)
[3]: opencontainers/image-spec#305 (comment)

Signed-off-by: W. Trevor King <[email protected]>
7c00d pushed a commit to 7c00d/J1nHyeockKim that referenced this pull request Jun 6, 2022
This didn't make it into 17c1f000 (*: rename serialization.md ->
config.md, 2016-09-13, #305), but I think we still want it [1,2,3].
While I was touching headers, I shifted the informative example
section down under the normative property definitions, and move the
normative whitespace rule up out of the example section.

[1]: opencontainers/image-spec#255 (comment)
[2]: opencontainers/image-spec#305 (comment)
[3]: opencontainers/image-spec#305 (comment)

Signed-off-by: W. Trevor King <[email protected]>
7c00d added a commit to 7c00d/J1nHyeockKim that referenced this pull request Jun 6, 2022
This didn't make it into 17c1f000 (*: rename serialization.md ->
config.md, 2016-09-13, #305), but I think we still want it [1,2,3].
While I was touching headers, I shifted the informative example
section down under the normative property definitions, and move the
normative whitespace rule up out of the example section.

[1]: opencontainers/image-spec#255 (comment)
[2]: opencontainers/image-spec#305 (comment)
[3]: opencontainers/image-spec#305 (comment)

Signed-off-by: W. Trevor King <[email protected]>
laventuraw added a commit to laventuraw/Kihara-tony0 that referenced this pull request Jun 6, 2022
This didn't make it into 17c1f000 (*: rename serialization.md ->
config.md, 2016-09-13, #305), but I think we still want it [1,2,3].
While I was touching headers, I shifted the informative example
section down under the normative property definitions, and move the
normative whitespace rule up out of the example section.

[1]: opencontainers/image-spec#255 (comment)
[2]: opencontainers/image-spec#305 (comment)
[3]: opencontainers/image-spec#305 (comment)

Signed-off-by: W. Trevor King <[email protected]>
tomalopbsr0tt added a commit to tomalopbsr0tt/fabiojosej that referenced this pull request Oct 6, 2022
This didn't make it into 17c1f000 (*: rename serialization.md ->
config.md, 2016-09-13, #305), but I think we still want it [1,2,3].
While I was touching headers, I shifted the informative example
section down under the normative property definitions, and move the
normative whitespace rule up out of the example section.

[1]: opencontainers/image-spec#255 (comment)
[2]: opencontainers/image-spec#305 (comment)
[3]: opencontainers/image-spec#305 (comment)

Signed-off-by: W. Trevor King <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants