package cronJob
CronJob represents the configuration of a single cron job.
Index
fn new(name, schedule, containers)
fn mapContainers(f)
fn mapContainersWithName(names, f)
obj metadata
fn withAnnotations(annotations)
fn withAnnotationsMixin(annotations)
fn withClusterName(clusterName)
fn withCreationTimestamp(creationTimestamp)
fn withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)
fn withDeletionTimestamp(deletionTimestamp)
fn withFinalizers(finalizers)
fn withFinalizersMixin(finalizers)
fn withGenerateName(generateName)
fn withGeneration(generation)
fn withLabels(labels)
fn withLabelsMixin(labels)
fn withManagedFields(managedFields)
fn withManagedFieldsMixin(managedFields)
fn withName(name)
fn withNamespace(namespace)
fn withOwnerReferences(ownerReferences)
fn withOwnerReferencesMixin(ownerReferences)
fn withResourceVersion(resourceVersion)
fn withSelfLink(selfLink)
fn withUid(uid)
obj spec
fn withConcurrencyPolicy(concurrencyPolicy)
fn withFailedJobsHistoryLimit(failedJobsHistoryLimit)
fn withSchedule(schedule)
fn withStartingDeadlineSeconds(startingDeadlineSeconds)
fn withSuccessfulJobsHistoryLimit(successfulJobsHistoryLimit)
fn withSuspend(suspend)
obj spec.jobTemplate
obj spec.jobTemplate.metadata
fn withAnnotations(annotations)
fn withAnnotationsMixin(annotations)
fn withClusterName(clusterName)
fn withCreationTimestamp(creationTimestamp)
fn withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)
fn withDeletionTimestamp(deletionTimestamp)
fn withFinalizers(finalizers)
fn withFinalizersMixin(finalizers)
fn withGenerateName(generateName)
fn withGeneration(generation)
fn withLabels(labels)
fn withLabelsMixin(labels)
fn withManagedFields(managedFields)
fn withManagedFieldsMixin(managedFields)
fn withName(name)
fn withNamespace(namespace)
fn withOwnerReferences(ownerReferences)
fn withOwnerReferencesMixin(ownerReferences)
fn withResourceVersion(resourceVersion)
fn withSelfLink(selfLink)
fn withUid(uid)
obj spec.jobTemplate.spec
fn withActiveDeadlineSeconds(activeDeadlineSeconds)
fn withBackoffLimit(backoffLimit)
fn withCompletions(completions)
fn withManualSelector(manualSelector)
fn withParallelism(parallelism)
fn withTtlSecondsAfterFinished(ttlSecondsAfterFinished)
obj spec.jobTemplate.spec.selector
obj spec.jobTemplate.spec.template
obj spec.jobTemplate.spec.template.metadata
fn withAnnotations(annotations)
fn withAnnotationsMixin(annotations)
fn withClusterName(clusterName)
fn withCreationTimestamp(creationTimestamp)
fn withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)
fn withDeletionTimestamp(deletionTimestamp)
fn withFinalizers(finalizers)
fn withFinalizersMixin(finalizers)
fn withGenerateName(generateName)
fn withGeneration(generation)
fn withLabels(labels)
fn withLabelsMixin(labels)
fn withManagedFields(managedFields)
fn withManagedFieldsMixin(managedFields)
fn withName(name)
fn withNamespace(namespace)
fn withOwnerReferences(ownerReferences)
fn withOwnerReferencesMixin(ownerReferences)
fn withResourceVersion(resourceVersion)
fn withSelfLink(selfLink)
fn withUid(uid)
obj spec.jobTemplate.spec.template.spec
fn withActiveDeadlineSeconds(activeDeadlineSeconds)
fn withAutomountServiceAccountToken(automountServiceAccountToken)
fn withContainers(containers)
fn withContainersMixin(containers)
fn withDnsPolicy(dnsPolicy)
fn withEnableServiceLinks(enableServiceLinks)
fn withEphemeralContainers(ephemeralContainers)
fn withEphemeralContainersMixin(ephemeralContainers)
fn withHostAliases(hostAliases)
fn withHostAliasesMixin(hostAliases)
fn withHostIPC(hostIPC)
fn withHostNetwork(hostNetwork)
fn withHostPID(hostPID)
fn withHostname(hostname)
fn withImagePullSecrets(imagePullSecrets)
fn withImagePullSecretsMixin(imagePullSecrets)
fn withInitContainers(initContainers)
fn withInitContainersMixin(initContainers)
fn withNodeName(nodeName)
fn withNodeSelector(nodeSelector)
fn withNodeSelectorMixin(nodeSelector)
fn withOverhead(overhead)
fn withOverheadMixin(overhead)
fn withPreemptionPolicy(preemptionPolicy)
fn withPriority(priority)
fn withPriorityClassName(priorityClassName)
fn withReadinessGates(readinessGates)
fn withReadinessGatesMixin(readinessGates)
fn withRestartPolicy(restartPolicy)
fn withRuntimeClassName(runtimeClassName)
fn withSchedulerName(schedulerName)
fn withServiceAccount(serviceAccount)
fn withServiceAccountName(serviceAccountName)
fn withShareProcessNamespace(shareProcessNamespace)
fn withSubdomain(subdomain)
fn withTerminationGracePeriodSeconds(terminationGracePeriodSeconds)
fn withTolerations(tolerations)
fn withTolerationsMixin(tolerations)
fn withTopologySpreadConstraints(topologySpreadConstraints)
fn withTopologySpreadConstraintsMixin(topologySpreadConstraints)
fn withVolumes(volumes)
fn withVolumesMixin(volumes)
obj spec.jobTemplate.spec.template.spec.affinity
obj spec.jobTemplate.spec.template.spec.affinity.nodeAffinity
fn withPreferredDuringSchedulingIgnoredDuringExecution(preferredDuringSchedulingIgnoredDuringExecution)
fn withPreferredDuringSchedulingIgnoredDuringExecutionMixin(preferredDuringSchedulingIgnoredDuringExecution)
obj spec.jobTemplate.spec.template.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution
obj spec.jobTemplate.spec.template.spec.affinity.podAffinity
fn withPreferredDuringSchedulingIgnoredDuringExecution(preferredDuringSchedulingIgnoredDuringExecution)
fn withPreferredDuringSchedulingIgnoredDuringExecutionMixin(preferredDuringSchedulingIgnoredDuringExecution)
fn withRequiredDuringSchedulingIgnoredDuringExecution(requiredDuringSchedulingIgnoredDuringExecution)
fn withRequiredDuringSchedulingIgnoredDuringExecutionMixin(requiredDuringSchedulingIgnoredDuringExecution)
obj spec.jobTemplate.spec.template.spec.affinity.podAntiAffinity
fn withPreferredDuringSchedulingIgnoredDuringExecution(preferredDuringSchedulingIgnoredDuringExecution)
fn withPreferredDuringSchedulingIgnoredDuringExecutionMixin(preferredDuringSchedulingIgnoredDuringExecution)
fn withRequiredDuringSchedulingIgnoredDuringExecution(requiredDuringSchedulingIgnoredDuringExecution)
fn withRequiredDuringSchedulingIgnoredDuringExecutionMixin(requiredDuringSchedulingIgnoredDuringExecution)
obj spec.jobTemplate.spec.template.spec.dnsConfig
obj spec.jobTemplate.spec.template.spec.securityContext
fn withFsGroup(fsGroup)
fn withFsGroupChangePolicy(fsGroupChangePolicy)
fn withRunAsGroup(runAsGroup)
fn withRunAsNonRoot(runAsNonRoot)
fn withRunAsUser(runAsUser)
fn withSupplementalGroups(supplementalGroups)
fn withSupplementalGroupsMixin(supplementalGroups)
fn withSysctls(sysctls)
fn withSysctlsMixin(sysctls)
obj spec.jobTemplate.spec.template.spec.securityContext.seLinuxOptions
obj spec.jobTemplate.spec.template.spec.securityContext.windowsOptions
Fields
fn new
new(name, schedule, containers)
new returns an instance of Cronjob
fn 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 mapContainersWithName
mapContainersWithName(names, f)
mapContainersWithName
is like mapContainers
, but only applies to those containers in the names
array
obj metadata
ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
fn metadata.withAnnotations
withAnnotations(annotations)
Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations
fn metadata.withAnnotationsMixin
withAnnotationsMixin(annotations)
Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations
Note: This function appends passed data to existing values
fn metadata.withClusterName
withClusterName(clusterName)
The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request.
fn metadata.withCreationTimestamp
withCreationTimestamp(creationTimestamp)
Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.
fn metadata.withDeletionGracePeriodSeconds
withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)
Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.
fn metadata.withDeletionTimestamp
withDeletionTimestamp(deletionTimestamp)
Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.
fn metadata.withFinalizers
withFinalizers(finalizers)
Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list.
fn metadata.withFinalizersMixin
withFinalizersMixin(finalizers)
Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list.
Note: This function appends passed data to existing values
fn metadata.withGenerateName
withGenerateName(generateName)
GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.
If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).
Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency
fn metadata.withGeneration
withGeneration(generation)
A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.
fn metadata.withLabels
withLabels(labels)
Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels
fn metadata.withLabelsMixin
withLabelsMixin(labels)
Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels
Note: This function appends passed data to existing values
fn metadata.withManagedFields
withManagedFields(managedFields)
ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn’t need to set or understand this field. A workflow can be the user’s name, a controller’s name, or the name of a specific apply path like ‘ci-cd’. The set of fields is always in the version that the workflow used when modifying the object.
fn metadata.withManagedFieldsMixin
withManagedFieldsMixin(managedFields)
ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn’t need to set or understand this field. A workflow can be the user’s name, a controller’s name, or the name of a specific apply path like ‘ci-cd’. The set of fields is always in the version that the workflow used when modifying the object.
Note: This function appends passed data to existing values
fn metadata.withName
withName(name)
Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names
fn metadata.withNamespace
withNamespace(namespace)
Namespace defines the space within each name must be unique. An empty namespace is equivalent to the “default” namespace, but “default” is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.
Must be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces
fn metadata.withOwnerReferences
withOwnerReferences(ownerReferences)
List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.
fn metadata.withOwnerReferencesMixin
withOwnerReferencesMixin(ownerReferences)
List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.
Note: This function appends passed data to existing values
fn metadata.withResourceVersion
withResourceVersion(resourceVersion)
An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.
Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
fn metadata.withSelfLink
withSelfLink(selfLink)
SelfLink is a URL representing this object. Populated by the system. Read-only.
DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release.
fn metadata.withUid
withUid(uid)
UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.
Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids
obj spec
CronJobSpec describes how the job execution will look like and when it will actually run.
fn spec.withConcurrencyPolicy
withConcurrencyPolicy(concurrencyPolicy)
Specifies how to treat concurrent executions of a Job. Valid values are: - ‘Allow’ (default): allows CronJobs 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
fn spec.withFailedJobsHistoryLimit
withFailedJobsHistoryLimit(failedJobsHistoryLimit)
The number of failed finished jobs to retain. This is a pointer to distinguish between explicit zero and not specified. Defaults to 1.
fn spec.withSchedule
withSchedule(schedule)
The schedule in Cron format, see https://en.wikipedia.org/wiki/Cron.
fn spec.withStartingDeadlineSeconds
withStartingDeadlineSeconds(startingDeadlineSeconds)
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.
fn spec.withSuccessfulJobsHistoryLimit
withSuccessfulJobsHistoryLimit(successfulJobsHistoryLimit)
The number of successful finished jobs to retain. This is a pointer to distinguish between explicit zero and not specified. Defaults to 3.
fn spec.withSuspend
withSuspend(suspend)
This flag tells the controller to suspend subsequent executions, it does not apply to already started executions. Defaults to false.
obj spec.jobTemplate
JobTemplateSpec describes the data a Job should have when created from a template
obj spec.jobTemplate.metadata
fn spec.jobTemplate.metadata.withAnnotations
withAnnotations(annotations)
Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations
fn spec.jobTemplate.metadata.withAnnotationsMixin
withAnnotationsMixin(annotations)
Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations
Note: This function appends passed data to existing values
fn spec.jobTemplate.metadata.withClusterName
withClusterName(clusterName)
The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request.
fn spec.jobTemplate.metadata.withCreationTimestamp
withCreationTimestamp(creationTimestamp)
Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.
fn spec.jobTemplate.metadata.withDeletionGracePeriodSeconds
withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)
Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.
fn spec.jobTemplate.metadata.withDeletionTimestamp
withDeletionTimestamp(deletionTimestamp)
Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.
fn spec.jobTemplate.metadata.withFinalizers
withFinalizers(finalizers)
Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list.
fn spec.jobTemplate.metadata.withFinalizersMixin
withFinalizersMixin(finalizers)
Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list.
Note: This function appends passed data to existing values
fn spec.jobTemplate.metadata.withGenerateName
withGenerateName(generateName)
GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.
If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).
Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency
fn spec.jobTemplate.metadata.withGeneration
withGeneration(generation)
A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.
fn spec.jobTemplate.metadata.withLabels
withLabels(labels)
Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels
fn spec.jobTemplate.metadata.withLabelsMixin
withLabelsMixin(labels)
Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels
Note: This function appends passed data to existing values
fn spec.jobTemplate.metadata.withManagedFields
withManagedFields(managedFields)
ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn’t need to set or understand this field. A workflow can be the user’s name, a controller’s name, or the name of a specific apply path like ‘ci-cd’. The set of fields is always in the version that the workflow used when modifying the object.
fn spec.jobTemplate.metadata.withManagedFieldsMixin
withManagedFieldsMixin(managedFields)
ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn’t need to set or understand this field. A workflow can be the user’s name, a controller’s name, or the name of a specific apply path like ‘ci-cd’. The set of fields is always in the version that the workflow used when modifying the object.
Note: This function appends passed data to existing values
fn spec.jobTemplate.metadata.withName
withName(name)
Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names
fn spec.jobTemplate.metadata.withNamespace
withNamespace(namespace)
Namespace defines the space within each name must be unique. An empty namespace is equivalent to the “default” namespace, but “default” is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.
Must be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces
fn spec.jobTemplate.metadata.withOwnerReferences
withOwnerReferences(ownerReferences)
List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.
fn spec.jobTemplate.metadata.withOwnerReferencesMixin
withOwnerReferencesMixin(ownerReferences)
List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.
Note: This function appends passed data to existing values
fn spec.jobTemplate.metadata.withResourceVersion
withResourceVersion(resourceVersion)
An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.
Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
fn spec.jobTemplate.metadata.withSelfLink
withSelfLink(selfLink)
SelfLink is a URL representing this object. Populated by the system. Read-only.
DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release.
fn spec.jobTemplate.metadata.withUid
withUid(uid)
UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.
Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids
obj spec.jobTemplate.spec
fn spec.jobTemplate.spec.withActiveDeadlineSeconds
withActiveDeadlineSeconds(activeDeadlineSeconds)
Specifies the duration in seconds relative to the startTime that the job may be active before the system tries to terminate it; value must be positive integer
fn spec.jobTemplate.spec.withBackoffLimit
withBackoffLimit(backoffLimit)
Specifies the number of retries before marking this job failed. Defaults to 6
fn spec.jobTemplate.spec.withCompletions
withCompletions(completions)
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/
fn spec.jobTemplate.spec.withManualSelector
withManualSelector(manualSelector)
manualSelector controls generation of pod labels and pod selectors. Leave manualSelector
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 manualSelector=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
fn spec.jobTemplate.spec.withParallelism
withParallelism(parallelism)
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/
fn spec.jobTemplate.spec.withTtlSecondsAfterFinished
withTtlSecondsAfterFinished(ttlSecondsAfterFinished)
ttlSecondsAfterFinished limits the lifetime of a Job that has finished execution (either Complete or Failed). If this field is set, ttlSecondsAfterFinished 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 unset, the Job won’t be automatically deleted. 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.
obj spec.jobTemplate.spec.selector
A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.
fn spec.jobTemplate.spec.selector.withMatchExpressions
withMatchExpressions(matchExpressions)
matchExpressions is a list of label selector requirements. The requirements are ANDed.
fn spec.jobTemplate.spec.selector.withMatchExpressionsMixin
withMatchExpressionsMixin(matchExpressions)
matchExpressions is a list of label selector requirements. The requirements are ANDed.
Note: This function appends passed data to existing values
fn spec.jobTemplate.spec.selector.withMatchLabels
withMatchLabels(matchLabels)
matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is “key”, the operator is “In”, and the values array contains only “value”. The requirements are ANDed.
fn spec.jobTemplate.spec.selector.withMatchLabelsMixin
withMatchLabelsMixin(matchLabels)
matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is “key”, the operator is “In”, and the values array contains only “value”. The requirements are ANDed.
Note: This function appends passed data to existing values
obj spec.jobTemplate.spec.template
obj spec.jobTemplate.spec.template.metadata
ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
fn spec.jobTemplate.spec.template.metadata.withAnnotations
withAnnotations(annotations)
Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations
fn spec.jobTemplate.spec.template.metadata.withAnnotationsMixin
withAnnotationsMixin(annotations)
Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations
Note: This function appends passed data to existing values
fn spec.jobTemplate.spec.template.metadata.withClusterName
withClusterName(clusterName)
The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request.
fn spec.jobTemplate.spec.template.metadata.withCreationTimestamp
withCreationTimestamp(creationTimestamp)
Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.
fn spec.jobTemplate.spec.template.metadata.withDeletionGracePeriodSeconds
withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)
Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.
fn spec.jobTemplate.spec.template.metadata.withDeletionTimestamp
withDeletionTimestamp(deletionTimestamp)
Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.
fn spec.jobTemplate.spec.template.metadata.withFinalizers
withFinalizers(finalizers)
Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list.
fn spec.jobTemplate.spec.template.metadata.withFinalizersMixin
withFinalizersMixin(finalizers)
Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list.
Note: This function appends passed data to existing values
fn spec.jobTemplate.spec.template.metadata.withGenerateName
withGenerateName(generateName)
GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.
If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).
Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency
fn spec.jobTemplate.spec.template.metadata.withGeneration
withGeneration(generation)
A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.
fn spec.jobTemplate.spec.template.metadata.withLabels
withLabels(labels)
Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels
fn spec.jobTemplate.spec.template.metadata.withLabelsMixin
withLabelsMixin(labels)
Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels
Note: This function appends passed data to existing values
fn spec.jobTemplate.spec.template.metadata.withManagedFields
withManagedFields(managedFields)
ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn’t need to set or understand this field. A workflow can be the user’s name, a controller’s name, or the name of a specific apply path like ‘ci-cd’. The set of fields is always in the version that the workflow used when modifying the object.
fn spec.jobTemplate.spec.template.metadata.withManagedFieldsMixin
withManagedFieldsMixin(managedFields)
ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn’t need to set or understand this field. A workflow can be the user’s name, a controller’s name, or the name of a specific apply path like ‘ci-cd’. The set of fields is always in the version that the workflow used when modifying the object.
Note: This function appends passed data to existing values
fn spec.jobTemplate.spec.template.metadata.withName
withName(name)
Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names
fn spec.jobTemplate.spec.template.metadata.withNamespace
withNamespace(namespace)
Namespace defines the space within each name must be unique. An empty namespace is equivalent to the “default” namespace, but “default” is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.
Must be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces
fn spec.jobTemplate.spec.template.metadata.withOwnerReferences
withOwnerReferences(ownerReferences)
List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.
fn spec.jobTemplate.spec.template.metadata.withOwnerReferencesMixin
withOwnerReferencesMixin(ownerReferences)
List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.
Note: This function appends passed data to existing values
fn spec.jobTemplate.spec.template.metadata.withResourceVersion
withResourceVersion(resourceVersion)
An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.
Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
fn spec.jobTemplate.spec.template.metadata.withSelfLink
withSelfLink(selfLink)
SelfLink is a URL representing this object. Populated by the system. Read-only.
DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release.
fn spec.jobTemplate.spec.template.metadata.withUid
withUid(uid)
UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.
Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids
obj spec.jobTemplate.spec.template.spec
PodSpec is a description of a pod.
fn spec.jobTemplate.spec.template.spec.withActiveDeadlineSeconds
withActiveDeadlineSeconds(activeDeadlineSeconds)
Optional duration in seconds the pod may be active on the node relative to StartTime before the system will actively try to mark it failed and kill associated containers. Value must be a positive integer.
fn spec.jobTemplate.spec.template.spec.withAutomountServiceAccountToken
withAutomountServiceAccountToken(automountServiceAccountToken)
AutomountServiceAccountToken indicates whether a service account token should be automatically mounted.
fn spec.jobTemplate.spec.template.spec.withContainers
withContainers(containers)
List of containers belonging to the pod. Containers cannot currently be added or removed. There must be at least one container in a Pod. Cannot be updated.
fn spec.jobTemplate.spec.template.spec.withContainersMixin
withContainersMixin(containers)
List of containers belonging to the pod. Containers cannot currently be added or removed. There must be at least one container in a Pod. Cannot be updated.
Note: This function appends passed data to existing values
fn spec.jobTemplate.spec.template.spec.withDnsPolicy
withDnsPolicy(dnsPolicy)
Set DNS policy for the pod. Defaults to ‘ClusterFirst’. Valid values are ‘ClusterFirstWithHostNet’, ‘ClusterFirst’, ‘Default’ or ‘None’. DNS parameters given in DNSConfig will be merged with the policy selected with DNSPolicy. To have DNS options set along with hostNetwork, you have to specify DNS policy explicitly to ‘ClusterFirstWithHostNet’.
fn spec.jobTemplate.spec.template.spec.withEnableServiceLinks
withEnableServiceLinks(enableServiceLinks)
EnableServiceLinks indicates whether information about services should be injected into pod’s environment variables, matching the syntax of Docker links. Optional: Defaults to true.
fn spec.jobTemplate.spec.template.spec.withEphemeralContainers
withEphemeralContainers(ephemeralContainers)
List of ephemeral containers run in this pod. Ephemeral containers may be run in an existing pod to perform user-initiated actions such as debugging. This list cannot be specified when creating a pod, and it cannot be modified by updating the pod spec. In order to add an ephemeral container to an existing pod, use the pod’s ephemeralcontainers subresource. This field is alpha-level and is only honored by servers that enable the EphemeralContainers feature.
fn spec.jobTemplate.spec.template.spec.withEphemeralContainersMixin
withEphemeralContainersMixin(ephemeralContainers)
List of ephemeral containers run in this pod. Ephemeral containers may be run in an existing pod to perform user-initiated actions such as debugging. This list cannot be specified when creating a pod, and it cannot be modified by updating the pod spec. In order to add an ephemeral container to an existing pod, use the pod’s ephemeralcontainers subresource. This field is alpha-level and is only honored by servers that enable the EphemeralContainers feature.
Note: This function appends passed data to existing values
fn spec.jobTemplate.spec.template.spec.withHostAliases
withHostAliases(hostAliases)
HostAliases is an optional list of hosts and IPs that will be injected into the pod’s hosts file if specified. This is only valid for non-hostNetwork pods.
fn spec.jobTemplate.spec.template.spec.withHostAliasesMixin
withHostAliasesMixin(hostAliases)
HostAliases is an optional list of hosts and IPs that will be injected into the pod’s hosts file if specified. This is only valid for non-hostNetwork pods.
Note: This function appends passed data to existing values
fn spec.jobTemplate.spec.template.spec.withHostIPC
withHostIPC(hostIPC)
Use the host’s ipc namespace. Optional: Default to false.
fn spec.jobTemplate.spec.template.spec.withHostNetwork
withHostNetwork(hostNetwork)
Host networking requested for this pod. Use the host’s network namespace. If this option is set, the ports that will be used must be specified. Default to false.
fn spec.jobTemplate.spec.template.spec.withHostPID
withHostPID(hostPID)
Use the host’s pid namespace. Optional: Default to false.
fn spec.jobTemplate.spec.template.spec.withHostname
withHostname(hostname)
Specifies the hostname of the Pod If not specified, the pod’s hostname will be set to a system-defined value.
fn spec.jobTemplate.spec.template.spec.withImagePullSecrets
withImagePullSecrets(imagePullSecrets)
ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec. If specified, these secrets will be passed to individual puller implementations for them to use. For example, in the case of docker, only DockerConfig type secrets are honored. More info: https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod
fn spec.jobTemplate.spec.template.spec.withImagePullSecretsMixin
withImagePullSecretsMixin(imagePullSecrets)
ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec. If specified, these secrets will be passed to individual puller implementations for them to use. For example, in the case of docker, only DockerConfig type secrets are honored. More info: https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod
Note: This function appends passed data to existing values
fn spec.jobTemplate.spec.template.spec.withInitContainers
withInitContainers(initContainers)
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 or removed. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/
fn spec.jobTemplate.spec.template.spec.withInitContainersMixin
withInitContainersMixin(initContainers)
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 or removed. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/
Note: This function appends passed data to existing values
fn spec.jobTemplate.spec.template.spec.withNodeName
withNodeName(nodeName)
NodeName is a request to schedule this pod onto a specific node. If it is non-empty, the scheduler simply schedules this pod onto that node, assuming that it fits resource requirements.
fn spec.jobTemplate.spec.template.spec.withNodeSelector
withNodeSelector(nodeSelector)
NodeSelector is a selector which must be true for the pod to fit on a node. Selector which must match a node’s labels for the pod to be scheduled on that node. More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/
fn spec.jobTemplate.spec.template.spec.withNodeSelectorMixin
withNodeSelectorMixin(nodeSelector)
NodeSelector is a selector which must be true for the pod to fit on a node. Selector which must match a node’s labels for the pod to be scheduled on that node. More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/
Note: This function appends passed data to existing values
fn spec.jobTemplate.spec.template.spec.withOverhead
withOverhead(overhead)
Overhead represents the resource overhead associated with running a pod for a given RuntimeClass. This field will be autopopulated at admission time by the RuntimeClass admission controller. If the RuntimeClass admission controller is enabled, overhead must not be set in Pod create requests. The RuntimeClass admission controller will reject Pod create requests which have the overhead already set. If RuntimeClass is configured and selected in the PodSpec, Overhead will be set to the value defined in the corresponding RuntimeClass, otherwise it will remain unset and treated as zero. More info: https://git.k8s.io/enhancements/keps/sig-node/20190226-pod-overhead.md This field is alpha-level as of Kubernetes v1.16, and is only honored by servers that enable the PodOverhead feature.
fn spec.jobTemplate.spec.template.spec.withOverheadMixin
withOverheadMixin(overhead)
Overhead represents the resource overhead associated with running a pod for a given RuntimeClass. This field will be autopopulated at admission time by the RuntimeClass admission controller. If the RuntimeClass admission controller is enabled, overhead must not be set in Pod create requests. The RuntimeClass admission controller will reject Pod create requests which have the overhead already set. If RuntimeClass is configured and selected in the PodSpec, Overhead will be set to the value defined in the corresponding RuntimeClass, otherwise it will remain unset and treated as zero. More info: https://git.k8s.io/enhancements/keps/sig-node/20190226-pod-overhead.md This field is alpha-level as of Kubernetes v1.16, and is only honored by servers that enable the PodOverhead feature.
Note: This function appends passed data to existing values
fn spec.jobTemplate.spec.template.spec.withPreemptionPolicy
withPreemptionPolicy(preemptionPolicy)
PreemptionPolicy is the Policy for preempting pods with lower priority. One of Never, PreemptLowerPriority. Defaults to PreemptLowerPriority if unset. This field is alpha-level and is only honored by servers that enable the NonPreemptingPriority feature.
fn spec.jobTemplate.spec.template.spec.withPriority
withPriority(priority)
The priority value. Various system components use this field to find the priority of the pod. When Priority Admission Controller is enabled, it prevents users from setting this field. The admission controller populates this field from PriorityClassName. The higher the value, the higher the priority.
fn spec.jobTemplate.spec.template.spec.withPriorityClassName
withPriorityClassName(priorityClassName)
If specified, indicates the pod’s priority. ‘system-node-critical’ and ‘system-cluster-critical’ are two special keywords which indicate the highest priorities with the former being the highest priority. Any other name must be defined by creating a PriorityClass object with that name. If not specified, the pod priority will be default or zero if there is no default.
fn spec.jobTemplate.spec.template.spec.withReadinessGates
withReadinessGates(readinessGates)
If specified, all readiness gates will be evaluated for pod readiness. A pod is ready when all its containers are ready AND all conditions specified in the readiness gates have status equal to “True” More info: https://git.k8s.io/enhancements/keps/sig-network/0007-pod-ready%2B%2B.md
fn spec.jobTemplate.spec.template.spec.withReadinessGatesMixin
withReadinessGatesMixin(readinessGates)
If specified, all readiness gates will be evaluated for pod readiness. A pod is ready when all its containers are ready AND all conditions specified in the readiness gates have status equal to “True” More info: https://git.k8s.io/enhancements/keps/sig-network/0007-pod-ready%2B%2B.md
Note: This function appends passed data to existing values
fn spec.jobTemplate.spec.template.spec.withRestartPolicy
withRestartPolicy(restartPolicy)
Restart policy for all containers within the pod. One of Always, OnFailure, Never. Default to Always. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy
fn spec.jobTemplate.spec.template.spec.withRuntimeClassName
withRuntimeClassName(runtimeClassName)
RuntimeClassName refers to a RuntimeClass object in the node.k8s.io group, which should be used to run this pod. If no RuntimeClass resource matches the named class, the pod will not be run. If unset or empty, the “legacy” RuntimeClass will be used, which is an implicit class with an empty definition that uses the default runtime handler. More info: https://git.k8s.io/enhancements/keps/sig-node/runtime-class.md This is a beta feature as of Kubernetes v1.14.
fn spec.jobTemplate.spec.template.spec.withSchedulerName
withSchedulerName(schedulerName)
If specified, the pod will be dispatched by specified scheduler. If not specified, the pod will be dispatched by default scheduler.
fn spec.jobTemplate.spec.template.spec.withServiceAccount
withServiceAccount(serviceAccount)
DeprecatedServiceAccount is a depreciated alias for ServiceAccountName. Deprecated: Use serviceAccountName instead.
fn spec.jobTemplate.spec.template.spec.withServiceAccountName
withServiceAccountName(serviceAccountName)
ServiceAccountName is the name of the ServiceAccount to use to run this pod. More info: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/
fn spec.jobTemplate.spec.template.spec.withShareProcessNamespace
withShareProcessNamespace(shareProcessNamespace)
Share a single process namespace between all of the containers in a pod. When this is set containers will be able to view and signal processes from other containers in the same pod, and the first process in each container will not be assigned PID 1. HostPID and ShareProcessNamespace cannot both be set. Optional: Default to false.
fn spec.jobTemplate.spec.template.spec.withSubdomain
withSubdomain(subdomain)
If specified, the fully qualified Pod hostname will be “
fn spec.jobTemplate.spec.template.spec.withTerminationGracePeriodSeconds
withTerminationGracePeriodSeconds(terminationGracePeriodSeconds)
Optional duration in seconds the pod needs to terminate gracefully. May be decreased in delete request. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period will be used instead. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. Defaults to 30 seconds.
fn spec.jobTemplate.spec.template.spec.withTolerations
withTolerations(tolerations)
If specified, the pod’s tolerations.
fn spec.jobTemplate.spec.template.spec.withTolerationsMixin
withTolerationsMixin(tolerations)
If specified, the pod’s tolerations.
Note: This function appends passed data to existing values
fn spec.jobTemplate.spec.template.spec.withTopologySpreadConstraints
withTopologySpreadConstraints(topologySpreadConstraints)
TopologySpreadConstraints describes how a group of pods ought to spread across topology domains. Scheduler will schedule pods in a way which abides by the constraints. This field is only honored by clusters that enable the EvenPodsSpread feature. All topologySpreadConstraints are ANDed.
fn spec.jobTemplate.spec.template.spec.withTopologySpreadConstraintsMixin
withTopologySpreadConstraintsMixin(topologySpreadConstraints)
TopologySpreadConstraints describes how a group of pods ought to spread across topology domains. Scheduler will schedule pods in a way which abides by the constraints. This field is only honored by clusters that enable the EvenPodsSpread feature. All topologySpreadConstraints are ANDed.
Note: This function appends passed data to existing values
fn spec.jobTemplate.spec.template.spec.withVolumes
withVolumes(volumes)
List of volumes that can be mounted by containers belonging to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes
fn spec.jobTemplate.spec.template.spec.withVolumesMixin
withVolumesMixin(volumes)
List of volumes that can be mounted by containers belonging to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes
Note: This function appends passed data to existing values
obj spec.jobTemplate.spec.template.spec.affinity
obj spec.jobTemplate.spec.template.spec.affinity.nodeAffinity
fn spec.jobTemplate.spec.template.spec.affinity.nodeAffinity.withPreferredDuringSchedulingIgnoredDuringExecution
withPreferredDuringSchedulingIgnoredDuringExecution(preferredDuringSchedulingIgnoredDuringExecution)
The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding “weight” to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred.
fn spec.jobTemplate.spec.template.spec.affinity.nodeAffinity.withPreferredDuringSchedulingIgnoredDuringExecutionMixin
withPreferredDuringSchedulingIgnoredDuringExecutionMixin(preferredDuringSchedulingIgnoredDuringExecution)
The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding “weight” to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred.
Note: This function appends passed data to existing values
obj spec.jobTemplate.spec.template.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution
A node selector represents the union of the results of one or more label queries over a set of nodes; that is, it represents the OR of the selectors represented by the node selector terms.
fn spec.jobTemplate.spec.template.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.withNodeSelectorTerms
withNodeSelectorTerms(nodeSelectorTerms)
Required. A list of node selector terms. The terms are ORed.
fn spec.jobTemplate.spec.template.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.withNodeSelectorTermsMixin
withNodeSelectorTermsMixin(nodeSelectorTerms)
Required. A list of node selector terms. The terms are ORed.
Note: This function appends passed data to existing values
obj spec.jobTemplate.spec.template.spec.affinity.podAffinity
fn spec.jobTemplate.spec.template.spec.affinity.podAffinity.withPreferredDuringSchedulingIgnoredDuringExecution
withPreferredDuringSchedulingIgnoredDuringExecution(preferredDuringSchedulingIgnoredDuringExecution)
The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding “weight” to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.
fn spec.jobTemplate.spec.template.spec.affinity.podAffinity.withPreferredDuringSchedulingIgnoredDuringExecutionMixin
withPreferredDuringSchedulingIgnoredDuringExecutionMixin(preferredDuringSchedulingIgnoredDuringExecution)
The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding “weight” to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.
Note: This function appends passed data to existing values
fn spec.jobTemplate.spec.template.spec.affinity.podAffinity.withRequiredDuringSchedulingIgnoredDuringExecution
withRequiredDuringSchedulingIgnoredDuringExecution(requiredDuringSchedulingIgnoredDuringExecution)
If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.
fn spec.jobTemplate.spec.template.spec.affinity.podAffinity.withRequiredDuringSchedulingIgnoredDuringExecutionMixin
withRequiredDuringSchedulingIgnoredDuringExecutionMixin(requiredDuringSchedulingIgnoredDuringExecution)
If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.
Note: This function appends passed data to existing values
obj spec.jobTemplate.spec.template.spec.affinity.podAntiAffinity
fn spec.jobTemplate.spec.template.spec.affinity.podAntiAffinity.withPreferredDuringSchedulingIgnoredDuringExecution
withPreferredDuringSchedulingIgnoredDuringExecution(preferredDuringSchedulingIgnoredDuringExecution)
The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding “weight” to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.
fn spec.jobTemplate.spec.template.spec.affinity.podAntiAffinity.withPreferredDuringSchedulingIgnoredDuringExecutionMixin
withPreferredDuringSchedulingIgnoredDuringExecutionMixin(preferredDuringSchedulingIgnoredDuringExecution)
The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding “weight” to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.
Note: This function appends passed data to existing values
fn spec.jobTemplate.spec.template.spec.affinity.podAntiAffinity.withRequiredDuringSchedulingIgnoredDuringExecution
withRequiredDuringSchedulingIgnoredDuringExecution(requiredDuringSchedulingIgnoredDuringExecution)
If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.
fn spec.jobTemplate.spec.template.spec.affinity.podAntiAffinity.withRequiredDuringSchedulingIgnoredDuringExecutionMixin
withRequiredDuringSchedulingIgnoredDuringExecutionMixin(requiredDuringSchedulingIgnoredDuringExecution)
If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.
Note: This function appends passed data to existing values
obj spec.jobTemplate.spec.template.spec.dnsConfig
PodDNSConfig defines the DNS parameters of a pod in addition to those generated from DNSPolicy.
fn spec.jobTemplate.spec.template.spec.dnsConfig.withNameservers
withNameservers(nameservers)
A list of DNS name server IP addresses. This will be appended to the base nameservers generated from DNSPolicy. Duplicated nameservers will be removed.
fn spec.jobTemplate.spec.template.spec.dnsConfig.withNameserversMixin
withNameserversMixin(nameservers)
A list of DNS name server IP addresses. This will be appended to the base nameservers generated from DNSPolicy. Duplicated nameservers will be removed.
Note: This function appends passed data to existing values
fn spec.jobTemplate.spec.template.spec.dnsConfig.withOptions
withOptions(options)
A list of DNS resolver options. This will be merged with the base options generated from DNSPolicy. Duplicated entries will be removed. Resolution options given in Options will override those that appear in the base DNSPolicy.
fn spec.jobTemplate.spec.template.spec.dnsConfig.withOptionsMixin
withOptionsMixin(options)
A list of DNS resolver options. This will be merged with the base options generated from DNSPolicy. Duplicated entries will be removed. Resolution options given in Options will override those that appear in the base DNSPolicy.
Note: This function appends passed data to existing values
fn spec.jobTemplate.spec.template.spec.dnsConfig.withSearches
withSearches(searches)
A list of DNS search domains for host-name lookup. This will be appended to the base search paths generated from DNSPolicy. Duplicated search paths will be removed.
fn spec.jobTemplate.spec.template.spec.dnsConfig.withSearchesMixin
withSearchesMixin(searches)
A list of DNS search domains for host-name lookup. This will be appended to the base search paths generated from DNSPolicy. Duplicated search paths will be removed.
Note: This function appends passed data to existing values
obj spec.jobTemplate.spec.template.spec.securityContext
fn spec.jobTemplate.spec.template.spec.securityContext.withFsGroup
withFsGroup(fsGroup)
A special supplemental group that applies to all containers in a pod. Some volume types allow the Kubelet to change the ownership of that volume to be owned by the pod:
- The owning GID will be the FSGroup 2. The setgid bit is set (new files created in the volume will be owned by FSGroup) 3. The permission bits are OR’d with rw-rw—-
If unset, the Kubelet will not modify the ownership and permissions of any volume.
fn spec.jobTemplate.spec.template.spec.securityContext.withFsGroupChangePolicy
withFsGroupChangePolicy(fsGroupChangePolicy)
fsGroupChangePolicy defines behavior of changing ownership and permission of the volume before being exposed inside Pod. This field will only apply to volume types which support fsGroup based ownership(and permissions). It will have no effect on ephemeral volume types such as: secret, configmaps and emptydir. Valid values are “OnRootMismatch” and “Always”. If not specified defaults to “Always”.
fn spec.jobTemplate.spec.template.spec.securityContext.withRunAsGroup
withRunAsGroup(runAsGroup)
The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container.
fn spec.jobTemplate.spec.template.spec.securityContext.withRunAsNonRoot
withRunAsNonRoot(runAsNonRoot)
Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
fn spec.jobTemplate.spec.template.spec.securityContext.withRunAsUser
withRunAsUser(runAsUser)
The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container.
fn spec.jobTemplate.spec.template.spec.securityContext.withSupplementalGroups
withSupplementalGroups(supplementalGroups)
A list of groups applied to the first process run in each container, in addition to the container’s primary GID. If unspecified, no groups will be added to any container.
fn spec.jobTemplate.spec.template.spec.securityContext.withSupplementalGroupsMixin
withSupplementalGroupsMixin(supplementalGroups)
A list of groups applied to the first process run in each container, in addition to the container’s primary GID. If unspecified, no groups will be added to any container.
Note: This function appends passed data to existing values
fn spec.jobTemplate.spec.template.spec.securityContext.withSysctls
withSysctls(sysctls)
Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported sysctls (by the container runtime) might fail to launch.
fn spec.jobTemplate.spec.template.spec.securityContext.withSysctlsMixin
withSysctlsMixin(sysctls)
Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported sysctls (by the container runtime) might fail to launch.
Note: This function appends passed data to existing values
obj spec.jobTemplate.spec.template.spec.securityContext.seLinuxOptions
SELinuxOptions are the labels to be applied to the container
fn spec.jobTemplate.spec.template.spec.securityContext.seLinuxOptions.withLevel
withLevel(level)
Level is SELinux level label that applies to the container.
fn spec.jobTemplate.spec.template.spec.securityContext.seLinuxOptions.withRole
withRole(role)
Role is a SELinux role label that applies to the container.
fn spec.jobTemplate.spec.template.spec.securityContext.seLinuxOptions.withType
withType(type)
Type is a SELinux type label that applies to the container.
fn spec.jobTemplate.spec.template.spec.securityContext.seLinuxOptions.withUser
withUser(user)
User is a SELinux user label that applies to the container.
obj spec.jobTemplate.spec.template.spec.securityContext.windowsOptions
WindowsSecurityContextOptions contain Windows-specific options and credentials.
fn spec.jobTemplate.spec.template.spec.securityContext.windowsOptions.withGmsaCredentialSpec
withGmsaCredentialSpec(gmsaCredentialSpec)
GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field.
fn spec.jobTemplate.spec.template.spec.securityContext.windowsOptions.withGmsaCredentialSpecName
withGmsaCredentialSpecName(gmsaCredentialSpecName)
GMSACredentialSpecName is the name of the GMSA credential spec to use.
fn spec.jobTemplate.spec.template.spec.securityContext.windowsOptions.withRunAsUserName
withRunAsUserName(runAsUserName)
The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.