1
0
mirror of https://github.com/distribution/distribution synced 2024-11-06 19:35:52 +01:00
The toolkit to pack, ship, store, and deliver container content
Go to file
Stephen J Day 6ba799b69e Provide simple storage driver health check
To ensure the ensure the web application is properly operating, we've added a
periodic health check for the storage driver. If the health check fails three
times in a row, the registry will serve 503 response status for any request
until the condition is resolved. The condition is reported in the response body
and via the /debug/health endpoint.

To ensure that all drivers will properly operate with this health check, a
function has been added to the driver testsuite.

Signed-off-by: Stephen J Day <stephen.day@docker.com>
2015-08-11 11:50:52 -07:00
cmd Provide simple storage driver health check 2015-08-11 11:50:52 -07:00
configuration Add pull through cache functionality to the Registry which can be configured 2015-08-04 16:09:55 -07:00
context Don't panic when a http.ResponseWriter does not implement CloseNotifier 2015-08-06 15:50:54 -07:00
contrib Two more Docker integration test fixes 2015-08-04 13:28:03 -07:00
digest Refactor specification of supported digests 2015-05-22 18:08:23 -07:00
docs Merge pull request #837 from dmp42/4.docs-2.1 2015-08-10 14:01:52 -07:00
Godeps Merge pull request #514 from denverdino/master 2015-08-04 12:01:02 -07:00
health Provide simple storage driver health check 2015-08-11 11:50:52 -07:00
manifest Fix typo 2015-06-04 23:35:14 +08:00
notifications Add pull through cache functionality to the Registry which can be configured 2015-08-04 16:09:55 -07:00
project Adds pre-commit hook, hook config script, and a README 2014-12-15 18:09:11 -08:00
registry Provide simple storage driver health check 2015-08-11 11:50:52 -07:00
testutil Add pull through cache functionality to the Registry which can be configured 2015-08-04 16:09:55 -07:00
uuid Only enable uuid generation warning when using registry handlers 2015-07-30 14:27:07 -07:00
version Rev base version to 2.1.0 2015-08-06 17:21:03 -07:00
.drone.yml Fix goverall 2014-11-22 10:17:14 -08:00
.gitignore Improve context package 2015-04-01 15:40:21 -07:00
.mailmap Fix double entry in AUTHORS file 2015-08-07 14:00:07 -07:00
AUTHORS Fix double entry in AUTHORS file 2015-08-07 14:00:07 -07:00
blobs.go Add pull through cache functionality to the Registry which can be configured 2015-08-04 16:09:55 -07:00
circle.yml Merge pull request #514 from denverdino/master 2015-08-04 12:01:02 -07:00
CONTRIBUTING.md Merge pull request #722 from stevvooe/coding-guidelines-docker 2015-07-21 15:18:56 -07:00
doc.go fix some typos in source comments 2015-04-17 12:39:52 +00:00
Dockerfile Rename dev-config.yml and example-config.yml to config-dev.yml and config-example.yml 2015-07-30 15:51:50 -07:00
errors.go Fix typo: respository->repository 2015-05-19 13:25:39 -04:00
LICENSE Initial commit 2014-12-22 15:49:26 -08:00
MAINTAINERS Add Stephen Day to maintainers file 2015-01-28 10:31:54 -08:00
Makefile Remove dist tool from distribution 2015-08-06 17:35:36 -07:00
README.md Remove dist tool from distribution 2015-08-06 17:35:36 -07:00
registry.go Create Repositories method 2015-07-21 21:45:14 -07:00
ROADMAP.md Add goals and feature discussion to ROADMAP 2015-07-17 12:34:12 -07:00

Distribution

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

This repository's main product is the Docker Registry 2.0 implementation for storing and distributing Docker images. It supersedes the docker/docker- registry project with a new API design, focused around security and performance.

This repository contains the following components:

Component Description
registry An implementation of the Docker Registry HTTP API V2 for use with docker 1.6+.
libraries A rich set of libraries for interacting with,distribution components. Please see godoc for details. Note: These libraries are unstable.
specifications Distribution related specifications are available in docs/spec
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 engine?

This project should provide an implementation to a V2 API for use in the Docker core project. The API should be embeddable and simplify the process of securely pulling and pushing content from docker daemons.

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.

More about Registry 2.0

The new registry implementation provides the following benefits:

  • faster push and pull
  • new, more efficient implementation
  • simplified deployment
  • pluggable storage backend
  • webhook notifications

For information on upcoming functionality, please see ROADMAP.md.

Who needs to deploy a registry?

By default, Docker users pull images from Docker's public registry instance. Installing Docker gives users this ability. Users can also push images to a repository on Docker's public registry, if they have a Docker Hub account.

For some users and even companies, this default behavior is sufficient. For others, it is not.

For example, users with their own software products may want to maintain a registry for private, company images. Also, you may wish to deploy your own image repository for images used to test or in continuous integration. For these use cases and others, deploying your own registry instance may be the better choice.

Migration to Registry 2.0

For those who have previously deployed their own registry based on the Registry 1.0 implementation and wish to deploy a Registry 2.0 while retaining images, data migration is required. A tool to assist with migration efforts has been created. For more information see [docker/migrator] (https://github.com/docker/migrator).

Contribute

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.

Support

If any issues are encountered while using the Distribution project, several avenues are available for support:

IRC #docker-distribution on FreeNode
Issue Tracker github.com/docker/distribution/issues
Google Groups https://groups.google.com/a/dockerproject.org/forum/#!forum/distribution
Mailing List docker@dockerproject.org

License

This project is distributed under Apache License, Version 2.0.