taskservice

Documentation

Overview

Package taskservice implement logic related to Proxmox Task.

Index

• Constants
• Variables
• func GetTask(ctx context.Context, machineScope *scope.MachineScope) (*proxmox.Task, error)
• func NewRequeueError(msg string, d time.Duration) error
• func ReconcileInFlightTask(ctx context.Context, machineScope *scope.MachineScope) (bool, error)
• type RequeueError
  • func (r *RequeueError) Error() string
  • func (r *RequeueError) RequeueAfter() time.Duration
• type TaskInfoState

Constants

const (
	TaskInfoStateQueued     = TaskInfoState("queued")
	TaskInfoStateRunning    = TaskInfoState("running")
	TaskInfoStateUnexpected = TaskInfoState("unexpected status")
	TaskInfoStateSuccess    = TaskInfoState("success")
	TaskInfoStateOK         = TaskInfoState("OK")
	TaskInfoStateError      = TaskInfoState("error")
)

all the task states.

Variables

var (
	// ErrTaskNotFound task is not found.
	ErrTaskNotFound = errors.New("task not found")
)

Functions

func GetTask

func GetTask(ctx context.Context, machineScope *scope.MachineScope) (*proxmox.Task, error)

GetTask returns the task relative to the current action.

func NewRequeueError

func NewRequeueError(msg string, d time.Duration) error

NewRequeueError returns an error of type RequeueError.

func ReconcileInFlightTask

func ReconcileInFlightTask(ctx context.Context, machineScope *scope.MachineScope) (bool, error)

ReconcileInFlightTask determines if a task associated to the Proxmox VM object is in flight or not.

Types

type RequeueError

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

RequeueError signals that a certain time must pass before continuing reconciliation.

The duration can be retrieved with RequeueAfter.

func (*RequeueError) Error

func (r *RequeueError) Error() string

func (*RequeueError) RequeueAfter

func (r *RequeueError) RequeueAfter() time.Duration

RequeueAfter returns the duration after which the controller will requeue the object.

type TaskInfoState

type TaskInfoState string

TaskInfoState the state of the task.