Documentation
¶
Index ¶
- Variables
- type BasicTransport
- type CustomTransport
- type ErrorTransport
- type Image
- type Info
- type Opt
- type Registry
- func (r *Registry) Catalog(ctx context.Context, u string) ([]string, error)
- func (r *Registry) Delete(ctx context.Context, repository string, ref string) (err error)
- func (r *Registry) GetImage(ctx context.Context, repo string, ref string) (*oci.Image, error)
- func (r *Registry) GetInfo(ctx context.Context, repo string, ref string) (*Info, error)
- func (r *Registry) GetInfoAll(ctx context.Context, repo string, ref string, arches []string, oses []string) ([]*Info, error)
- func (r *Registry) Headers(ctx context.Context, uri string) (map[string]string, error)
- func (r *Registry) Tags(ctx context.Context, repository string) ([]string, error)
- func (r *Registry) Token(ctx context.Context, url string) (string, error)
- type TokenTransport
Constants ¶
This section is empty.
Variables ¶
var ( // ErrBasicAuth indicates that the repository requires basic rather than token authentication. ErrBasicAuth = errors.New("basic auth required") )
Functions ¶
This section is empty.
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.
type CustomTransport ¶
type CustomTransport struct {
Transport http.RoundTripper
Headers map[string]string
}
CustomTransport defines the data structure for custom http.Request options.
type ErrorTransport ¶
type ErrorTransport struct {
Transport http.RoundTripper
}
ErrorTransport defines the data structure for returning errors from the round tripper.
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 ¶
ParseImage returns an Image struct with all the values filled in for a given image.
func (Image) Reference ¶
Reference returns either the digest if it is non-empty or the tag for the image.
type Info ¶
type Info struct {
Image *oci.Image
Platform *oci.Platform
Digest string
DigestAll string
ID string
Repo string
Ref string
Size int64
}
Info type for interesting information
type Opt ¶
type Opt struct {
Domain string
CAFile string
CertFile string
KeyFile string
Passphrase string
Insecure bool
Debug bool
Digests 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
Passphrase string
Client *http.Client
Opt Opt
// contains filtered or unexported fields
}
Registry defines the client for retrieving information from the registry API.
func (*Registry) Delete ¶
Delete removes a repository digest from the registry. https://docs.docker.com/registry/spec/api/#deleting-an-image https://github.com/opencontainers/distribution-spec/blob/main/spec.md#deleting-tags
func (*Registry) GetInfoAll ¶
func (r *Registry) GetInfoAll(ctx context.Context, repo string, ref string, arches []string, oses []string) ([]*Info, error)
GetInfoAll from fat manifests and then each manifest
type TokenTransport ¶
type TokenTransport struct {
Transport http.RoundTripper
Username string
Password string
}
TokenTransport defines the data structure for authentication via tokens.
Source Files