The toolkit to pack, ship, store, and deliver container content
Find a file
Sebastiaan van Stijn 226b21beb6
reference: make some regexp vars a const, remove intermediate vars
This patch:

- makes regexp strings that are constant a const
- moves some variables closer to where they're used
- removes some intermediate vars
- un-wraps some lines; they're lengthy, but probably more readable than having
  them wrapped over multiple lines.
- touches-up some docs.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2022-11-20 15:07:24 +01:00
.github/workflows Add Go 1.19 to GHA 2022-10-09 16:52:41 -04:00
cmd format code with gofumpt 2022-11-03 22:48:20 +01:00
configuration replace strings.Split(N) for strings.Cut() or alternatives 2022-11-10 22:38:12 +01:00
context replace strings.Split(N) for strings.Cut() or alternatives 2022-11-10 22:38:12 +01:00
contrib Merge pull request #3766 from thaJeztah/gofumpt 2022-11-04 12:19:53 +01:00
digestset digestset: deprecate package in favor of go-digest/digestset 2022-11-08 23:17:10 +01:00
dockerfiles dockerfiles: formatting 2022-07-20 16:44:31 +02:00
docs Merge pull request #3681 from Jamstah/api-doc-fix 2022-11-07 15:34:07 +00:00
health Merge pull request #3766 from thaJeztah/gofumpt 2022-11-04 12:19:53 +01:00
manifest simplify mocks 2022-11-10 17:09:24 +01:00
metrics Add notification metrics 2019-02-15 21:14:57 +08:00
notifications deprecate ReadSeekCloser in favor of io.ReadSeekCloser 2022-11-10 23:10:32 +01:00
project Adds pre-commit hook, hook config script, and a README 2014-12-15 18:09:11 -08:00
reference reference: make some regexp vars a const, remove intermediate vars 2022-11-20 15:07:24 +01:00
registry Merge pull request #3787 from thaJeztah/simplify_mocks 2022-11-18 08:53:26 +00:00
releases docs: update release-tool link 2021-08-23 00:01:41 -07:00
script ci: remove dco check (dco bot already does this) 2022-07-20 14:10:24 +02:00
tests Add a basic e2e test for CI 2021-02-01 16:15:45 +08:00
testutil replace deprecated io/ioutil 2022-11-04 23:47:52 +01:00
uuid Only enable uuid generation warning when using registry handlers 2015-07-30 14:27:07 -07:00
vendor Merge pull request #3764 from thaJeztah/bump_cobra 2022-11-09 11:19:22 +08:00
version format code with gofumpt 2022-11-03 22:48:20 +01:00
.dockerignore Dockerfile: switch to xx 2022-05-03 20:07:07 +02:00
.gitignore add s3 region filters for cloudfront 2017-12-01 15:58:58 -08:00
.golangci.yml Update golangci-lint version and fix reports 2022-01-28 11:21:00 +00:00
.mailmap Update mailmap file 2018-09-26 11:15:01 -07:00
ADOPTERS.md Add Adopters 2020-12-09 17:44:18 +00:00
blobs.go deprecate ReadSeekCloser in favor of io.ReadSeekCloser 2022-11-10 23:10:32 +01:00
BUILDING.md Merge pull request #3679 from Jamstah/building-doc-updates 2022-11-08 22:46:09 +00:00
CODE-OF-CONDUCT.md Update roadmap, add code of conduct file 2021-01-26 11:34:53 +00:00
CONTRIBUTING.md Review contributing for Docker references 2022-07-08 13:52:12 +01:00
distribution-logo.svg Update distribution logo 2021-06-15 13:29:58 -07:00
doc.go fix some typos in source comments 2015-04-17 12:39:52 +00:00
docker-bake.hcl ci: git validation target 2022-07-20 14:18:27 +02:00
Dockerfile dockerfiles: formatting 2022-07-20 16:44:31 +02:00
errors.go disable schema1 by default, add a config flag to enable it 2017-12-19 10:23:25 -08:00
go.mod go.mod: github.com/spf13/cobra v1.6.1 2022-11-02 19:48:45 +01:00
go.sum go.mod: github.com/spf13/cobra v1.6.1 2022-11-02 19:48:45 +01:00
GOVERNANCE.md Remove duplicate code of conduct 2021-03-01 12:22:06 -08:00
LICENSE Initial commit 2014-12-22 15:49:26 -08:00
MAINTAINERS Update maintainers mailing list 2022-06-08 16:31:08 +01:00
Makefile ci: git validation target 2022-07-20 14:18:27 +02:00
manifests.go Fix gometalint errors 2019-02-04 16:01:04 -08:00
README.md Fix OCI conformance workflow report and README badge 2021-06-30 15:37:18 +01:00
registry.go go.mod: change imports to github.com/distribution/distribution/v3 2021-02-08 18:30:46 +01:00
ROADMAP.md Update roadmap, add code of conduct file 2021-01-26 11:34:53 +00:00
tags.go Migrate to golangci-lint 2020-02-14 08:11:16 +11:00

Distribution

The toolset to pack, ship, store, and deliver content.

This repository's main product is the Open Source Registry implementation for storing and distributing container images using the OCI Distribution Specification. The goal of this project is to provide a simple, secure, and scalable base for building a large scale registry solution or running a simple private registry. It is a core library for many registry operators including Docker Hub, GitHub Container Registry, GitLab Container Registry and DigitalOcean Container Registry, as well as the CNCF Harbor Project, and VMware Harbor Registry.

Build Status GoDoc License: Apache-2.0 codecov FOSSA Status OCI Conformance

This repository contains the following components:

Component Description
registry An implementation of the OCI Distribution Specification.
libraries A rich set of libraries for interacting with distribution components. Please see godoc for details. Note: The interfaces for these libraries are unstable.
documentation Docker's full documentation set is available at docs.docker.com. This repository contains the subset related just to the registry.

How does this integrate with Docker, containerd, and other OCI client?

Clients implement against the OCI specification and communicate with the registry using HTTP. This project contains a client implementation which is currently in use by Docker, however, it is deprecated for the implementation in containerd and will not support new features.

What are the long term goals of the Distribution project?

The Distribution project has the further long term goal of providing a secure tool chain for distributing content. The specifications, APIs and tools should be as useful with Docker as they are without.

Our goal is to design a professional grade and extensible content distribution system that allow users to:

  • Enjoy an efficient, secured and reliable way to store, manage, package and exchange content
  • Hack/roll their own on top of healthy open-source components
  • Implement their own home made solution through good specs, and solid extensions mechanism.

Contribution

Please see CONTRIBUTING.md for details on how to contribute issues, fixes, and patches to this project. If you are contributing code, see the instructions for building a development environment.

Communication

For async communication and long running discussions please use issues and pull requests on the github repo. This will be the best place to discuss design and implementation.

For sync communication we have a #distribution channel in the CNCF Slack that everyone is welcome to join and chat about development.

Licenses

The distribution codebase is released under the Apache 2.0 license. The README.md file, and files in the "docs" folder are licensed under the Creative Commons Attribution 4.0 International License. You may obtain a copy of the license, titled CC-BY-4.0, at http://creativecommons.org/licenses/by/4.0/.