vbatts/registry
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Add documentation for how to register new StorageDrivers

Browse source 
This commit adds context-specific documentation on StorageDriver,
StorageDriverFactory, and the factory’s Register func, explaining how
the internal registration mechanism should be used.

This documentation follows from the thread starting at
https://github.com/deis/builder/pull/262/files#r56720200.

cc/ @stevvooe

Signed-off-by: Aaron Schlesinger <aschlesinger@deis.com>
This commit is contained in:
Aaron Schlesinger 2016-03-18 16:28:42 -07:00
parent 0ef5587b76
commit 0f09bcd16a
2 changed files with 18 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

9
docs/storage/driver/storagedriver.go
View file

@ -34,7 +34,14 @@ func (version Version) Minor() uint {
const CurrentVersion Version = "0.1"
// StorageDriver defines methods that a Storage Driver must implement for a
// filesystem-like key/value object storage.
// filesystem-like key/value object storage. Storage Drivers are automatically
// registered via an internal registration mechanism, and generally created
// via the StorageDriverFactory interface (https://godoc.org/github.com/docker/distribution/registry/storage/driver/factory).
// See below for an example of how to get a StorageDriver for S3:
//
// import _ "github.com/docker/distribution/registry/storage/driver/s3-aws"
// s3Driver, err = factory.Create("s3", storageParams)
// // assuming no error, s3Driver is the StorageDriver that communicates with S3 according to storageParams
type StorageDriver interface {
// Name returns the human-readable "name" of the driver, useful in error
// messages and logging. By convention, this will just be the registration