package kubecaml

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

Cron_job_spec describes how the job execution will look like and when it will actually run.

type t
val to_yojson : t -> Yojson.Safe.t
val make : ?suspend:bool -> ?successful_jobs_history_limit:int -> ?starting_deadline_seconds:int -> schedule:string -> job_template:Kubernetes.Definitions.Api.Batch.V1beta1.Job_template_spec.t -> ?failed_jobs_history_limit:int -> ?concurrency_policy:string -> unit -> t
val concurrency_policy : t -> string option

Specifies how to treat concurrent executions of a Job. Valid values are: - "allow" (default): allows Cron_jobs to run concurrently; - "forbid": forbids concurrent runs, skipping next run if previous run hasn't finished yet; - "replace": cancels currently running job and replaces it with a new one

val failed_jobs_history_limit : t -> int option

The number of failed finished jobs to retain. This is a pointer to distinguish between explicit zero and not specified. Defaults to 1.

Specifies the job that will be created when executing a Cron_job.

val schedule : t -> string

The schedule in Cron format, see https://en.wikipedia.org/wiki/Cron.

val starting_deadline_seconds : t -> int option

Optional deadline in seconds for starting the job if it misses scheduled time for any reason. Missed jobs executions will be counted as failed ones.

val successful_jobs_history_limit : t -> int option

The number of successful finished jobs to retain. This is a pointer to distinguish between explicit zero and not specified. Defaults to 3.

val suspend : t -> bool option

This flag tells the controller to suspend subsequent executions, it does not apply to already started executions. Defaults to false.

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

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct