registryclient

Documentation

Index

• Variables
• func BuildRemoteOption(c Client) remote.Option
• type Client
  • func InitClient(options ...Option) (Client, error)
• type Option
  • func WithAllowInsecureRegistry() Option
  • func WithKeychainPullSecrets(kubClient kubernetes.Interface, namespace, serviceAccount string, ...) Option

Variables

var DefaultClient, _ = InitClient()

DefaultClient is default registry client.

Functions

func BuildRemoteOption

func BuildRemoteOption(c Client) remote.Option

BuildRemoteOption builds remote.Option based on client.

Types

type Client

type Client interface {
	// Keychain provides keychain object.
	Keychain() authn.Keychain

	// Transport provides transport object.
	Transport() *http.Transport

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

	// UseLocalKeychain updates keychain with the default local keychain.
	UseLocalKeychain()

	// RefreshKeychainPullSecrets loads fresh data from pull secrets and updates Keychain.
	// If pull secrets are empty - returns.
	RefreshKeychainPullSecrets() error
}

Client provides registry related objects.

func InitClient

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

InitClient initialize registry client with given options.

type Option

type Option func(*client) 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 WithKeychainPullSecrets

func WithKeychainPullSecrets(kubClient kubernetes.Interface, namespace, serviceAccount string, imagePullSecrets []string) Option

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