task

Documentation

Index

• func NewTaskRunner(task Task, writer filewriter.FileWriter, opts ...TaskRunnerOpt) *taskRunner
• func UnmarshalTaskCheckpoint(taskCheckpoint TaskCheckpoint, config TaskCheckpoint) error
• type CheckpointInfo
• type CommandContext
  • func (c *CommandContext) SetError(err error)
• type CompletedTask
• type Profiler
  • func (pp *Profiler) MarkDone(taskName string, msg string)
  • func (pp *Profiler) MarkDoneTask(taskName string)
  • func (pp *Profiler) Metrics() map[string]map[string]time.Duration
  • func (pp *Profiler) SetStart(taskName string, msg string)
  • func (pp *Profiler) SetStartTask(taskName string)
• type Task
• type TaskCheckpoint
• type TaskRunnerOpt
  • func WithCheckpointFile() TaskRunnerOpt

Functions

func NewTaskRunner

func NewTaskRunner(task Task, writer filewriter.FileWriter, opts ...TaskRunnerOpt) *taskRunner

func UnmarshalTaskCheckpoint

func UnmarshalTaskCheckpoint(taskCheckpoint TaskCheckpoint, config TaskCheckpoint) error

UnmarshalTaskCheckpoint marshals the received task checkpoint (type interface{}) then unmarshalls it into the desired type

specified in the Restore() method. When reading from a yaml file, there isn't a direct way in Go to do a type conversion from interface{} to the desired type. We use interface{} because the TaskCheckpoint type will vary depending on what's needed for a specific task. The known workaround for this is to marshal & unmarshal it into the checkpoint type.

Types

type CheckpointInfo

type CheckpointInfo struct {
	CompletedTasks map[string]*CompletedTask `json:"completedTasks"`
}

type CommandContext

type CommandContext struct {
	Bootstrapper              interfaces.Bootstrapper
	Provider                  providers.Provider
	ClusterManager            interfaces.ClusterManager
	GitOpsManager             interfaces.GitOpsManager
	Validations               interfaces.Validator
	Writer                    filewriter.FileWriter
	EksdInstaller             interfaces.EksdInstaller
	PackageInstaller          interfaces.PackageInstaller
	EksdUpgrader              interfaces.EksdUpgrader
	ClusterUpgrader           interfaces.ClusterUpgrader
	CAPIManager               interfaces.CAPIManager
	ClusterSpec               *cluster.Spec
	CurrentClusterSpec        *cluster.Spec
	UpgradeChangeDiff         *types.ChangeDiff
	BootstrapCluster          *types.Cluster
	ManagementCluster         *types.Cluster
	WorkloadCluster           *types.Cluster
	Profiler                  *Profiler
	OriginalError             error
	ManagementClusterStateDir string
	ForceCleanup              bool
}

Command context maintains the mutable and shared entities.

func (*CommandContext) SetError

func (c *CommandContext) SetError(err error)

type CompletedTask

type CompletedTask struct {
	Checkpoint TaskCheckpoint `json:"checkpoint"`
}

type Profiler

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

func (*Profiler) MarkDone

func (pp *Profiler) MarkDone(taskName string, msg string)

this can be used to profile sub tasks.

func (*Profiler) MarkDoneTask

func (pp *Profiler) MarkDoneTask(taskName string)

needs to be called after setStart.

func (*Profiler) Metrics

func (pp *Profiler) Metrics() map[string]map[string]time.Duration

get Metrics.

func (*Profiler) SetStart

func (pp *Profiler) SetStart(taskName string, msg string)

this can be used to profile sub tasks.

func (*Profiler) SetStartTask

func (pp *Profiler) SetStartTask(taskName string)

profiler for a Task.

type Task

type Task interface {
	Run(ctx context.Context, commandContext *CommandContext) Task
	Name() string
	Checkpoint() *CompletedTask
	Restore(ctx context.Context, commandContext *CommandContext, completedTask *CompletedTask) (Task, error)
}

Task is a logical unit of work - meant to be implemented by each Task.

type TaskCheckpoint

type TaskCheckpoint interface{}

type TaskRunnerOpt

type TaskRunnerOpt func(*taskRunner)

func WithCheckpointFile

func WithCheckpointFile() TaskRunnerOpt