v1alpha1

Documentation

Overview

The v1alpha1 API provides a set of common fields for addon objects.

What is the purpose of this API?

The API provides a common set of spec and status fields that are required to manage addons consistently.

How stable is this API?

This is an evolving API and will change without bumping the version number until it is promoted to a beta API.

Index

• type CommonObject
• type CommonSpec
• type CommonStatus
  • func (in *CommonStatus) DeepCopy() *CommonStatus
  • func (in *CommonStatus) DeepCopyInto(out *CommonStatus)
• type PatchSpec
  • func (in *PatchSpec) DeepCopy() *PatchSpec
  • func (in *PatchSpec) DeepCopyInto(out *PatchSpec)
• type Patchable

Types

type CommonObject

type CommonObject interface {
	runtime.Object
	metav1.Object
	ComponentName() string
	CommonSpec() CommonSpec
	GetCommonStatus() CommonStatus
	SetCommonStatus(CommonStatus)
}

CommonObject is an interface that must be implemented by all Addon objects in order to use the Addon pattern

type CommonSpec

type CommonSpec struct {
	// Version specifies the exact addon version to be deployed, eg 1.2.3
	// It should not be specified if Channel is specified
	Version string `json:"version,omitempty"`
	// Channel specifies a channel that can be used to resolve a specific addon, eg: stable
	// It will be ignored if Version is specified
	Channel string `json:"channel,omitempty"`
}

CommonSpec defines the set of configuration attributes that must be exposed on all addons.

type CommonStatus

type CommonStatus struct {
	Healthy bool     `json:"healthy"`
	Errors  []string `json:"errors,omitempty"`
	Phase   string   `json:"phase,omitempty"`
}

CommonStatus is a set of status attributes that must be exposed on all addons.

func (*CommonStatus) DeepCopy

func (in *CommonStatus) DeepCopy() *CommonStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CommonStatus.

func (*CommonStatus) DeepCopyInto

func (in *CommonStatus) DeepCopyInto(out *CommonStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type PatchSpec

type PatchSpec struct {
	Patches []*runtime.RawExtension `json:"patches,omitempty"`
}

+k8s:deepcopy-gen=true

func (*PatchSpec) DeepCopy

func (in *PatchSpec) DeepCopy() *PatchSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PatchSpec.

func (*PatchSpec) DeepCopyInto

func (in *PatchSpec) DeepCopyInto(out *PatchSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type Patchable

type Patchable interface {
	PatchSpec() PatchSpec
}

Patchable is a trait for addon CRDs that expose a raw set of Patches to be applied to the declarative manifest.