-
Notifications
You must be signed in to change notification settings - Fork 645
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Clean-up spec to remove non-spec-ish items #458
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,2 @@ | ||
code-of-conduct.md | ||
/oci-validate-examples | ||
output |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,51 @@ | ||
# Open Container Initiative Image Format Specification | ||
|
||
This specification defines an OCI Image, consisting of a [manifest](manifest.md), a set of [filesystem layers](layer.md), and a [configuration](config.md). | ||
|
||
The goal of this specification is to enable the creation of interoperable tools for building, transporting, and preparing a container image to run. | ||
|
||
## Table of Contents | ||
|
||
- [Introduction](spec.md) | ||
- [Notational Conventions](#notational-conventions) | ||
- [Overview](#overview) | ||
- [Understanding the Specification](#understanding-the-specification) | ||
- [Media Types](media-types.md) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Inconsistent indent? You should replace the earlier tab with four spaces (opencontainers/runtime-spec#495). There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. done |
||
- [Content Descriptors](descriptor.md) | ||
- [Image Layout](image-layout.md) | ||
- [Image Manifest](manifest.md) | ||
- [Image Manifest List](manifest-list.md) | ||
- [Filesystem Layers](layer.md) | ||
- [Image Configuration](config.md) | ||
- [Canonicalization](canonicalization.md) | ||
|
||
# Notational Conventions | ||
|
||
The key words "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). | ||
|
||
The key words "unspecified", "undefined", and "implementation-defined" are to be interpreted as described in the [rationale for the C99 standard][c99-unspecified]. | ||
|
||
# Overview | ||
|
||
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 layer changeset](layer.md) archives that will be unpacked to make up the final runnable filesystem. | ||
The image configuration includes information such as application arguments, environments, etc. | ||
|
||
![](img/build-diagram.png) | ||
|
||
Once built the OCI Image can then be discovered by name, downloaded, verified by hash, trusted through a signature, and unpacked into an [OCI Runtime Bundle](https://github.com/opencontainers/runtime-spec/blob/master/bundle.md). | ||
|
||
![](img/run-diagram.png) | ||
|
||
## Understanding the Specification | ||
|
||
The [OCI Image Media Types](media-types.md) document is a starting point to understanding the overall structure of the specification. | ||
|
||
The high-level components of the spec include: | ||
|
||
* An archival format for container images, consisting of an [image manifest](manifest.md), an [image layout](image-layout.md), a set of [filesystem layers](layer.md), and [image configuration](config.md) (base OCI layer) | ||
* A [process of referencing container images by a cryptographic hash of their content](descriptor.md) (base OCI layer) | ||
* A format for [storing CAS blobs and references to them](image-layout.md) (optional OCI layer) | ||
* Signatures that are based on signing image content address (optional OCI layer) | ||
* Naming that is federated based on DNS and can be delegated (optional OCI layer) | ||
|
||
[c99-unspecified]: http://www.open-std.org/jtc1/sc22/wg14/www/C99RationaleV5.10.pdf#page=18 |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why rename this?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The current approach to single-file PDF/HTML generation is to feed all the Markdown into Pandoc. Pandoc seems to treat them as a single, concatenated file internally and doesn't like seeing the same reference defined more than once, so he's giving this a globally-unique name to avoid conflicting with the entry in
config.md
.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Gah, what a mess. I really just want to drop PDF/HTML.