kdmimages

Documentation

Index

• Constants
• type ClusterType
  • func (t ClusterType) String() string
• type Getter
  • func NewGetter(o *GetterOptions) (Getter, error)
• type GetterOptions

Constants

const (
	// The "images-all" file is only provided for RKE2 amd64 images. This may be subject to change.
	RKE2ImageLinux   = "https://github.com/rancher/rke2/releases/download/%s/rke2-images-all.linux-amd64.txt"
	RKE2ImageWindows = "https://github.com/rancher/rke2/releases/download/%s/rke2-images.windows-amd64.txt"
	K3SImageURL      = "https://github.com/k3s-io/k3s/releases/download/%s/k3s-images.txt"

	// CN mirror URL (some versions were not mirrored to the CN mirror, so use the global GitHub instead)
	RKE2ImageLinuxCN   = "https://rancher-mirror.rancher.cn/rke2/%s/rke2-images-all.linux-amd64.txt"
	RKE2ImageWindowsCN = "https://rancher-mirror.rancher.cn/rke2/%s/rke2-images.windows-amd64.txt"
	K3SImageURLCN      = "https://rancher-mirror.rancher.cn/k3s/%s/k3s-images.txt"
)

Types

type ClusterType

type ClusterType string

const (
	K3S  ClusterType = "k3s"
	RKE2 ClusterType = "rke2"
	RKE  ClusterType = "rke"
)

func (ClusterType) String

func (t ClusterType) String() string

type Getter

type Getter interface {
	// Get method is for getting the images and versions.
	Get(ctx context.Context) error

	// LinuxImageSet method gets the linux images and sources.
	LinuxImageSet() map[string]map[string]bool

	// WindowsImageSet method gets the Windows images and sources.
	WindowsImageSet() map[string]map[string]bool

	// VersionSet method gets the versions.
	VersionSet() map[string]bool

	// Source method gets the cluster type of getter.
	Source() ClusterType
}

Getter is the interface for getting images and versions from KDM data.

func NewGetter

func NewGetter(o *GetterOptions) (Getter, error)

type GetterOptions

type GetterOptions struct {
	Type           ClusterType
	RancherVersion string
	MinKubeVersion string
	KDMData        kdm.Data

	// RemoveDeprecated removes the old deprecated k8s versions and
	// only outputs the highest k8s patch version
	RemoveDeprecated bool
	InsecureSkipTLS  bool
}