task

Documentation

Index

• type ApplyTask
  • func (a *ApplyTask) Action() event.ResourceAction
  • func (a *ApplyTask) ClearTimeout()
  • func (a *ApplyTask) Identifiers() object.ObjMetadataSet
  • func (a *ApplyTask) Name() string
  • func (a *ApplyTask) Start(taskContext *taskrunner.TaskContext)
• type DeleteInvTask
  • func (i *DeleteInvTask) Action() event.ResourceAction
  • func (i *DeleteInvTask) ClearTimeout()
  • func (i *DeleteInvTask) Identifiers() object.ObjMetadataSet
  • func (i *DeleteInvTask) Name() string
  • func (i *DeleteInvTask) Start(taskContext *taskrunner.TaskContext)
• type InvAddTask
  • func (i *InvAddTask) Action() event.ResourceAction
  • func (i *InvAddTask) ClearTimeout()
  • func (i *InvAddTask) Identifiers() object.ObjMetadataSet
  • func (i *InvAddTask) Name() string
  • func (i *InvAddTask) Start(taskContext *taskrunner.TaskContext)
• type InvSetTask
  • func (i *InvSetTask) Action() event.ResourceAction
  • func (i *InvSetTask) ClearTimeout()
  • func (i *InvSetTask) Identifiers() object.ObjMetadataSet
  • func (i *InvSetTask) Name() string
  • func (i *InvSetTask) Start(taskContext *taskrunner.TaskContext)
• type KubectlPrinterAdapter
• type PruneTask
  • func (p *PruneTask) Action() event.ResourceAction
  • func (p *PruneTask) ClearTimeout()
  • func (p *PruneTask) Identifiers() object.ObjMetadataSet
  • func (p *PruneTask) Name() string
  • func (p *PruneTask) Start(taskContext *taskrunner.TaskContext)
• type ResetRESTMapperTask
  • func (r *ResetRESTMapperTask) ClearTimeout()
  • func (r *ResetRESTMapperTask) Start(taskContext *taskrunner.TaskContext)
• type SendEventTask
  • func (s *SendEventTask) ClearTimeout()
  • func (s *SendEventTask) Start(taskContext *taskrunner.TaskContext)

Types

type ApplyTask

type ApplyTask struct {
	TaskName string

	Factory           util.Factory
	InfoHelper        info.InfoHelper
	Mapper            meta.RESTMapper
	Objects           object.UnstructuredSet
	Filters           []filter.ValidationFilter
	Mutators          []mutator.Interface
	DryRunStrategy    common.DryRunStrategy
	ServerSideOptions common.ServerSideOptions
}

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

func (*ApplyTask) Action

func (a *ApplyTask) Action() event.ResourceAction

func (*ApplyTask) ClearTimeout

func (a *ApplyTask) ClearTimeout()

ClearTimeout is not supported by the ApplyTask.

func (*ApplyTask) Identifiers

func (a *ApplyTask) Identifiers() object.ObjMetadataSet

func (*ApplyTask) Name

func (a *ApplyTask) Name() string

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 DeleteInvTask

type DeleteInvTask struct {
	TaskName  string
	InvClient inventory.InventoryClient
	InvInfo   inventory.InventoryInfo
	DryRun    common.DryRunStrategy
}

DeleteInvTask encapsulates structures necessary to delete the inventory object from the cluster. Implements the Task interface. This task should happen after all resources have been deleted.

func (*DeleteInvTask) Action

func (i *DeleteInvTask) Action() event.ResourceAction

func (*DeleteInvTask) ClearTimeout

func (i *DeleteInvTask) ClearTimeout()

ClearTimeout is not supported by the DeleteInvTask.

func (*DeleteInvTask) Identifiers

func (i *DeleteInvTask) Identifiers() object.ObjMetadataSet

func (*DeleteInvTask) Name

func (i *DeleteInvTask) Name() string

func (*DeleteInvTask) Start

func (i *DeleteInvTask) Start(taskContext *taskrunner.TaskContext)

Start deletes the inventory object from the cluster.

type InvAddTask

type InvAddTask struct {
	TaskName  string
	InvClient inventory.InventoryClient
	InvInfo   inventory.InventoryInfo
	Objects   object.UnstructuredSet
	DryRun    common.DryRunStrategy
}

InvAddTask encapsulates structures necessary to add/merge inventory into the cluster. The InvAddTask should add/merge inventory references before the actual object is applied.

func (*InvAddTask) Action

func (i *InvAddTask) Action() event.ResourceAction

func (*InvAddTask) ClearTimeout

func (i *InvAddTask) ClearTimeout()

ClearTimeout is not supported by the InvAddTask.

func (*InvAddTask) Identifiers

func (i *InvAddTask) Identifiers() object.ObjMetadataSet

func (*InvAddTask) Name

func (i *InvAddTask) Name() string

func (*InvAddTask) Start

func (i *InvAddTask) Start(taskContext *taskrunner.TaskContext)

Start updates the inventory by merging the locally applied objects into the current inventory.

type InvSetTask

type InvSetTask struct {
	TaskName      string
	InvClient     inventory.InventoryClient
	InvInfo       inventory.InventoryInfo
	PrevInventory map[object.ObjMetadata]bool
	DryRun        common.DryRunStrategy
}

InvSetTask encapsulates structures necessary to set the inventory references at the end of the apply/prune.

func (*InvSetTask) Action

func (i *InvSetTask) Action() event.ResourceAction

func (*InvSetTask) ClearTimeout

func (i *InvSetTask) ClearTimeout()

ClearTimeout is not supported by the InvSetTask.

func (*InvSetTask) Identifiers

func (i *InvSetTask) Identifiers() object.ObjMetadataSet

func (*InvSetTask) Name

func (i *InvSetTask) Name() string

func (*InvSetTask) Start

func (i *InvSetTask) Start(taskContext *taskrunner.TaskContext)

Start sets the inventory using the resources applied and the prunes that failed. This task must run after all the apply and prune tasks have completed.

type KubectlPrinterAdapter

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

KubectlPrinterAdapter is a workaround for capturing progress from ApplyOptions. ApplyOptions were originally meant to print progress directly using a configurable printer. The KubectlPrinterAdapter plugs into ApplyOptions as a ToPrinter function, but instead of printing the info, it emits it as an event on the provided channel.

type PruneTask

type PruneTask struct {
	TaskName string

	PruneOptions      *prune.PruneOptions
	Objects           object.UnstructuredSet
	Filters           []filter.ValidationFilter
	DryRunStrategy    common.DryRunStrategy
	PropagationPolicy metav1.DeletionPropagation
	// True if we are destroying, which deletes the inventory object
	// as well (possibly) the inventory namespace.
	Destroy bool
}

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) Action

func (p *PruneTask) Action() event.ResourceAction

func (*PruneTask) ClearTimeout

func (p *PruneTask) ClearTimeout()

ClearTimeout is not supported by the PruneTask.

func (*PruneTask) Identifiers

func (p *PruneTask) Identifiers() object.ObjMetadataSet

func (*PruneTask) Name

func (p *PruneTask) Name() string

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 ResetRESTMapperTask

type ResetRESTMapperTask struct {
	Mapper meta.RESTMapper
}

ResetRESTMapperTask resets the provided RESTMapper.

func (*ResetRESTMapperTask) ClearTimeout

func (r *ResetRESTMapperTask) ClearTimeout()

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

func (*ResetRESTMapperTask) Start

func (r *ResetRESTMapperTask) Start(taskContext *taskrunner.TaskContext)

Start creates a new goroutine that will unwrap the provided RESTMapper to get the underlying DeferredDiscoveryRESTMapper and then reset it. It will send a TaskResult on the taskChannel to signal that the task has been completed.

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.