Skip to content

batch.v1

Index

Fields

obj cronJob

fn cronJob.new

new(name, schedule, containers)

fn cronJob.configMapVolumeMount

configMapVolumeMount(configMap, path, volumeMountMixin, volumeMixin, containers)

configMapVolumeMount mounts a configMap on path. It will also add an annotation hash to ensure the pods are re-deployed when the config map changes.

If containers is specified as an array of container names it will only be mounted to those containers, otherwise it will be mounted on all containers.

This helper function can be augmented with a volumeMixin. For example, passing "k.core.v1.volume.configMap.withDefaultMode(420)" will result in a default mode mixin. This helper function can be augmented with a volumeMountsMixin. For example, passing "k.core.v1.volumeMount.withSubPath(subpath)" will result in a subpath mixin.

fn cronJob.configVolumeMount

configVolumeMount(name, path, volumeMountMixin, volumeMixin, containers)

configVolumeMount mounts a ConfigMap by name on path.

If containers is specified as an array of container names it will only be mounted to those containers, otherwise it will be mounted on all containers.

This helper function can be augmented with a volumeMixin. For example, passing "k.core.v1.volume.configMap.withDefaultMode(420)" will result in a default mode mixin. This helper function can be augmented with a volumeMountsMixin. For example, passing "k.core.v1.volumeMount.withSubPath(subpath)" will result in a subpath mixin.

fn cronJob.csiVolumeMount

csiVolumeMount(name, path, driver, volumeAttributes={}, volumeMountMixin, volumeMixin, containers)

csiVolumeMount mounts CSI volume by name into all container on path. If containers is specified as an array of container names it will only be mounted to those containers, otherwise it will be mounted on all containers. This helper function can be augmented with a volumeMixin. For example, passing "k.core.v1.volume.csi.withReadOnly(false)" will result in a mixin that makes the volume writeable. This helper function can be augmented with a volumeMountsMixin. For example, passing "k.core.v1.volumeMount.withSubPath(subpath)" will result in a subpath mixin.

fn cronJob.emptyVolumeMount

emptyVolumeMount(name, path, volumeMountMixin, volumeMixin, containers)

emptyVolumeMount mounts empty volume by name into all container on path.

If containers is specified as an array of container names it will only be mounted to those containers, otherwise it will be mounted on all containers.

This helper function can be augmented with a volumeMixin. For example, passing "k.core.v1.volume.emptyDir.withSizeLimit('100Mi')" will result in a mixin that limits the size of the volume to 100Mi. This helper function can be augmented with a volumeMountsMixin. For example, passing "k.core.v1.volumeMount.withSubPath(subpath)" will result in a subpath mixin.

fn cronJob.hostVolumeMount

hostVolumeMount(name, hostPath, path, readOnly, volumeMountMixin, volumeMixin, containers)

hostVolumeMount mounts a hostPath on path.

If containers is specified as an array of container names it will only be mounted to those containers, otherwise it will be mounted on all containers.

This helper function can be augmented with a volumeMixin. For example, passing "k.core.v1.volume.hostPath.withType('Socket')" will result in a socket type mixin. This helper function can be augmented with a volumeMountsMixin. For example, passing "k.core.v1.volumeMount.withSubPath(subpath)" will result in a subpath mixin.

fn cronJob.mapContainers

mapContainers(f)

mapContainers applies the function f to each container. It works exactly as std.map, but on the containers of this object.

Signature of f: 

f(container: Object) Object

fn cronJob.mapContainersWithName

mapContainersWithName(names, f)

mapContainersWithName is like mapContainers, but only applies to those containers in the names array

fn cronJob.pvcVolumeMount

pvcVolumeMount(name, path, readOnly, volumeMountMixin, volumeMixin, containers)

hostVolumeMount mounts a PersistentVolumeClaim by name on path.

If containers is specified as an array of container names it will only be mounted to those containers, otherwise it will be mounted on all containers.

This helper function can be augmented with a volumeMixin. For example, passing "k.core.v1.volume.persistentVolumeClaim.withReadOnly(true)" will result in a mixin that forces all container mounts to be read-only. This helper function can be augmented with a volumeMountsMixin. For example, passing "k.core.v1.volumeMount.withSubPath(subpath)" will result in a subpath mixin.

fn cronJob.secretVolumeMount

secretVolumeMount(name, path, defaultMode, volumeMountMixin, volumeMixin, containers)

secretVolumeMount mounts a Secret by name into all container on path.'

If containers is specified as an array of container names it will only be mounted to those containers, otherwise it will be mounted on all containers.

This helper function can be augmented with a volumeMixin. For example, passing "k.core.v1.volume.secret.withOptional(true)" will result in a mixin that allows the secret to be optional. This helper function can be augmented with a volumeMountsMixin. For example, passing "k.core.v1.volumeMount.withSubPath(subpath)" will result in a subpath mixin.

fn cronJob.secretVolumeMountAnnotated

secretVolumeMountAnnotated(name, path, defaultMode, volumeMountMixin, volumeMixin, containers)

same as secretVolumeMount, adding an annotation to force redeploy on change.This helper function can be augmented with a volumeMountsMixin. For example, passing "k.core.v1.volumeMount.withSubPath(subpath)" will result in a subpath mixin.