registry

package
v1.4.2-0...-58121c5 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Aug 4, 2015 License: Apache-2.0 Imports: 41 Imported by: 0

Documentation

Overview

Package registry contains client primitives to interact with a remote Docker registry.

Index

Constants

View Source 
const (
	// DefaultNamespace is the default namespace
	DefaultNamespace = "docker.io"
	// DefaultRegistryVersionHeader is the name of the default HTTP header
	// that carries Registry version info
	DefaultRegistryVersionHeader = "Docker-Distribution-Api-Version"
	// DefaultV1Registry is the URI of the default v1 registry
	DefaultV1Registry = "https://index.docker.io"

	// CertsDir is the directory where certificates are stored
	CertsDir = "/etc/docker/certs.d"

	// IndexServer is the v1 registry server used for user auth + account creation
	IndexServer = DefaultV1Registry + "/v1/"
	// IndexName is the name of the index
	IndexName = "docker.io"

	// NotaryServer is the endpoint serving the Notary trust server
	NotaryServer = "https://notary.docker.io"
)
View Source 
const (
	APIVersionUnknown = iota
	APIVersion1
	APIVersion2
)

API Version identifiers.

View Source 
const DefaultV2Registry = "https://registry-1.docker.io"

DefaultV2Registry is the URI of the default v2 registry

Variables

View Source 
var (
	// ErrAlreadyExists is an error returned if an image being pushed
	// already exists on the remote side
	ErrAlreadyExists = errors.New("Image already exists")
)
View Source 
var (
	// ErrInvalidRepositoryName is an error returned if the repository name did
	// not have the correct form
	ErrInvalidRepositoryName = errors.New("Invalid repository name (ex: \"registry.domain.tld/myrepos\")")
)
View Source 
var (
	// ErrRepoNotFound is returned if the repository didn't exist on the
	// remote side
	ErrRepoNotFound = errors.New("Repository not found")
)

Functions

func AuthTransport 

func AuthTransport(base http.RoundTripper, authConfig *cliconfig.AuthConfig, alwaysSetBasicAuth bool) http.RoundTripper

AuthTransport handles the auth layer when communicating with a v1 registry (private or official)

For private v1 registries, set alwaysSetBasicAuth to true.

For the official v1 registry, if there isn't already an Authorization header in the request, but there is an X-Docker-Token header set to true, then Basic Auth will be used to set the Authorization header. After sending the request with the provided base http.RoundTripper, if an X-Docker-Token header, representing a token, is present in the response, then it gets cached and sent in the Authorization header of all subsequent requests.

If the server sends a token without the client having requested it, it is ignored.

This RoundTripper also has a CancelRequest method important for correct timeout handling.

func ContinueOnError 

func ContinueOnError(err error) bool

ContinueOnError returns true if we should fallback to the next endpoint as a result of this error.

func DockerHeaders 

func DockerHeaders(metaHeaders http.Header) []transport.RequestModifier

DockerHeaders returns request modifiers that ensure requests have the User-Agent header set to dockerUserAgent and that metaHeaders are added.

func HTTPClient 

func HTTPClient(transport http.RoundTripper) *http.Client

HTTPClient returns a HTTP client structure which uses the given transport and contains the necessary headers for redirected requests

func Login 

func Login(authConfig *cliconfig.AuthConfig, registryEndpoint *Endpoint) (string, error)

Login tries to register/login to the registry server.

func NewTransport 

func NewTransport(tlsConfig *tls.Config) *http.Transport

NewTransport returns a new HTTP transport. If tlsConfig is nil, it uses the default TLS configuration.

func NormalizeLocalName 

func NormalizeLocalName(name string) string

NormalizeLocalName transforms a repository name into a normalize LocalName Passes through the name without transformation on error (image id, etc)

func ReadCertsDirectory 

func ReadCertsDirectory(tlsConfig *tls.Config, directory string) error

ReadCertsDirectory reads the directory for TLS certificates including roots and certificate pairs and updates the provided TLS configuration.

func ResolveAuthConfig 

func ResolveAuthConfig(config *cliconfig.ConfigFile, index *IndexInfo) cliconfig.AuthConfig

ResolveAuthConfig matches an auth configuration to a server address or a URL

func ValidateIndexName 

func ValidateIndexName(val string) (string, error)

ValidateIndexName validates an index name.

func ValidateMirror 

func ValidateMirror(val string) (string, error)

ValidateMirror validates an HTTP(S) registry mirror

func ValidateRepositoryName 

func ValidateRepositoryName(reposName string) error

ValidateRepositoryName validates a repository name

Types

type APIEndpoint 

type APIEndpoint struct {
	Mirror        bool
	URL           string
	Version       APIVersion
	Official      bool
	TrimHostname  bool
	TLSConfig     *tls.Config
	VersionHeader string
	Versions      []auth.APIVersion
}

APIEndpoint represents a remote API endpoint

func (APIEndpoint) ToV1Endpoint 

func (e APIEndpoint) ToV1Endpoint(metaHeaders http.Header) (*Endpoint, error)

ToV1Endpoint returns a V1 API endpoint based on the APIEndpoint

type APIVersion 

type APIVersion int

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

func (APIVersion) String 

func (av APIVersion) String() string

type AuthorizationChallenge 

type AuthorizationChallenge struct {
	Scheme     string
	Parameters map[string]string
}

AuthorizationChallenge carries information from a WWW-Authenticate response header.

type Endpoint 

type Endpoint struct {
	URL            *url.URL
	Version        APIVersion
	IsSecure       bool
	AuthChallenges []*AuthorizationChallenge
	URLBuilder     *v2.URLBuilder
	// contains filtered or unexported fields
}

Endpoint stores basic information about a registry endpoint.

func NewEndpoint 

func NewEndpoint(index *IndexInfo, metaHeaders http.Header) (*Endpoint, error)

NewEndpoint parses the given address to return a registry endpoint.

func (*Endpoint) Path 

func (e *Endpoint) Path(path string) string

Path returns a formatted string for the URL of this endpoint with the given path appended.

func (*Endpoint) Ping 

func (e *Endpoint) Ping() (PingResult, error)

Ping pings the remote endpoint with v2 and v1 pings to determine the API version. It returns a PingResult containing the discovered version. The PingResult also indicates whether the registry is standalone or not.

func (*Endpoint) String 

func (e *Endpoint) String() string

Get the formated URL for the root of this registry Endpoint

func (*Endpoint) VersionString 

func (e *Endpoint) VersionString(version APIVersion) string

VersionString returns a formatted string of this endpoint address using the given API Version.

type ErrNoSupport 

type ErrNoSupport struct{ Err error }

ErrNoSupport is an error type used for errors indicating that an operation is not supported. It encapsulates a more specific error.

func (ErrNoSupport) Error 

func (e ErrNoSupport) Error() string

type ImgData 

type ImgData struct {
	// ID is an opaque string that identifies the image
	ID              string `json:"id"`
	Checksum        string `json:"checksum,omitempty"`
	ChecksumPayload string `json:"-"`
	Tag             string `json:",omitempty"`
}

ImgData is used to transfer image checksums to and from the registry

type IndexInfo 

type IndexInfo struct {
	// Name is the name of the registry, such as "docker.io"
	Name string
	// Mirrors is a list of mirrors, expressed as URIs
	Mirrors []string
	// Secure is set to false if the registry is part of the list of
	// insecure registries. Insecure registries accept HTTP and/or accept
	// HTTPS with certificates from unknown CAs.
	Secure bool
	// Official indicates whether this is an official registry
	Official bool
}

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,
}

func (*IndexInfo) GetAuthConfigKey 

func (index *IndexInfo) GetAuthConfigKey() string

GetAuthConfigKey special-cases using the full index address of the official index as the AuthConfig key, and uses the (host)name[:port] for private indexes.

type Options 

type Options struct {
	Mirrors            opts.ListOpts
	InsecureRegistries opts.ListOpts
}

Options holds command line options.

func (*Options) InstallFlags 

func (options *Options) InstallFlags(cmd *flag.FlagSet, usageFn func(string) string)

InstallFlags adds command-line options to the top-level flag parser for the current process.

type PingResult 

type PingResult struct {
	// Version is the registry version supplied by the registry in a HTTP
	// header
	Version string `json:"version"`
	// Standalone is set to true if the registry indicates it is a
	// standalone registry in the X-Docker-Registry-Standalone
	// header
	Standalone bool `json:"standalone"`
}

PingResult contains the information returned when pinging a registry. It indicates the registry's version and whether the registry claims to be a standalone registry.

type Reference 

type Reference interface {
	// HasDigest returns whether the reference has a verifiable
	// content addressable reference which may be considered secure.
	HasDigest() bool

	// ImageName returns an image name for the given repository
	ImageName(string) string

	// Returns a string representation of the reference
	String() string
}

Reference represents a tag or digest within a repository

func DigestReference 

func DigestReference(dgst digest.Digest) Reference

DigestReference creates a digest reference using a digest

func ParseReference 

func ParseReference(ref string) Reference

ParseReference parses a reference into either a digest or tag reference

type RepositoryData 

type RepositoryData struct {
	// ImgList is a list of images in the repository
	ImgList map[string]*ImgData
	// Endpoints is a list of endpoints returned in X-Docker-Endpoints
	Endpoints []string
	// Tokens is currently unused (remove it?)
	Tokens []string
}

RepositoryData tracks the image list, list of endpoints, and list of tokens for a repository

type RepositoryInfo 

type RepositoryInfo struct {
	// Index points to registry information
	Index *IndexInfo
	// RemoteName is the remote name of the repository, such as
	// "library/ubuntu-12.04-base"
	RemoteName string
	// LocalName is the local name of the repository, such as
	// "ubuntu-12.04-base"
	LocalName string
	// CanonicalName is the canonical name of the repository, such as
	// "docker.io/library/ubuntu-12.04-base"
	CanonicalName string
	// Official indicates whether the repository is considered official.
	// If the registry is official, and the normalized name does not
	// contain a '/' (e.g. "foo"), then it is considered an official repo.
	Official bool
}

RepositoryInfo describes a repository

func ParseRepositoryInfo 

func ParseRepositoryInfo(reposName string) (*RepositoryInfo, error)

ParseRepositoryInfo performs the breakdown of a repository name into a RepositoryInfo, but lacks registry configuration.

func (*RepositoryInfo) GetEndpoint 

func (repoInfo *RepositoryInfo) GetEndpoint(metaHeaders http.Header) (*Endpoint, error)

GetEndpoint returns a new endpoint with the specified headers

func (*RepositoryInfo) GetSearchTerm 

func (repoInfo *RepositoryInfo) GetSearchTerm() string

GetSearchTerm special-cases using local name for official index, and remote name for private indexes.

type SearchResult 

type SearchResult struct {
	// StarCount indicates the number of stars this repository has
	StarCount int `json:"star_count"`
	// IsOfficial indicates whether the result is an official repository or not
	IsOfficial bool `json:"is_official"`
	// Name is the name of the repository
	Name string `json:"name"`
	// IsOfficial indicates whether the result is trusted
	IsTrusted bool `json:"is_trusted"`
	// IsAutomated indicates whether the result is automated
	IsAutomated bool `json:"is_automated"`
	// Description is a textual description of the repository
	Description string `json:"description"`
}

SearchResult describes a search result returned from a registry

type SearchResults 

type SearchResults struct {
	// Query contains the query string that generated the search results
	Query string `json:"query"`
	// NumResults indicates the number of results the query returned
	NumResults int `json:"num_results"`
	// Results is a slice containing the acutal results for the search
	Results []SearchResult `json:"results"`
}

SearchResults lists a collection search results returned from a registry

type Service 

type Service struct {
	Config *ServiceConfig
}

Service is a registry service. It tracks configuration data such as a list of mirrors.

func NewService 

func NewService(options *Options) *Service

NewService returns a new instance of Service ready to be installed into an engine.

func (*Service) Auth 

func (s *Service) Auth(authConfig *cliconfig.AuthConfig) (string, error)

Auth contacts the public registry with the provided credentials, and returns OK if authentication was sucessful. It can be used to verify the validity of a client's credentials.

func (*Service) LookupEndpoints 

func (s *Service) LookupEndpoints(repoName string) (endpoints []APIEndpoint, err error)

LookupEndpoints creates an list of endpoints to try, in order of preference. It gives preference to v2 endpoints over v1, mirrors over the actual registry, and HTTPS over plain HTTP.

func (*Service) ResolveIndex 

func (s *Service) ResolveIndex(name string) (*IndexInfo, error)

ResolveIndex takes indexName and returns index info

func (*Service) ResolveRepository 

func (s *Service) ResolveRepository(name string) (*RepositoryInfo, error)

ResolveRepository splits a repository name into its components and configuration of the associated registry.

func (*Service) Search 

func (s *Service) Search(term string, authConfig *cliconfig.AuthConfig, headers map[string][]string) (*SearchResults, error)

Search queries the public registry for images matching the specified search terms, and returns the results.

func (*Service) TLSConfig 

func (s *Service) TLSConfig(hostname string) (*tls.Config, error)

TLSConfig constructs a client TLS configuration based on server defaults

type ServiceConfig 

type ServiceConfig struct {
	InsecureRegistryCIDRs []*netIPNet           `json:"InsecureRegistryCIDRs"`
	IndexConfigs          map[string]*IndexInfo `json:"IndexConfigs"`
	Mirrors               []string
}

ServiceConfig stores daemon registry services configuration.

func NewServiceConfig 

func NewServiceConfig(options *Options) *ServiceConfig

NewServiceConfig returns a new instance of ServiceConfig

func (*ServiceConfig) NewIndexInfo 

func (config *ServiceConfig) NewIndexInfo(indexName string) (*IndexInfo, error)

NewIndexInfo returns IndexInfo configuration from indexName

func (*ServiceConfig) NewRepositoryInfo 

func (config *ServiceConfig) NewRepositoryInfo(reposName string) (*RepositoryInfo, error)

NewRepositoryInfo validates and breaks down a repository name into a RepositoryInfo

type Session 

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

A Session is used to communicate with a V1 registry

func NewSession 

func NewSession(client *http.Client, authConfig *cliconfig.AuthConfig, endpoint *Endpoint) (r *Session, err error)

NewSession creates a new session TODO(tiborvass): remove authConfig param once registry client v2 is vendored

func (*Session) GetAuthConfig 

func (r *Session) GetAuthConfig(withPasswd bool) *cliconfig.AuthConfig

GetAuthConfig returns the authentication settings for a session TODO(tiborvass): remove this once registry client v2 is vendored

func (*Session) GetRemoteHistory 

func (r *Session) GetRemoteHistory(imgID, registry string) ([]string, error)

GetRemoteHistory retrieves the history of a given image from the registry. It returns a list of the parent's JSON files (including the requested image).

func (*Session) GetRemoteImageJSON 

func (r *Session) GetRemoteImageJSON(imgID, registry string) ([]byte, int, error)

GetRemoteImageJSON retrieves an image's JSON metadata from the registry.

func (*Session) GetRemoteImageLayer 

func (r *Session) GetRemoteImageLayer(imgID, registry string, imgSize int64) (io.ReadCloser, error)

GetRemoteImageLayer retrieves an image layer from the registry

func (*Session) GetRemoteTag 

func (r *Session) GetRemoteTag(registries []string, repository string, askedTag string) (string, error)

GetRemoteTag retrieves the tag named in the askedTag argument from the given repository. It queries each of the registries supplied in the registries argument, and returns data from the first one that answers the query successfully.

func (*Session) GetRemoteTags 

func (r *Session) GetRemoteTags(registries []string, repository string) (map[string]string, error)

GetRemoteTags retrieves all tags from the given repository. It queries each of the registries supplied in the registries argument, and returns data from the first one that answers the query successfully. It returns a map with tag names as the keys and image IDs as the values.

func (*Session) GetRepositoryData 

func (r *Session) GetRepositoryData(remote string) (*RepositoryData, error)

GetRepositoryData returns lists of images and endpoints for the repository

func (*Session) ID 

func (r *Session) ID() string

ID returns this registry session's ID.

func (*Session) LookupRemoteImage 

func (r *Session) LookupRemoteImage(imgID, registry string) error

LookupRemoteImage checks if an image exists in the registry

func (*Session) PushImageChecksumRegistry 

func (r *Session) PushImageChecksumRegistry(imgData *ImgData, registry string) error

PushImageChecksumRegistry uploads checksums for an image

func (*Session) PushImageJSONIndex 

func (r *Session) PushImageJSONIndex(remote string, imgList []*ImgData, validate bool, regs []string) (*RepositoryData, error)

PushImageJSONIndex uploads an image list to the repository

func (*Session) PushImageJSONRegistry 

func (r *Session) PushImageJSONRegistry(imgData *ImgData, jsonRaw []byte, registry string) error

PushImageJSONRegistry pushes JSON metadata for a local image to the registry

func (*Session) PushImageLayerRegistry 

func (r *Session) PushImageLayerRegistry(imgID string, layer io.Reader, registry string, jsonRaw []byte) (checksum string, checksumPayload string, err error)

PushImageLayerRegistry sends the checksum of an image layer to the registry

func (*Session) PushRegistryTag 

func (r *Session) PushRegistryTag(remote, revision, tag, registry string) error

PushRegistryTag pushes a tag on the registry. Remote has the format '<user>/<repo>

func (*Session) SearchRepositories 

func (r *Session) SearchRepositories(term string) (*SearchResults, error)

SearchRepositories performs a search against the remote repository

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.