cronJob

CronJob represents the configuration of a single cron job.

Constuctors

Mixins
  • metadata

    Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata


    Functions
    • mixinInstance

      mixinInstance(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


    • 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


    • 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.


    • 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.


    • 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.


    • 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/api-conventions.md#idempotency


    • 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


    • 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


    • 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


    • 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


    • 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.

      withOwnerReferences takes an array of type ownerReferencesType. You can create an instance of ownerReferencesType with hidden.meta.v1.ownerReference.new().

      see hidden.meta.v1.ownerReference


    • 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.

      withOwnerReferencesMixin takes an array of type ownerReferencesType. You can create an instance of ownerReferencesType with hidden.meta.v1.ownerReference.new().

      see hidden.meta.v1.ownerReference


    Mixins
    • initializers

      An initializer is a controller which enforces some system invariant at object creation time. This field is a list of initializers that have not yet acted on this object. If nil or empty, this object has been completely initialized. Otherwise, the object is considered uninitialized and is hidden (in list/watch and get calls) from clients that haven't explicitly asked to observe uninitialized objects.

      When an object is created, the system will populate this list with the current set of initializers. Only privileged users may set or modify this list. Once it is empty, it may not be modified further by any user.


      Functions
      • mixinInstance

        mixinInstance(initializers)


      • withPending

        withPending(pending)

        Pending is a list of initializers that must execute in order before this object is visible. When the last pending initializer is removed, and no failing result is set, the initializers struct will be set to nil and the object is considered as initialized and visible to all clients.

        withPending takes an array of type pendingType. You can create an instance of pendingType with hidden.meta.v1.initializer.new().

        see hidden.meta.v1.initializer


      • withPendingMixin

        withPendingMixin(pending)

        Pending is a list of initializers that must execute in order before this object is visible. When the last pending initializer is removed, and no failing result is set, the initializers struct will be set to nil and the object is considered as initialized and visible to all clients.

        withPendingMixin takes an array of type pendingType. You can create an instance of pendingType with hidden.meta.v1.initializer.new().

        see hidden.meta.v1.initializer


  • spec

    Specification of the desired behavior of a cron job, including the schedule. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status


    Functions
    • mixinInstance

      mixinInstance(spec)


    • withConcurrencyPolicy

      withConcurrencyPolicy(concurrencyPolicy)

      Specifies how to treat concurrent executions of a Job. Defaults to Allow.


    • withFailedJobsHistoryLimit

      withFailedJobsHistoryLimit(failedJobsHistoryLimit)

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


    • withSchedule

      withSchedule(schedule)

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


    • 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.


    • withSuccessfulJobsHistoryLimit

      withSuccessfulJobsHistoryLimit(successfulJobsHistoryLimit)

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


    • withSuspend

      withSuspend(suspend)

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


    Mixins
    • jobTemplate

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


      Functions
      Mixins
      • metadata

        Standard object's metadata of the jobs created from this template. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata


        Functions
        • mixinInstance

          mixinInstance(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


        • 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


        • 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.


        • 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.


        • 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.


        • 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/api-conventions.md#idempotency


        • 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


        • 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


        • 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


        • 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


        • 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.

          withOwnerReferences takes an array of type ownerReferencesType. You can create an instance of ownerReferencesType with hidden.meta.v1.ownerReference.new().

          see hidden.meta.v1.ownerReference


        • 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.

          withOwnerReferencesMixin takes an array of type ownerReferencesType. You can create an instance of ownerReferencesType with hidden.meta.v1.ownerReference.new().

          see hidden.meta.v1.ownerReference


        Mixins
        • initializers

          An initializer is a controller which enforces some system invariant at object creation time. This field is a list of initializers that have not yet acted on this object. If nil or empty, this object has been completely initialized. Otherwise, the object is considered uninitialized and is hidden (in list/watch and get calls) from clients that haven't explicitly asked to observe uninitialized objects.

          When an object is created, the system will populate this list with the current set of initializers. Only privileged users may set or modify this list. Once it is empty, it may not be modified further by any user.


          Functions
          • mixinInstance

            mixinInstance(initializers)


          • withPending

            withPending(pending)

            Pending is a list of initializers that must execute in order before this object is visible. When the last pending initializer is removed, and no failing result is set, the initializers struct will be set to nil and the object is considered as initialized and visible to all clients.

            withPending takes an array of type pendingType. You can create an instance of pendingType with hidden.meta.v1.initializer.new().

            see hidden.meta.v1.initializer


          • withPendingMixin

            withPendingMixin(pending)

            Pending is a list of initializers that must execute in order before this object is visible. When the last pending initializer is removed, and no failing result is set, the initializers struct will be set to nil and the object is considered as initialized and visible to all clients.

            withPendingMixin takes an array of type pendingType. You can create an instance of pendingType with hidden.meta.v1.initializer.new().

            see hidden.meta.v1.initializer


      • spec

        Specification of the desired behavior of the job. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status


        Functions
        • mixinInstance

          mixinInstance(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


        • withBackoffLimit

          withBackoffLimit(backoffLimit)

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


        • 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/


        • 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://git.k8s.io/community/contributors/design-proposals/selector-generation.md


        • 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/


        Mixins
        • selector

          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


          Functions
          • mixinInstance

            mixinInstance(selector)


          • withMatchExpressions

            withMatchExpressions(matchExpressions)

            matchExpressions is a list of label selector requirements. The requirements are ANDed.

            withMatchExpressions takes an array of type matchExpressionsType. You can create an instance of matchExpressionsType with hidden.meta.v1.labelSelectorRequirement.new().

            see hidden.meta.v1.labelSelectorRequirement


          • withMatchExpressionsMixin

            withMatchExpressionsMixin(matchExpressions)

            matchExpressions is a list of label selector requirements. The requirements are ANDed.

            withMatchExpressionsMixin takes an array of type matchExpressionsType. You can create an instance of matchExpressionsType with hidden.meta.v1.labelSelectorRequirement.new().

            see hidden.meta.v1.labelSelectorRequirement


          • 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.


          • 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.


        • template

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


          Functions
          Mixins
          • metadata

            Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata


            Functions
            • mixinInstance

              mixinInstance(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


            • 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


            • 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.


            • 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.


            • 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.


            • 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/api-conventions.md#idempotency


            • 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


            • 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


            • 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


            • 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


            • 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.

              withOwnerReferences takes an array of type ownerReferencesType. You can create an instance of ownerReferencesType with hidden.meta.v1.ownerReference.new().

              see hidden.meta.v1.ownerReference


            • 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.

              withOwnerReferencesMixin takes an array of type ownerReferencesType. You can create an instance of ownerReferencesType with hidden.meta.v1.ownerReference.new().

              see hidden.meta.v1.ownerReference


            Mixins
            • initializers

              An initializer is a controller which enforces some system invariant at object creation time. This field is a list of initializers that have not yet acted on this object. If nil or empty, this object has been completely initialized. Otherwise, the object is considered uninitialized and is hidden (in list/watch and get calls) from clients that haven't explicitly asked to observe uninitialized objects.

              When an object is created, the system will populate this list with the current set of initializers. Only privileged users may set or modify this list. Once it is empty, it may not be modified further by any user.


              Functions
              • mixinInstance

                mixinInstance(initializers)


              • withPending

                withPending(pending)

                Pending is a list of initializers that must execute in order before this object is visible. When the last pending initializer is removed, and no failing result is set, the initializers struct will be set to nil and the object is considered as initialized and visible to all clients.

                withPending takes an array of type pendingType. You can create an instance of pendingType with hidden.meta.v1.initializer.new().

                see hidden.meta.v1.initializer


              • withPendingMixin

                withPendingMixin(pending)

                Pending is a list of initializers that must execute in order before this object is visible. When the last pending initializer is removed, and no failing result is set, the initializers struct will be set to nil and the object is considered as initialized and visible to all clients.

                withPendingMixin takes an array of type pendingType. You can create an instance of pendingType with hidden.meta.v1.initializer.new().

                see hidden.meta.v1.initializer


          • spec

            Specification of the desired behavior of the pod. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status


            Functions
            • mixinInstance

              mixinInstance(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.


            • withAutomountServiceAccountToken

              withAutomountServiceAccountToken(automountServiceAccountToken)

              AutomountServiceAccountToken indicates whether a service account token should be automatically mounted.


            • 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.

              withContainers takes an array of type containersType. You can create an instance of containersType with hidden.core.v1.container.new().

              see hidden.core.v1.container


            • 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.

              withContainersMixin takes an array of type containersType. You can create an instance of containersType with hidden.core.v1.container.new().

              see hidden.core.v1.container


            • withDnsPolicy

              withDnsPolicy(dnsPolicy)

              Set DNS policy for containers within the pod. One of ‘ClusterFirstWithHostNet’, ‘ClusterFirst’ or ‘Default’. Defaults to “ClusterFirst”. To have DNS options set along with hostNetwork, you have to specify DNS policy explicitly to ‘ClusterFirstWithHostNet’.


            • 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.

              withHostAliases takes an array of type hostAliasesType. You can create an instance of hostAliasesType with hidden.core.v1.hostAlias.new().

              see hidden.core.v1.hostAlias


            • 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.

              withHostAliasesMixin takes an array of type hostAliasesType. You can create an instance of hostAliasesType with hidden.core.v1.hostAlias.new().

              see hidden.core.v1.hostAlias


            • withHostIpc

              withHostIpc(hostIpc)

              Use the host’s ipc namespace. Optional: Default to false.


            • 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.


            • withHostPid

              withHostPid(hostPid)

              Use the host’s pid namespace. Optional: Default to false.


            • withHostname

              withHostname(hostname)

              Specifies the hostname of the Pod If not specified, the pod’s hostname will be set to a system-defined value.


            • 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

              withImagePullSecrets takes an array of type imagePullSecretsType. You can create an instance of imagePullSecretsType with hidden.core.v1.localObjectReference.new().

              see hidden.core.v1.localObjectReference


            • 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

              withImagePullSecretsMixin takes an array of type imagePullSecretsType. You can create an instance of imagePullSecretsType with hidden.core.v1.localObjectReference.new().

              see hidden.core.v1.localObjectReference


            • 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, or Liveness 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/

              withInitContainers takes an array of type initContainersType. You can create an instance of initContainersType with hidden.core.v1.container.new().

              see hidden.core.v1.container


            • 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, or Liveness 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/

              withInitContainersMixin takes an array of type initContainersType. You can create an instance of initContainersType with hidden.core.v1.container.new().

              see hidden.core.v1.container


            • 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.


            • 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/


            • 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/


            • 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.


            • withPriorityClassName

              withPriorityClassName(priorityClassName)

              If specified, indicates the pod’s priority. “SYSTEM” is a special keyword which indicates 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.


            • 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


            • withSchedulerName

              withSchedulerName(schedulerName)

              If specified, the pod will be dispatched by specified scheduler. If not specified, the pod will be dispatched by default scheduler.


            • withServiceAccount

              withServiceAccount(serviceAccount)

              DeprecatedServiceAccount is a depreciated alias for ServiceAccountName. Deprecated: Use serviceAccountName instead.


            • 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/


            • withSubdomain

              withSubdomain(subdomain)

              If specified, the fully qualified Pod hostname will be “...svc.”. If not specified, the pod will not have a domainname at all.


            • 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.


            • withTolerations

              withTolerations(tolerations)

              If specified, the pod’s tolerations.

              withTolerations takes an array of type tolerationsType. You can create an instance of tolerationsType with hidden.core.v1.toleration.new().

              see hidden.core.v1.toleration


            • withTolerationsMixin

              withTolerationsMixin(tolerations)

              If specified, the pod’s tolerations.

              withTolerationsMixin takes an array of type tolerationsType. You can create an instance of tolerationsType with hidden.core.v1.toleration.new().

              see hidden.core.v1.toleration


            • 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

              withVolumes takes an array of type volumesType. You can create an instance of volumesType with hidden.core.v1.volume.new().

              see hidden.core.v1.volume


            • 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

              withVolumesMixin takes an array of type volumesType. You can create an instance of volumesType with hidden.core.v1.volume.new().

              see hidden.core.v1.volume


            Mixins
            • affinity

              If specified, the pod's scheduling constraints


              Functions
              Mixins
              • nodeAffinity

                Describes node affinity scheduling rules for the pod.


                Functions
                • mixinInstance

                  mixinInstance(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.

                  withPreferredDuringSchedulingIgnoredDuringExecution takes an array of type preferredDuringSchedulingIgnoredDuringExecutionType. You can create an instance of preferredDuringSchedulingIgnoredDuringExecutionType with hidden.core.v1.preferredSchedulingTerm.new().

                  see hidden.core.v1.preferredSchedulingTerm


                • 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.

                  withPreferredDuringSchedulingIgnoredDuringExecutionMixin takes an array of type preferredDuringSchedulingIgnoredDuringExecutionType. You can create an instance of preferredDuringSchedulingIgnoredDuringExecutionType with hidden.core.v1.preferredSchedulingTerm.new().

                  see hidden.core.v1.preferredSchedulingTerm


                Mixins
                • 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 an update), the system may or may not try to eventually evict the pod from its node.


                  Functions
                  • mixinInstance

                    mixinInstance(requiredDuringSchedulingIgnoredDuringExecution)


                  • withNodeSelectorTerms

                    withNodeSelectorTerms(nodeSelectorTerms)

                    Required. A list of node selector terms. The terms are ORed.

                    withNodeSelectorTerms takes an array of type nodeSelectorTermsType. You can create an instance of nodeSelectorTermsType with hidden.core.v1.nodeSelectorTerm.new().

                    see hidden.core.v1.nodeSelectorTerm


                  • withNodeSelectorTermsMixin

                    withNodeSelectorTermsMixin(nodeSelectorTerms)

                    Required. A list of node selector terms. The terms are ORed.

                    withNodeSelectorTermsMixin takes an array of type nodeSelectorTermsType. You can create an instance of nodeSelectorTermsType with hidden.core.v1.nodeSelectorTerm.new().

                    see hidden.core.v1.nodeSelectorTerm


              • podAffinity

                Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).


                Functions
                • mixinInstance

                  mixinInstance(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.

                  withPreferredDuringSchedulingIgnoredDuringExecution takes an array of type preferredDuringSchedulingIgnoredDuringExecutionType. You can create an instance of preferredDuringSchedulingIgnoredDuringExecutionType with hidden.core.v1.weightedPodAffinityTerm.new().

                  see hidden.core.v1.weightedPodAffinityTerm


                • 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.

                  withPreferredDuringSchedulingIgnoredDuringExecutionMixin takes an array of type preferredDuringSchedulingIgnoredDuringExecutionType. You can create an instance of preferredDuringSchedulingIgnoredDuringExecutionType with hidden.core.v1.weightedPodAffinityTerm.new().

                  see hidden.core.v1.weightedPodAffinityTerm


                • 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.

                  withRequiredDuringSchedulingIgnoredDuringExecution takes an array of type requiredDuringSchedulingIgnoredDuringExecutionType. You can create an instance of requiredDuringSchedulingIgnoredDuringExecutionType with hidden.core.v1.podAffinityTerm.new().

                  see hidden.core.v1.podAffinityTerm


                • 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.

                  withRequiredDuringSchedulingIgnoredDuringExecutionMixin takes an array of type requiredDuringSchedulingIgnoredDuringExecutionType. You can create an instance of requiredDuringSchedulingIgnoredDuringExecutionType with hidden.core.v1.podAffinityTerm.new().

                  see hidden.core.v1.podAffinityTerm


              • podAntiAffinity

                Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).


                Functions
                • mixinInstance

                  mixinInstance(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.

                  withPreferredDuringSchedulingIgnoredDuringExecution takes an array of type preferredDuringSchedulingIgnoredDuringExecutionType. You can create an instance of preferredDuringSchedulingIgnoredDuringExecutionType with hidden.core.v1.weightedPodAffinityTerm.new().

                  see hidden.core.v1.weightedPodAffinityTerm


                • 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.

                  withPreferredDuringSchedulingIgnoredDuringExecutionMixin takes an array of type preferredDuringSchedulingIgnoredDuringExecutionType. You can create an instance of preferredDuringSchedulingIgnoredDuringExecutionType with hidden.core.v1.weightedPodAffinityTerm.new().

                  see hidden.core.v1.weightedPodAffinityTerm


                • 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.

                  withRequiredDuringSchedulingIgnoredDuringExecution takes an array of type requiredDuringSchedulingIgnoredDuringExecutionType. You can create an instance of requiredDuringSchedulingIgnoredDuringExecutionType with hidden.core.v1.podAffinityTerm.new().

                  see hidden.core.v1.podAffinityTerm


                • 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.

                  withRequiredDuringSchedulingIgnoredDuringExecutionMixin takes an array of type requiredDuringSchedulingIgnoredDuringExecutionType. You can create an instance of requiredDuringSchedulingIgnoredDuringExecutionType with hidden.core.v1.podAffinityTerm.new().

                  see hidden.core.v1.podAffinityTerm


            • securityContext

              SecurityContext holds pod-level security attributes and common container settings. Optional: Defaults to empty. See type description for default values of each field.


              Functions
              • mixinInstance

                mixinInstance(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:

                1. 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.


              • 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.


              • 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.


              • 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.


              • 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.


              Mixins
              • seLinuxOptions

                The SELinux context to be applied to all containers. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container.


                Functions
                • mixinInstance

                  mixinInstance(seLinuxOptions)


                • withLevel

                  withLevel(level)

                  Level is SELinux level label that applies to the container.


                • withRole

                  withRole(role)

                  Role is a SELinux role label that applies to the container.


                • withType

                  withType(type)

                  Type is a SELinux type label that applies to the container.


                • withUser

                  withUser(user)

                  User is a SELinux user label that applies to the container.