image

Documentation

Index

• Constants
• func Import(ctx context.Context, imagePath, indexName string) error
• func NewResolver(reg config.Registries) remotes.Resolver
• func PrepareAuth(auth config.RegistryAuthConfig, host, expectedHost string) (string, string, error)
• func Pull(ctx context.Context, registryBuilder RegistriesBuilder, ...) (img containerd.Image, err error)
• func RegistryHosts(reg config.Registries) docker.RegistryHosts
• type EndpointEntry
  • func RegistryEndpointEntriesFromConfig(host string, reg config.RegistryMirrorConfig) ([]EndpointEntry, error)
  • func RegistryEndpoints(reg config.Registries, host string) (endpoints []EndpointEntry, err error)
• type PullOption
  • func WithSkipIfAlreadyPulled() PullOption
• type PullOptions
• type RegistriesBuilder

Constants

const (
	PullTimeout       = 20 * time.Minute
	PullRetryInterval = 5 * time.Second
)

Image pull retry settings.

const (
	ImportTimeout       = 5 * time.Minute
	ImportRetryInterval = 5 * time.Second
	ImportRetryJitter   = time.Second
)

Image import retry settings.

Functions

func Import

func Import(ctx context.Context, imagePath, indexName string) error

Import is a convenience function that wraps containerd image import with retries.

func NewResolver

func NewResolver(reg config.Registries) remotes.Resolver

NewResolver builds registry resolver based on Talos configuration.

func PrepareAuth

func PrepareAuth(auth config.RegistryAuthConfig, host, expectedHost string) (string, string, error)

PrepareAuth returns authentication info in the format expected by containerd.

func Pull

func Pull(ctx context.Context, registryBuilder RegistriesBuilder, client *containerd.Client, ref string, opt ...PullOption) (img containerd.Image, err error)

Pull is a convenience function that wraps the containerd image pull func with retry functionality.

func RegistryHosts

func RegistryHosts(reg config.Registries) docker.RegistryHosts

RegistryHosts returns host configuration per registry.

Types

type EndpointEntry

type EndpointEntry struct {
	Endpoint     string
	OverridePath bool
}

EndpointEntry represents a registry endpoint.

func RegistryEndpointEntriesFromConfig

func RegistryEndpointEntriesFromConfig(host string, reg config.RegistryMirrorConfig) ([]EndpointEntry, error)

RegistryEndpointEntriesFromConfig returns registry endpoints per host.

func RegistryEndpoints

func RegistryEndpoints(reg config.Registries, host string) (endpoints []EndpointEntry, err error)

RegistryEndpoints returns registry endpoints per host using reg.

type PullOption

type PullOption func(*PullOptions)

PullOption is an option for Pull function.

func WithSkipIfAlreadyPulled

func WithSkipIfAlreadyPulled() PullOption

WithSkipIfAlreadyPulled skips pulling if image is already pulled and unpacked.

type PullOptions

type PullOptions struct {
	SkipIfAlreadyPulled bool
}

PullOptions configure Pull function.

type RegistriesBuilder

type RegistriesBuilder = func(context.Context) (config.Registries, error)

RegistriesBuilder is a function that returns registries configuration.