registry

README

pkg/registry

This package implements a Docker v2 registry and the OCI distribution specification.

It is designed to be used anywhere a low dependency container registry is needed, with an initial focus on tests.

Its goal is to be standards compliant and its strictness will increase over time.

This is currently a low flightmiles system. It's likely quite safe to use in tests; If you're using it in production, please let us know how and send us PRs for integration tests.

Before sending a PR, understand that the expectation of this package is that it remain free of extraneous dependencies. This means that we expect pkg/registry to only have dependencies on Go's standard library, and other packages in go-containerregistry.

You may be asked to change your code to reduce dependencies, and your PR might be rejected if this is deemed impossible.

Documentation

Overview

Package registry implements a docker V2 registry and the OCI distribution specification.

It is designed to be used anywhere a low dependency container registry is needed, with an initial focus on tests.

Its goal is to be standards compliant and its strictness will increase over time.

This is currently a low flightmiles system. It's likely quite safe to use in tests; If you're using it in production, please let us know how and send us CL's for integration tests.

Index

• func New(opts ...Option) http.Handler
• func TLS(domain string) (*httptest.Server, error)
• type Option
  • func DiskBlobStorage() Option
  • func Logger(l *log.Logger) Option
  • func MemStorageWithRepoSeparation() Option

Functions

func New

func New(opts ...Option) http.Handler

New returns a handler which implements the docker registry protocol. It should be registered at the site root.

func TLS

func TLS(domain string) (*httptest.Server, error)

TLS returns an httptest server, with an http client that has been configured to send all requests to the returned server. The TLS certs are generated for the given domain which should correspond to the domain the image is stored in. If you need a transport, Client().Transport is correctly configured.

Types

type Option

type Option func(r *registry)

Option describes the available options for creating the registry.

func DiskBlobStorage

func DiskBlobStorage() Option

DiskBlobStorage Save blobs to disk

func Logger

func Logger(l *log.Logger) Option

Logger overrides the logger used to record requests to the registry.

func MemStorageWithRepoSeparation

func MemStorageWithRepoSeparation() Option

MemStorageWithRepoSeparation Save the blobs in memory but separated per repository