Skip to content
This repository has been archived by the owner on Jul 18, 2023. It is now read-only.

Commit

Permalink
Add well-known types
Browse files Browse the repository at this point in the history
  • Loading branch information
SteveLasker committed Aug 26, 2019
1 parent 7656982 commit 4154ee8
Showing 1 changed file with 54 additions and 0 deletions.
54 changes: 54 additions & 0 deletions definitions-terms.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
# Definitions and Terms

A collection of definitions and terms used within this repository.

* [Artifact Author](#artifact-author)
* [Distribution Operator](#distribution-operator)
* [Media Type](#media-type)
* [OCI Image](#oci-image)
* [Registry](#registry)
* [Well Known Type](#well-known-type)
* [YASS](#yass)

## Artifact Author

The owner of an artifact format. The [OCI Image Spec](https://github.com/opencontainers/image-spec/) is owned by the OCI working group.

An artifact is defined to be unique by its `config.mediaType`.

## Container Registry

See [Registry](#registry)

## Distribution Operator

Vendors that implement and/or run the [OCI Distribution Spec](https://github.com/opencontainers/distribution-spec/).

## Media Type

The uniqueness of an artifact is defined by its type. An artifact has a type, which has a collection of layers.

The Artifact is defined as unique by its `manifest.config.mediaType`. Layers are defined by their `layer.config.mediaType`.

## OCI Image

OCI Image is a specific type of artifact. However, an OCI image is not meant to define all artifacts. Tooling, such as docker, containerD and vulnerability scanners that perform security checks upon container images, use the `config.mediaType` to know they can pull and instance container images. Docker and containerD are not intended to pull and instance Helm Charts, Singularity, OPA or other artifact types.

## Registry

A registry, or container registry, is an instance of the [distribution-spec]. See [Implementors][implementors] for a list of registries that support OCI Artifacts.

## Well Known Type

Types that many to most registry operators would likely want to support ([OCI Image][image-spec], [Helm][helm], [Singularity][singularity]). While registry operators are not required to support all types, registry operators would likely want to support well known types, if there was an easy way to understand the differing types. OCI Artifacts includes publishing of well-known types for registry operators to import.

## YASS

[OCI Artifacts][artifacts] provides an alternative to having to build, distribute and run "**Y**et **A**nother **S**torage **S**ervice".

[artifacts]: https://github.com/opencontainers/artifacts
[helm]: https://helm.sh
[implementors]: https://github.com/SteveLasker/artifacts/blob/implementors/implementations.md
[image-spec]: https://github.com/opencontainers/image-spec/
[distribution-spec]: https://github.com/opencontainers/distribution-spec/
[singularity]: https://github.com/sylabs/singularity

0 comments on commit 4154ee8

Please sign in to comment.