common

Documentation

Index

• Constants
• Variables
• func AddAppLabels(requestInstance *v1beta1.SSP, name string, component AppComponent, ...) client.Object
• func CheckOwnerAnnotation(obj client.Object, owner client.Object) bool
• func EnvOrDefault(envName string, defVal string) string
• func GetInfrastructureTopology(c client.Reader) (osconfv1.TopologyMode, error)
• func GetOperatorVersion() string
• type AppComponent
  • func (a AppComponent) String() string
• type CleanupResult
  • func Cleanup(request *Request, resource client.Object) (CleanupResult, error)
  • func DeleteAll(request *Request, resources ...client.Object) ([]CleanupResult, error)
• type OperationResult
• type ReconcileBuilder
  • func CreateOrUpdate(request *Request) ReconcileBuilder
• type ReconcileFunc
• type ReconcileOptions
• type ReconcileResult
  • func CollectResourceStatus(request *Request, funcs ...ReconcileFunc) ([]ReconcileResult, error)
  • func ResourceDeletedResult(resource client.Object, res OperationResult) ReconcileResult
  • func (r *ReconcileResult) IsSuccess() bool
• type Request
  • func (r *Request) IsSingleReplicaTopologyMode() bool
• type ResourceSpecGetter
• 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 (
	SSPOperatorReconcilingProperly = prometheus.NewGauge(prometheus.GaugeOpts{
		Name: "ssp_operator_reconciling_properly",
		Help: "Set to 1 if the reconcile process of all operands completes with no errors, and to 0 otherwise",
	})
)

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 CheckOwnerAnnotation

func CheckOwnerAnnotation(obj client.Object, owner client.Object) bool

func EnvOrDefault

func EnvOrDefault(envName string, defVal string) string

func GetInfrastructureTopology

func GetInfrastructureTopology(c client.Reader) (osconfv1.TopologyMode, error)

func GetOperatorVersion

func GetOperatorVersion() 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 CleanupResult

type CleanupResult struct {
	Resource client.Object
	Deleted  bool
}

func Cleanup

func Cleanup(request *Request, resource client.Object) (CleanupResult, error)

func DeleteAll

func DeleteAll(request *Request, resources ...client.Object) ([]CleanupResult, error)

type OperationResult

type OperationResult string

const (
	OperationResultNone    OperationResult = "unchanged"
	OperationResultCreated OperationResult = "created"
	OperationResultUpdated OperationResult = "updated"
	OperationResultDeleted OperationResult = "deleted"
)

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
	ImmutableSpec(getter ResourceSpecGetter) ReconcileBuilder

	Options(options ReconcileOptions) ReconcileBuilder

	Reconcile() (ReconcileResult, error)
}

func CreateOrUpdate

func CreateOrUpdate(request *Request) ReconcileBuilder

type ReconcileFunc

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

type ReconcileOptions

type ReconcileOptions struct {
	// AlwaysCallUpdateFunc specifies if the UpdateFunc should be called
	// on changes that don't increase the .metadata.generation field.
	// For example, labels and annotations.
	AlwaysCallUpdateFunc bool
}

type ReconcileResult

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

func CollectResourceStatus

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

func ResourceDeletedResult

func ResourceDeletedResult(resource client.Object, res OperationResult) ReconcileResult

func (*ReconcileResult) IsSuccess

func (r *ReconcileResult) IsSuccess() bool

type Request

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

func (*Request) IsSingleReplicaTopologyMode

func (r *Request) IsSingleReplicaTopologyMode() bool

type ResourceSpecGetter

type ResourceSpecGetter = func(resource client.Object) interface{}

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)