package
1.9.0
Repository: https://github.com/alexandrev/docker.git
Documentation: pkg.go.dev

# Functions

AuthTransport handles the auth layer when communicating with a v1 registry (private or official) For private v1 registries, set alwaysSetBasicAuth to true.
ContinueOnError returns true if we should fallback to the next endpoint as a result of this error.
DigestReference creates a digest reference using a digest.
DockerHeaders returns request modifiers that ensure requests have the User-Agent header set to dockerUserAgent and that metaHeaders are added.
HTTPClient returns a HTTP client structure which uses the given transport and contains the necessary headers for redirected requests.
Login tries to register/login to the registry server.
NewEndpoint parses the given address to return a registry endpoint.
NewService returns a new instance of Service ready to be installed into an engine.
NewServiceConfig returns a new instance of ServiceConfig.
NewSession creates a new session TODO(tiborvass): remove authConfig param once registry client v2 is vendored.
NewTransport returns a new HTTP transport.
NormalizeLocalName transforms a repository name into a normalize LocalName Passes through the name without transformation on error (image id, etc).
ParseIndexInfo will use repository name to get back an indexInfo.
ParseReference parses a reference into either a digest or tag reference.
ParseRepositoryInfo performs the breakdown of a repository name into a RepositoryInfo, but lacks registry configuration.
ReadCertsDirectory reads the directory for TLS certificates including roots and certificate pairs and updates the provided TLS configuration.
ResolveAuthConfig matches an auth configuration to a server address or a URL.
ValidateIndexName validates an index name.
ValidateMirror validates an HTTP(S) registry mirror.
ValidateRepositoryName validates a repository name.

# Constants

API Version identifiers.
API Version identifiers.
API Version identifiers.
CertsDir is the directory where certificates are stored.
DefaultNamespace is the default namespace.
DefaultRegistryVersionHeader is the name of the default HTTP header that carries Registry version info.
DefaultV1Registry is the URI of the default v1 registry.
DefaultV2Registry is the URI of the default v2 registry.
IndexName is the name of the index.
IndexServer is the v1 registry server used for user auth + account creation.
NotaryServer is the endpoint serving the Notary trust server.

# Variables

ErrAlreadyExists is an error returned if an image being pushed already exists on the remote side.
ErrInvalidRepositoryName is an error returned if the repository name did not have the correct form.
ErrRepoNotFound is returned if the repository didn't exist on the remote side.
V2Only controls access to legacy registries.

# Structs

APIEndpoint represents a remote API endpoint.
AuthorizationChallenge carries information from a WWW-Authenticate response header.
Endpoint stores basic information about a registry endpoint.
ErrNoSupport is an error type used for errors indicating that an operation is not supported.
ImgData is used to transfer image checksums to and from the registry.
IndexInfo contains information about a registry RepositoryInfo Examples: { "Index" : { "Name" : "docker.io", "Mirrors" : ["https://registry-2.docker.io/v1/", "https://registry-3.docker.io/v1/"], "Secure" : true, "Official" : true, }, "RemoteName" : "library/debian", "LocalName" : "debian", "CanonicalName" : "docker.io/debian" "Official" : true, } { "Index" : { "Name" : "127.0.0.1:5000", "Mirrors" : [], "Secure" : false, "Official" : false, }, "RemoteName" : "user/repo", "LocalName" : "127.0.0.1:5000/user/repo", "CanonicalName" : "127.0.0.1:5000/user/repo", "Official" : false, }.
Options holds command line options.
PingResult contains the information returned when pinging a registry.
RepositoryData tracks the image list, list of endpoints, and list of tokens for a repository.
RepositoryInfo describes a repository.
SearchResult describes a search result returned from a registry.
SearchResults lists a collection search results returned from a registry.
Service is a registry service.
ServiceConfig stores daemon registry services configuration.
A Session is used to communicate with a V1 registry.

# Interfaces

Reference represents a tag or digest within a repository.

# Type aliases

APIVersion is an integral representation of an API version (presently either 1 or 2).