scalejob

Documentation

Overview

Package scalejob is deprecated This package contains deprecated functions used to "scale" jobs in a way inconsistent with normal scaling rules

Index

• type JobPsuedoScaler
  • func (scaler *JobPsuedoScaler) Scale(namespace, name string, newSize uint, preconditions *ScalePrecondition, ...) error
  • func (scaler *JobPsuedoScaler) ScaleSimple(namespace, name string, preconditions *ScalePrecondition, newSize uint) (string, error)
• type PreconditionError
  • func (pe PreconditionError) Error() string
• type RetryParams
• type ScalePrecondition

Types

type JobPsuedoScaler

type JobPsuedoScaler struct {
	JobsClient batchclient.JobsGetter
}

JobPsuedoScaler is a deprecated scale-similar thing that doesn't obey scale semantics

func (*JobPsuedoScaler) Scale

func (scaler *JobPsuedoScaler) Scale(namespace, name string, newSize uint, preconditions *ScalePrecondition, retry, waitForReplicas *RetryParams) error

Scale updates a Job to a new size, with optional precondition check (if preconditions is not nil), optional retries (if retry is not nil), and then optionally waits for parallelism to reach desired number, which can be less than requested based on job's current progress.

func (*JobPsuedoScaler) ScaleSimple

func (scaler *JobPsuedoScaler) ScaleSimple(namespace, name string, preconditions *ScalePrecondition, newSize uint) (string, error)

ScaleSimple is responsible for updating job's parallelism. It returns the resourceVersion of the job if the update is successful.

type PreconditionError

type PreconditionError struct {
	Precondition  string
	ExpectedValue string
	ActualValue   string
}

PreconditionError is a deprecated error

func (PreconditionError) Error

func (pe PreconditionError) Error() string

type RetryParams

type RetryParams struct {
	Interval, Timeout time.Duration
}

RetryParams is a deprecated retry struct

type ScalePrecondition

type ScalePrecondition struct {
	Size            int
	ResourceVersion string
}

ScalePrecondition is a deprecated precondition