From 78971d68a5e763b7bd3b157395103519f4c23cff Mon Sep 17 00:00:00 2001 From: Jimmy Zelinskie Date: Wed, 3 Aug 2016 22:09:22 -0400 Subject: [PATCH 1/2] readme: add some terminology --- README.md | 38 +++++++++++++++++++++++++++++++++++++- 1 file changed, 37 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 4a61ca1f3..2f5536c86 100644 --- a/README.md +++ b/README.md @@ -156,4 +156,40 @@ TODO ### Terminology -TODO +#### Organizations + +- **AppC**: a standards body responsible for a _Runtime_ and _Image Format_ superseded by the _Open Container Initiative_ +- **Open Container Initiative**: a standards body responsible for a _Runtime_ specification and an _Image Format_ +- **Docker**: a company that builds a platform that has its own _Image Formats_, _Build System_, _Container Runtime_, and _Container Orchestration_ + +#### Concepts + +- **Image**: an archive containing all of the contents necessary to execute a container +- **Image Format**: a specification for the structure of an _Image_ +- **Image Layer**: an _Image_ that may depend on being applied to other _Images_ to generate a final _Image_ +- **Image Squashing**: the process of compressing an _Image_ into a single _Layer_ +- **Manifest**: a text file containing metadata for a particular _Image_ +- **Tag**: a human-friendly named, mutable pointer to a particular set of _Images_ +- **Build System**: a program used to generate _Images_ +- **Registry**: a program that speaks one or more standard protocols to store and receive _Images_ +- **Repository**: a collection of related _Tags_ organized by a _Registry_ +- **Push**: the act of uploading an _Image_ to a _Registry_ +- **Pull**: the act of downloading an _Image_ from a _Registry_ +- **Container**: an _Image_ and its execution environment +- **Container Runtime**: a program that can transform an _Image_ into a _Container_ by executing it +- **Container Orchestration**: a program or set of programs that provides a framework for deploying _Containers_ + +#### Software + +- **Quay.io**: CoreOS's hosted _Registry_ +- **Quay**: CoreOS's enterprise-grade _Registry_ product +- **quayctl**: an open source program that implements alternative methods for _pulling_ _Images_ from _Quay_ +- **Clair**: an open source static analysis tool used to detect vulnerability in _Images_ +- **Quay Security Scanning**: the integration between _Clair_ and _Quay_ +- **Kubernetes**: an open source program implementing _Container Orchestration_ +- **Docker Hub**: Docker's hosted _Registry_ +- **Docker Trusted Registry**: Docker's enterprise-grade _Registry_ product +- **Notary**: an open source implementation of the TUF protocol used in _Docker Content Trust_ +- **Docker Content Trust**: the integration between _Notary_ and _Docker Trusted Registry) +- **Docker Engine**: a program used to interact with all aspects of the Docker platform +- **Swarm**: a program implementing _Container Orchestration_ for the Docker platform From 53934b14260e73e6cb88b6e5d042c1450db27469 Mon Sep 17 00:00:00 2001 From: Jimmy Zelinskie Date: Wed, 3 Aug 2016 22:18:09 -0400 Subject: [PATCH 2/2] readme: fix URLs pointing to the wrong docs --- README.md | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 2f5536c86..b50ad3b76 100644 --- a/README.md +++ b/README.md @@ -11,8 +11,10 @@ Quay is project to build, store, and distribute container images. High-level features include: -- Docker Registry Protocol [v1], [v2.1] -- [AppC Image Discovery] +- Docker Registry Protocol [v1], [v2] +- Docker Manifest Schema [v2.1] +- [AppC Image Discovery] via on-demand transcoding +- Image Squashing via on-demand transcoding - Authentication provided by [LDAP], [Keystone], [Dex], [Google], [GitHub] - ACLs, team management, and auditability logs - Geo-replicated storage provided by local filesystems, [S3], [GCS], [Swift], [Ceph] @@ -21,8 +23,9 @@ High-level features include: - [Swagger]-compliant HTTP API [releases]: https://github.com/coreos-inc/quay/releases -[v1]: https://github.com/docker/distribution/blob/master/docs/spec/manifest-v2-1.md -[v2.1]: https://github.com/docker/distribution/blob/master/docs/spec/manifest-v2-2.md +[v1]: https://docs.docker.com/v1.6/reference/api/registry_api/ +[v2]: https://docs.docker.com/v1.6/registry/ +[v2.1]: https://github.com/docker/distribution/blob/master/docs/spec/manifest-v2-1.md [AppC Image Discovery]: https://github.com/appc/spec/blob/master/spec/discovery.md [LDAP]: https://en.wikipedia.org/wiki/Lightweight_Directory_Access_Protocol [Keystone]: http://docs.openstack.org/developer/keystone @@ -190,6 +193,6 @@ TODO - **Docker Hub**: Docker's hosted _Registry_ - **Docker Trusted Registry**: Docker's enterprise-grade _Registry_ product - **Notary**: an open source implementation of the TUF protocol used in _Docker Content Trust_ -- **Docker Content Trust**: the integration between _Notary_ and _Docker Trusted Registry) +- **Docker Content Trust**: the integration between _Notary_ and _Docker Trusted Registry_ - **Docker Engine**: a program used to interact with all aspects of the Docker platform - **Swarm**: a program implementing _Container Orchestration_ for the Docker platform