channels

Documentation

Index

• Constants
• func FindChannelVersions(ns *v1.Namespace) map[string]*ChannelVersion
• type Addon
  • func (a *Addon) AddNeedsUpdateLabel(ctx context.Context, k8sClient kubernetes.Interface, required *AddonUpdate) error
  • func (a *Addon) ChannelVersion() *ChannelVersion
  • func (a *Addon) EnsureUpdated(ctx context.Context, k8sClient kubernetes.Interface, ...) (*AddonUpdate, error)
  • func (a *Addon) GetManifestFullUrl() (*url.URL, error)
  • func (a *Addon) GetNamespace() string
  • func (a *Addon) GetRequiredUpdates(ctx context.Context, k8sClient kubernetes.Interface, ...) (*AddonUpdate, error)
• type AddonMenu
  • func NewAddonMenu() *AddonMenu
  • func (m *AddonMenu) MergeAddons(o *AddonMenu)
• type AddonUpdate
• type Addons
  • func LoadAddons(name string, location *url.URL) (*Addons, error)
  • func ParseAddons(name string, location *url.URL, data []byte) (*Addons, error)
  • func (a *Addons) GetCurrent(kubernetesVersion semver.Version) (*AddonMenu, error)
• type Applier
• type Channel
  • func (c *Channel) AnnotationName() string
  • func (c *Channel) GetInstalledVersion(ctx context.Context, k8sClient kubernetes.Interface) (*ChannelVersion, error)
  • func (c *Channel) IsPKIInstalled(ctx context.Context, k8sClient kubernetes.Interface, ...) (bool, error)
  • func (c *Channel) SetInstalledVersion(ctx context.Context, k8sClient kubernetes.Interface, version *ChannelVersion) error
• type ChannelVersion
  • func ParseChannelVersion(s string) (*ChannelVersion, error)
  • func (c *ChannelVersion) Encode() (string, error)
  • func (c *ChannelVersion) String() string
• type ClientApplier
  • func (p *ClientApplier) Apply(ctx context.Context, manifest []byte) error
• type KubectlApplier
  • func (*KubectlApplier) Apply(ctx context.Context, data []byte) error
• type Pruner
  • func (p *Pruner) Prune(ctx context.Context, manifest []byte, spec *api.PruneSpec) error

Constants

const AnnotationPrefix = "addons.k8s.io/"

const CurrentSystemGeneration = 1

CurrentSystemGeneration holds our current SystemGeneration value. Version history:

0  Pre-history (and the default value); versions prior to prune.
1  Prune functionality introduced.

Functions

func FindChannelVersions

func FindChannelVersions(ns *v1.Namespace) map[string]*ChannelVersion

Types

type Addon

type Addon struct {
	Name            string
	ChannelName     string
	ChannelLocation url.URL
	Spec            *api.AddonSpec
}

Addon is a wrapper around a single version of an addon

func (*Addon) AddNeedsUpdateLabel

func (a *Addon) AddNeedsUpdateLabel(ctx context.Context, k8sClient kubernetes.Interface, required *AddonUpdate) error

func (*Addon) ChannelVersion

func (a *Addon) ChannelVersion() *ChannelVersion

func (*Addon) EnsureUpdated

func (a *Addon) EnsureUpdated(ctx context.Context, k8sClient kubernetes.Interface, cmClient certmanager.Interface, pruner *Pruner, applier Applier, existingVersion *ChannelVersion) (*AddonUpdate, error)

func (*Addon) GetManifestFullUrl

func (a *Addon) GetManifestFullUrl() (*url.URL, error)

func (*Addon) GetNamespace

func (a *Addon) GetNamespace() string

func (*Addon) GetRequiredUpdates

func (a *Addon) GetRequiredUpdates(ctx context.Context, k8sClient kubernetes.Interface, cmClient certmanager.Interface, existingVersion *ChannelVersion) (*AddonUpdate, error)

type AddonMenu

type AddonMenu struct {
	Addons map[string]*Addon
}

AddonMenu is a collection of addons, with helpers for computing the latest versions

func NewAddonMenu

func NewAddonMenu() *AddonMenu

func (*AddonMenu) MergeAddons

func (m *AddonMenu) MergeAddons(o *AddonMenu)

type AddonUpdate

type AddonUpdate struct {
	Name            string
	ExistingVersion *ChannelVersion
	NewVersion      *ChannelVersion
	InstallPKI      bool
}

AddonUpdate holds data about a proposed update to an addon

type Addons

type Addons struct {
	ChannelName     string
	ChannelLocation url.URL
	APIObject       *api.Addons
}

func LoadAddons

func LoadAddons(name string, location *url.URL) (*Addons, error)

func ParseAddons

func ParseAddons(name string, location *url.URL, data []byte) (*Addons, error)

func (*Addons) GetCurrent

func (a *Addons) GetCurrent(kubernetesVersion semver.Version) (*AddonMenu, error)

type Applier

type Applier interface {
	Apply(ctx context.Context, data []byte) error
}

type Channel

type Channel struct {
	Namespace string
	Name      string
}

func (*Channel) AnnotationName

func (c *Channel) AnnotationName() string

func (*Channel) GetInstalledVersion

func (c *Channel) GetInstalledVersion(ctx context.Context, k8sClient kubernetes.Interface) (*ChannelVersion, error)

func (*Channel) IsPKIInstalled

func (c *Channel) IsPKIInstalled(ctx context.Context, k8sClient kubernetes.Interface, cmClient certmanager.Interface) (bool, error)

func (*Channel) SetInstalledVersion

func (c *Channel) SetInstalledVersion(ctx context.Context, k8sClient kubernetes.Interface, version *ChannelVersion) error

type ChannelVersion

type ChannelVersion struct {
	Channel      *string `json:"channel,omitempty"`
	Id           string  `json:"id,omitempty"`
	ManifestHash string  `json:"manifestHash,omitempty"`

	// SystemGeneration holds the generation of the channels functionality.
	// It is used so that we reapply when we introduce new features, such as prune.
	SystemGeneration int `json:"systemGeneration,omitempty"`
}

func ParseChannelVersion

func ParseChannelVersion(s string) (*ChannelVersion, error)

func (*ChannelVersion) Encode

func (c *ChannelVersion) Encode() (string, error)

func (*ChannelVersion) String

func (c *ChannelVersion) String() string

type ClientApplier

type ClientApplier struct {
	Client     dynamic.Interface
	RESTMapper *restmapper.DeferredDiscoveryRESTMapper
}

func (*ClientApplier) Apply

func (p *ClientApplier) Apply(ctx context.Context, manifest []byte) error

Apply applies the manifest to the cluster.

type KubectlApplier

type KubectlApplier struct{}

func (*KubectlApplier) Apply

func (*KubectlApplier) Apply(ctx context.Context, data []byte) error

Apply calls kubectl apply to apply the manifest. We will likely in future change this to create things directly (or more likely embed this logic into kubectl itself)

type Pruner

type Pruner struct {
	Client     dynamic.Interface
	RESTMapper *restmapper.DeferredDiscoveryRESTMapper
}

func (*Pruner) Prune

func (p *Pruner) Prune(ctx context.Context, manifest []byte, spec *api.PruneSpec) error

Prune prunes objects not in the manifest, according to PruneSpec.