Documentation
¶
Index ¶
- func Buttons(ctx context.Context, client client.Reader, restartOn *v1alpha1.RestartOnSpec, ...) (map[string]*v1alpha1.UIButton, error)
- func FileWatches(ctx context.Context, client client.Reader, restartOn *v1alpha1.RestartOnSpec) (map[string]*v1alpha1.FileWatch, error)
- func LastRestartEvent(restartOn *v1alpha1.RestartOnSpec, triggerObjs Objects) (time.Time, *v1alpha1.UIButton)
- func LastStartEvent(startOn *v1alpha1.StartOnSpec, triggerObjs Objects) (time.Time, *v1alpha1.UIButton)
- func SetupController(builder *builder.Builder, idxer *indexer.Indexer, extractFunc ExtractFunc)
- type ExtractFunc
- type Objects
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Buttons ¶
func Buttons(ctx context.Context, client client.Reader, restartOn *v1alpha1.RestartOnSpec, startOn *v1alpha1.StartOnSpec) (map[string]*v1alpha1.UIButton, error)
Fetch all the buttons that this object depends on.
If a button isn't in the API server yet, it will simply be missing from the map.
Other errors reaching the API server will be returned to the caller.
TODO(nick): If the user typos a button name, there's currently no feedback that this is happening. This is probably the correct product behavior (in particular: resources should still run if their restarton button has been deleted). We might eventually need some sort of StartOnStatus/RestartOnStatus to express errors in lookup.
func FileWatches ¶
func FileWatches(ctx context.Context, client client.Reader, restartOn *v1alpha1.RestartOnSpec) (map[string]*v1alpha1.FileWatch, error)
Fetch all the filewatches that this object depends on.
If a filewatch isn't in the API server yet, it will simply be missing from the map.
Other errors reaching the API server will be returned to the caller.
TODO(nick): If the user typos a filewatch name, there's currently no feedback that this is happening. This is probably the correct product behavior (in particular: resources should still run if their restarton filewatch has been deleted). We might eventually need some sort of RestartOnStatus to express errors in lookup.
func LastRestartEvent ¶
func LastRestartEvent(restartOn *v1alpha1.RestartOnSpec, triggerObjs Objects) (time.Time, *v1alpha1.UIButton)
Fetch the last time a restart was requested from this target's dependencies.
Returns the most recent trigger time. If the most recent trigger is a button, return the button. Some consumers use the button for text inputs.
func LastStartEvent ¶
func LastStartEvent(startOn *v1alpha1.StartOnSpec, triggerObjs Objects) (time.Time, *v1alpha1.UIButton)
Fetch the last time a start was requested from this target's dependencies.
Returns the most recent trigger time. If the most recent trigger is a button, return the button. Some consumers use the button for text inputs.
func SetupController ¶ added in v0.23.0
func SetupController(builder *builder.Builder, idxer *indexer.Indexer, extractFunc ExtractFunc)
SetupController creates watches for types referenced by v1alpha1.RestartOnSpec & v1alpha1.StartOnSpec and registers an index function for them.
Types ¶
type ExtractFunc ¶ added in v0.23.0
type ExtractFunc func(obj client.Object) (*v1alpha1.RestartOnSpec, *v1alpha1.StartOnSpec)
type Objects ¶ added in v0.22.15
type Objects struct {
UIButtons map[string]*v1alpha1.UIButton
FileWatches map[string]*v1alpha1.FileWatch
}
Objects is a container for objects referenced by a RestartOnSpec and/or StartOnSpec.
func FetchObjects ¶ added in v0.22.15
func FetchObjects(ctx context.Context, client client.Reader, restartOn *v1alpha1.RestartOnSpec, startOn *v1alpha1.StartOnSpec) (Objects, error)
FetchObjects retrieves all objects referenced in either the RestartOnSpec or StartOnSpec.
Source Files