interfaces

package
v0.0.0-...-ffc01b6 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 10, 2024 License: Apache-2.0 Imports: 10 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ActiveMetricsObject

type ActiveMetricsObject interface {
	GetActiveMetricsAttributes() []attribute.KeyValue
	IsEndTimeSet() bool
}

ActiveMetricsObject represents an object whose active metrics are stored

type ActiveMetricsObjectWrapper

type ActiveMetricsObjectWrapper struct {
	Obj ActiveMetricsObject
}

func NewActiveMetricsObjectWrapperFromClientObject

func NewActiveMetricsObjectWrapperFromClientObject(object client.Object) (*ActiveMetricsObjectWrapper, error)

func (ActiveMetricsObjectWrapper) GetActiveMetricsAttributes

func (amo ActiveMetricsObjectWrapper) GetActiveMetricsAttributes() []attribute.KeyValue

func (ActiveMetricsObjectWrapper) IsEndTimeSet

func (amo ActiveMetricsObjectWrapper) IsEndTimeSet() bool

type Controller

type Controller interface {
	SetupWithManager(mgr ctrl.Manager) error
}

type EventObject

type EventObject interface {
	GetEventAnnotations() map[string]string
}

EventObject represents an object who can send k8s Events with annotations

type EventObjectWrapper

type EventObjectWrapper struct {
	Obj EventObject
}

func NewEventObjectWrapperFromClientObject

func NewEventObjectWrapperFromClientObject(object client.Object) (*EventObjectWrapper, error)

func (EventObjectWrapper) GetEventAnnotations

func (eo EventObjectWrapper) GetEventAnnotations() map[string]string

type IMeter

type IMeter interface {
	Int64Counter(name string, options ...metric.Int64CounterOption) (metric.Int64Counter, error)
	Int64Histogram(name string, options ...metric.Int64HistogramOption) (metric.Int64Histogram, error)
	Float64Counter(name string, options ...metric.Float64CounterOption) (metric.Float64Counter, error)
	Float64Histogram(name string, options ...metric.Float64HistogramOption) (metric.Float64Histogram, error)
	RegisterCallback(f metric.Callback, instruments ...metric.Observable) (metric.Registration, error)
	Int64ObservableGauge(name string, options ...metric.Int64ObservableGaugeOption) (metric.Int64ObservableGauge, error)
	Float64ObservableGauge(name string, options ...metric.Float64ObservableGaugeOption) (metric.Float64ObservableGauge, error)
}

type ListItem

type ListItem interface {
	GetItems() []client.Object
}

type ListItemWrapper

type ListItemWrapper struct {
	Obj ListItem
}

func NewListItemWrapperFromClientObjectList

func NewListItemWrapperFromClientObjectList(object client.ObjectList) (*ListItemWrapper, error)

func (ListItemWrapper) GetItems

func (pw ListItemWrapper) GetItems() []client.Object

type MetricsObject

type MetricsObject interface {
	GetDurationMetricsAttributes() []attribute.KeyValue
	GetMetricsAttributes() []attribute.KeyValue
	GetEndTime() time.Time
	GetStartTime() time.Time
	IsEndTimeSet() bool
	GetPreviousVersion() string
	GetParentName() string
	GetNamespace() string
}

MetricsObject represents an object whose metrics are stored

type MetricsObjectWrapper

type MetricsObjectWrapper struct {
	Obj MetricsObject
}

func NewMetricsObjectWrapperFromClientObject

func NewMetricsObjectWrapperFromClientObject(object client.Object) (*MetricsObjectWrapper, error)

func (MetricsObjectWrapper) GetDurationMetricsAttributes

func (mo MetricsObjectWrapper) GetDurationMetricsAttributes() []attribute.KeyValue

func (MetricsObjectWrapper) GetEndTime

func (mo MetricsObjectWrapper) GetEndTime() time.Time

func (MetricsObjectWrapper) GetMetricsAttributes

func (mo MetricsObjectWrapper) GetMetricsAttributes() []attribute.KeyValue

func (MetricsObjectWrapper) GetNamespace

func (mo MetricsObjectWrapper) GetNamespace() string

func (MetricsObjectWrapper) GetParentName

func (mo MetricsObjectWrapper) GetParentName() string

func (MetricsObjectWrapper) GetPreviousVersion

func (mo MetricsObjectWrapper) GetPreviousVersion() string

func (MetricsObjectWrapper) GetStartTime

func (mo MetricsObjectWrapper) GetStartTime() time.Time

func (MetricsObjectWrapper) IsEndTimeSet

func (mo MetricsObjectWrapper) IsEndTimeSet() bool

type PhaseItem

type PhaseItem interface {
	GetState() apicommon.KeptnState
	SetState(apicommon.KeptnState)
	GetCurrentPhase() string
	SetCurrentPhase(string)
	Complete()
	IsEndTimeSet() bool
	GetEndTime() time.Time
	GetStartTime() time.Time
	GetVersion() string
	GetPreviousVersion() string
	GetParentName() string
	GetNamespace() string
	GetAppName() string
	GetPreDeploymentTasks() []string
	GetPostDeploymentTasks() []string
	GetPromotionTasks() []string
	GetPreDeploymentTaskStatus() []apilifecycle.ItemStatus
	GetPostDeploymentTaskStatus() []apilifecycle.ItemStatus
	GetPromotionTaskStatus() []apilifecycle.ItemStatus
	GetPreDeploymentEvaluations() []string
	GetPostDeploymentEvaluations() []string
	GetPreDeploymentEvaluationTaskStatus() []apilifecycle.ItemStatus
	GetPostDeploymentEvaluationTaskStatus() []apilifecycle.ItemStatus
	GenerateTask(taskDefinition apilifecycle.KeptnTaskDefinition, checkType apicommon.CheckType) apilifecycle.KeptnTask
	GenerateEvaluation(evaluationDefinition apilifecycle.KeptnEvaluationDefinition, checkType apicommon.CheckType) apilifecycle.KeptnEvaluation
	GetSpanAttributes() []attribute.KeyValue
	SetSpanAttributes(span trace.Span)
	DeprecateRemainingPhases(phase apicommon.KeptnPhaseType)
}

PhaseItem represents an object which has reconciled phases

type PhaseItemWrapper

type PhaseItemWrapper struct {
	Obj PhaseItem
}

func NewPhaseItemWrapperFromClientObject

func NewPhaseItemWrapperFromClientObject(object client.Object) (*PhaseItemWrapper, error)

func (*PhaseItemWrapper) Complete

func (pw *PhaseItemWrapper) Complete()

func (PhaseItemWrapper) DeprecateRemainingPhases

func (pw PhaseItemWrapper) DeprecateRemainingPhases(phase apicommon.KeptnPhaseType)

func (PhaseItemWrapper) GenerateEvaluation

func (pw PhaseItemWrapper) GenerateEvaluation(evaluationDefinition apilifecycle.KeptnEvaluationDefinition, checkType apicommon.CheckType) apilifecycle.KeptnEvaluation

func (PhaseItemWrapper) GenerateTask

func (pw PhaseItemWrapper) GenerateTask(taskDefinition apilifecycle.KeptnTaskDefinition, checkType apicommon.CheckType) apilifecycle.KeptnTask

func (PhaseItemWrapper) GetAppName

func (pw PhaseItemWrapper) GetAppName() string

func (PhaseItemWrapper) GetCurrentPhase

func (pw PhaseItemWrapper) GetCurrentPhase() string

func (PhaseItemWrapper) GetEndTime

func (pw PhaseItemWrapper) GetEndTime() time.Time

func (PhaseItemWrapper) GetNamespace

func (pw PhaseItemWrapper) GetNamespace() string

func (PhaseItemWrapper) GetParentName

func (pw PhaseItemWrapper) GetParentName() string

func (PhaseItemWrapper) GetPostDeploymentEvaluationTaskStatus

func (pw PhaseItemWrapper) GetPostDeploymentEvaluationTaskStatus() []apilifecycle.ItemStatus

func (PhaseItemWrapper) GetPostDeploymentEvaluations

func (pw PhaseItemWrapper) GetPostDeploymentEvaluations() []string

func (PhaseItemWrapper) GetPostDeploymentTaskStatus

func (pw PhaseItemWrapper) GetPostDeploymentTaskStatus() []apilifecycle.ItemStatus

func (PhaseItemWrapper) GetPostDeploymentTasks

func (pw PhaseItemWrapper) GetPostDeploymentTasks() []string

func (PhaseItemWrapper) GetPreDeploymentEvaluationTaskStatus

func (pw PhaseItemWrapper) GetPreDeploymentEvaluationTaskStatus() []apilifecycle.ItemStatus

func (PhaseItemWrapper) GetPreDeploymentEvaluations

func (pw PhaseItemWrapper) GetPreDeploymentEvaluations() []string

func (PhaseItemWrapper) GetPreDeploymentTaskStatus

func (pw PhaseItemWrapper) GetPreDeploymentTaskStatus() []apilifecycle.ItemStatus

func (PhaseItemWrapper) GetPreDeploymentTasks

func (pw PhaseItemWrapper) GetPreDeploymentTasks() []string

func (PhaseItemWrapper) GetPreviousVersion

func (pw PhaseItemWrapper) GetPreviousVersion() string

func (PhaseItemWrapper) GetPromotionTaskStatus

func (pw PhaseItemWrapper) GetPromotionTaskStatus() []apilifecycle.ItemStatus

func (PhaseItemWrapper) GetPromotionTasks

func (pw PhaseItemWrapper) GetPromotionTasks() []string

func (PhaseItemWrapper) GetSpanAttributes

func (pw PhaseItemWrapper) GetSpanAttributes() []attribute.KeyValue

func (PhaseItemWrapper) GetStartTime

func (pw PhaseItemWrapper) GetStartTime() time.Time

func (PhaseItemWrapper) GetState

func (pw PhaseItemWrapper) GetState() apicommon.KeptnState

func (PhaseItemWrapper) GetVersion

func (pw PhaseItemWrapper) GetVersion() string

func (PhaseItemWrapper) IsEndTimeSet

func (pw PhaseItemWrapper) IsEndTimeSet() bool

func (*PhaseItemWrapper) SetCurrentPhase

func (pw *PhaseItemWrapper) SetCurrentPhase(phase string)

func (PhaseItemWrapper) SetSpanAttributes

func (pw PhaseItemWrapper) SetSpanAttributes(span trace.Span)

func (*PhaseItemWrapper) SetState

func (pw *PhaseItemWrapper) SetState(state apicommon.KeptnState)

type SpanItem

type SpanItem interface {
	SetSpanAttributes(span trace.Span)
	SetPhaseTraceID(phase string, carrier propagation.MapCarrier)
	GetSpanKey(phase string) string
	GetSpanName(phase string) string
}

SpanItem represents an object whose metrics are stored

type SpanItemWrapper

type SpanItemWrapper struct {
	Obj SpanItem
}

func NewSpanItemWrapperFromClientObject

func NewSpanItemWrapperFromClientObject(object client.Object) (*SpanItemWrapper, error)

func (SpanItemWrapper) GetSpanKey

func (pw SpanItemWrapper) GetSpanKey(phase string) string

func (SpanItemWrapper) GetSpanName

func (pw SpanItemWrapper) GetSpanName(phase string) string

func (SpanItemWrapper) SetPhaseTraceID

func (pw SpanItemWrapper) SetPhaseTraceID(phase string, carrier propagation.MapCarrier)

func (SpanItemWrapper) SetSpanAttributes

func (pw SpanItemWrapper) SetSpanAttributes(span trace.Span)

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL