regclient

Documentation

Overview

Package regclient is a legacy package, this has been moved to the top level regclient package

Index

• Constants
• Variables
• type Client
• type ConfigHost
• type ImageOpts
• type Opt
• type RegClient
• type RepoDockerList
• type RepoList
• type RepoOpts
• type TLSConf
• type TagDockerList
• type TagList
• type TagOpts

Constants

const (
	TLSUndefined = config.TLSUndefined
	TLSEnabled   = config.TLSEnabled
	TLSInsecure  = config.TLSInsecure
	TLSDisabled  = config.TLSDisabled
)

const (
	DefaultBlobChunk   = reg.DefaultBlobChunk
	DefaultBlobMax     = reg.DefaultBlobMax
	DefaultRetryLimit  = reghttp.DefaultRetryLimit
	DefaultUserAgent   = rcTop.DefaultUserAgent
	DockerCertDir      = rcTop.DockerCertDir
	DockerRegistry     = config.DockerRegistry
	DockerRegistryAuth = config.DockerRegistryAuth
	DockerRegistryDNS  = config.DockerRegistryDNS
)

Variables

var (
	ErrAPINotFound = types.ErrAPINotFound
	ErrCanceled    = types.ErrCanceled
	//lint:ignore ST1003 exported field cannot be changed for legacy reasons
	ErrHttpStatus               = types.ErrHTTPStatus
	ErrMissingDigest            = types.ErrMissingDigest
	ErrMissingLocation          = types.ErrMissingLocation
	ErrMissingName              = types.ErrMissingName
	ErrMissingTag               = types.ErrMissingTag
	ErrMissingTagOrDigest       = types.ErrMissingTagOrDigest
	ErrMountReturnedLocation    = types.ErrMountReturnedLocation
	ErrNotFound                 = types.ErrNotFound
	ErrNotImplemented           = types.ErrNotImplemented
	ErrParsingFailed            = types.ErrParsingFailed
	ErrRateLimit                = types.ErrRateLimit
	ErrUnavailable              = types.ErrUnavailable
	ErrUnauthorized             = types.ErrUnauthorized
	ErrUnsupportedAPI           = types.ErrUnsupportedAPI
	ErrUnsupportedConfigVersion = types.ErrUnsupportedConfigVersion
	ErrUnsupportedMediaType     = types.ErrUnsupportedMediaType
)

var (
	MediaTypeDocker1Manifest       = types.MediaTypeDocker1Manifest
	MediaTypeDocker1ManifestSigned = types.MediaTypeDocker1ManifestSigned
	MediaTypeDocker2Manifest       = types.MediaTypeDocker2Manifest
	MediaTypeDocker2ManifestList   = types.MediaTypeDocker2ManifestList
	MediaTypeDocker2ImageConfig    = types.MediaTypeDocker2ImageConfig
	MediaTypeOCI1Manifest          = types.MediaTypeOCI1Manifest
	MediaTypeOCI1ManifestList      = types.MediaTypeOCI1ManifestList
	MediaTypeOCI1ImageConfig       = types.MediaTypeOCI1ImageConfig
	MediaTypeDocker2Layer          = types.MediaTypeDocker2Layer
	MediaTypeOCI1Layer             = types.MediaTypeOCI1Layer
	MediaTypeOCI1LayerGzip         = types.MediaTypeOCI1LayerGzip
	MediaTypeBuildkitCacheConfig   = types.MediaTypeBuildkitCacheConfig
)

var (
	NewRegClient            = rcTop.New
	WithCertDir             = rcTop.WithCertDir
	WithDockerCerts         = rcTop.WithDockerCerts
	WithDockerCreds         = rcTop.WithDockerCreds
	WithConfigHosts         = rcTop.WithConfigHosts
	WithConfigHost          = rcTop.WithConfigHost
	WithBlobSize            = rcTop.WithBlobSize
	WithLog                 = rcTop.WithLog
	WithRetryDelay          = rcTop.WithRetryDelay
	WithRetryLimit          = rcTop.WithRetryLimit
	WithUserAgent           = rcTop.WithUserAgent
	ImageWithForceRecursive = rcTop.ImageWithForceRecursive
	ImageWithDigestTags     = rcTop.ImageWithDigestTags
	ImageWithPlatforms      = rcTop.ImageWithPlatforms
	WithRepoLast            = scheme.WithRepoLast
	WithRepoLimit           = scheme.WithRepoLimit
	TagOptLast              = scheme.WithTagLast
	TagOptLimit             = scheme.WithTagLimit
)

var ConfigHostNewName = config.HostNewName

var TemplateFuncs = gotemplate.FuncMap{}

var (
	// VCSRef is injected from a build flag, used to version the UserAgent header
	VCSRef = "unknown"
)

Types

type Client

type Client = *rcTop.RegClient

type ConfigHost

type ConfigHost = config.Host

type ImageOpts

type ImageOpts = rcTop.ImageOpts

type Opt

type Opt = rcTop.Opt

type RegClient

type RegClient = *rcTop.RegClient

type RepoDockerList

type RepoDockerList = repo.RepoRegistryList

type RepoList

type RepoList = *repo.RepoList

type RepoOpts

type RepoOpts = scheme.RepoOpts // RepoOpts is a breaking change (struct to func opts)

type TLSConf

type TLSConf = config.TLSConf

type TagDockerList

type TagDockerList = tag.DockerList

type TagList

type TagList = *tag.List

type TagOpts

type TagOpts = scheme.TagOpts