package kubecaml

  1. Overview
  2. Docs
package kubecaml
Legend:
Library
Module
Module type
Parameter
Class
Class type

Job_spec describes how the job execution will look like.

type t
val to_yojson : t -> Yojson.Safe.t
val make : template:Kubernetes.Definitions.Api.Core.V1.Pod_template_spec.t -> ?selector: Kubernetes.Definitions.Apimachinery.Pkg.Apis.Meta.V1.Label_selector.t -> ?parallelism:int -> ?manual_selector:bool -> ?completions:int -> ?backoff_limit:int -> ?active_deadline_seconds:int -> unit -> t
val active_deadline_seconds : t -> int option

Specifies the duration in seconds relative to the start_time that the job may be active before the system tries to terminate it; value must be positive integer

val backoff_limit : t -> int option

Specifies the number of retries before marking this job failed. Defaults to 6

val completions : t -> int option

Specifies the desired number of successfully finished pods the job should be run with. Setting to nil means that the success of any pod signals the success of all pods, and allows parallelism to have any positive value. Setting to 1 means that parallelism is limited to 1 and the success of that pod signals the success of the job. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/

val manual_selector : t -> bool option

manual_selector controls generation of pod labels and pod selectors. Leave `manual_selector` unset unless you are certain what you are doing. When false or unset, the system pick labels unique to this job and appends those labels to the pod template. When true, the user is responsible for picking unique labels and specifying the selector. Failure to pick a unique label may cause this and other jobs to not function correctly. However, You may see `manual_selector=true` in jobs that were created with the old `extensions/v1beta1` Api. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/#specifying-your-own-pod-selector

val parallelism : t -> int option

Specifies the maximum desired number of pods the job should run at any given time. The actual number of pods running in steady state will be less than this number when ((.spec.completions - .status.successful) < .spec.parallelism), i.e. when the work left to do is less than max parallelism. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/

A label query over pods that should match the pod count. Normally, the system sets this field for you. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors

Describes the pod that will be created when executing a job. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/

module Object : Object.S with type value := t