workflow.v1alpha1.workflowWatchEvent

Index

fn withType(type)
obj object

Fields

fn withType

withType(type)

obj object

"Workflow is the definition of a workflow resource"

fn object.withApiVersion

withApiVersion(apiVersion)

"APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.io.k8s.community/contributors/devel/sig-architecture/api-conventions.md#resources"

fn object.withKind

withKind(kind)

"Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.io.k8s.community/contributors/devel/sig-architecture/api-conventions.md#types-kinds"

obj object.metadata

"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create."

fn object.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 object.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 object.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 object.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 object.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 object.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 object.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 object.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 object.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.\n\nIf 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).\n\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency"

fn object.metadata.withGeneration

withGeneration(generation)

"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only."

fn object.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 object.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 object.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 object.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 object.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 object.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.\n\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces"

fn object.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 object.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 object.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.\n\nPopulated 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 object.metadata.withSelfLink

withSelfLink(selfLink)

"SelfLink is a URL representing this object. Populated by the system. Read-only.\n\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release."

fn object.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.\n\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids"

obj object.spec

"WorkflowSpec is the specification of a Workflow."

fn object.spec.withActiveDeadlineSeconds

withActiveDeadlineSeconds(activeDeadlineSeconds)

"Optional duration in seconds relative to the workflow start time which the workflow is allowed to run before the controller terminates the io.argoproj.workflow.v1alpha1. A value of zero is used to terminate a Running workflow"

fn object.spec.withAutomountServiceAccountToken

withAutomountServiceAccountToken(automountServiceAccountToken)

"AutomountServiceAccountToken indicates whether a service account token should be automatically mounted in pods. ServiceAccountName of ExecutorConfig must be specified if this value is false."

fn object.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 object.spec.withEntrypoint

withEntrypoint(entrypoint)

"Entrypoint is a template reference to the starting point of the io.argoproj.workflow.v1alpha1."

fn object.spec.withHostAliases

withHostAliases(hostAliases)

fn object.spec.withHostAliasesMixin

withHostAliasesMixin(hostAliases)

Note: This function appends passed data to existing values

fn object.spec.withHostNetwork

withHostNetwork(hostNetwork)

"Host networking requested for this workflow pod. Default to false."

fn object.spec.withImagePullSecrets

withImagePullSecrets(imagePullSecrets)

"ImagePullSecrets is a list of references to secrets in the same namespace to use for pulling any images in pods that reference this ServiceAccount. ImagePullSecrets are distinct from Secrets because Secrets can be mounted in the pod, but ImagePullSecrets are only accessed by the kubelet. More info: https://kubernetes.io/docs/concepts/containers/images/#specifying-imagepullsecrets-on-a-pod"

fn object.spec.withImagePullSecretsMixin

withImagePullSecretsMixin(imagePullSecrets)

"ImagePullSecrets is a list of references to secrets in the same namespace to use for pulling any images in pods that reference this ServiceAccount. ImagePullSecrets are distinct from Secrets because Secrets can be mounted in the pod, but ImagePullSecrets are only accessed by the kubelet. More info: https://kubernetes.io/docs/concepts/containers/images/#specifying-imagepullsecrets-on-a-pod"

Note: This function appends passed data to existing values

fn object.spec.withNodeSelector

withNodeSelector(nodeSelector)

"NodeSelector is a selector which will result in all pods of the workflow to be scheduled on the selected node(s). This is able to be overridden by a nodeSelector specified in the template."

fn object.spec.withNodeSelectorMixin

withNodeSelectorMixin(nodeSelector)

"NodeSelector is a selector which will result in all pods of the workflow to be scheduled on the selected node(s). This is able to be overridden by a nodeSelector specified in the template."

Note: This function appends passed data to existing values

fn object.spec.withOnExit

withOnExit(onExit)

"OnExit is a template reference which is invoked at the end of the workflow, irrespective of the success, failure, or error of the primary io.argoproj.workflow.v1alpha1."

fn object.spec.withParallelism

withParallelism(parallelism)

"Parallelism limits the max total parallel pods that can execute at the same time in a workflow"

fn object.spec.withPodPriority

withPodPriority(podPriority)

"Priority to apply to workflow pods."

fn object.spec.withPodPriorityClassName

withPodPriorityClassName(podPriorityClassName)

"PriorityClassName to apply to workflow pods."

fn object.spec.withPodSpecPatch

withPodSpecPatch(podSpecPatch)

"PodSpecPatch holds strategic merge patch to apply against the pod spec. Allows parameterization of container fields which are not strings (e.g. resource limits)."

fn object.spec.withPriority

withPriority(priority)

"Priority is used if controller is configured to process limited number of workflows in parallel. Workflows with higher priority are processed first."

fn object.spec.withSchedulerName

withSchedulerName(schedulerName)

"Set scheduler name for all pods. Will be overridden if container/script template's scheduler name is set. Default scheduler will be used if neither specified."

fn object.spec.withServiceAccountName

withServiceAccountName(serviceAccountName)

"ServiceAccountName is the name of the ServiceAccount to run all pods of the workflow as."

fn object.spec.withShutdown

withShutdown(shutdown)

"Shutdown will shutdown the workflow according to its ShutdownStrategy"

fn object.spec.withSuspend

withSuspend(suspend)

"Suspend will suspend the workflow and prevent execution of any future steps in the workflow"

fn object.spec.withTemplates

withTemplates(templates)

"Templates is a list of workflow templates used in a workflow"

fn object.spec.withTemplatesMixin

withTemplatesMixin(templates)

"Templates is a list of workflow templates used in a workflow"

Note: This function appends passed data to existing values

fn object.spec.withTolerations

withTolerations(tolerations)

"Tolerations to apply to workflow pods."

fn object.spec.withTolerationsMixin

withTolerationsMixin(tolerations)

"Tolerations to apply to workflow pods."

Note: This function appends passed data to existing values

fn object.spec.withVolumeClaimTemplates

withVolumeClaimTemplates(volumeClaimTemplates)

"VolumeClaimTemplates is a list of claims that containers are allowed to reference. The Workflow controller will create the claims at the beginning of the workflow and delete the claims upon completion of the workflow"

fn object.spec.withVolumeClaimTemplatesMixin

withVolumeClaimTemplatesMixin(volumeClaimTemplates)

"VolumeClaimTemplates is a list of claims that containers are allowed to reference. The Workflow controller will create the claims at the beginning of the workflow and delete the claims upon completion of the workflow"

Note: This function appends passed data to existing values

fn object.spec.withVolumes

withVolumes(volumes)

"Volumes is a list of volumes that can be mounted by containers in a io.argoproj.workflow.v1alpha1."

fn object.spec.withVolumesMixin

withVolumesMixin(volumes)

"Volumes is a list of volumes that can be mounted by containers in a io.argoproj.workflow.v1alpha1."

Note: This function appends passed data to existing values

obj object.spec.affinity

"Affinity is a group of affinity scheduling rules."

obj object.spec.affinity.nodeAffinity

"Node affinity is a group of node affinity scheduling rules."

fn object.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 object.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 object.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 object.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.withNodeSelectorTerms

withNodeSelectorTerms(nodeSelectorTerms)

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

fn object.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 object.spec.affinity.podAffinity

"Pod affinity is a group of inter pod affinity scheduling rules."

fn object.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 object.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 object.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 object.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 object.spec.affinity.podAntiAffinity

"Pod anti affinity is a group of inter pod anti affinity scheduling rules."

fn object.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 object.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 object.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 object.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 object.spec.arguments

"Arguments to a template"

fn object.spec.arguments.withArtifacts

withArtifacts(artifacts)

"Artifacts is the list of artifacts to pass to the template or workflow"

fn object.spec.arguments.withArtifactsMixin

withArtifactsMixin(artifacts)

"Artifacts is the list of artifacts to pass to the template or workflow"

Note: This function appends passed data to existing values

fn object.spec.arguments.withParameters

withParameters(parameters)

"Parameters is the list of parameters to pass to the template or workflow"

fn object.spec.arguments.withParametersMixin

withParametersMixin(parameters)

"Parameters is the list of parameters to pass to the template or workflow"

Note: This function appends passed data to existing values

obj object.spec.artifactRepositoryRef

fn object.spec.artifactRepositoryRef.withConfigMap

withConfigMap(configMap)

"The name of the config map. Defaults to \"artifact-repositories\"."

fn object.spec.artifactRepositoryRef.withKey

withKey(key)

"The config map key. Defaults to the value of the \"workflows.argoproj.io/default-artifact-repository\" annotation."

obj object.spec.dnsConfig

"PodDNSConfig defines the DNS parameters of a pod in addition to those generated from DNSPolicy."

fn object.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 object.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 object.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 object.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 object.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 object.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 object.spec.executor

"ExecutorConfig holds configurations of an executor container."

fn object.spec.executor.withServiceAccountName

withServiceAccountName(serviceAccountName)

"ServiceAccountName specifies the service account name of the executor container."

obj object.spec.metrics

"Metrics are a list of metrics emitted from a Workflow/Template"

fn object.spec.metrics.withPrometheus

withPrometheus(prometheus)

"Prometheus is a list of prometheus metrics to be emitted"

fn object.spec.metrics.withPrometheusMixin

withPrometheusMixin(prometheus)

"Prometheus is a list of prometheus metrics to be emitted"

Note: This function appends passed data to existing values

obj object.spec.podDisruptionBudget

"PodDisruptionBudgetSpec is a description of a PodDisruptionBudget."

fn object.spec.podDisruptionBudget.withMaxUnavailable

withMaxUnavailable(maxUnavailable)

fn object.spec.podDisruptionBudget.withMinAvailable

withMinAvailable(minAvailable)

obj object.spec.podDisruptionBudget.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 object.spec.podDisruptionBudget.selector.withMatchExpressions

withMatchExpressions(matchExpressions)

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

fn object.spec.podDisruptionBudget.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 object.spec.podDisruptionBudget.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 object.spec.podDisruptionBudget.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 object.spec.podGC

"PodGC describes how to delete completed pods as they complete"

fn object.spec.podGC.withStrategy

withStrategy(strategy)

"Strategy is the strategy to use. One of \"OnPodCompletion\", \"OnPodSuccess\", \"OnWorkflowCompletion\", \"OnWorkflowSuccess\

obj object.spec.podGC.labelSelector

"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 object.spec.podGC.labelSelector.withMatchExpressions

withMatchExpressions(matchExpressions)

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

fn object.spec.podGC.labelSelector.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 object.spec.podGC.labelSelector.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 object.spec.podGC.labelSelector.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 object.spec.podMetadata

"Pod metdata"

fn object.spec.podMetadata.withAnnotations

withAnnotations(annotations)

fn object.spec.podMetadata.withAnnotationsMixin

withAnnotationsMixin(annotations)

Note: This function appends passed data to existing values

fn object.spec.podMetadata.withLabels

withLabels(labels)

fn object.spec.podMetadata.withLabelsMixin

withLabelsMixin(labels)

Note: This function appends passed data to existing values

obj object.spec.retryStrategy

"RetryStrategy provides controls on how to retry a workflow step"

fn object.spec.retryStrategy.withLimit

withLimit(limit)

fn object.spec.retryStrategy.withRetryPolicy

withRetryPolicy(retryPolicy)

"RetryPolicy is a policy of NodePhase statuses that will be retried"

obj object.spec.retryStrategy.affinity

"RetryAffinity prevents running steps on the same host."

fn object.spec.retryStrategy.affinity.withNodeAntiAffinity

withNodeAntiAffinity(nodeAntiAffinity)

"RetryNodeAntiAffinity is a placeholder for future expansion, only empty nodeAntiAffinity is allowed. In order to prevent running steps on the same host, it uses \"kubernetes.io/hostname\"."

fn object.spec.retryStrategy.affinity.withNodeAntiAffinityMixin

withNodeAntiAffinityMixin(nodeAntiAffinity)

"RetryNodeAntiAffinity is a placeholder for future expansion, only empty nodeAntiAffinity is allowed. In order to prevent running steps on the same host, it uses \"kubernetes.io/hostname\"."

Note: This function appends passed data to existing values

obj object.spec.retryStrategy.backoff

"Backoff is a backoff strategy to use within retryStrategy"

fn object.spec.retryStrategy.backoff.withDuration

withDuration(duration)

"Duration is the amount to back off. Default unit is seconds, but could also be a duration (e.g. \"2m\", \"1h\")"

fn object.spec.retryStrategy.backoff.withFactor

withFactor(factor)

fn object.spec.retryStrategy.backoff.withMaxDuration

withMaxDuration(maxDuration)

"MaxDuration is the maximum amount of time allowed for the backoff strategy"

obj object.spec.securityContext

"PodSecurityContext holds pod-level security attributes and common container settings. Some fields are also present in container.securityContext. Field values of container.securityContext take precedence over field values of PodSecurityContext."

fn object.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:\n\n1. 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----\n\nIf unset, the Kubelet will not modify the ownership and permissions of any volume."

fn object.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 object.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 object.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 object.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 object.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 object.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 object.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 object.spec.securityContext.seLinuxOptions

"SELinuxOptions are the labels to be applied to the container"

fn object.spec.securityContext.seLinuxOptions.withLevel

withLevel(level)

"Level is SELinux level label that applies to the container."

fn object.spec.securityContext.seLinuxOptions.withRole

withRole(role)

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

fn object.spec.securityContext.seLinuxOptions.withType

withType(type)

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

fn object.spec.securityContext.seLinuxOptions.withUser

withUser(user)

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

obj object.spec.securityContext.windowsOptions

"WindowsSecurityContextOptions contain Windows-specific options and credentials."

fn object.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. This field is alpha-level and is only honored by servers that enable the WindowsGMSA feature flag."

fn object.spec.securityContext.windowsOptions.withGmsaCredentialSpecName

withGmsaCredentialSpecName(gmsaCredentialSpecName)

"GMSACredentialSpecName is the name of the GMSA credential spec to use. This field is alpha-level and is only honored by servers that enable the WindowsGMSA feature flag."

fn object.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. This field is beta-level and may be disabled with the WindowsRunAsUserName feature flag."

obj object.spec.synchronization

"Synchronization holds synchronization lock configuration"

obj object.spec.synchronization.mutex

"Mutex holds Mutex configuration"

fn object.spec.synchronization.mutex.withName

withName(name)

"name of the mutex"

obj object.spec.synchronization.semaphore

"SemaphoreRef is a reference of Semaphore"

obj object.spec.synchronization.semaphore.configMapKeyRef

"Selects a key from a ConfigMap."

fn object.spec.synchronization.semaphore.configMapKeyRef.withKey

withKey(key)

"The key to select."

fn object.spec.synchronization.semaphore.configMapKeyRef.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn object.spec.synchronization.semaphore.configMapKeyRef.withOptional

withOptional(optional)

"Specify whether the ConfigMap or its key must be defined"

obj object.spec.templateDefaults

"Template is a reusable and composable unit of execution in a workflow"

fn object.spec.templateDefaults.withActiveDeadlineSeconds

withActiveDeadlineSeconds(activeDeadlineSeconds)

fn object.spec.templateDefaults.withAutomountServiceAccountToken

withAutomountServiceAccountToken(automountServiceAccountToken)

"AutomountServiceAccountToken indicates whether a service account token should be automatically mounted in pods. ServiceAccountName of ExecutorConfig must be specified if this value is false."

fn object.spec.templateDefaults.withDaemon

withDaemon(daemon)

"Deamon will allow a workflow to proceed to the next step so long as the container reaches readiness"

fn object.spec.templateDefaults.withFailFast

withFailFast(failFast)

"FailFast, if specified, will fail this template if any of its child pods has failed. This is useful for when this template is expanded with withItems, etc."

fn object.spec.templateDefaults.withHostAliases

withHostAliases(hostAliases)

"HostAliases is an optional list of hosts and IPs that will be injected into the pod spec"

fn object.spec.templateDefaults.withHostAliasesMixin

withHostAliasesMixin(hostAliases)

"HostAliases is an optional list of hosts and IPs that will be injected into the pod spec"

Note: This function appends passed data to existing values

fn object.spec.templateDefaults.withInitContainers

withInitContainers(initContainers)

"InitContainers is a list of containers which run before the main container."

fn object.spec.templateDefaults.withInitContainersMixin

withInitContainersMixin(initContainers)

"InitContainers is a list of containers which run before the main container."

Note: This function appends passed data to existing values

fn object.spec.templateDefaults.withName

withName(name)

"Name is the name of the template"

fn object.spec.templateDefaults.withNodeSelector

withNodeSelector(nodeSelector)

"NodeSelector is a selector to schedule this step of the workflow to be run on the selected node(s). Overrides the selector set at the workflow level."

fn object.spec.templateDefaults.withNodeSelectorMixin

withNodeSelectorMixin(nodeSelector)

"NodeSelector is a selector to schedule this step of the workflow to be run on the selected node(s). Overrides the selector set at the workflow level."

Note: This function appends passed data to existing values

fn object.spec.templateDefaults.withParallelism

withParallelism(parallelism)

"Parallelism limits the max total parallel pods that can execute at the same time within the boundaries of this template invocation. If additional steps/dag templates are invoked, the pods created by those templates will not be counted towards this total."

fn object.spec.templateDefaults.withPodSpecPatch

withPodSpecPatch(podSpecPatch)

"PodSpecPatch holds strategic merge patch to apply against the pod spec. Allows parameterization of container fields which are not strings (e.g. resource limits)."

fn object.spec.templateDefaults.withPriority

withPriority(priority)

"Priority to apply to workflow pods."

fn object.spec.templateDefaults.withPriorityClassName

withPriorityClassName(priorityClassName)

"PriorityClassName to apply to workflow pods."

fn object.spec.templateDefaults.withSchedulerName

withSchedulerName(schedulerName)

"If specified, the pod will be dispatched by specified scheduler. Or it will be dispatched by workflow scope scheduler if specified. If neither specified, the pod will be dispatched by default scheduler."

fn object.spec.templateDefaults.withServiceAccountName

withServiceAccountName(serviceAccountName)

"ServiceAccountName to apply to workflow pods"

fn object.spec.templateDefaults.withSidecars

withSidecars(sidecars)

"Sidecars is a list of containers which run alongside the main container Sidecars are automatically killed when the main container completes"

fn object.spec.templateDefaults.withSidecarsMixin

withSidecarsMixin(sidecars)

"Sidecars is a list of containers which run alongside the main container Sidecars are automatically killed when the main container completes"

Note: This function appends passed data to existing values

fn object.spec.templateDefaults.withSteps

withSteps(steps)

"Steps define a series of sequential/parallel workflow steps"

fn object.spec.templateDefaults.withStepsMixin

withStepsMixin(steps)

"Steps define a series of sequential/parallel workflow steps"

Note: This function appends passed data to existing values

fn object.spec.templateDefaults.withTimeout

withTimeout(timeout)

"Timout allows to set the total node execution timeout duration counting from the node's start time. This duration also includes time in which the node spends in Pending state. This duration may not be applied to Step or DAG templates."

fn object.spec.templateDefaults.withTolerations

withTolerations(tolerations)

"Tolerations to apply to workflow pods."

fn object.spec.templateDefaults.withTolerationsMixin

withTolerationsMixin(tolerations)

"Tolerations to apply to workflow pods."

Note: This function appends passed data to existing values

fn object.spec.templateDefaults.withVolumes

withVolumes(volumes)

"Volumes is a list of volumes that can be mounted by containers in a template."

fn object.spec.templateDefaults.withVolumesMixin

withVolumesMixin(volumes)

"Volumes is a list of volumes that can be mounted by containers in a template."

Note: This function appends passed data to existing values

obj object.spec.templateDefaults.affinity

"Affinity is a group of affinity scheduling rules."

obj object.spec.templateDefaults.affinity.nodeAffinity

"Node affinity is a group of node affinity scheduling rules."

fn object.spec.templateDefaults.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 object.spec.templateDefaults.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 object.spec.templateDefaults.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 object.spec.templateDefaults.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.withNodeSelectorTerms

withNodeSelectorTerms(nodeSelectorTerms)

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

fn object.spec.templateDefaults.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 object.spec.templateDefaults.affinity.podAffinity

"Pod affinity is a group of inter pod affinity scheduling rules."

fn object.spec.templateDefaults.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 object.spec.templateDefaults.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 object.spec.templateDefaults.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 object.spec.templateDefaults.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 object.spec.templateDefaults.affinity.podAntiAffinity

"Pod anti affinity is a group of inter pod anti affinity scheduling rules."

fn object.spec.templateDefaults.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 object.spec.templateDefaults.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 object.spec.templateDefaults.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 object.spec.templateDefaults.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 object.spec.templateDefaults.archiveLocation

"ArtifactLocation describes a location for a single or multiple artifacts. It is used as single artifact in the context of inputs/outputs (e.g. outputs.artifacts.artname). It is also used to describe the location of multiple artifacts such as the archive location of a single workflow step, which the executor will use as a default location to store its files."

fn object.spec.templateDefaults.archiveLocation.withArchiveLogs

withArchiveLogs(archiveLogs)

"ArchiveLogs indicates if the container logs should be archived"

obj object.spec.templateDefaults.archiveLocation.artifactory

"ArtifactoryArtifact is the location of an artifactory artifact"

fn object.spec.templateDefaults.archiveLocation.artifactory.withUrl

withUrl(url)

"URL of the artifact"

obj object.spec.templateDefaults.archiveLocation.artifactory.passwordSecret

"SecretKeySelector selects a key of a Secret."

fn object.spec.templateDefaults.archiveLocation.artifactory.passwordSecret.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn object.spec.templateDefaults.archiveLocation.artifactory.passwordSecret.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn object.spec.templateDefaults.archiveLocation.artifactory.passwordSecret.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj object.spec.templateDefaults.archiveLocation.artifactory.usernameSecret

"SecretKeySelector selects a key of a Secret."

fn object.spec.templateDefaults.archiveLocation.artifactory.usernameSecret.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn object.spec.templateDefaults.archiveLocation.artifactory.usernameSecret.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn object.spec.templateDefaults.archiveLocation.artifactory.usernameSecret.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj object.spec.templateDefaults.archiveLocation.gcs

"GCSArtifact is the location of a GCS artifact"

fn object.spec.templateDefaults.archiveLocation.gcs.withBucket

withBucket(bucket)

"Bucket is the name of the bucket"

fn object.spec.templateDefaults.archiveLocation.gcs.withKey

withKey(key)

"Key is the path in the bucket where the artifact resides"

obj object.spec.templateDefaults.archiveLocation.gcs.serviceAccountKeySecret

"SecretKeySelector selects a key of a Secret."

fn object.spec.templateDefaults.archiveLocation.gcs.serviceAccountKeySecret.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn object.spec.templateDefaults.archiveLocation.gcs.serviceAccountKeySecret.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn object.spec.templateDefaults.archiveLocation.gcs.serviceAccountKeySecret.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj object.spec.templateDefaults.archiveLocation.git

"GitArtifact is the location of an git artifact"

fn object.spec.templateDefaults.archiveLocation.git.withDepth

withDepth(depth)

"Depth specifies clones/fetches should be shallow and include the given number of commits from the branch tip"

fn object.spec.templateDefaults.archiveLocation.git.withDisableSubmodules

withDisableSubmodules(disableSubmodules)

"DisableSubmodules disables submodules during git clone"

fn object.spec.templateDefaults.archiveLocation.git.withFetch

withFetch(fetch)

"Fetch specifies a number of refs that should be fetched before checkout"

fn object.spec.templateDefaults.archiveLocation.git.withFetchMixin

withFetchMixin(fetch)

"Fetch specifies a number of refs that should be fetched before checkout"

Note: This function appends passed data to existing values

fn object.spec.templateDefaults.archiveLocation.git.withInsecureIgnoreHostKey

withInsecureIgnoreHostKey(insecureIgnoreHostKey)

"InsecureIgnoreHostKey disables SSH strict host key checking during git clone"

fn object.spec.templateDefaults.archiveLocation.git.withRepo

withRepo(repo)

"Repo is the git repository"

fn object.spec.templateDefaults.archiveLocation.git.withRevision

withRevision(revision)

"Revision is the git commit, tag, branch to checkout"

obj object.spec.templateDefaults.archiveLocation.git.passwordSecret

"SecretKeySelector selects a key of a Secret."

fn object.spec.templateDefaults.archiveLocation.git.passwordSecret.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn object.spec.templateDefaults.archiveLocation.git.passwordSecret.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn object.spec.templateDefaults.archiveLocation.git.passwordSecret.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj object.spec.templateDefaults.archiveLocation.git.sshPrivateKeySecret

"SecretKeySelector selects a key of a Secret."

fn object.spec.templateDefaults.archiveLocation.git.sshPrivateKeySecret.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn object.spec.templateDefaults.archiveLocation.git.sshPrivateKeySecret.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn object.spec.templateDefaults.archiveLocation.git.sshPrivateKeySecret.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj object.spec.templateDefaults.archiveLocation.git.usernameSecret

"SecretKeySelector selects a key of a Secret."

fn object.spec.templateDefaults.archiveLocation.git.usernameSecret.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn object.spec.templateDefaults.archiveLocation.git.usernameSecret.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn object.spec.templateDefaults.archiveLocation.git.usernameSecret.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj object.spec.templateDefaults.archiveLocation.hdfs

"HDFSArtifact is the location of an HDFS artifact"

fn object.spec.templateDefaults.archiveLocation.hdfs.withAddresses

withAddresses(addresses)

"Addresses is accessible addresses of HDFS name nodes"

fn object.spec.templateDefaults.archiveLocation.hdfs.withAddressesMixin

withAddressesMixin(addresses)

"Addresses is accessible addresses of HDFS name nodes"

Note: This function appends passed data to existing values

fn object.spec.templateDefaults.archiveLocation.hdfs.withForce

withForce(force)

"Force copies a file forcibly even if it exists (default: false)"

fn object.spec.templateDefaults.archiveLocation.hdfs.withHdfsUser

withHdfsUser(hdfsUser)

"HDFSUser is the user to access HDFS file system. It is ignored if either ccache or keytab is used."

fn object.spec.templateDefaults.archiveLocation.hdfs.withKrbRealm

withKrbRealm(krbRealm)

"KrbRealm is the Kerberos realm used with Kerberos keytab It must be set if keytab is used."

fn object.spec.templateDefaults.archiveLocation.hdfs.withKrbServicePrincipalName

withKrbServicePrincipalName(krbServicePrincipalName)

"KrbServicePrincipalName is the principal name of Kerberos service It must be set if either ccache or keytab is used."

fn object.spec.templateDefaults.archiveLocation.hdfs.withKrbUsername

withKrbUsername(krbUsername)

"KrbUsername is the Kerberos username used with Kerberos keytab It must be set if keytab is used."

fn object.spec.templateDefaults.archiveLocation.hdfs.withPath

withPath(path)

"Path is a file path in HDFS"

obj object.spec.templateDefaults.archiveLocation.hdfs.krbCCacheSecret

"SecretKeySelector selects a key of a Secret."

fn object.spec.templateDefaults.archiveLocation.hdfs.krbCCacheSecret.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn object.spec.templateDefaults.archiveLocation.hdfs.krbCCacheSecret.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn object.spec.templateDefaults.archiveLocation.hdfs.krbCCacheSecret.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj object.spec.templateDefaults.archiveLocation.hdfs.krbConfigConfigMap

"Selects a key from a ConfigMap."

fn object.spec.templateDefaults.archiveLocation.hdfs.krbConfigConfigMap.withKey

withKey(key)

"The key to select."

fn object.spec.templateDefaults.archiveLocation.hdfs.krbConfigConfigMap.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn object.spec.templateDefaults.archiveLocation.hdfs.krbConfigConfigMap.withOptional

withOptional(optional)

"Specify whether the ConfigMap or its key must be defined"

obj object.spec.templateDefaults.archiveLocation.hdfs.krbKeytabSecret

"SecretKeySelector selects a key of a Secret."

fn object.spec.templateDefaults.archiveLocation.hdfs.krbKeytabSecret.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn object.spec.templateDefaults.archiveLocation.hdfs.krbKeytabSecret.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn object.spec.templateDefaults.archiveLocation.hdfs.krbKeytabSecret.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj object.spec.templateDefaults.archiveLocation.http

"HTTPArtifact allows an file served on HTTP to be placed as an input artifact in a container"

fn object.spec.templateDefaults.archiveLocation.http.withHeaders

withHeaders(headers)

"Headers are an optional list of headers to send with HTTP requests for artifacts"

fn object.spec.templateDefaults.archiveLocation.http.withHeadersMixin

withHeadersMixin(headers)

"Headers are an optional list of headers to send with HTTP requests for artifacts"

Note: This function appends passed data to existing values

fn object.spec.templateDefaults.archiveLocation.http.withUrl

withUrl(url)

"URL of the artifact"

obj object.spec.templateDefaults.archiveLocation.oss

"OSSArtifact is the location of an Alibaba Cloud OSS artifact"

fn object.spec.templateDefaults.archiveLocation.oss.withBucket

withBucket(bucket)

"Bucket is the name of the bucket"

fn object.spec.templateDefaults.archiveLocation.oss.withCreateBucketIfNotPresent

withCreateBucketIfNotPresent(createBucketIfNotPresent)

"CreateBucketIfNotPresent tells the driver to attempt to create the OSS bucket for output artifacts, if it doesn't exist"

fn object.spec.templateDefaults.archiveLocation.oss.withEndpoint

withEndpoint(endpoint)

"Endpoint is the hostname of the bucket endpoint"

fn object.spec.templateDefaults.archiveLocation.oss.withKey

withKey(key)

"Key is the path in the bucket where the artifact resides"

fn object.spec.templateDefaults.archiveLocation.oss.withSecurityToken

withSecurityToken(securityToken)

"SecurityToken is the user's temporary security token. For more details, check out: https://www.alibabacloud.com/help/doc-detail/100624.htm"

obj object.spec.templateDefaults.archiveLocation.oss.accessKeySecret

"SecretKeySelector selects a key of a Secret."

fn object.spec.templateDefaults.archiveLocation.oss.accessKeySecret.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn object.spec.templateDefaults.archiveLocation.oss.accessKeySecret.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn object.spec.templateDefaults.archiveLocation.oss.accessKeySecret.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj object.spec.templateDefaults.archiveLocation.oss.lifecycleRule

"OSSLifecycleRule specifies how to manage bucket's lifecycle"

fn object.spec.templateDefaults.archiveLocation.oss.lifecycleRule.withMarkDeletionAfterDays

withMarkDeletionAfterDays(markDeletionAfterDays)

"MarkDeletionAfterDays is the number of days before we delete objects in the bucket"

fn object.spec.templateDefaults.archiveLocation.oss.lifecycleRule.withMarkInfrequentAccessAfterDays

withMarkInfrequentAccessAfterDays(markInfrequentAccessAfterDays)

"MarkInfrequentAccessAfterDays is the number of days before we convert the objects in the bucket to Infrequent Access (IA) storage type"

obj object.spec.templateDefaults.archiveLocation.oss.secretKeySecret

"SecretKeySelector selects a key of a Secret."

fn object.spec.templateDefaults.archiveLocation.oss.secretKeySecret.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn object.spec.templateDefaults.archiveLocation.oss.secretKeySecret.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn object.spec.templateDefaults.archiveLocation.oss.secretKeySecret.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj object.spec.templateDefaults.archiveLocation.raw

"RawArtifact allows raw string content to be placed as an artifact in a container"

fn object.spec.templateDefaults.archiveLocation.raw.withData

withData(data)

"Data is the string contents of the artifact"

obj object.spec.templateDefaults.archiveLocation.s3

"S3Artifact is the location of an S3 artifact"

fn object.spec.templateDefaults.archiveLocation.s3.withBucket

withBucket(bucket)

"Bucket is the name of the bucket"

fn object.spec.templateDefaults.archiveLocation.s3.withEndpoint

withEndpoint(endpoint)

"Endpoint is the hostname of the bucket endpoint"

fn object.spec.templateDefaults.archiveLocation.s3.withInsecure

withInsecure(insecure)

"Insecure will connect to the service with TLS"

fn object.spec.templateDefaults.archiveLocation.s3.withKey

withKey(key)

"Key is the key in the bucket where the artifact resides"

fn object.spec.templateDefaults.archiveLocation.s3.withRegion

withRegion(region)

"Region contains the optional bucket region"

fn object.spec.templateDefaults.archiveLocation.s3.withRoleARN

withRoleARN(roleARN)

"RoleARN is the Amazon Resource Name (ARN) of the role to assume."

fn object.spec.templateDefaults.archiveLocation.s3.withUseSDKCreds

withUseSDKCreds(useSDKCreds)

"UseSDKCreds tells the driver to figure out credentials based on sdk defaults."

obj object.spec.templateDefaults.archiveLocation.s3.accessKeySecret

"SecretKeySelector selects a key of a Secret."

fn object.spec.templateDefaults.archiveLocation.s3.accessKeySecret.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn object.spec.templateDefaults.archiveLocation.s3.accessKeySecret.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn object.spec.templateDefaults.archiveLocation.s3.accessKeySecret.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj object.spec.templateDefaults.archiveLocation.s3.createBucketIfNotPresent

"CreateS3BucketOptions options used to determine automatic automatic bucket-creation process"

fn object.spec.templateDefaults.archiveLocation.s3.createBucketIfNotPresent.withObjectLocking

withObjectLocking(objectLocking)

"ObjectLocking Enable object locking"

obj object.spec.templateDefaults.archiveLocation.s3.secretKeySecret

"SecretKeySelector selects a key of a Secret."

fn object.spec.templateDefaults.archiveLocation.s3.secretKeySecret.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn object.spec.templateDefaults.archiveLocation.s3.secretKeySecret.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn object.spec.templateDefaults.archiveLocation.s3.secretKeySecret.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj object.spec.templateDefaults.container

"A single application container that you want to run within a pod."

fn object.spec.templateDefaults.container.withArgs

withArgs(args)

"Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell"

fn object.spec.templateDefaults.container.withArgsMixin

withArgsMixin(args)

"Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell"

Note: This function appends passed data to existing values

fn object.spec.templateDefaults.container.withCommand

withCommand(command)

"Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell"

fn object.spec.templateDefaults.container.withCommandMixin

withCommandMixin(command)

"Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell"

Note: This function appends passed data to existing values

fn object.spec.templateDefaults.container.withEnv

withEnv(env)

"List of environment variables to set in the container. Cannot be updated."

fn object.spec.templateDefaults.container.withEnvFrom

withEnvFrom(envFrom)

"List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated."

fn object.spec.templateDefaults.container.withEnvFromMixin

withEnvFromMixin(envFrom)

"List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated."

Note: This function appends passed data to existing values

fn object.spec.templateDefaults.container.withEnvMixin

withEnvMixin(env)

"List of environment variables to set in the container. Cannot be updated."

Note: This function appends passed data to existing values

fn object.spec.templateDefaults.container.withImage

withImage(image)

"Docker image name. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets."

fn object.spec.templateDefaults.container.withImagePullPolicy

withImagePullPolicy(imagePullPolicy)

"Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images"

fn object.spec.templateDefaults.container.withName

withName(name)

"Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated."

fn object.spec.templateDefaults.container.withPorts

withPorts(ports)

"List of ports to expose from the container. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default \"0.0.0.0\" address inside a container will be accessible from the network. Cannot be updated."

fn object.spec.templateDefaults.container.withPortsMixin

withPortsMixin(ports)

"List of ports to expose from the container. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default \"0.0.0.0\" address inside a container will be accessible from the network. Cannot be updated."

Note: This function appends passed data to existing values

fn object.spec.templateDefaults.container.withStdin

withStdin(stdin)

"Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false."

fn object.spec.templateDefaults.container.withStdinOnce

withStdinOnce(stdinOnce)

"Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false"

fn object.spec.templateDefaults.container.withTerminationMessagePath

withTerminationMessagePath(terminationMessagePath)

"Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated."

fn object.spec.templateDefaults.container.withTerminationMessagePolicy

withTerminationMessagePolicy(terminationMessagePolicy)

"Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated."

fn object.spec.templateDefaults.container.withTty

withTty(tty)

"Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false."

fn object.spec.templateDefaults.container.withVolumeDevices

withVolumeDevices(volumeDevices)

"volumeDevices is the list of block devices to be used by the container. This is a beta feature."

fn object.spec.templateDefaults.container.withVolumeDevicesMixin

withVolumeDevicesMixin(volumeDevices)

"volumeDevices is the list of block devices to be used by the container. This is a beta feature."

Note: This function appends passed data to existing values

fn object.spec.templateDefaults.container.withVolumeMounts

withVolumeMounts(volumeMounts)

"Pod volumes to mount into the container's filesystem. Cannot be updated."

fn object.spec.templateDefaults.container.withVolumeMountsMixin

withVolumeMountsMixin(volumeMounts)

"Pod volumes to mount into the container's filesystem. Cannot be updated."

Note: This function appends passed data to existing values

fn object.spec.templateDefaults.container.withWorkingDir

withWorkingDir(workingDir)

"Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated."

obj object.spec.templateDefaults.container.lifecycle

"Lifecycle describes actions that the management system should take in response to container lifecycle events. For the PostStart and PreStop lifecycle handlers, management of the container blocks until the action is complete, unless the container process fails, in which case the handler is aborted."

obj object.spec.templateDefaults.container.lifecycle.postStart

"Handler defines a specific action that should be taken"

obj object.spec.templateDefaults.container.lifecycle.postStart.exec

"ExecAction describes a \"run in container\" action."

fn object.spec.templateDefaults.container.lifecycle.postStart.exec.withCommand

withCommand(command)

"Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy."

fn object.spec.templateDefaults.container.lifecycle.postStart.exec.withCommandMixin

withCommandMixin(command)

"Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy."

Note: This function appends passed data to existing values

obj object.spec.templateDefaults.container.lifecycle.postStart.httpGet

"HTTPGetAction describes an action based on HTTP Get requests."

fn object.spec.templateDefaults.container.lifecycle.postStart.httpGet.withHost

withHost(host)

"Host name to connect to, defaults to the pod IP. You probably want to set \"Host\" in httpHeaders instead."

fn object.spec.templateDefaults.container.lifecycle.postStart.httpGet.withHttpHeaders

withHttpHeaders(httpHeaders)

"Custom headers to set in the request. HTTP allows repeated headers."

fn object.spec.templateDefaults.container.lifecycle.postStart.httpGet.withHttpHeadersMixin

withHttpHeadersMixin(httpHeaders)

"Custom headers to set in the request. HTTP allows repeated headers."

Note: This function appends passed data to existing values

fn object.spec.templateDefaults.container.lifecycle.postStart.httpGet.withPath

withPath(path)

"Path to access on the HTTP server."

fn object.spec.templateDefaults.container.lifecycle.postStart.httpGet.withPort

withPort(port)

fn object.spec.templateDefaults.container.lifecycle.postStart.httpGet.withScheme

withScheme(scheme)

"Scheme to use for connecting to the host. Defaults to HTTP."

obj object.spec.templateDefaults.container.lifecycle.postStart.tcpSocket

"TCPSocketAction describes an action based on opening a socket"

fn object.spec.templateDefaults.container.lifecycle.postStart.tcpSocket.withHost

withHost(host)

"Optional: Host name to connect to, defaults to the pod IP."

fn object.spec.templateDefaults.container.lifecycle.postStart.tcpSocket.withPort

withPort(port)

obj object.spec.templateDefaults.container.lifecycle.preStop

"Handler defines a specific action that should be taken"

obj object.spec.templateDefaults.container.lifecycle.preStop.exec

"ExecAction describes a \"run in container\" action."

fn object.spec.templateDefaults.container.lifecycle.preStop.exec.withCommand

withCommand(command)

"Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy."

fn object.spec.templateDefaults.container.lifecycle.preStop.exec.withCommandMixin

withCommandMixin(command)

"Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy."

Note: This function appends passed data to existing values

obj object.spec.templateDefaults.container.lifecycle.preStop.httpGet

"HTTPGetAction describes an action based on HTTP Get requests."

fn object.spec.templateDefaults.container.lifecycle.preStop.httpGet.withHost

withHost(host)

"Host name to connect to, defaults to the pod IP. You probably want to set \"Host\" in httpHeaders instead."

fn object.spec.templateDefaults.container.lifecycle.preStop.httpGet.withHttpHeaders

withHttpHeaders(httpHeaders)

"Custom headers to set in the request. HTTP allows repeated headers."

fn object.spec.templateDefaults.container.lifecycle.preStop.httpGet.withHttpHeadersMixin

withHttpHeadersMixin(httpHeaders)

"Custom headers to set in the request. HTTP allows repeated headers."

Note: This function appends passed data to existing values

fn object.spec.templateDefaults.container.lifecycle.preStop.httpGet.withPath

withPath(path)

"Path to access on the HTTP server."

fn object.spec.templateDefaults.container.lifecycle.preStop.httpGet.withPort

withPort(port)

fn object.spec.templateDefaults.container.lifecycle.preStop.httpGet.withScheme

withScheme(scheme)

"Scheme to use for connecting to the host. Defaults to HTTP."

obj object.spec.templateDefaults.container.lifecycle.preStop.tcpSocket

"TCPSocketAction describes an action based on opening a socket"

fn object.spec.templateDefaults.container.lifecycle.preStop.tcpSocket.withHost

withHost(host)

"Optional: Host name to connect to, defaults to the pod IP."

fn object.spec.templateDefaults.container.lifecycle.preStop.tcpSocket.withPort

withPort(port)

obj object.spec.templateDefaults.container.livenessProbe

"Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic."

fn object.spec.templateDefaults.container.livenessProbe.withFailureThreshold

withFailureThreshold(failureThreshold)

"Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1."

fn object.spec.templateDefaults.container.livenessProbe.withInitialDelaySeconds

withInitialDelaySeconds(initialDelaySeconds)

"Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"

fn object.spec.templateDefaults.container.livenessProbe.withPeriodSeconds

withPeriodSeconds(periodSeconds)

"How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1."

fn object.spec.templateDefaults.container.livenessProbe.withSuccessThreshold

withSuccessThreshold(successThreshold)

"Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1."

fn object.spec.templateDefaults.container.livenessProbe.withTimeoutSeconds

withTimeoutSeconds(timeoutSeconds)

"Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"

obj object.spec.templateDefaults.container.livenessProbe.exec

"ExecAction describes a \"run in container\" action."

fn object.spec.templateDefaults.container.livenessProbe.exec.withCommand

withCommand(command)

"Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy."

fn object.spec.templateDefaults.container.livenessProbe.exec.withCommandMixin

withCommandMixin(command)

"Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy."

Note: This function appends passed data to existing values

obj object.spec.templateDefaults.container.livenessProbe.httpGet

"HTTPGetAction describes an action based on HTTP Get requests."

fn object.spec.templateDefaults.container.livenessProbe.httpGet.withHost

withHost(host)

"Host name to connect to, defaults to the pod IP. You probably want to set \"Host\" in httpHeaders instead."

fn object.spec.templateDefaults.container.livenessProbe.httpGet.withHttpHeaders

withHttpHeaders(httpHeaders)

"Custom headers to set in the request. HTTP allows repeated headers."

fn object.spec.templateDefaults.container.livenessProbe.httpGet.withHttpHeadersMixin

withHttpHeadersMixin(httpHeaders)

"Custom headers to set in the request. HTTP allows repeated headers."

Note: This function appends passed data to existing values

fn object.spec.templateDefaults.container.livenessProbe.httpGet.withPath

withPath(path)

"Path to access on the HTTP server."

fn object.spec.templateDefaults.container.livenessProbe.httpGet.withPort

withPort(port)

fn object.spec.templateDefaults.container.livenessProbe.httpGet.withScheme

withScheme(scheme)

"Scheme to use for connecting to the host. Defaults to HTTP."

obj object.spec.templateDefaults.container.livenessProbe.tcpSocket

"TCPSocketAction describes an action based on opening a socket"

fn object.spec.templateDefaults.container.livenessProbe.tcpSocket.withHost

withHost(host)

"Optional: Host name to connect to, defaults to the pod IP."

fn object.spec.templateDefaults.container.livenessProbe.tcpSocket.withPort

withPort(port)

obj object.spec.templateDefaults.container.readinessProbe

"Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic."

fn object.spec.templateDefaults.container.readinessProbe.withFailureThreshold

withFailureThreshold(failureThreshold)

"Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1."

fn object.spec.templateDefaults.container.readinessProbe.withInitialDelaySeconds

withInitialDelaySeconds(initialDelaySeconds)

"Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"

fn object.spec.templateDefaults.container.readinessProbe.withPeriodSeconds

withPeriodSeconds(periodSeconds)

"How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1."

fn object.spec.templateDefaults.container.readinessProbe.withSuccessThreshold

withSuccessThreshold(successThreshold)

"Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1."

fn object.spec.templateDefaults.container.readinessProbe.withTimeoutSeconds

withTimeoutSeconds(timeoutSeconds)

"Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"

obj object.spec.templateDefaults.container.readinessProbe.exec

"ExecAction describes a \"run in container\" action."

fn object.spec.templateDefaults.container.readinessProbe.exec.withCommand

withCommand(command)

"Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy."

fn object.spec.templateDefaults.container.readinessProbe.exec.withCommandMixin

withCommandMixin(command)

"Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy."

Note: This function appends passed data to existing values

obj object.spec.templateDefaults.container.readinessProbe.httpGet

"HTTPGetAction describes an action based on HTTP Get requests."

fn object.spec.templateDefaults.container.readinessProbe.httpGet.withHost

withHost(host)

"Host name to connect to, defaults to the pod IP. You probably want to set \"Host\" in httpHeaders instead."

fn object.spec.templateDefaults.container.readinessProbe.httpGet.withHttpHeaders

withHttpHeaders(httpHeaders)

"Custom headers to set in the request. HTTP allows repeated headers."

fn object.spec.templateDefaults.container.readinessProbe.httpGet.withHttpHeadersMixin

withHttpHeadersMixin(httpHeaders)

"Custom headers to set in the request. HTTP allows repeated headers."

Note: This function appends passed data to existing values

fn object.spec.templateDefaults.container.readinessProbe.httpGet.withPath

withPath(path)

"Path to access on the HTTP server."

fn object.spec.templateDefaults.container.readinessProbe.httpGet.withPort

withPort(port)

fn object.spec.templateDefaults.container.readinessProbe.httpGet.withScheme

withScheme(scheme)

"Scheme to use for connecting to the host. Defaults to HTTP."

obj object.spec.templateDefaults.container.readinessProbe.tcpSocket

"TCPSocketAction describes an action based on opening a socket"

fn object.spec.templateDefaults.container.readinessProbe.tcpSocket.withHost

withHost(host)

"Optional: Host name to connect to, defaults to the pod IP."

fn object.spec.templateDefaults.container.readinessProbe.tcpSocket.withPort

withPort(port)

obj object.spec.templateDefaults.container.resources

"ResourceRequirements describes the compute resource requirements."

fn object.spec.templateDefaults.container.resources.withLimits

withLimits(limits)

"Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/"

fn object.spec.templateDefaults.container.resources.withLimitsMixin

withLimitsMixin(limits)

"Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/"

Note: This function appends passed data to existing values

fn object.spec.templateDefaults.container.resources.withRequests

withRequests(requests)

"Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/"

fn object.spec.templateDefaults.container.resources.withRequestsMixin

withRequestsMixin(requests)

"Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/"

Note: This function appends passed data to existing values

obj object.spec.templateDefaults.container.securityContext

"SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence."

fn object.spec.templateDefaults.container.securityContext.withAllowPrivilegeEscalation

withAllowPrivilegeEscalation(allowPrivilegeEscalation)

"AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN"

fn object.spec.templateDefaults.container.securityContext.withPrivileged

withPrivileged(privileged)

"Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false."

fn object.spec.templateDefaults.container.securityContext.withProcMount

withProcMount(procMount)

"procMount denotes the type of proc mount to use for the containers. The default is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled."

fn object.spec.templateDefaults.container.securityContext.withReadOnlyRootFilesystem

withReadOnlyRootFilesystem(readOnlyRootFilesystem)

"Whether this container has a read-only root filesystem. Default is false."

fn object.spec.templateDefaults.container.securityContext.withRunAsGroup

withRunAsGroup(runAsGroup)

"The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence."

fn object.spec.templateDefaults.container.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 PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence."

fn object.spec.templateDefaults.container.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 PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence."

obj object.spec.templateDefaults.container.securityContext.capabilities

"Adds and removes POSIX capabilities from running containers."

fn object.spec.templateDefaults.container.securityContext.capabilities.withAdd

withAdd(add)

"Added capabilities"

fn object.spec.templateDefaults.container.securityContext.capabilities.withAddMixin

withAddMixin(add)

"Added capabilities"

Note: This function appends passed data to existing values

fn object.spec.templateDefaults.container.securityContext.capabilities.withDrop

withDrop(drop)

"Removed capabilities"

fn object.spec.templateDefaults.container.securityContext.capabilities.withDropMixin

withDropMixin(drop)

"Removed capabilities"

Note: This function appends passed data to existing values

obj object.spec.templateDefaults.container.securityContext.seLinuxOptions

"SELinuxOptions are the labels to be applied to the container"

fn object.spec.templateDefaults.container.securityContext.seLinuxOptions.withLevel

withLevel(level)

"Level is SELinux level label that applies to the container."

fn object.spec.templateDefaults.container.securityContext.seLinuxOptions.withRole

withRole(role)

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

fn object.spec.templateDefaults.container.securityContext.seLinuxOptions.withType

withType(type)

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

fn object.spec.templateDefaults.container.securityContext.seLinuxOptions.withUser

withUser(user)

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

obj object.spec.templateDefaults.container.securityContext.windowsOptions

"WindowsSecurityContextOptions contain Windows-specific options and credentials."

fn object.spec.templateDefaults.container.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. This field is alpha-level and is only honored by servers that enable the WindowsGMSA feature flag."

fn object.spec.templateDefaults.container.securityContext.windowsOptions.withGmsaCredentialSpecName

withGmsaCredentialSpecName(gmsaCredentialSpecName)

"GMSACredentialSpecName is the name of the GMSA credential spec to use. This field is alpha-level and is only honored by servers that enable the WindowsGMSA feature flag."

fn object.spec.templateDefaults.container.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. This field is beta-level and may be disabled with the WindowsRunAsUserName feature flag."

obj object.spec.templateDefaults.container.startupProbe

"Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic."

fn object.spec.templateDefaults.container.startupProbe.withFailureThreshold

withFailureThreshold(failureThreshold)

"Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1."

fn object.spec.templateDefaults.container.startupProbe.withInitialDelaySeconds

withInitialDelaySeconds(initialDelaySeconds)

"Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"

fn object.spec.templateDefaults.container.startupProbe.withPeriodSeconds

withPeriodSeconds(periodSeconds)

"How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1."

fn object.spec.templateDefaults.container.startupProbe.withSuccessThreshold

withSuccessThreshold(successThreshold)

"Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1."

fn object.spec.templateDefaults.container.startupProbe.withTimeoutSeconds

withTimeoutSeconds(timeoutSeconds)

"Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"

obj object.spec.templateDefaults.container.startupProbe.exec

"ExecAction describes a \"run in container\" action."

fn object.spec.templateDefaults.container.startupProbe.exec.withCommand

withCommand(command)

"Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy."

fn object.spec.templateDefaults.container.startupProbe.exec.withCommandMixin

withCommandMixin(command)

"Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy."

Note: This function appends passed data to existing values

obj object.spec.templateDefaults.container.startupProbe.httpGet

"HTTPGetAction describes an action based on HTTP Get requests."

fn object.spec.templateDefaults.container.startupProbe.httpGet.withHost

withHost(host)

"Host name to connect to, defaults to the pod IP. You probably want to set \"Host\" in httpHeaders instead."

fn object.spec.templateDefaults.container.startupProbe.httpGet.withHttpHeaders

withHttpHeaders(httpHeaders)

"Custom headers to set in the request. HTTP allows repeated headers."

fn object.spec.templateDefaults.container.startupProbe.httpGet.withHttpHeadersMixin

withHttpHeadersMixin(httpHeaders)

"Custom headers to set in the request. HTTP allows repeated headers."

Note: This function appends passed data to existing values

fn object.spec.templateDefaults.container.startupProbe.httpGet.withPath

withPath(path)

"Path to access on the HTTP server."

fn object.spec.templateDefaults.container.startupProbe.httpGet.withPort

withPort(port)

fn object.spec.templateDefaults.container.startupProbe.httpGet.withScheme

withScheme(scheme)

"Scheme to use for connecting to the host. Defaults to HTTP."

obj object.spec.templateDefaults.container.startupProbe.tcpSocket

"TCPSocketAction describes an action based on opening a socket"

fn object.spec.templateDefaults.container.startupProbe.tcpSocket.withHost

withHost(host)

"Optional: Host name to connect to, defaults to the pod IP."

fn object.spec.templateDefaults.container.startupProbe.tcpSocket.withPort

withPort(port)

obj object.spec.templateDefaults.containerSet

fn object.spec.templateDefaults.containerSet.withContainers

withContainers(containers)

fn object.spec.templateDefaults.containerSet.withContainersMixin

withContainersMixin(containers)

Note: This function appends passed data to existing values

fn object.spec.templateDefaults.containerSet.withVolumeMounts

withVolumeMounts(volumeMounts)

fn object.spec.templateDefaults.containerSet.withVolumeMountsMixin

withVolumeMountsMixin(volumeMounts)

Note: This function appends passed data to existing values

obj object.spec.templateDefaults.dag

"DAGTemplate is a template subtype for directed acyclic graph templates"

fn object.spec.templateDefaults.dag.withFailFast

withFailFast(failFast)

"This flag is for DAG logic. The DAG logic has a built-in \"fail fast\" feature to stop scheduling new steps, as soon as it detects that one of the DAG nodes is failed. Then it waits until all DAG nodes are completed before failing the DAG itself. The FailFast flag default is true, if set to false, it will allow a DAG to run all branches of the DAG to completion (either success or failure), regardless of the failed outcomes of branches in the DAG. More info and example about this feature at https://github.com/argoproj/argo-workflows/issues/1442"

fn object.spec.templateDefaults.dag.withTarget

withTarget(target)

"Target are one or more names of targets to execute in a DAG"

fn object.spec.templateDefaults.dag.withTasks

withTasks(tasks)

"Tasks are a list of DAG tasks"

fn object.spec.templateDefaults.dag.withTasksMixin

withTasksMixin(tasks)

"Tasks are a list of DAG tasks"

Note: This function appends passed data to existing values

obj object.spec.templateDefaults.data

"Data is a data template"

fn object.spec.templateDefaults.data.withTransformation

withTransformation(transformation)

"Transformation applies a set of transformations"

fn object.spec.templateDefaults.data.withTransformationMixin

withTransformationMixin(transformation)

"Transformation applies a set of transformations"

Note: This function appends passed data to existing values

obj object.spec.templateDefaults.data.source

"DataSource sources external data into a data template"

obj object.spec.templateDefaults.data.source.artifactPaths

"ArtifactPaths expands a step from a collection of artifacts"

fn object.spec.templateDefaults.data.source.artifactPaths.withArchiveLogs

withArchiveLogs(archiveLogs)

"ArchiveLogs indicates if the container logs should be archived"

fn object.spec.templateDefaults.data.source.artifactPaths.withFrom

withFrom(from)

"From allows an artifact to reference an artifact from a previous step"

fn object.spec.templateDefaults.data.source.artifactPaths.withFromExpression

withFromExpression(fromExpression)

"FromExpression, if defined, is evaluated to specify the value for the artifact"

fn object.spec.templateDefaults.data.source.artifactPaths.withGlobalName

withGlobalName(globalName)

"GlobalName exports an output artifact to the global scope, making it available as '{{io.argoproj.workflow.v1alpha1.outputs.artifacts.XXXX}} and in workflow.status.outputs.artifacts"

fn object.spec.templateDefaults.data.source.artifactPaths.withMode

withMode(mode)

"mode bits to use on this file, must be a value between 0 and 0777 set when loading input artifacts."

fn object.spec.templateDefaults.data.source.artifactPaths.withName

withName(name)

"name of the artifact. must be unique within a template's inputs/outputs."

fn object.spec.templateDefaults.data.source.artifactPaths.withOptional

withOptional(optional)

"Make Artifacts optional, if Artifacts doesn't generate or exist"

fn object.spec.templateDefaults.data.source.artifactPaths.withPath

withPath(path)

"Path is the container path to the artifact"

fn object.spec.templateDefaults.data.source.artifactPaths.withRecurseMode

withRecurseMode(recurseMode)

"If mode is set, apply the permission recursively into the artifact if it is a folder"

fn object.spec.templateDefaults.data.source.artifactPaths.withSubPath

withSubPath(subPath)

"SubPath allows an artifact to be sourced from a subpath within the specified source"

obj object.spec.templateDefaults.data.source.artifactPaths.archive

"ArchiveStrategy describes how to archive files/directory when saving artifacts"

fn object.spec.templateDefaults.data.source.artifactPaths.archive.withNone

withNone(none)

"NoneStrategy indicates to skip tar process and upload the files or directory tree as independent files. Note that if the artifact is a directory, the artifact driver must support the ability to save/load the directory appropriately."

fn object.spec.templateDefaults.data.source.artifactPaths.archive.withNoneMixin

withNoneMixin(none)

"NoneStrategy indicates to skip tar process and upload the files or directory tree as independent files. Note that if the artifact is a directory, the artifact driver must support the ability to save/load the directory appropriately."

Note: This function appends passed data to existing values

fn object.spec.templateDefaults.data.source.artifactPaths.archive.withZip

withZip(zip)

"ZipStrategy will unzip zipped input artifacts"

fn object.spec.templateDefaults.data.source.artifactPaths.archive.withZipMixin

withZipMixin(zip)

"ZipStrategy will unzip zipped input artifacts"

Note: This function appends passed data to existing values

obj object.spec.templateDefaults.data.source.artifactPaths.archive.tar

"TarStrategy will tar and gzip the file or directory when saving"

fn object.spec.templateDefaults.data.source.artifactPaths.archive.tar.withCompressionLevel

withCompressionLevel(compressionLevel)

"CompressionLevel specifies the gzip compression level to use for the artifact. Defaults to gzip.DefaultCompression."

obj object.spec.templateDefaults.data.source.artifactPaths.artifactory

"ArtifactoryArtifact is the location of an artifactory artifact"

fn object.spec.templateDefaults.data.source.artifactPaths.artifactory.withUrl

withUrl(url)

"URL of the artifact"

obj object.spec.templateDefaults.data.source.artifactPaths.artifactory.passwordSecret

"SecretKeySelector selects a key of a Secret."

fn object.spec.templateDefaults.data.source.artifactPaths.artifactory.passwordSecret.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn object.spec.templateDefaults.data.source.artifactPaths.artifactory.passwordSecret.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn object.spec.templateDefaults.data.source.artifactPaths.artifactory.passwordSecret.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj object.spec.templateDefaults.data.source.artifactPaths.artifactory.usernameSecret

"SecretKeySelector selects a key of a Secret."

fn object.spec.templateDefaults.data.source.artifactPaths.artifactory.usernameSecret.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn object.spec.templateDefaults.data.source.artifactPaths.artifactory.usernameSecret.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn object.spec.templateDefaults.data.source.artifactPaths.artifactory.usernameSecret.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj object.spec.templateDefaults.data.source.artifactPaths.gcs

"GCSArtifact is the location of a GCS artifact"

fn object.spec.templateDefaults.data.source.artifactPaths.gcs.withBucket

withBucket(bucket)

"Bucket is the name of the bucket"

fn object.spec.templateDefaults.data.source.artifactPaths.gcs.withKey

withKey(key)

"Key is the path in the bucket where the artifact resides"

obj object.spec.templateDefaults.data.source.artifactPaths.gcs.serviceAccountKeySecret

"SecretKeySelector selects a key of a Secret."

fn object.spec.templateDefaults.data.source.artifactPaths.gcs.serviceAccountKeySecret.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn object.spec.templateDefaults.data.source.artifactPaths.gcs.serviceAccountKeySecret.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn object.spec.templateDefaults.data.source.artifactPaths.gcs.serviceAccountKeySecret.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj object.spec.templateDefaults.data.source.artifactPaths.git

"GitArtifact is the location of an git artifact"

fn object.spec.templateDefaults.data.source.artifactPaths.git.withDepth

withDepth(depth)

"Depth specifies clones/fetches should be shallow and include the given number of commits from the branch tip"

fn object.spec.templateDefaults.data.source.artifactPaths.git.withDisableSubmodules

withDisableSubmodules(disableSubmodules)

"DisableSubmodules disables submodules during git clone"

fn object.spec.templateDefaults.data.source.artifactPaths.git.withFetch

withFetch(fetch)

"Fetch specifies a number of refs that should be fetched before checkout"

fn object.spec.templateDefaults.data.source.artifactPaths.git.withFetchMixin

withFetchMixin(fetch)

"Fetch specifies a number of refs that should be fetched before checkout"

Note: This function appends passed data to existing values

fn object.spec.templateDefaults.data.source.artifactPaths.git.withInsecureIgnoreHostKey

withInsecureIgnoreHostKey(insecureIgnoreHostKey)

"InsecureIgnoreHostKey disables SSH strict host key checking during git clone"

fn object.spec.templateDefaults.data.source.artifactPaths.git.withRepo

withRepo(repo)

"Repo is the git repository"

fn object.spec.templateDefaults.data.source.artifactPaths.git.withRevision

withRevision(revision)

"Revision is the git commit, tag, branch to checkout"

obj object.spec.templateDefaults.data.source.artifactPaths.git.passwordSecret

"SecretKeySelector selects a key of a Secret."

fn object.spec.templateDefaults.data.source.artifactPaths.git.passwordSecret.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn object.spec.templateDefaults.data.source.artifactPaths.git.passwordSecret.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn object.spec.templateDefaults.data.source.artifactPaths.git.passwordSecret.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj object.spec.templateDefaults.data.source.artifactPaths.git.sshPrivateKeySecret

"SecretKeySelector selects a key of a Secret."

fn object.spec.templateDefaults.data.source.artifactPaths.git.sshPrivateKeySecret.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn object.spec.templateDefaults.data.source.artifactPaths.git.sshPrivateKeySecret.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn object.spec.templateDefaults.data.source.artifactPaths.git.sshPrivateKeySecret.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj object.spec.templateDefaults.data.source.artifactPaths.git.usernameSecret

"SecretKeySelector selects a key of a Secret."

fn object.spec.templateDefaults.data.source.artifactPaths.git.usernameSecret.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn object.spec.templateDefaults.data.source.artifactPaths.git.usernameSecret.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn object.spec.templateDefaults.data.source.artifactPaths.git.usernameSecret.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj object.spec.templateDefaults.data.source.artifactPaths.hdfs

"HDFSArtifact is the location of an HDFS artifact"

fn object.spec.templateDefaults.data.source.artifactPaths.hdfs.withAddresses

withAddresses(addresses)

"Addresses is accessible addresses of HDFS name nodes"

fn object.spec.templateDefaults.data.source.artifactPaths.hdfs.withAddressesMixin

withAddressesMixin(addresses)

"Addresses is accessible addresses of HDFS name nodes"

Note: This function appends passed data to existing values

fn object.spec.templateDefaults.data.source.artifactPaths.hdfs.withForce

withForce(force)

"Force copies a file forcibly even if it exists (default: false)"

fn object.spec.templateDefaults.data.source.artifactPaths.hdfs.withHdfsUser

withHdfsUser(hdfsUser)

"HDFSUser is the user to access HDFS file system. It is ignored if either ccache or keytab is used."

fn object.spec.templateDefaults.data.source.artifactPaths.hdfs.withKrbRealm

withKrbRealm(krbRealm)

"KrbRealm is the Kerberos realm used with Kerberos keytab It must be set if keytab is used."

fn object.spec.templateDefaults.data.source.artifactPaths.hdfs.withKrbServicePrincipalName

withKrbServicePrincipalName(krbServicePrincipalName)

"KrbServicePrincipalName is the principal name of Kerberos service It must be set if either ccache or keytab is used."

fn object.spec.templateDefaults.data.source.artifactPaths.hdfs.withKrbUsername

withKrbUsername(krbUsername)

"KrbUsername is the Kerberos username used with Kerberos keytab It must be set if keytab is used."

fn object.spec.templateDefaults.data.source.artifactPaths.hdfs.withPath

withPath(path)

"Path is a file path in HDFS"

obj object.spec.templateDefaults.data.source.artifactPaths.hdfs.krbCCacheSecret

"SecretKeySelector selects a key of a Secret."

fn object.spec.templateDefaults.data.source.artifactPaths.hdfs.krbCCacheSecret.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn object.spec.templateDefaults.data.source.artifactPaths.hdfs.krbCCacheSecret.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn object.spec.templateDefaults.data.source.artifactPaths.hdfs.krbCCacheSecret.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj object.spec.templateDefaults.data.source.artifactPaths.hdfs.krbConfigConfigMap

"Selects a key from a ConfigMap."

fn object.spec.templateDefaults.data.source.artifactPaths.hdfs.krbConfigConfigMap.withKey

withKey(key)

"The key to select."

fn object.spec.templateDefaults.data.source.artifactPaths.hdfs.krbConfigConfigMap.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn object.spec.templateDefaults.data.source.artifactPaths.hdfs.krbConfigConfigMap.withOptional

withOptional(optional)

"Specify whether the ConfigMap or its key must be defined"

obj object.spec.templateDefaults.data.source.artifactPaths.hdfs.krbKeytabSecret

"SecretKeySelector selects a key of a Secret."

fn object.spec.templateDefaults.data.source.artifactPaths.hdfs.krbKeytabSecret.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn object.spec.templateDefaults.data.source.artifactPaths.hdfs.krbKeytabSecret.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn object.spec.templateDefaults.data.source.artifactPaths.hdfs.krbKeytabSecret.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj object.spec.templateDefaults.data.source.artifactPaths.http

"HTTPArtifact allows an file served on HTTP to be placed as an input artifact in a container"

fn object.spec.templateDefaults.data.source.artifactPaths.http.withHeaders

withHeaders(headers)

"Headers are an optional list of headers to send with HTTP requests for artifacts"

fn object.spec.templateDefaults.data.source.artifactPaths.http.withHeadersMixin

withHeadersMixin(headers)

"Headers are an optional list of headers to send with HTTP requests for artifacts"

Note: This function appends passed data to existing values

fn object.spec.templateDefaults.data.source.artifactPaths.http.withUrl

withUrl(url)

"URL of the artifact"

obj object.spec.templateDefaults.data.source.artifactPaths.oss

"OSSArtifact is the location of an Alibaba Cloud OSS artifact"

fn object.spec.templateDefaults.data.source.artifactPaths.oss.withBucket

withBucket(bucket)

"Bucket is the name of the bucket"

fn object.spec.templateDefaults.data.source.artifactPaths.oss.withCreateBucketIfNotPresent

withCreateBucketIfNotPresent(createBucketIfNotPresent)

"CreateBucketIfNotPresent tells the driver to attempt to create the OSS bucket for output artifacts, if it doesn't exist"

fn object.spec.templateDefaults.data.source.artifactPaths.oss.withEndpoint

withEndpoint(endpoint)

"Endpoint is the hostname of the bucket endpoint"

fn object.spec.templateDefaults.data.source.artifactPaths.oss.withKey

withKey(key)

"Key is the path in the bucket where the artifact resides"

fn object.spec.templateDefaults.data.source.artifactPaths.oss.withSecurityToken

withSecurityToken(securityToken)

"SecurityToken is the user's temporary security token. For more details, check out: https://www.alibabacloud.com/help/doc-detail/100624.htm"

obj object.spec.templateDefaults.data.source.artifactPaths.oss.accessKeySecret

"SecretKeySelector selects a key of a Secret."

fn object.spec.templateDefaults.data.source.artifactPaths.oss.accessKeySecret.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn object.spec.templateDefaults.data.source.artifactPaths.oss.accessKeySecret.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn object.spec.templateDefaults.data.source.artifactPaths.oss.accessKeySecret.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj object.spec.templateDefaults.data.source.artifactPaths.oss.lifecycleRule

"OSSLifecycleRule specifies how to manage bucket's lifecycle"

fn object.spec.templateDefaults.data.source.artifactPaths.oss.lifecycleRule.withMarkDeletionAfterDays

withMarkDeletionAfterDays(markDeletionAfterDays)

"MarkDeletionAfterDays is the number of days before we delete objects in the bucket"

fn object.spec.templateDefaults.data.source.artifactPaths.oss.lifecycleRule.withMarkInfrequentAccessAfterDays

withMarkInfrequentAccessAfterDays(markInfrequentAccessAfterDays)

"MarkInfrequentAccessAfterDays is the number of days before we convert the objects in the bucket to Infrequent Access (IA) storage type"

obj object.spec.templateDefaults.data.source.artifactPaths.oss.secretKeySecret

"SecretKeySelector selects a key of a Secret."

fn object.spec.templateDefaults.data.source.artifactPaths.oss.secretKeySecret.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn object.spec.templateDefaults.data.source.artifactPaths.oss.secretKeySecret.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn object.spec.templateDefaults.data.source.artifactPaths.oss.secretKeySecret.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj object.spec.templateDefaults.data.source.artifactPaths.raw

"RawArtifact allows raw string content to be placed as an artifact in a container"

fn object.spec.templateDefaults.data.source.artifactPaths.raw.withData

withData(data)

"Data is the string contents of the artifact"

obj object.spec.templateDefaults.data.source.artifactPaths.s3

"S3Artifact is the location of an S3 artifact"

fn object.spec.templateDefaults.data.source.artifactPaths.s3.withBucket

withBucket(bucket)

"Bucket is the name of the bucket"

fn object.spec.templateDefaults.data.source.artifactPaths.s3.withEndpoint

withEndpoint(endpoint)

"Endpoint is the hostname of the bucket endpoint"

fn object.spec.templateDefaults.data.source.artifactPaths.s3.withInsecure

withInsecure(insecure)

"Insecure will connect to the service with TLS"

fn object.spec.templateDefaults.data.source.artifactPaths.s3.withKey

withKey(key)

"Key is the key in the bucket where the artifact resides"

fn object.spec.templateDefaults.data.source.artifactPaths.s3.withRegion

withRegion(region)

"Region contains the optional bucket region"

fn object.spec.templateDefaults.data.source.artifactPaths.s3.withRoleARN

withRoleARN(roleARN)

"RoleARN is the Amazon Resource Name (ARN) of the role to assume."

fn object.spec.templateDefaults.data.source.artifactPaths.s3.withUseSDKCreds

withUseSDKCreds(useSDKCreds)

"UseSDKCreds tells the driver to figure out credentials based on sdk defaults."

obj object.spec.templateDefaults.data.source.artifactPaths.s3.accessKeySecret

"SecretKeySelector selects a key of a Secret."

fn object.spec.templateDefaults.data.source.artifactPaths.s3.accessKeySecret.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn object.spec.templateDefaults.data.source.artifactPaths.s3.accessKeySecret.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn object.spec.templateDefaults.data.source.artifactPaths.s3.accessKeySecret.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj object.spec.templateDefaults.data.source.artifactPaths.s3.createBucketIfNotPresent

"CreateS3BucketOptions options used to determine automatic automatic bucket-creation process"

fn object.spec.templateDefaults.data.source.artifactPaths.s3.createBucketIfNotPresent.withObjectLocking

withObjectLocking(objectLocking)

"ObjectLocking Enable object locking"

obj object.spec.templateDefaults.data.source.artifactPaths.s3.secretKeySecret

"SecretKeySelector selects a key of a Secret."

fn object.spec.templateDefaults.data.source.artifactPaths.s3.secretKeySecret.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn object.spec.templateDefaults.data.source.artifactPaths.s3.secretKeySecret.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn object.spec.templateDefaults.data.source.artifactPaths.s3.secretKeySecret.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj object.spec.templateDefaults.executor

"ExecutorConfig holds configurations of an executor container."

fn object.spec.templateDefaults.executor.withServiceAccountName

withServiceAccountName(serviceAccountName)

"ServiceAccountName specifies the service account name of the executor container."

obj object.spec.templateDefaults.inputs

"Inputs are the mechanism for passing parameters, artifacts, volumes from one template to another"

fn object.spec.templateDefaults.inputs.withArtifacts

withArtifacts(artifacts)

"Artifact are a list of artifacts passed as inputs"

fn object.spec.templateDefaults.inputs.withArtifactsMixin

withArtifactsMixin(artifacts)

"Artifact are a list of artifacts passed as inputs"

Note: This function appends passed data to existing values

fn object.spec.templateDefaults.inputs.withParameters

withParameters(parameters)

"Parameters are a list of parameters passed as inputs"

fn object.spec.templateDefaults.inputs.withParametersMixin

withParametersMixin(parameters)

"Parameters are a list of parameters passed as inputs"

Note: This function appends passed data to existing values

obj object.spec.templateDefaults.memoize

"Memoization enables caching for the Outputs of the template"

fn object.spec.templateDefaults.memoize.withKey

withKey(key)

"Key is the key to use as the caching key"

fn object.spec.templateDefaults.memoize.withMaxAge

withMaxAge(maxAge)

"MaxAge is the maximum age (e.g. \"180s\", \"24h\") of an entry that is still considered valid. If an entry is older than the MaxAge, it will be ignored."

obj object.spec.templateDefaults.memoize.cache

"Cache is the configuration for the type of cache to be used"

obj object.spec.templateDefaults.memoize.cache.configMap

"Selects a key from a ConfigMap."

fn object.spec.templateDefaults.memoize.cache.configMap.withKey

withKey(key)

"The key to select."

fn object.spec.templateDefaults.memoize.cache.configMap.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn object.spec.templateDefaults.memoize.cache.configMap.withOptional

withOptional(optional)

"Specify whether the ConfigMap or its key must be defined"

obj object.spec.templateDefaults.metadata

"Pod metdata"

fn object.spec.templateDefaults.metadata.withAnnotations

withAnnotations(annotations)

fn object.spec.templateDefaults.metadata.withAnnotationsMixin

withAnnotationsMixin(annotations)

Note: This function appends passed data to existing values

fn object.spec.templateDefaults.metadata.withLabels

withLabels(labels)

fn object.spec.templateDefaults.metadata.withLabelsMixin

withLabelsMixin(labels)

Note: This function appends passed data to existing values

obj object.spec.templateDefaults.metrics

"Metrics are a list of metrics emitted from a Workflow/Template"

fn object.spec.templateDefaults.metrics.withPrometheus

withPrometheus(prometheus)

"Prometheus is a list of prometheus metrics to be emitted"

fn object.spec.templateDefaults.metrics.withPrometheusMixin

withPrometheusMixin(prometheus)

"Prometheus is a list of prometheus metrics to be emitted"

Note: This function appends passed data to existing values

obj object.spec.templateDefaults.outputs

"Outputs hold parameters, artifacts, and results from a step"

fn object.spec.templateDefaults.outputs.withArtifacts

withArtifacts(artifacts)

"Artifacts holds the list of output artifacts produced by a step"

fn object.spec.templateDefaults.outputs.withArtifactsMixin

withArtifactsMixin(artifacts)

"Artifacts holds the list of output artifacts produced by a step"

Note: This function appends passed data to existing values

fn object.spec.templateDefaults.outputs.withExitCode

withExitCode(exitCode)

"ExitCode holds the exit code of a script template"

fn object.spec.templateDefaults.outputs.withParameters

withParameters(parameters)

"Parameters holds the list of output parameters produced by a step"

fn object.spec.templateDefaults.outputs.withParametersMixin

withParametersMixin(parameters)

"Parameters holds the list of output parameters produced by a step"

Note: This function appends passed data to existing values

fn object.spec.templateDefaults.outputs.withResult

withResult(result)

"Result holds the result (stdout) of a script template"

obj object.spec.templateDefaults.resource

"ResourceTemplate is a template subtype to manipulate kubernetes resources"

fn object.spec.templateDefaults.resource.withAction

withAction(action)

"Action is the action to perform to the resource. Must be one of: get, create, apply, delete, replace, patch"

fn object.spec.templateDefaults.resource.withFailureCondition

withFailureCondition(failureCondition)

"FailureCondition is a label selector expression which describes the conditions of the k8s resource in which the step was considered failed"

fn object.spec.templateDefaults.resource.withFlags

withFlags(flags)

"Flags is a set of additional options passed to kubectl before submitting a resource I.e. to disable resource validation: flags: [\n\t\"--validate=false\" # disable resource validation\n]"

fn object.spec.templateDefaults.resource.withFlagsMixin

withFlagsMixin(flags)

"Flags is a set of additional options passed to kubectl before submitting a resource I.e. to disable resource validation: flags: [\n\t\"--validate=false\" # disable resource validation\n]"

Note: This function appends passed data to existing values

fn object.spec.templateDefaults.resource.withManifest

withManifest(manifest)

"Manifest contains the kubernetes manifest"

fn object.spec.templateDefaults.resource.withMergeStrategy

withMergeStrategy(mergeStrategy)

"MergeStrategy is the strategy used to merge a patch. It defaults to \"strategic\" Must be one of: strategic, merge, json"

fn object.spec.templateDefaults.resource.withSetOwnerReference

withSetOwnerReference(setOwnerReference)

"SetOwnerReference sets the reference to the workflow on the OwnerReference of generated resource."

fn object.spec.templateDefaults.resource.withSuccessCondition

withSuccessCondition(successCondition)

"SuccessCondition is a label selector expression which describes the conditions of the k8s resource in which it is acceptable to proceed to the following step"

obj object.spec.templateDefaults.retryStrategy

"RetryStrategy provides controls on how to retry a workflow step"

fn object.spec.templateDefaults.retryStrategy.withLimit

withLimit(limit)

fn object.spec.templateDefaults.retryStrategy.withRetryPolicy

withRetryPolicy(retryPolicy)

"RetryPolicy is a policy of NodePhase statuses that will be retried"

obj object.spec.templateDefaults.retryStrategy.affinity

"RetryAffinity prevents running steps on the same host."

fn object.spec.templateDefaults.retryStrategy.affinity.withNodeAntiAffinity

withNodeAntiAffinity(nodeAntiAffinity)

"RetryNodeAntiAffinity is a placeholder for future expansion, only empty nodeAntiAffinity is allowed. In order to prevent running steps on the same host, it uses \"kubernetes.io/hostname\"."

fn object.spec.templateDefaults.retryStrategy.affinity.withNodeAntiAffinityMixin

withNodeAntiAffinityMixin(nodeAntiAffinity)

"RetryNodeAntiAffinity is a placeholder for future expansion, only empty nodeAntiAffinity is allowed. In order to prevent running steps on the same host, it uses \"kubernetes.io/hostname\"."

Note: This function appends passed data to existing values

obj object.spec.templateDefaults.retryStrategy.backoff

"Backoff is a backoff strategy to use within retryStrategy"

fn object.spec.templateDefaults.retryStrategy.backoff.withDuration

withDuration(duration)

"Duration is the amount to back off. Default unit is seconds, but could also be a duration (e.g. \"2m\", \"1h\")"

fn object.spec.templateDefaults.retryStrategy.backoff.withFactor

withFactor(factor)

fn object.spec.templateDefaults.retryStrategy.backoff.withMaxDuration

withMaxDuration(maxDuration)

"MaxDuration is the maximum amount of time allowed for the backoff strategy"

obj object.spec.templateDefaults.script

"ScriptTemplate is a template subtype to enable scripting through code steps"

fn object.spec.templateDefaults.script.withArgs

withArgs(args)

"Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell"

fn object.spec.templateDefaults.script.withArgsMixin

withArgsMixin(args)

"Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell"

Note: This function appends passed data to existing values

fn object.spec.templateDefaults.script.withCommand

withCommand(command)

"Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell"

fn object.spec.templateDefaults.script.withCommandMixin

withCommandMixin(command)

"Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell"

Note: This function appends passed data to existing values

fn object.spec.templateDefaults.script.withEnv

withEnv(env)

"List of environment variables to set in the container. Cannot be updated."

fn object.spec.templateDefaults.script.withEnvFrom

withEnvFrom(envFrom)

"List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated."

fn object.spec.templateDefaults.script.withEnvFromMixin

withEnvFromMixin(envFrom)

"List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated."

Note: This function appends passed data to existing values

fn object.spec.templateDefaults.script.withEnvMixin

withEnvMixin(env)

"List of environment variables to set in the container. Cannot be updated."

Note: This function appends passed data to existing values

fn object.spec.templateDefaults.script.withImage

withImage(image)

"Docker image name. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets."

fn object.spec.templateDefaults.script.withImagePullPolicy

withImagePullPolicy(imagePullPolicy)

"Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images"

fn object.spec.templateDefaults.script.withName

withName(name)

"Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated."

fn object.spec.templateDefaults.script.withPorts

withPorts(ports)

"List of ports to expose from the container. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default \"0.0.0.0\" address inside a container will be accessible from the network. Cannot be updated."

fn object.spec.templateDefaults.script.withPortsMixin

withPortsMixin(ports)

"List of ports to expose from the container. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default \"0.0.0.0\" address inside a container will be accessible from the network. Cannot be updated."

Note: This function appends passed data to existing values

fn object.spec.templateDefaults.script.withSource

withSource(source)

"Source contains the source code of the script to execute"

fn object.spec.templateDefaults.script.withStdin

withStdin(stdin)

"Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false."

fn object.spec.templateDefaults.script.withStdinOnce

withStdinOnce(stdinOnce)

"Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false"

fn object.spec.templateDefaults.script.withTerminationMessagePath

withTerminationMessagePath(terminationMessagePath)

"Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated."

fn object.spec.templateDefaults.script.withTerminationMessagePolicy

withTerminationMessagePolicy(terminationMessagePolicy)

"Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated."

fn object.spec.templateDefaults.script.withTty

withTty(tty)

"Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false."

fn object.spec.templateDefaults.script.withVolumeDevices

withVolumeDevices(volumeDevices)

"volumeDevices is the list of block devices to be used by the container."

fn object.spec.templateDefaults.script.withVolumeDevicesMixin

withVolumeDevicesMixin(volumeDevices)

"volumeDevices is the list of block devices to be used by the container."

Note: This function appends passed data to existing values

fn object.spec.templateDefaults.script.withVolumeMounts

withVolumeMounts(volumeMounts)

"Pod volumes to mount into the container's filesystem. Cannot be updated."

fn object.spec.templateDefaults.script.withVolumeMountsMixin

withVolumeMountsMixin(volumeMounts)

"Pod volumes to mount into the container's filesystem. Cannot be updated."

Note: This function appends passed data to existing values

fn object.spec.templateDefaults.script.withWorkingDir

withWorkingDir(workingDir)

"Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated."

obj object.spec.templateDefaults.script.lifecycle

"Lifecycle describes actions that the management system should take in response to container lifecycle events. For the PostStart and PreStop lifecycle handlers, management of the container blocks until the action is complete, unless the container process fails, in which case the handler is aborted."

obj object.spec.templateDefaults.script.lifecycle.postStart

"Handler defines a specific action that should be taken"

obj object.spec.templateDefaults.script.lifecycle.postStart.exec

"ExecAction describes a \"run in container\" action."

fn object.spec.templateDefaults.script.lifecycle.postStart.exec.withCommand

withCommand(command)

"Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy."

fn object.spec.templateDefaults.script.lifecycle.postStart.exec.withCommandMixin

withCommandMixin(command)

"Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy."

Note: This function appends passed data to existing values

obj object.spec.templateDefaults.script.lifecycle.postStart.httpGet

"HTTPGetAction describes an action based on HTTP Get requests."

fn object.spec.templateDefaults.script.lifecycle.postStart.httpGet.withHost

withHost(host)

"Host name to connect to, defaults to the pod IP. You probably want to set \"Host\" in httpHeaders instead."

fn object.spec.templateDefaults.script.lifecycle.postStart.httpGet.withHttpHeaders

withHttpHeaders(httpHeaders)

"Custom headers to set in the request. HTTP allows repeated headers."

fn object.spec.templateDefaults.script.lifecycle.postStart.httpGet.withHttpHeadersMixin

withHttpHeadersMixin(httpHeaders)

"Custom headers to set in the request. HTTP allows repeated headers."

Note: This function appends passed data to existing values

fn object.spec.templateDefaults.script.lifecycle.postStart.httpGet.withPath

withPath(path)

"Path to access on the HTTP server."

fn object.spec.templateDefaults.script.lifecycle.postStart.httpGet.withPort

withPort(port)

fn object.spec.templateDefaults.script.lifecycle.postStart.httpGet.withScheme

withScheme(scheme)

"Scheme to use for connecting to the host. Defaults to HTTP."

obj object.spec.templateDefaults.script.lifecycle.postStart.tcpSocket

"TCPSocketAction describes an action based on opening a socket"

fn object.spec.templateDefaults.script.lifecycle.postStart.tcpSocket.withHost

withHost(host)

"Optional: Host name to connect to, defaults to the pod IP."

fn object.spec.templateDefaults.script.lifecycle.postStart.tcpSocket.withPort

withPort(port)

obj object.spec.templateDefaults.script.lifecycle.preStop

"Handler defines a specific action that should be taken"

obj object.spec.templateDefaults.script.lifecycle.preStop.exec

"ExecAction describes a \"run in container\" action."

fn object.spec.templateDefaults.script.lifecycle.preStop.exec.withCommand

withCommand(command)

"Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy."

fn object.spec.templateDefaults.script.lifecycle.preStop.exec.withCommandMixin

withCommandMixin(command)

"Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy."

Note: This function appends passed data to existing values

obj object.spec.templateDefaults.script.lifecycle.preStop.httpGet

"HTTPGetAction describes an action based on HTTP Get requests."

fn object.spec.templateDefaults.script.lifecycle.preStop.httpGet.withHost

withHost(host)

"Host name to connect to, defaults to the pod IP. You probably want to set \"Host\" in httpHeaders instead."

fn object.spec.templateDefaults.script.lifecycle.preStop.httpGet.withHttpHeaders

withHttpHeaders(httpHeaders)

"Custom headers to set in the request. HTTP allows repeated headers."

fn object.spec.templateDefaults.script.lifecycle.preStop.httpGet.withHttpHeadersMixin

withHttpHeadersMixin(httpHeaders)

"Custom headers to set in the request. HTTP allows repeated headers."

Note: This function appends passed data to existing values

fn object.spec.templateDefaults.script.lifecycle.preStop.httpGet.withPath

withPath(path)

"Path to access on the HTTP server."

fn object.spec.templateDefaults.script.lifecycle.preStop.httpGet.withPort

withPort(port)

fn object.spec.templateDefaults.script.lifecycle.preStop.httpGet.withScheme

withScheme(scheme)

"Scheme to use for connecting to the host. Defaults to HTTP."

obj object.spec.templateDefaults.script.lifecycle.preStop.tcpSocket

"TCPSocketAction describes an action based on opening a socket"

fn object.spec.templateDefaults.script.lifecycle.preStop.tcpSocket.withHost

withHost(host)

"Optional: Host name to connect to, defaults to the pod IP."

fn object.spec.templateDefaults.script.lifecycle.preStop.tcpSocket.withPort

withPort(port)

obj object.spec.templateDefaults.script.livenessProbe

"Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic."

fn object.spec.templateDefaults.script.livenessProbe.withFailureThreshold

withFailureThreshold(failureThreshold)

"Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1."

fn object.spec.templateDefaults.script.livenessProbe.withInitialDelaySeconds

withInitialDelaySeconds(initialDelaySeconds)

"Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"

fn object.spec.templateDefaults.script.livenessProbe.withPeriodSeconds

withPeriodSeconds(periodSeconds)

"How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1."

fn object.spec.templateDefaults.script.livenessProbe.withSuccessThreshold

withSuccessThreshold(successThreshold)

"Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1."

fn object.spec.templateDefaults.script.livenessProbe.withTimeoutSeconds

withTimeoutSeconds(timeoutSeconds)

"Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"

obj object.spec.templateDefaults.script.livenessProbe.exec

"ExecAction describes a \"run in container\" action."

fn object.spec.templateDefaults.script.livenessProbe.exec.withCommand

withCommand(command)

"Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy."

fn object.spec.templateDefaults.script.livenessProbe.exec.withCommandMixin

withCommandMixin(command)

"Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy."

Note: This function appends passed data to existing values

obj object.spec.templateDefaults.script.livenessProbe.httpGet

"HTTPGetAction describes an action based on HTTP Get requests."

fn object.spec.templateDefaults.script.livenessProbe.httpGet.withHost

withHost(host)

"Host name to connect to, defaults to the pod IP. You probably want to set \"Host\" in httpHeaders instead."

fn object.spec.templateDefaults.script.livenessProbe.httpGet.withHttpHeaders

withHttpHeaders(httpHeaders)

"Custom headers to set in the request. HTTP allows repeated headers."

fn object.spec.templateDefaults.script.livenessProbe.httpGet.withHttpHeadersMixin

withHttpHeadersMixin(httpHeaders)

"Custom headers to set in the request. HTTP allows repeated headers."

Note: This function appends passed data to existing values

fn object.spec.templateDefaults.script.livenessProbe.httpGet.withPath

withPath(path)

"Path to access on the HTTP server."

fn object.spec.templateDefaults.script.livenessProbe.httpGet.withPort

withPort(port)

fn object.spec.templateDefaults.script.livenessProbe.httpGet.withScheme

withScheme(scheme)

"Scheme to use for connecting to the host. Defaults to HTTP."

obj object.spec.templateDefaults.script.livenessProbe.tcpSocket

"TCPSocketAction describes an action based on opening a socket"

fn object.spec.templateDefaults.script.livenessProbe.tcpSocket.withHost

withHost(host)

"Optional: Host name to connect to, defaults to the pod IP."

fn object.spec.templateDefaults.script.livenessProbe.tcpSocket.withPort

withPort(port)

obj object.spec.templateDefaults.script.readinessProbe

"Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic."

fn object.spec.templateDefaults.script.readinessProbe.withFailureThreshold

withFailureThreshold(failureThreshold)

"Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1."

fn object.spec.templateDefaults.script.readinessProbe.withInitialDelaySeconds

withInitialDelaySeconds(initialDelaySeconds)

"Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"

fn object.spec.templateDefaults.script.readinessProbe.withPeriodSeconds

withPeriodSeconds(periodSeconds)

"How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1."

fn object.spec.templateDefaults.script.readinessProbe.withSuccessThreshold

withSuccessThreshold(successThreshold)

"Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1."

fn object.spec.templateDefaults.script.readinessProbe.withTimeoutSeconds

withTimeoutSeconds(timeoutSeconds)

"Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"

obj object.spec.templateDefaults.script.readinessProbe.exec

"ExecAction describes a \"run in container\" action."

fn object.spec.templateDefaults.script.readinessProbe.exec.withCommand

withCommand(command)

"Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy."

fn object.spec.templateDefaults.script.readinessProbe.exec.withCommandMixin

withCommandMixin(command)

"Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy."

Note: This function appends passed data to existing values

obj object.spec.templateDefaults.script.readinessProbe.httpGet

"HTTPGetAction describes an action based on HTTP Get requests."

fn object.spec.templateDefaults.script.readinessProbe.httpGet.withHost

withHost(host)

"Host name to connect to, defaults to the pod IP. You probably want to set \"Host\" in httpHeaders instead."

fn object.spec.templateDefaults.script.readinessProbe.httpGet.withHttpHeaders

withHttpHeaders(httpHeaders)

"Custom headers to set in the request. HTTP allows repeated headers."

fn object.spec.templateDefaults.script.readinessProbe.httpGet.withHttpHeadersMixin

withHttpHeadersMixin(httpHeaders)

"Custom headers to set in the request. HTTP allows repeated headers."

Note: This function appends passed data to existing values

fn object.spec.templateDefaults.script.readinessProbe.httpGet.withPath

withPath(path)

"Path to access on the HTTP server."

fn object.spec.templateDefaults.script.readinessProbe.httpGet.withPort

withPort(port)

fn object.spec.templateDefaults.script.readinessProbe.httpGet.withScheme

withScheme(scheme)

"Scheme to use for connecting to the host. Defaults to HTTP."

obj object.spec.templateDefaults.script.readinessProbe.tcpSocket

"TCPSocketAction describes an action based on opening a socket"

fn object.spec.templateDefaults.script.readinessProbe.tcpSocket.withHost

withHost(host)

"Optional: Host name to connect to, defaults to the pod IP."

fn object.spec.templateDefaults.script.readinessProbe.tcpSocket.withPort

withPort(port)

obj object.spec.templateDefaults.script.resources

"ResourceRequirements describes the compute resource requirements."

fn object.spec.templateDefaults.script.resources.withLimits

withLimits(limits)

"Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/"

fn object.spec.templateDefaults.script.resources.withLimitsMixin

withLimitsMixin(limits)

"Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/"

Note: This function appends passed data to existing values

fn object.spec.templateDefaults.script.resources.withRequests

withRequests(requests)

"Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/"

fn object.spec.templateDefaults.script.resources.withRequestsMixin

withRequestsMixin(requests)

"Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/"

Note: This function appends passed data to existing values

obj object.spec.templateDefaults.script.securityContext

"SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence."

fn object.spec.templateDefaults.script.securityContext.withAllowPrivilegeEscalation

withAllowPrivilegeEscalation(allowPrivilegeEscalation)

"AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN"

fn object.spec.templateDefaults.script.securityContext.withPrivileged

withPrivileged(privileged)

"Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false."

fn object.spec.templateDefaults.script.securityContext.withProcMount

withProcMount(procMount)

"procMount denotes the type of proc mount to use for the containers. The default is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled."

fn object.spec.templateDefaults.script.securityContext.withReadOnlyRootFilesystem

withReadOnlyRootFilesystem(readOnlyRootFilesystem)

"Whether this container has a read-only root filesystem. Default is false."

fn object.spec.templateDefaults.script.securityContext.withRunAsGroup

withRunAsGroup(runAsGroup)

"The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence."

fn object.spec.templateDefaults.script.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 PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence."

fn object.spec.templateDefaults.script.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 PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence."

obj object.spec.templateDefaults.script.securityContext.capabilities

"Adds and removes POSIX capabilities from running containers."

fn object.spec.templateDefaults.script.securityContext.capabilities.withAdd

withAdd(add)

"Added capabilities"

fn object.spec.templateDefaults.script.securityContext.capabilities.withAddMixin

withAddMixin(add)

"Added capabilities"

Note: This function appends passed data to existing values

fn object.spec.templateDefaults.script.securityContext.capabilities.withDrop

withDrop(drop)

"Removed capabilities"

fn object.spec.templateDefaults.script.securityContext.capabilities.withDropMixin

withDropMixin(drop)

"Removed capabilities"

Note: This function appends passed data to existing values

obj object.spec.templateDefaults.script.securityContext.seLinuxOptions

"SELinuxOptions are the labels to be applied to the container"

fn object.spec.templateDefaults.script.securityContext.seLinuxOptions.withLevel

withLevel(level)

"Level is SELinux level label that applies to the container."

fn object.spec.templateDefaults.script.securityContext.seLinuxOptions.withRole

withRole(role)

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

fn object.spec.templateDefaults.script.securityContext.seLinuxOptions.withType

withType(type)

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

fn object.spec.templateDefaults.script.securityContext.seLinuxOptions.withUser

withUser(user)

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

obj object.spec.templateDefaults.script.securityContext.windowsOptions

"WindowsSecurityContextOptions contain Windows-specific options and credentials."

fn object.spec.templateDefaults.script.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. This field is alpha-level and is only honored by servers that enable the WindowsGMSA feature flag."

fn object.spec.templateDefaults.script.securityContext.windowsOptions.withGmsaCredentialSpecName

withGmsaCredentialSpecName(gmsaCredentialSpecName)

"GMSACredentialSpecName is the name of the GMSA credential spec to use. This field is alpha-level and is only honored by servers that enable the WindowsGMSA feature flag."

fn object.spec.templateDefaults.script.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. This field is beta-level and may be disabled with the WindowsRunAsUserName feature flag."

obj object.spec.templateDefaults.script.startupProbe

"Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic."

fn object.spec.templateDefaults.script.startupProbe.withFailureThreshold

withFailureThreshold(failureThreshold)

"Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1."

fn object.spec.templateDefaults.script.startupProbe.withInitialDelaySeconds

withInitialDelaySeconds(initialDelaySeconds)

"Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"

fn object.spec.templateDefaults.script.startupProbe.withPeriodSeconds

withPeriodSeconds(periodSeconds)

"How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1."

fn object.spec.templateDefaults.script.startupProbe.withSuccessThreshold

withSuccessThreshold(successThreshold)

"Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1."

fn object.spec.templateDefaults.script.startupProbe.withTimeoutSeconds

withTimeoutSeconds(timeoutSeconds)

"Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"

obj object.spec.templateDefaults.script.startupProbe.exec

"ExecAction describes a \"run in container\" action."

fn object.spec.templateDefaults.script.startupProbe.exec.withCommand

withCommand(command)

"Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy."

fn object.spec.templateDefaults.script.startupProbe.exec.withCommandMixin

withCommandMixin(command)

"Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy."

Note: This function appends passed data to existing values

obj object.spec.templateDefaults.script.startupProbe.httpGet

"HTTPGetAction describes an action based on HTTP Get requests."

fn object.spec.templateDefaults.script.startupProbe.httpGet.withHost

withHost(host)

"Host name to connect to, defaults to the pod IP. You probably want to set \"Host\" in httpHeaders instead."

fn object.spec.templateDefaults.script.startupProbe.httpGet.withHttpHeaders

withHttpHeaders(httpHeaders)

"Custom headers to set in the request. HTTP allows repeated headers."

fn object.spec.templateDefaults.script.startupProbe.httpGet.withHttpHeadersMixin

withHttpHeadersMixin(httpHeaders)

"Custom headers to set in the request. HTTP allows repeated headers."

Note: This function appends passed data to existing values

fn object.spec.templateDefaults.script.startupProbe.httpGet.withPath

withPath(path)

"Path to access on the HTTP server."

fn object.spec.templateDefaults.script.startupProbe.httpGet.withPort

withPort(port)

fn object.spec.templateDefaults.script.startupProbe.httpGet.withScheme

withScheme(scheme)

"Scheme to use for connecting to the host. Defaults to HTTP."

obj object.spec.templateDefaults.script.startupProbe.tcpSocket

"TCPSocketAction describes an action based on opening a socket"

fn object.spec.templateDefaults.script.startupProbe.tcpSocket.withHost

withHost(host)

"Optional: Host name to connect to, defaults to the pod IP."

fn object.spec.templateDefaults.script.startupProbe.tcpSocket.withPort

withPort(port)

obj object.spec.templateDefaults.securityContext

"PodSecurityContext holds pod-level security attributes and common container settings. Some fields are also present in container.securityContext. Field values of container.securityContext take precedence over field values of PodSecurityContext."

fn object.spec.templateDefaults.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:\n\n1. 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----\n\nIf unset, the Kubelet will not modify the ownership and permissions of any volume."

fn object.spec.templateDefaults.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 object.spec.templateDefaults.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 object.spec.templateDefaults.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 object.spec.templateDefaults.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 object.spec.templateDefaults.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 object.spec.templateDefaults.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 object.spec.templateDefaults.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 object.spec.templateDefaults.securityContext.seLinuxOptions

"SELinuxOptions are the labels to be applied to the container"

fn object.spec.templateDefaults.securityContext.seLinuxOptions.withLevel

withLevel(level)

"Level is SELinux level label that applies to the container."

fn object.spec.templateDefaults.securityContext.seLinuxOptions.withRole

withRole(role)

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

fn object.spec.templateDefaults.securityContext.seLinuxOptions.withType

withType(type)

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

fn object.spec.templateDefaults.securityContext.seLinuxOptions.withUser

withUser(user)

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

obj object.spec.templateDefaults.securityContext.windowsOptions

"WindowsSecurityContextOptions contain Windows-specific options and credentials."

fn object.spec.templateDefaults.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. This field is alpha-level and is only honored by servers that enable the WindowsGMSA feature flag."

fn object.spec.templateDefaults.securityContext.windowsOptions.withGmsaCredentialSpecName

withGmsaCredentialSpecName(gmsaCredentialSpecName)

"GMSACredentialSpecName is the name of the GMSA credential spec to use. This field is alpha-level and is only honored by servers that enable the WindowsGMSA feature flag."

fn object.spec.templateDefaults.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. This field is beta-level and may be disabled with the WindowsRunAsUserName feature flag."

obj object.spec.templateDefaults.suspend

"SuspendTemplate is a template subtype to suspend a workflow at a predetermined point in time"

fn object.spec.templateDefaults.suspend.withDuration

withDuration(duration)

"Duration is the seconds to wait before automatically resuming a template"

obj object.spec.templateDefaults.synchronization

"Synchronization holds synchronization lock configuration"

obj object.spec.templateDefaults.synchronization.mutex

"Mutex holds Mutex configuration"

fn object.spec.templateDefaults.synchronization.mutex.withName

withName(name)

"name of the mutex"

obj object.spec.templateDefaults.synchronization.semaphore

"SemaphoreRef is a reference of Semaphore"

obj object.spec.templateDefaults.synchronization.semaphore.configMapKeyRef

"Selects a key from a ConfigMap."

fn object.spec.templateDefaults.synchronization.semaphore.configMapKeyRef.withKey

withKey(key)

"The key to select."

fn object.spec.templateDefaults.synchronization.semaphore.configMapKeyRef.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn object.spec.templateDefaults.synchronization.semaphore.configMapKeyRef.withOptional

withOptional(optional)

"Specify whether the ConfigMap or its key must be defined"

obj object.spec.ttlStrategy

"TTLStrategy is the strategy for the time to live depending on if the workflow succeeded or failed"

fn object.spec.ttlStrategy.withSecondsAfterCompletion

withSecondsAfterCompletion(secondsAfterCompletion)

"SecondsAfterCompletion is the number of seconds to live after completion"

fn object.spec.ttlStrategy.withSecondsAfterFailure

withSecondsAfterFailure(secondsAfterFailure)

"SecondsAfterFailure is the number of seconds to live after failure"

fn object.spec.ttlStrategy.withSecondsAfterSuccess

withSecondsAfterSuccess(secondsAfterSuccess)

"SecondsAfterSuccess is the number of seconds to live after success"

obj object.spec.volumeClaimGC

"VolumeClaimGC describes how to delete volumes from completed Workflows"

fn object.spec.volumeClaimGC.withStrategy

withStrategy(strategy)

"Strategy is the strategy to use. One of \"OnWorkflowCompletion\", \"OnWorkflowSuccess\

obj object.spec.workflowTemplateRef

"WorkflowTemplateRef is a reference to a WorkflowTemplate resource."

fn object.spec.workflowTemplateRef.withClusterScope

withClusterScope(clusterScope)

"ClusterScope indicates the referred template is cluster scoped (i.e. a ClusterWorkflowTemplate)."

fn object.spec.workflowTemplateRef.withName

withName(name)

"Name is the resource name of the workflow template."