job

Documentation

Index

• type Job
  • func New(job *v1.Job, timeouts *Timeouts) *Job
  • func NewWithDefaults(job *v1.Job) *Job
  • func NewWithDefaultsUseExistingName(job *v1.Job) *Job
  • func (j *Job) AddContainer(add container.Container)
  • func (j *Job) AddInitContainer(add container.Container)
  • func (j *Job) AppendPullSecret(imagePullSecret corev1.LocalObjectReference)
  • func (j *Job) AppendVolumeIfMissing(volume corev1.Volume)
  • func (j *Job) ContainerFinished(client controller.Client, contName string) (bool, error)
  • func (j *Job) ContainerStatus(client controller.Client, contName string) (Status, error)
  • func (j *Job) Delete(client controller.Client) error
  • func (j *Job) GetContainer(name string) (cont container.Container, err error)
  • func (j *Job) MustGetContainer(name string) container.Container
  • func (j *Job) Status(client controller.Client) (Status, error)
  • func (j *Job) UpdateSecurityContextForAllContainers(sc container.SecurityContext)
  • func (j *Job) WaitUntilActive(client controller.Client) error
  • func (j *Job) WaitUntilContainerFinished(client controller.Client, contName string) error
  • func (j *Job) WaitUntilFinished(client controller.Client) error
• type Status
• type Timeouts

Types

type Job

type Job struct {
	*v1.Job

	Timeouts *Timeouts
}

func New

func New(job *v1.Job, timeouts *Timeouts) *Job

func NewWithDefaults

func NewWithDefaults(job *v1.Job) *Job

func NewWithDefaultsUseExistingName

func NewWithDefaultsUseExistingName(job *v1.Job) *Job

func (*Job) AddContainer

func (j *Job) AddContainer(add container.Container)

func (*Job) AddInitContainer

func (j *Job) AddInitContainer(add container.Container)

func (*Job) AppendPullSecret

func (j *Job) AppendPullSecret(imagePullSecret corev1.LocalObjectReference)

func (*Job) AppendVolumeIfMissing

func (j *Job) AppendVolumeIfMissing(volume corev1.Volume)

func (*Job) ContainerFinished

func (j *Job) ContainerFinished(client controller.Client, contName string) (bool, error)

func (*Job) ContainerStatus

func (j *Job) ContainerStatus(client controller.Client, contName string) (Status, error)

func (*Job) Delete

func (j *Job) Delete(client controller.Client) error

func (*Job) GetContainer

func (j *Job) GetContainer(name string) (cont container.Container, err error)

func (*Job) MustGetContainer

func (j *Job) MustGetContainer(name string) container.Container

func (*Job) Status

func (j *Job) Status(client controller.Client) (Status, error)

func (*Job) UpdateSecurityContextForAllContainers

func (j *Job) UpdateSecurityContextForAllContainers(sc container.SecurityContext)

UpdateSecurityContextForAllContainers updates the security context for all containers defined in the job

func (*Job) WaitUntilActive

func (j *Job) WaitUntilActive(client controller.Client) error

func (*Job) WaitUntilContainerFinished

func (j *Job) WaitUntilContainerFinished(client controller.Client, contName string) error

func (*Job) WaitUntilFinished

func (j *Job) WaitUntilFinished(client controller.Client) error

type Status

type Status string

const (
	FAILED    Status = "failed"
	COMPLETED Status = "completed"
	UNKNOWN   Status = "unknown"
)

type Timeouts

type Timeouts struct {
	WaitUntilActive, WaitUntilFinished time.Duration
}