Hierarchy

  • Partial<Omit<kplus.CronJobProps, "schedule">>
    • DatabaseSyncProps

Properties

activeDeadline?: Duration

Specifies the duration the job may be active before the system tries to terminate it.

Default

- If unset, then there is no deadline.
automountServiceAccountToken?: boolean

Indicates whether a service account token should be automatically mounted.

backoffLimit?: number

Specifies the number of retries before marking this job failed.

Default

- If not set, system defaults to 6.
concurrencyPolicy?: ConcurrencyPolicy

Specifies the concurrency policy for the job.

Default

ConcurrencyPolicy.Forbid
containers?: ContainerProps[]

List of containers belonging to the pod. Containers cannot currently be added or removed. There must be at least one container in a Pod.

You can add additionnal containers using podSpec.addContainer()

Default

- No containers. Note that a pod spec must include at least one container.
dns?: PodDnsProps

DNS settings for the pod.

See

https://kubernetes.io/docs/concepts/services-networking/dns-pod-service/

Default

policy: DnsPolicy.CLUSTER_FIRST
hostnameAsFQDN: false
dockerRegistryAuth?: ISecret

A secret containing docker credentials for authenticating to a registry.

Default

- No auth. Images are assumed to be publicly available.
failedJobsRetained?: number

Specifies the number of failed jobs history retained. This would retain the Job and the associated Pod resource and can be useful for debugging.

Default

1
hostAliases?: HostAlias[]

HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod's hosts file.

Schema

io.k8s.api.core.v1.HostAlias

hostNetwork?: boolean

Host network for the pod.

Default

false
image: ContainerImageProps
initContainers?: ContainerProps[]

List of initialization containers belonging to the pod. Init containers are executed in order prior to containers being started. If any init container fails, the pod is considered to have failed and is handled according to its restartPolicy. The name for an init container or normal container must be unique among all containers. Init containers may not have Lifecycle actions, Readiness probes, Liveness probes, or Startup probes. The resourceRequirements of an init container are taken into account during scheduling by finding the highest request/limit for each resource type, and then using the max of of that value or the sum of the normal containers. Limits are applied to init containers in a similar fashion.

Init containers cannot currently be added ,removed or updated.

isolate?: boolean

Isolates the pod. This will prevent any ingress or egress connections to / from this pod. You can however allow explicit connections post instantiation by using the .connections property.

Default

false
metadata?: ApiObjectMetadata

Metadata that all persisted resources must have, which includes all objects users must create.

podMetadata?: ApiObjectMetadata

The pod metadata of this workload.

restartPolicy?: RestartPolicy

Restart policy for all containers within the pod.

schedule: CronOptions
securityContext?: PodSecurityContextProps

SecurityContext holds pod-level security attributes and common container settings.

Default

fsGroupChangePolicy: FsGroupChangePolicy.FsGroupChangePolicy.ALWAYS
ensureNonRoot: true
select?: boolean

Automatically allocates a pod label selector for this workload and add it to the pod metadata. This ensures this workload manages pods created by its pod template.

Default

true
serviceAccount?: IServiceAccount

A service account provides an identity for processes that run in a Pod.

When you (a human) access the cluster (for example, using kubectl), you are authenticated by the apiserver as a particular User Account (currently this is usually admin, unless your cluster administrator has customized your cluster). Processes in containers inside pods can also contact the apiserver. When they do, they are authenticated as a particular Service Account (for example, default).

sourceDsn?: null | string
spread?: boolean

Automatically spread pods across hostname and zones.

startingDeadline?: Duration

Kubernetes attempts to start cron jobs at its schedule time, but this is not guaranteed. This deadline specifies how much time can pass after a schedule point, for which kubernetes can still start the job. For example, if this is set to 100 seconds, kubernetes is allowed to start the job at a maximum 100 seconds after the scheduled time.

Note that the Kubernetes CronJobController checks for things every 10 seconds, for this reason, a deadline below 10 seconds is not allowed, as it may cause your job to never be scheduled.

In addition, kubernetes will stop scheduling jobs if more than 100 schedules were missed (for any reason). This property also controls what time interval should kubernetes consider when counting for missed schedules.

For example, suppose a CronJob is set to schedule a new Job every one minute beginning at 08:30:00, and its startingDeadline field is not set. If the CronJob controller happens to be down from 08:29:00 to 10:21:00, the job will not start as the number of missed jobs which missed their schedule is greater than 100. However, if startingDeadline is set to 200 seconds, kubernetes will only count 3 missed schedules, and thus start a new execution at 10:22:00.

Default

Duration.seconds(10)
successfulJobsRetained?: number

Specifies the number of successful jobs history retained. This would retain the Job and the associated Pod resource and can be useful for debugging.

Default

3
suspend?: boolean

Specifies if the cron job should be suspended. Only applies to future executions, current ones are remained untouched.

Default

false
terminationGracePeriod?: Duration

Grace period until the pod is terminated

Default

Duration.seconds(30)
timeZone?: string

Specifies the timezone for the job. This helps aligining the schedule to follow the specified timezone.

See

https://en.wikipedia.org/wiki/List_of_tz_database_time_zones for list of valid timezone values.

Default

- Timezone of kube-controller-manager process.
ttlAfterFinished?: Duration

Limits the lifetime of a Job that has finished execution (either Complete or Failed). If this field is set, after the Job finishes, it is eligible to be automatically deleted. When the Job is being deleted, its lifecycle guarantees (e.g. finalizers) will be honored. If this field is set to zero, the Job becomes eligible to be deleted immediately after it finishes. This field is alpha-level and is only honored by servers that enable the TTLAfterFinished feature.

Default

- If this field is unset, the Job won't be automatically deleted.
volumes?: Volume[]

List of volumes that can be mounted by containers belonging to the pod.

You can also add volumes later using podSpec.addVolume()

Generated using TypeDoc