common

Documentation

Index

• Constants
• Variables
• func AddAppLabels(requestInstance *v1beta1.SSP, name string, component AppComponent, ...) client.Object
• func EnvOrDefault(envName string, defVal string) string
• type AppComponent
  • func (a AppComponent) String() string
• type ReconcileBuilder
  • func CreateOrUpdate(request *Request) ReconcileBuilder
• type ReconcileFunc
• type ReconcileResult
  • func CollectResourceStatus(request *Request, funcs ...ReconcileFunc) ([]ReconcileResult, error)
• type Request
• type ResourceStatus
• type ResourceStatusFunc
• type ResourceUpdateFunc
• type StatusMessage
• type VersionCache
  • func (v VersionCache) Add(obj client.Object)
  • func (v VersionCache) Contains(obj client.Object) bool
  • func (v VersionCache) RemoveObj(obj client.Object)

Constants

const (
	OperatorVersionKey = "OPERATOR_VERSION"

	TemplateValidatorImageKey = "VALIDATOR_IMAGE"
)

const (
	AppKubernetesNameLabel      = "app.kubernetes.io/name"
	AppKubernetesPartOfLabel    = "app.kubernetes.io/part-of"
	AppKubernetesVersionLabel   = "app.kubernetes.io/version"
	AppKubernetesManagedByLabel = "app.kubernetes.io/managed-by"
	AppKubernetesComponentLabel = "app.kubernetes.io/component"
)

Variables

var (
	// Scheme used for the SSP operator.
	Scheme = runtime.NewScheme()
)

Functions

func AddAppLabels

func AddAppLabels(requestInstance *v1beta1.SSP, name string, component AppComponent, obj client.Object) client.Object

AddAppLabels to the provided obj Name will translate into the AppKubernetesNameLabel Component will translate into the AppKubernetesComponentLabel Instance wide labels will be taken from the request if available

func EnvOrDefault

func EnvOrDefault(envName string, defVal string) string

Types

type AppComponent

type AppComponent string

const (
	AppComponentMonitoring AppComponent = "monitoring"
	AppComponentSchedule   AppComponent = "schedule"
	AppComponentTemplating AppComponent = "templating"
)

func (AppComponent) String

func (a AppComponent) String() string

type ReconcileBuilder

type ReconcileBuilder interface {
	NamespacedResource(client.Object) ReconcileBuilder
	ClusterResource(client.Object) ReconcileBuilder
	WithAppLabels(name string, component AppComponent) ReconcileBuilder
	UpdateFunc(ResourceUpdateFunc) ReconcileBuilder
	StatusFunc(ResourceStatusFunc) ReconcileBuilder

	Reconcile() (ReconcileResult, error)
}

func CreateOrUpdate

func CreateOrUpdate(request *Request) ReconcileBuilder

type ReconcileFunc

type ReconcileFunc = func(*Request) (ReconcileResult, error)

type ReconcileResult

type ReconcileResult struct {
	Status          ResourceStatus
	Resource        client.Object
	OperationResult controllerutil.OperationResult
}

func CollectResourceStatus

func CollectResourceStatus(request *Request, funcs ...ReconcileFunc) ([]ReconcileResult, error)

type Request

type Request struct {
	reconcile.Request
	Client       client.Client
	Context      context.Context
	Instance     *ssp.SSP
	Logger       logr.Logger
	VersionCache VersionCache
}

type ResourceStatus

type ResourceStatus struct {
	Progressing  StatusMessage
	NotAvailable StatusMessage
	Degraded     StatusMessage
}

type ResourceStatusFunc

type ResourceStatusFunc = func(resource client.Object) ResourceStatus

type ResourceUpdateFunc

type ResourceUpdateFunc = func(expected, found client.Object)

type StatusMessage

type StatusMessage = *string

type VersionCache

type VersionCache map[cacheKey]cacheValue

func (VersionCache) Add

func (v VersionCache) Add(obj client.Object)

func (VersionCache) Contains

func (v VersionCache) Contains(obj client.Object) bool

func (VersionCache) RemoveObj

func (v VersionCache) RemoveObj(obj client.Object)