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

Commit

Permalink
Collection of definitions and terms
Browse files Browse the repository at this point in the history
Signed-off-by: Steven Lasker <stevenlasker@hotmail.com>
  • Loading branch information
SteveLasker committed Aug 23, 2019
1 parent 7656982 commit 4148029
Showing 1 changed file with 46 additions and 0 deletions.
46 changes: 46 additions & 0 deletions definitions-terms.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
# 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)
* [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 it's `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 it's type. An artifact has a type, which has a collection of layers.

The Artifact is defined as unique by it's `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.

## 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
[distribution-spec]: https://github.com/opencontainers/distribution-spec/

0 comments on commit 4148029

Please sign in to comment.