job

Documentation

Index

• func AreAllJobsSucceeded(jobPrefix, namespace string) (bool, error)
• func DescribeJobs(jobPrefix, namespace string)
• func WaitOnDeleted(jobPrefix, namespace string, sleep, timeout time.Duration) (bool, error)
• func WaitOnSucceeded(jobPrefix, namespace string, sleep, timeout time.Duration) (bool, error)
• type AreAllJobsSucceededResult
  • func AreAllJobsSucceededAsync(jobPrefix, namespace string) AreAllJobsSucceededResult
• type GetAllByPrefixResult
  • func GetAllByPrefixAsync(prefix, namespace string) GetAllByPrefixResult
• type GetResult
  • func GetAsync(jobName, namespace string) GetResult
• type Job
  • func CreateJobFromFile(filename, name, namespace string, sleep, timeout time.Duration) (*Job, error)
  • func CreateJobFromFileDeleteIfExists(filename, name, namespace string, sleep, timeout time.Duration) (*Job, error)
  • func CreateWindowsJobFromTemplate(filename, name, namespace string, windowsTestImages *engine.WindowsTestImages, ...) (*Job, error)
  • func CreateWindowsJobFromTemplateDeleteIfExists(filename, name, namespace string, windowsTestImages *engine.WindowsTestImages, ...) (*Job, error)
  • func Get(jobName, namespace string) (*Job, error)
  • func GetAllByPrefix(prefix, namespace string) ([]Job, error)
  • func GetWithRetry(jobName, namespace string, sleep, timeout time.Duration) (*Job, error)
  • func (j *Job) Delete(retries int) error
  • func (j *Job) Describe() error
  • func (j *Job) WaitOnSucceeded(sleep, timeout time.Duration) (bool, error)
• type List
  • func GetAll(namespace string) (*List, error)
• type Spec
• type Status

Functions

func AreAllJobsSucceeded

func AreAllJobsSucceeded(jobPrefix, namespace string) (bool, error)

AreAllJobsSucceeded will return true if all jobs with a common prefix in a given namespace are in a Completed State

func DescribeJobs

func DescribeJobs(jobPrefix, namespace string)

DescribeJobs describes all jobs whose name matches a substring

func WaitOnDeleted

func WaitOnDeleted(jobPrefix, namespace string, sleep, timeout time.Duration) (bool, error)

WaitOnDeleted returns when all jobs matching a prefix substring are successfully deleted

func WaitOnSucceeded

func WaitOnSucceeded(jobPrefix, namespace string, sleep, timeout time.Duration) (bool, error)

WaitOnSucceeded returns true if all jobs matching a prefix substring are in a succeeded state within a period of time

Types

type AreAllJobsSucceededResult

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

AreAllJobsSucceededResult is a return struct for AreAllJobsSucceededAsync

func AreAllJobsSucceededAsync

func AreAllJobsSucceededAsync(jobPrefix, namespace string) AreAllJobsSucceededResult

AreAllJobsSucceededAsync wraps AreAllJobsSucceeded with a struct response for goroutine + channel usage

type GetAllByPrefixResult

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

GetAllByPrefixResult is a return struct for GetAllByPrefixAsync

func GetAllByPrefixAsync

func GetAllByPrefixAsync(prefix, namespace string) GetAllByPrefixResult

GetAllByPrefixAsync wraps GetAllByPrefix with a struct response for goroutine + channel usage

type GetResult

type GetResult struct {
	Job *Job
	Err error
}

GetResult is a return struct for GetAsync

func GetAsync

func GetAsync(jobName, namespace string) GetResult

GetAsync wraps Get with a struct response for goroutine + channel usage

type Job

type Job struct {
	Metadata pod.Metadata `json:"metadata"`
	Spec     Spec         `json:"spec"`
	Status   Status       `json:"status"`
}

Job is used to parse data from kubectl get jobs

func CreateJobFromFile

func CreateJobFromFile(filename, name, namespace string, sleep, timeout time.Duration) (*Job, error)

CreateJobFromFile will create a Job from file with a name

func CreateJobFromFileDeleteIfExists

func CreateJobFromFileDeleteIfExists(filename, name, namespace string, sleep, timeout time.Duration) (*Job, error)

CreateJobFromFileDeleteIfExists will create a Job from file, deleting any pre-existing job with the same name

func CreateWindowsJobFromTemplate

func CreateWindowsJobFromTemplate(filename, name, namespace string, windowsTestImages *engine.WindowsTestImages, sleep, timeout time.Duration) (*Job, error)

CreateWindowsJobFromTemplate will create a Job from file with a name

func CreateWindowsJobFromTemplateDeleteIfExists

func CreateWindowsJobFromTemplateDeleteIfExists(filename, name, namespace string, windowsTestImages *engine.WindowsTestImages, sleep, timeout time.Duration) (*Job, error)

CreateWindowsJobFromTemplateDeleteIfExists will create a Job from file, deleting any pre-existing job with the same name

func Get

func Get(jobName, namespace string) (*Job, error)

Get will return a job with a given name and namespace

func GetAllByPrefix

func GetAllByPrefix(prefix, namespace string) ([]Job, error)

GetAllByPrefix will return all jobs in a given namespace that match a prefix

func GetWithRetry

func GetWithRetry(jobName, namespace string, sleep, timeout time.Duration) (*Job, error)

GetWithRetry gets a job, allowing for retries

func (*Job) Delete

func (j *Job) Delete(retries int) error

Delete will delete a Job in a given namespace

func (*Job) Describe

func (j *Job) Describe() error

Describe will describe a Job resource

func (*Job) WaitOnSucceeded

func (j *Job) WaitOnSucceeded(sleep, timeout time.Duration) (bool, error)

WaitOnSucceeded will call the static method WaitOnSucceeded passing in p.Metadata.Name and p.Metadata.Namespace

type List

type List struct {
	Jobs []Job `json:"items"`
}

List is a container that holds all jobs returned from doing a kubectl get jobs

func GetAll

func GetAll(namespace string) (*List, error)

GetAll will return all jobs in a given namespace

type Spec

type Spec struct {
	Completions int `json:"completions"`
	Parallelism int `json:"parallelism"`
}

Spec holds job spec metadata

type Status

type Status struct {
	Active    int `json:"active"`
	Succeeded int `json:"succeeded"`
}

Status holds job status information