job

Documentation

Index

• func GetJobEvents(client client.Interface, namespace, jobName string) (*common.EventList, error)
• func GetJobPods(client k8sClient.Interface, heapsterClient client.HeapsterClient, ...) (*pod.PodList, error)
• func GetJobPodsEvents(client client.Interface, namespace, jobName string) ([]api.Event, error)
• type Job
  • func ToJob(job *batch.Job, podInfo *common.PodInfo) Job
• type JobDetail
  • func GetJobDetail(client k8sClient.Interface, heapsterClient client.HeapsterClient, ...) (*JobDetail, error)
• type JobList
  • func CreateJobList(jobs []batch.Job, pods []api.Pod, events []api.Event, ...) *JobList
  • func GetJobList(client client.Interface, nsQuery *common.NamespaceQuery, ...) (*JobList, error)
  • func GetJobListFromChannels(channels *common.ResourceChannels, pQuery *common.PaginationQuery) (*JobList, error)

Functions

func GetJobEvents

func GetJobEvents(client client.Interface, namespace, jobName string) (
	*common.EventList, error)

GetJobEvents gets events associated to job.

func GetJobPods

func GetJobPods(client k8sClient.Interface, heapsterClient client.HeapsterClient,
	pQuery *common.PaginationQuery, jobName, namespace string) (*pod.PodList, error)

GetJobPods return list of pods targeting job.

func GetJobPodsEvents

func GetJobPodsEvents(client client.Interface, namespace, jobName string) (
	[]api.Event, error)

GetJobPodsEvents gets events associated to pods in job.

Types

type Job

type Job struct {
	ObjectMeta common.ObjectMeta `json:"objectMeta"`
	TypeMeta   common.TypeMeta   `json:"typeMeta"`

	// Aggregate information about pods belonging to this Job.
	Pods common.PodInfo `json:"pods"`

	// Container images of the Job.
	ContainerImages []string `json:"containerImages"`
}

Job is a presentation layer view of Kubernetes Job resource. This means it is Job plus additional augumented data we can get from other sources

func ToJob

func ToJob(job *batch.Job, podInfo *common.PodInfo) Job

type JobDetail

type JobDetail struct {
	ObjectMeta common.ObjectMeta `json:"objectMeta"`
	TypeMeta   common.TypeMeta   `json:"typeMeta"`

	// Aggregate information about pods belonging to this Job.
	PodInfo common.PodInfo `json:"podInfo"`

	// Detailed information about Pods belonging to this Job.
	PodList pod.PodList `json:"podList"`

	// Container images of the Job.
	ContainerImages []string `json:"containerImages"`

	// List of events related to this Job.
	EventList common.EventList `json:"eventList"`

	// Parallelism specifies the maximum desired number of pods the job should run at any given
	// time.
	Parallelism *int32 `json:"paralleism"`

	// Completions specifies the desired number of successfully finished pods the job should be
	// run with.
	Completions *int32 `json:"completions"`
}

JobDetail is a presentation layer view of Kubernetes Job resource. This means it is Job plus additional augmented data we can get from other sources (like services that target the same pods).

func GetJobDetail

func GetJobDetail(client k8sClient.Interface, heapsterClient client.HeapsterClient,
	namespace, name string, pQuery *common.PaginationQuery) (*JobDetail, error)

GetJobDetail gets job details.

type JobList

type JobList struct {
	ListMeta common.ListMeta `json:"listMeta"`

	// Unordered list of Jobs.
	Jobs []Job `json:"jobs"`
}

JobList contains a list of Jobs in the cluster.

func CreateJobList

func CreateJobList(jobs []batch.Job, pods []api.Pod, events []api.Event,
	pQuery *common.PaginationQuery) *JobList

CreateJobList returns a list of all Job model objects in the cluster, based on all Kubernetes Job API objects.

func GetJobList

func GetJobList(client client.Interface, nsQuery *common.NamespaceQuery,
	pQuery *common.PaginationQuery) (*JobList, error)

GetJobList returns a list of all Jobs in the cluster.

func GetJobListFromChannels

func GetJobListFromChannels(channels *common.ResourceChannels, pQuery *common.PaginationQuery) (
	*JobList, error)

GetJobList returns a list of all Jobs in the cluster reading required resource list once from the channels.