generic

Documentation

Index

• Constants
• Variables
• func NewResourceStatusIndicator(object *unstructured.Unstructured) (indicator *indicators.StringEqualConditionIndicator, humanJSONPath string, ...)
• func SetWatchErrorHandler(cancelFn context.CancelFunc, resName string, ...) error
• type ContribResourceStatusRules
• type EventStatus
  • func NewEventStatus(event *corev1.Event) *EventStatus
  • func (s *EventStatus) FailureReason() string
  • func (s *EventStatus) IsFailure() bool
• type Feed
  • func NewFeed(tracker *Tracker) *Feed
  • func (f *Feed) OnAdded(function func(status *ResourceStatus) error)
  • func (f *Feed) OnEventMsg(function func(event *corev1.Event) error)
  • func (f *Feed) OnFailed(function func(status *ResourceStatus) error)
  • func (f *Feed) OnReady(function func(status *ResourceStatus) error)
  • func (f *Feed) OnStatus(function func(status *ResourceStatus) error)
  • func (f *Feed) Track(ctx context.Context, timeout, noActivityTimeout time.Duration) error
• type ResourceEventsWatcher
  • func NewResourceEventsWatcher(object *unstructured.Unstructured, resID *resid.ResourceID, ...) *ResourceEventsWatcher
  • func (i *ResourceEventsWatcher) Run(ctx context.Context, eventsCh chan<- *corev1.Event) error
• type ResourceStateWatcher
  • func NewResourceStateWatcher(resID *resid.ResourceID, client kubernetes.Interface, ...) *ResourceStateWatcher
  • func (w *ResourceStateWatcher) Run(ctx context.Context, ...) error
• type ResourceStatus
  • func NewDeletedResourceStatus() *ResourceStatus
  • func NewFailedResourceStatus(failureReason string) *ResourceStatus
  • func NewResourceStatus(object *unstructured.Unstructured) (*ResourceStatus, error)
  • func NewSucceededResourceStatus() *ResourceStatus
  • func (s *ResourceStatus) DiffersFrom(newStatus *ResourceStatus) bool
  • func (s *ResourceStatus) FailureReason() string
  • func (s *ResourceStatus) HumanConditionPath() string
  • func (s *ResourceStatus) IsDeleted() bool
  • func (s *ResourceStatus) IsFailed() bool
  • func (s *ResourceStatus) IsReady() bool
• type ResourceStatusJSONPathCondition
• type SetWatchErrorHandlerOptions
• type Tracker
  • func NewTracker(resID *resid.ResourceID, client kubernetes.Interface, ...) *Tracker
  • func (t *Tracker) Track(ctx context.Context, noActivityTimeout time.Duration, ...) error
• type TrackerState
• type UnrecoverableWatchError
  • func (e UnrecoverableWatchError) Error() string
  • func (e UnrecoverableWatchError) Unwrap() error

Constants

const ResourceStatusStabilizingDuration time.Duration = 2 * time.Second

Variables

var ResourceStatusJSONPathConditions []*ResourceStatusJSONPathCondition

Functions

func NewResourceStatusIndicator

func NewResourceStatusIndicator(object *unstructured.Unstructured) (indicator *indicators.StringEqualConditionIndicator, humanJSONPath string, err error)

func SetWatchErrorHandler

func SetWatchErrorHandler(cancelFn context.CancelFunc, resName string, setWatchErrorHandler func(handler cache.WatchErrorHandler) error, opts SetWatchErrorHandlerOptions) error

Types

type ContribResourceStatusRules

type ContribResourceStatusRules struct {
	Rules []struct {
		ResourceGroup *string `yaml:"resourceGroup"`
		ResourceKind  *string `yaml:"resourceKind"`
		JSONPath      string  `yaml:"jsonPath"`
		HumanJSONPath string  `yaml:"humanJsonPath"`
		Conditions    struct {
			Ready       []string `yaml:"ready"`
			Progressing []string `yaml:"progressing"`
			Failed      []string `yaml:"failed"`
		} `yaml:"conditions"`
	} `yaml:"rules"`
}

type EventStatus

type EventStatus struct {
	// contains filtered or unexported fields
}

func NewEventStatus

func NewEventStatus(event *corev1.Event) *EventStatus

func (*EventStatus) FailureReason

func (s *EventStatus) FailureReason() string

func (*EventStatus) IsFailure

func (s *EventStatus) IsFailure() bool

type Feed

type Feed struct {
	// contains filtered or unexported fields
}

func NewFeed

func NewFeed(tracker *Tracker) *Feed

func (*Feed) OnAdded

func (f *Feed) OnAdded(function func(status *ResourceStatus) error)

func (*Feed) OnEventMsg

func (f *Feed) OnEventMsg(function func(event *corev1.Event) error)

func (*Feed) OnFailed

func (f *Feed) OnFailed(function func(status *ResourceStatus) error)

func (*Feed) OnReady

func (f *Feed) OnReady(function func(status *ResourceStatus) error)

func (*Feed) OnStatus

func (f *Feed) OnStatus(function func(status *ResourceStatus) error)

func (*Feed) Track

func (f *Feed) Track(ctx context.Context, timeout, noActivityTimeout time.Duration) error

type ResourceEventsWatcher

type ResourceEventsWatcher struct {
	ResourceID *resid.ResourceID
	// contains filtered or unexported fields
}

func NewResourceEventsWatcher

func NewResourceEventsWatcher(
	object *unstructured.Unstructured,
	resID *resid.ResourceID,
	client kubernetes.Interface,
) *ResourceEventsWatcher

func (*ResourceEventsWatcher) Run

func (i *ResourceEventsWatcher) Run(ctx context.Context, eventsCh chan<- *corev1.Event) error

type ResourceStateWatcher

type ResourceStateWatcher struct {
	ResourceID *resid.ResourceID
	// contains filtered or unexported fields
}

func NewResourceStateWatcher

func NewResourceStateWatcher(
	resID *resid.ResourceID,
	client kubernetes.Interface,
	dynClient dynamic.Interface,
	mapper meta.RESTMapper,
) *ResourceStateWatcher

func (*ResourceStateWatcher) Run

func (w *ResourceStateWatcher) Run(ctx context.Context, resourceAddedCh, resourceModifiedCh, resourceDeletedCh chan<- *unstructured.Unstructured) error

type ResourceStatus

type ResourceStatus struct {
	Indicator *indicators.StringEqualConditionIndicator
	// contains filtered or unexported fields
}

func NewDeletedResourceStatus

func NewDeletedResourceStatus() *ResourceStatus

func NewFailedResourceStatus

func NewFailedResourceStatus(failureReason string) *ResourceStatus

func NewResourceStatus

func NewResourceStatus(object *unstructured.Unstructured) (*ResourceStatus, error)

func NewSucceededResourceStatus

func NewSucceededResourceStatus() *ResourceStatus

func (*ResourceStatus) DiffersFrom

func (s *ResourceStatus) DiffersFrom(newStatus *ResourceStatus) bool

func (*ResourceStatus) FailureReason

func (s *ResourceStatus) FailureReason() string

func (*ResourceStatus) HumanConditionPath

func (s *ResourceStatus) HumanConditionPath() string

func (*ResourceStatus) IsDeleted

func (s *ResourceStatus) IsDeleted() bool

func (*ResourceStatus) IsFailed

func (s *ResourceStatus) IsFailed() bool

func (*ResourceStatus) IsReady

func (s *ResourceStatus) IsReady() bool

type ResourceStatusJSONPathCondition

type ResourceStatusJSONPathCondition struct {
	GroupKind     *schema.GroupKind
	JSONPath      string
	HumanPath     string
	ReadyValues   []string
	PendingValues []string
	FailedValues  []string

	CurrentValue string
}

type SetWatchErrorHandlerOptions

type SetWatchErrorHandlerOptions struct {
	FatalWatchErr *UnrecoverableWatchError // If unrecoverable watch error occurred it will be saved here.
}

type Tracker

type Tracker struct {
	ResourceID *resid.ResourceID
	// contains filtered or unexported fields
}

func NewTracker

func NewTracker(
	resID *resid.ResourceID,
	client kubernetes.Interface,
	dynClient dynamic.Interface,
	discClient discovery.CachedDiscoveryInterface,
	mapper meta.RESTMapper,
) *Tracker

func (*Tracker) Track

func (t *Tracker) Track(ctx context.Context, noActivityTimeout time.Duration, addedCh, succeededCh, failedCh, regularCh chan<- *ResourceStatus, eventCh chan<- *corev1.Event) error

type TrackerState

type TrackerState string

const (
	TrackerStateInitial           TrackerState = "TrackerStateInitial"
	TrackerStateStatusStabilizing TrackerState = "TrackerStateStatusStabilizing"
	TrackerStateStarted           TrackerState = "TrackerStateStarted"
	TrackerStateResourceAdded     TrackerState = "TrackerStateResourceAdded"
	TrackerStateResourceSucceeded TrackerState = "TrackerStateResourceSucceeded"
	TrackerStateResourceFailed    TrackerState = "TrackerStateResourceFailed"
	TrackerStateResourceDeleted   TrackerState = "TrackerStateResourceDeleted"
)

type UnrecoverableWatchError

type UnrecoverableWatchError struct {
	ResName string
	Err     error
}

func (UnrecoverableWatchError) Error

func (e UnrecoverableWatchError) Error() string

func (UnrecoverableWatchError) Unwrap

func (e UnrecoverableWatchError) Unwrap() error