images

Documentation

Index

• Constants
• Variables
• func Pull(dir, name string, image name.Reference) error
• type ImageOverrideConfig
• type Resolver
  • func NewResolver(c ImageOverrideConfig) (*Resolver, error)
  • func (r *Resolver) GetReference(i string, opts ...ResolverOpt) (name.Reference, error)
  • func (r *Resolver) MustGetReference(i string, opts ...ResolverOpt) name.Reference
  • func (r *Resolver) ParseAndSetDefaultRegistry(s string) error
  • func (r *Resolver) ParseAndSetOverride(i, n string) error
  • func (r *Resolver) SetOverride(i string, n name.Reference)
• type ResolverOpt
  • func WithRegistry(s string) ResolverOpt

Constants

const (
	Runtime                = "runtime-image"
	KubeAPIServer          = "kube-apiserver-image"
	KubeControllerManager  = "kube-controller-manager-image"
	KubeProxy              = "kube-proxy-image"
	KubeScheduler          = "kube-scheduler-image"
	ETCD                   = "etcd-image"
	Pause                  = "pause-image"
	CloudControllerManager = "cloud-controller-manager-image"
)

Image defaults overridden by config passed in and ImageOverrideConfig below

Variables

var (
	DefaultRegistry                    = name.DefaultRegistry
	DefaultEtcdImage                   = "rancher/hardened-etcd"
	DefaultKubernetesImage             = "rancher/hardened-kubernetes"
	DefaultPauseImage                  = "rancher/pause"
	DefaultRuntimeImage                = "rancher/rke2-runtime"
	DefaultCloudControllerManagerImage = "rancher/rke2-cloud-provider"
)

These defaults are overridden at build time and do not need to be updated here

Functions

func Pull

func Pull(dir, name string, image name.Reference) error

Pull checks for preloaded images in dir. If they are available, nothing is done. If they are not available, it adds the image to name.txt in dir. This is used to get K3s to pre-pull images for static pods.

Types

type ImageOverrideConfig

type ImageOverrideConfig struct {
	SystemDefaultRegistry  string
	KubeAPIServer          string
	KubeControllerManager  string
	KubeProxy              string
	KubeScheduler          string
	Pause                  string
	Runtime                string
	ETCD                   string
	CloudControllerManager string
}

ImageOverrideConfig stores configuration from the CLI.

type Resolver

type Resolver struct {
	// contains filtered or unexported fields
}

Resolver provides functionality to resolve an RKE2 image name to a reference.

func NewResolver

func NewResolver(c ImageOverrideConfig) (*Resolver, error)

NewResolver creates a new image resolver, with options to modify the resolver behavior.

func (*Resolver) GetReference

func (r *Resolver) GetReference(i string, opts ...ResolverOpt) (name.Reference, error)

GetReference returns a reference to an image. If an override is set it is used, otherwise the compile-time default is retrieved and default-registry settings applied. Options can be passed to modify the reference before it is returned.

func (*Resolver) MustGetReference

func (r *Resolver) MustGetReference(i string, opts ...ResolverOpt) name.Reference

func (*Resolver) ParseAndSetDefaultRegistry

func (r *Resolver) ParseAndSetDefaultRegistry(s string) error

ParseAndSetDefaultRegistry updates the default registry, if it can be parsed as a valid Registry

func (*Resolver) ParseAndSetOverride

func (r *Resolver) ParseAndSetOverride(i, n string) error

ParseAndSetOverride sets an image override from a string, if it can be parsed as a valid Reference.

func (*Resolver) SetOverride

func (r *Resolver) SetOverride(i string, n name.Reference)

SetOverride set an image override from a Reference. If the reference is nil, the override is cleared.

type ResolverOpt

type ResolverOpt func(name.Reference) (name.Reference, error)

ResolverOpt is an option to modify image resolution behavior.

func WithRegistry

func WithRegistry(s string) ResolverOpt

WithRegistry overrides the registry when resolving the reference to an image.