storage

Documentation

Overview

Package storage contains storage services for use in the registry application. It should be considered an internal package, as of Go 1.4.

Index

• Variables
• func DisableDigestResumption(registry *registry) error
• func EnableDelete(registry *registry) error
• func EnableRedirect(registry *registry) error
• func EnumerateAllDigests(ms distribution.ManifestService) error
• func NewRegistry(ctx context.Context, driver storagedriver.StorageDriver, ...) (distribution.Namespace, error)
• func PurgeUploads(ctx context.Context, driver storageDriver.StorageDriver, olderThan time.Time, ...) ([]string, []error)
• func RegistryBlobDeleter(ns distribution.Namespace) (distribution.BlobDeleter, error)
• func RegistryBlobEnumerator(ns distribution.Namespace) (distribution.BlobEnumerator, error)
• func RemoveParentsOnDelete(registry *registry) error
• func SkipLayerVerification(ms distribution.ManifestService) error
• func Walk(ctx context.Context, driver storageDriver.StorageDriver, from string, f WalkFn) error
• func WalkSortedChildren(ctx context.Context, driver storageDriver.StorageDriver, from string, f WalkFn) error
• func WalkWithChildrenFilter(ctx context.Context, driver storageDriver.StorageDriver, from string, ...) error
• type RegistryOption
  • func BlobDescriptorCacheProvider(blobDescriptorCacheProvider cache.BlobDescriptorCacheProvider) RegistryOption
• type Vacuum
  • func NewVacuum(ctx context.Context, driver driver.StorageDriver) Vacuum
  • func (v Vacuum) RemoveBlob(dgst string) error
  • func (v Vacuum) RemoveRepository(repoName string) error
• type WalkChildrenFilter
• type WalkFn

Variables

var ErrFinishedWalk = errors.New("finished walk")

ErrFinishedWalk is used when the called walk function no longer wants to accept any more values. This is used for pagination when the required number of items have been found.

var ErrSkipDir = errors.New("skip this directory")

ErrSkipDir is used as a return value from onFileFunc to indicate that the directory named in the call is to be skipped. It is not returned as an error by any function.

Functions

func DisableDigestResumption

func DisableDigestResumption(registry *registry) error

DisableDigestResumption is a functional option for NewRegistry. It should be used if the registry is acting as a caching proxy.

func EnableDelete

func EnableDelete(registry *registry) error

EnableDelete is a functional option for NewRegistry. It enables deletion on the registry.

func EnableRedirect

func EnableRedirect(registry *registry) error

EnableRedirect is a functional option for NewRegistry. It causes the backend blob server to attempt using (StorageDriver).URLFor to serve all blobs.

func EnumerateAllDigests

func EnumerateAllDigests(ms distribution.ManifestService) error

EnumerateAllDigests causes Enumerate method to include all the digests found without checking whether they exist and belong to manifest revisions or not.

func NewRegistry

func NewRegistry(ctx context.Context, driver storagedriver.StorageDriver, options ...RegistryOption) (distribution.Namespace, error)

NewRegistry creates a new registry instance from the provided driver. The resulting registry may be shared by multiple goroutines but is cheap to allocate. If the Redirect option is specified, the backend blob server will attempt to use (StorageDriver).URLFor to serve all blobs.

func PurgeUploads

func PurgeUploads(ctx context.Context, driver storageDriver.StorageDriver, olderThan time.Time, actuallyDelete bool) ([]string, []error)

PurgeUploads deletes files from the upload directory created before olderThan. The list of files deleted and errors encountered are returned

func RegistryBlobDeleter

func RegistryBlobDeleter(ns distribution.Namespace) (distribution.BlobDeleter, error)

RegistryBlobDeleter returns an instance of BlobDeleter for given registry object.

func RegistryBlobEnumerator

func RegistryBlobEnumerator(ns distribution.Namespace) (distribution.BlobEnumerator, error)

RegistryBlobEnumerator returns an instance of BlobEnumerator for given registry object.

func RemoveParentsOnDelete

func RemoveParentsOnDelete(registry *registry) error

RemoveParentsOnDelete is a functional option for NewRegistry. It causes parent directory of blob's data or link to be deleted as well during Delete. It should be used only with storage drivers providing strong consistency. Must be used together with `EnableDelete`.

func SkipLayerVerification

func SkipLayerVerification(ms distribution.ManifestService) error

SkipLayerVerification allows a manifest to be Put before it's layers are on the filesystem

func Walk

func Walk(ctx context.Context, driver storageDriver.StorageDriver, from string, f WalkFn) error

Walk traverses a filesystem defined within driver, starting from the given path, calling f on each file.

func WalkSortedChildren

func WalkSortedChildren(ctx context.Context, driver storageDriver.StorageDriver, from string, f WalkFn) error

WalkSortedChildren traverses a filesystem defined within driver, starting from the given path, calling f on each file in lexicographical order.

func WalkWithChildrenFilter

func WalkWithChildrenFilter(ctx context.Context, driver storageDriver.StorageDriver, from string, filter WalkChildrenFilter, f WalkFn) error

WalkWithChildrenFilter traverses a filesystem defined within driver, starting from the given path, calling f on each file. Given filter will be called on a list of directory children before being recursively processed.

Types

type RegistryOption

type RegistryOption func(*registry) error

RegistryOption is the type used for functional options for NewRegistry.

func BlobDescriptorCacheProvider

func BlobDescriptorCacheProvider(blobDescriptorCacheProvider cache.BlobDescriptorCacheProvider) RegistryOption

BlobDescriptorCacheProvider returns a functional option for NewRegistry. It creates a cached blob statter for use by the registry.

type Vacuum

type Vacuum struct {
	// contains filtered or unexported fields
}

Vacuum removes content from the filesystem

func NewVacuum

func NewVacuum(ctx context.Context, driver driver.StorageDriver) Vacuum

NewVacuum creates a new Vacuum

func (Vacuum) RemoveBlob

func (v Vacuum) RemoveBlob(dgst string) error

RemoveBlob removes a blob from the filesystem

func (Vacuum) RemoveRepository

func (v Vacuum) RemoveRepository(repoName string) error

RemoveRepository removes a repository directory from the filesystem

type WalkChildrenFilter

type WalkChildrenFilter func([]string) []string

WalkChildrenFilter transforms a list of directory children during a walk before before it's recursively traversed.

type WalkFn

type WalkFn func(fileInfo storageDriver.FileInfo) error

WalkFn is called once per file by Walk If the returned error is ErrSkipDir and fileInfo refers to a directory, the directory will not be entered and Walk will continue the traversal. Otherwise Walk will return