Skip to content

Commit

Permalink
Merge pull request #621 from erikh/rewrite-spec-links
Browse files Browse the repository at this point in the history
README: rework description of spec components
  • Loading branch information
stevvooe authored Apr 5, 2017
2 parents 319fb0a + 687d989 commit e9f698e
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 4 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

The OCI Image Format project creates and maintains the software shipping container image format spec (OCI Image Format).

The specification can be found [here](spec.md).
**[The specification can be found here](spec.md).**

This repository also provides [Go types](specs-go), [intra-blob validation tooling, and JSON Schema](schema).
The Go types and validation should be compatible with the current Go release; earlier Go releases are not supported.
Expand Down
9 changes: 6 additions & 3 deletions spec.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,9 +51,12 @@ The [OCI Image Media Types](media-types.md) document is a starting point to unde

The high-level components of the spec include:

* An archival format for container images, consisting of an [image manifest](manifest.md), an [image index](image-index.md) (optional), 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)
* [Image Manifest](manifest.md) - Describes the components that make up a container image.
* [Image Index](image-index.md) - An index of annotated image manifests distributed as a complete unit.
* [Image Layout](image-layout.md) - The filesystem layout representing the contents of an image
* [Filesystem Layers](layer.md) - changesets that describe a container's filesystem
* [Image Configuration](config.md) - The document determining layer ordering and configuration of the image suitable for consumption by runtime-spec
* [Descriptors](descriptor.md) - Describes the type, metadata and content address of referenced content.
* 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)

Expand Down

0 comments on commit e9f698e

Please sign in to comment.