task

Documentation

Index

• type ApplyTask
  • func (a *ApplyTask) ClearTimeout()
  • func (a *ApplyTask) Start(taskContext *taskrunner.TaskContext)
• type PruneTask
  • func (p *PruneTask) ClearTimeout()
  • func (p *PruneTask) Start(taskContext *taskrunner.TaskContext)
• type SendEventTask
  • func (s *SendEventTask) ClearTimeout()
  • func (s *SendEventTask) Start(taskContext *taskrunner.TaskContext)

Types

type ApplyTask

type ApplyTask struct {
	ApplyOptions applyOptions
	Objects      []*resource.Info
	DryRun       bool
}

ApplyTask applies the given Objects to the cluster by using the ApplyOptions.

func (*ApplyTask) ClearTimeout

func (a *ApplyTask) ClearTimeout()

ClearTimeout is not supported by the ApplyTask.

func (*ApplyTask) Start

func (a *ApplyTask) Start(taskContext *taskrunner.TaskContext)

Start creates a new goroutine that will invoke the Run function on the ApplyOptions to update the cluster. It will push a TaskResult on the taskChannel to signal to the taskrunner that the task has completed (or failed). It will also fetch the Generation from each of the applied resources after the Run function has completed. This information is then added to the taskContext. The generation is increased every time the desired state of a resource is changed.

type PruneTask

type PruneTask struct {
	PruneOptions      *prune.PruneOptions
	Objects           []*resource.Info
	DryRun            bool
	PropagationPolicy metav1.DeletionPropagation
}

PruneTask prunes objects from the cluster by using the PruneOptions. The provided Objects is the set of resources that have just been applied.

func (*PruneTask) ClearTimeout

func (p *PruneTask) ClearTimeout()

ClearTimeout is not supported by the PruneTask.

func (*PruneTask) Start

func (p *PruneTask) Start(taskContext *taskrunner.TaskContext)

Start creates a new goroutine that will invoke the Run function on the PruneOptions to update the cluster. It will push a TaskResult on the taskChannel to signal to the taskrunner that the task has completed (or failed).

type SendEventTask

type SendEventTask struct {
	Event event.Event
}

SendEventTask is an implementation of the Task interface that will send the provided event on the eventChannel when executed.

func (*SendEventTask) ClearTimeout

func (s *SendEventTask) ClearTimeout()

ClearTimeout doesn't do anything as SendEventTask doesn't support timeouts.

func (*SendEventTask) Start

func (s *SendEventTask) Start(taskContext *taskrunner.TaskContext)

Start start a separate goroutine that will send the event and then push a TaskResult on the taskChannel to signal to the taskrunner that the task is completed.