api

Documentation

Index

• type AddonSpec
• type Addons
  • func (a *Addons) Verify() error
• type AddonsSpec
• type NeedsRollingUpdate
• type PruneKindSpec
• type PruneSpec

Types

type AddonSpec

type AddonSpec struct {
	Name *string `json:"name,omitempty"`

	Namespace *string `json:"namespace,omitempty"`

	// Selector is a label query over pods that should match the Replicas count.
	Selector map[string]string `json:"selector"`

	// Manifest is the URL to the manifest that should be applied
	Manifest *string `json:"manifest,omitempty"`

	// ManifestHash is the sha256 hash of our manifest
	ManifestHash string `json:"manifestHash,omitempty"`

	// KubernetesVersion is a semver version range on which this version of the addon can be applied
	KubernetesVersion string `json:"kubernetesVersion,omitempty"`

	// Id is an optional value which can be used to force a refresh even if the Version matches
	// This is useful for when we have two manifests expressing the same addon version for two
	// different kubernetes api versions.  For example, we might label the 1.5 version "k8s-1.5"
	// and the 1.6 version "k8s-1.6".  Both would have the same Version, determined by the
	// version of the software we are packaging.  But we always want to reinstall when we
	// switch kubernetes versions.
	Id string `json:"id,omitempty"`

	// NeedsRollingUpdate determines if we should mark nodes as needing an update.
	// Legal values are control-plane, workers, and all
	// Empty value means no update needed
	NeedsRollingUpdate NeedsRollingUpdate `json:"needsRollingUpdate,omitempty"`

	// NeedsPKI determines if channels should provision a CA and a cert-manager issuer for the addon.
	NeedsPKI bool `json:"needsPKI,omitempty"`

	Version string `json:"version,omitempty"`

	// PruneSpec specifies how old objects should be removed (pruned).
	Prune *PruneSpec `json:"prune,omitempty"`
}

type Addons

type Addons struct {
	metav1.TypeMeta `json:",inline"`

	ObjectMeta metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec AddonsSpec `json:"spec,omitempty"`
}

func (*Addons) Verify

func (a *Addons) Verify() error

type AddonsSpec

type AddonsSpec struct {
	Addons []*AddonSpec `json:"addons,omitempty"`
}

type NeedsRollingUpdate

type NeedsRollingUpdate string

const (
	NeedsRollingUpdateControlPlane NeedsRollingUpdate = "control-plane"
	NeedsRollingUpdateWorkers      NeedsRollingUpdate = "workers"
	NeedsRollingUpdateAll          NeedsRollingUpdate = "all"
)

type PruneKindSpec

type PruneKindSpec struct {
	// Group specifies the object Group to be pruned (required).
	Group string `json:"group,omitempty"`
	// Kind specifies the object Kind to be pruned (required).
	Kind string `json:"kind,omitempty"`

	// Namespaces limits pruning only to objects in certain namespaces.
	Namespaces []string `json:"namespaces,omitempty"`

	// LabelSelector limits pruning only to objects matching the specified labels.
	LabelSelector string `json:"labelSelector,omitempty"`

	// FieldSelector allows pruning only of objects matching the field selector.
	// (This isn't currently used, but adding it now lets us start without worrying about version skew)
	FieldSelector string `json:"fieldSelector,omitempty"`
}

PruneKindSpec specifies pruning for a particular Kind of object.

type PruneSpec

type PruneSpec struct {
	// Kinds specifies the objects to be pruned, by Kind.
	Kinds []PruneKindSpec `json:"kinds,omitempty"`
}

PruneSpec specifies how old objects should be removed (pruned).