registryclient

Documentation

Index

• Constants
• Variables
• func NewAutoRefreshSecretsKeychain(lister corev1listers.SecretNamespaceLister, imagePullSecrets ...string) (authn.Keychain, error)
• type Client
  • func New(options ...Option) (Client, error)
  • func NewOrDie(options ...Option) Client
• type Option
  • func WithAllowInsecureRegistry() Option
  • func WithCredentialProviders(credentialProviders ...string) Option
  • func WithKeychainPullSecrets(lister corev1listers.SecretNamespaceLister, imagePullSecrets ...string) Option
  • func WithLocalKeychain() Option
  • func WithTracing() Option

Constants

const (
	ServiceECR       = "ecr"
	ServiceECRPublic = "ecr-public"
)

Variables

var AWSKeychain authn.Keychain = awskeychain{}

var AnonymousKeychain authn.Keychain = anonymuskc{}

var AzureKeychain authn.Keychain = azurekeychain{}

var GCPKeychain authn.Keychain = gcpkeychain{}

Functions

func NewAutoRefreshSecretsKeychain

func NewAutoRefreshSecretsKeychain(lister corev1listers.SecretNamespaceLister, imagePullSecrets ...string) (authn.Keychain, error)

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)

	// BuildCosignRemoteOption builds remote.Option for cosign client.
	BuildCosignRemoteOption(context.Context) (remote.Option, error)

	// BuildGCRRemoteOption builds []gcrremote.option based on client.
	BuildGCRRemoteOption(ctx context.Context) ([]gcrremote.Option, 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

WithAllowInsecureRegistry initialize registry client option that allows to use insecure registries.

func WithCredentialProviders

func WithCredentialProviders(credentialProviders ...string) Option

WithCredentialProviders initialize registry client option by using registries credentials

func WithKeychainPullSecrets

func WithKeychainPullSecrets(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.