registryclient

Documentation

Index

• type Client
  • func New(options ...Option) (Client, error)
  • func NewOrDie(options ...Option) Client
• type Option
  • func WithAllowInsecureRegistry() Option
  • func WithCredentialHelpers(credentialHelpers ...string) Option
  • func WithKeychainPullSecrets(ctx context.Context, lister corev1listers.SecretNamespaceLister, ...) Option
  • func WithLocalKeychain() Option
  • func WithTracing() Option

Types

type Client

type Client interface {
	// Keychain provides the configured credentials
	Keychain() authn.Keychain

	// FetchImageDescriptor fetches Descriptor from registry with given imageRef
	// and provides access to metadata about remote artifact.
	FetchImageDescriptor(context.Context, string) (*gcrremote.Descriptor, error)

	// BuildRemoteOption builds remote.Option based on client.
	BuildRemoteOption(context.Context) remote.Option

	// RefreshKeychainPullSecrets loads fresh data from pull secrets (if non-empty) and updates Keychain.
	RefreshKeychainPullSecrets(ctx context.Context) error
	// contains filtered or unexported methods
}

Client provides registry related objects.

func New

func New(options ...Option) (Client, error)

New creates a new Client with options

func NewOrDie

func NewOrDie(options ...Option) Client

New creates a new Client with options

type Option

type Option = func(*config) error

Option is an option to initialize registry client.

func WithAllowInsecureRegistry

func WithAllowInsecureRegistry() Option

WithKeychainPullSecrets provides initialize registry client option that allows to use insecure registries.

func WithCredentialHelpers

func WithCredentialHelpers(credentialHelpers ...string) Option

WithKeychainPullSecrets provides initialize registry client option that allows to use insecure registries.

func WithKeychainPullSecrets

func WithKeychainPullSecrets(ctx context.Context, lister corev1listers.SecretNamespaceLister, imagePullSecrets ...string) Option

WithKeychainPullSecrets provides initialize registry client option that allows to use pull secrets.

func WithLocalKeychain

func WithLocalKeychain() Option

WithLocalKeychain provides initialize keychain with the default local keychain.

func WithTracing

func WithTracing() Option

WithTracing enables tracing in the http client.