registry

Documentation

Index

• Variables
• func Log(format string, args ...interface{})
• func Quiet(format string, args ...interface{})
• type BasicTransport
  • func (t *BasicTransport) RoundTrip(req *http.Request) (*http.Response, error)
• type CustomTransport
  • func (t *CustomTransport) RoundTrip(request *http.Request) (*http.Response, error)
• type ErrorTransport
  • func (t *ErrorTransport) RoundTrip(request *http.Request) (*http.Response, error)
• type Image
  • func ParseImage(image string) (Image, error)
  • func (i Image) Reference() string
  • func (i Image) String() string
  • func (i *Image) WithDigest(digest digest.Digest) (err error)
• type LogfCallback
• type Opt
• type Registry
  • func New(ctx context.Context, auth types.AuthConfig, opt Opt) (*Registry, error)
  • func (registry *Registry) Catalog(ctx context.Context, u string) ([]string, error)
  • func (registry *Registry) Delete(ctx context.Context, repository string, digest digest.Digest) (err error)
  • func (registry *Registry) Digest(ctx context.Context, image Image) (digest.Digest, error)
  • func (registry *Registry) DownloadLayer(ctx context.Context, repository string, digest digest.Digest) (io.ReadCloser, error)
  • func (registry *Registry) HasLayer(ctx context.Context, repository string, digest digest.Digest) (bool, error)
  • func (registry *Registry) Headers(ctx context.Context, uri string) (map[string]string, error)
  • func (registry *Registry) LayerMetadata(repository string, digest digest.Digest) (distribution.Descriptor, error)
  • func (registry *Registry) Manifest(ctx context.Context, repository, ref string) (distribution.Manifest, error)
  • func (registry *Registry) ManifestList(ctx context.Context, repository, ref string) (manifestlist.ManifestList, error)
  • func (registry *Registry) ManifestV1(ctx context.Context, repository, ref string) (schema1.SignedManifest, error)
  • func (registry *Registry) ManifestV2(ctx context.Context, repository, ref string) (schema2.Manifest, error)
  • func (registry *Registry) Ping(ctx context.Context) error
  • func (registry *Registry) Pingable() bool
  • func (registry *Registry) PutManifest(ctx context.Context, repository, ref string, manifest distribution.Manifest) error
  • func (registry *Registry) Tags(ctx context.Context, repository string) ([]string, error)
  • func (registry *Registry) Token(ctx context.Context, url string) (string, error)
  • func (registry *Registry) UploadLayer(ctx context.Context, repository string, digest reference.Reference, ...) error
• type TokenTransport
  • func (t *TokenTransport) RoundTrip(req *http.Request) (*http.Response, error)

Variables

var (

	// ErrBasicAuth indicates that the repository requires basic rather than token authentication.
	ErrBasicAuth = errors.New("basic auth required")
)

var (
	// ErrUnexpectedSchemaVersion a specific schema version was requested, but was not returned
	ErrUnexpectedSchemaVersion = errors.New("recieved a different schema version than expected")
)

Functions

func Log

func Log(format string, args ...interface{})

Log passes log messages to the logging package.

func Quiet

func Quiet(format string, args ...interface{})

Quiet discards logs silently.

Types

type BasicTransport

type BasicTransport struct {
	Transport http.RoundTripper
	URL       string
	Username  string
	Password  string
}

BasicTransport defines the data structure for authentication via basic auth.

func (*BasicTransport) RoundTrip

func (t *BasicTransport) RoundTrip(req *http.Request) (*http.Response, error)

RoundTrip defines the round tripper for basic auth transport.

type CustomTransport

type CustomTransport struct {
	Transport http.RoundTripper
	Headers   map[string]string
}

CustomTransport defines the data structure for custom http.Request options.

func (*CustomTransport) RoundTrip

func (t *CustomTransport) RoundTrip(request *http.Request) (*http.Response, error)

RoundTrip defines the round tripper for the error transport.

type ErrorTransport

type ErrorTransport struct {
	Transport http.RoundTripper
}

ErrorTransport defines the data structure for returning errors from the round tripper.

func (*ErrorTransport) RoundTrip

func (t *ErrorTransport) RoundTrip(request *http.Request) (*http.Response, error)

RoundTrip defines the round tripper for the error transport.

type Image

type Image struct {
	Domain string
	Path   string
	Tag    string
	Digest digest.Digest
	// contains filtered or unexported fields
}

Image holds information about an image.

func ParseImage

func ParseImage(image string) (Image, error)

ParseImage returns an Image struct with all the values filled in for a given image.

func (Image) Reference

func (i Image) Reference() string

Reference returns either the digest if it is non-empty or the tag for the image.

func (Image) String

func (i Image) String() string

String returns the string representation of an image.

func (*Image) WithDigest

func (i *Image) WithDigest(digest digest.Digest) (err error)

WithDigest sets the digest for an image.

type LogfCallback

type LogfCallback func(format string, args ...interface{})

LogfCallback is the callback for formatting logs.

type Opt

type Opt struct {
	Domain   string
	Insecure bool
	Debug    bool
	SkipPing bool
	NonSSL   bool
	Timeout  time.Duration
	Headers  map[string]string
}

Opt holds the options for a new registry.

type Registry

type Registry struct {
	URL      string
	Domain   string
	Username string
	Password string
	Client   *http.Client
	Logf     LogfCallback
	Opt      Opt
}

Registry defines the client for retrieving information from the registry API.

func New

func New(ctx context.Context, auth types.AuthConfig, opt Opt) (*Registry, error)

New creates a new Registry struct with the given URL and credentials.

func (*Registry) Catalog

func (registry *Registry) Catalog(ctx context.Context, u string) ([]string, error)

Catalog returns the repositories in a registry.

func (*Registry) Delete

func (registry *Registry) Delete(ctx context.Context, repository string, digest digest.Digest) (err error)

Delete removes a repository digest from the registry. https://docs.docker.com/registry/spec/api/#deleting-an-image

func (*Registry) Digest

func (registry *Registry) Digest(ctx context.Context, image Image) (digest.Digest, error)

Digest returns the digest for an image.

func (*Registry) DownloadLayer

func (registry *Registry) DownloadLayer(ctx context.Context, repository string, digest digest.Digest) (io.ReadCloser, error)

DownloadLayer downloads a specific layer by digest for a repository.

func (*Registry) HasLayer

func (registry *Registry) HasLayer(ctx context.Context, repository string, digest digest.Digest) (bool, error)

HasLayer returns if the registry contains the specific digest for a repository.

func (*Registry) Headers

func (registry *Registry) Headers(ctx context.Context, uri string) (map[string]string, error)

Headers returns the authorization headers for a specific uri.

func (*Registry) LayerMetadata

func (registry *Registry) LayerMetadata(repository string, digest digest.Digest) (distribution.Descriptor, error)

func (*Registry) Manifest

func (registry *Registry) Manifest(ctx context.Context, repository, ref string) (distribution.Manifest, error)

Manifest returns the manifest for a specific repository:tag.

func (*Registry) ManifestList

func (registry *Registry) ManifestList(ctx context.Context, repository, ref string) (manifestlist.ManifestList, error)

ManifestList gets the registry v2 manifest list.

func (*Registry) ManifestV1

func (registry *Registry) ManifestV1(ctx context.Context, repository, ref string) (schema1.SignedManifest, error)

ManifestV1 gets the registry v1 manifest.

func (*Registry) ManifestV2

func (registry *Registry) ManifestV2(ctx context.Context, repository, ref string) (schema2.Manifest, error)

ManifestV2 gets the registry v2 manifest.

func (*Registry) Ping

func (registry *Registry) Ping(ctx context.Context) error

Ping tries to contact a registry URL to make sure it is up and accessible.

func (*Registry) Pingable

func (registry *Registry) Pingable() bool

Pingable checks pingable

func (*Registry) PutManifest

func (registry *Registry) PutManifest(ctx context.Context, repository, ref string, manifest distribution.Manifest) error

PutManifest calls a PUT for the specific manifest for an image.

func (*Registry) Tags

func (registry *Registry) Tags(ctx context.Context, repository string) ([]string, error)

Tags returns the tags for a specific repository.

func (*Registry) Token

func (registry *Registry) Token(ctx context.Context, url string) (string, error)

Token returns the required token for the specific resource url. If the registry requires basic authentication, this function returns ErrBasicAuth.

func (*Registry) UploadLayer

func (registry *Registry) UploadLayer(ctx context.Context, repository string, digest reference.Reference, content io.Reader) error

UploadLayer uploads a specific layer by digest for a repository.

type TokenTransport

type TokenTransport struct {
	Transport http.RoundTripper
	Username  string
	Password  string
}

TokenTransport defines the data structure for authentication via tokens.

func (*TokenTransport) RoundTrip

func (t *TokenTransport) RoundTrip(req *http.Request) (*http.Response, error)

RoundTrip defines the round tripper for token transport.