workflow.v1alpha1.dagTask
"DAGTask represents a node in the graph during DAG execution"
Index
fn withDependencies(dependencies)fn withDependenciesMixin(dependencies)fn withDepends(depends)fn withHooks(hooks)fn withHooksMixin(hooks)fn withName(name)fn withOnExit(onExit)fn withTemplate(template)fn withWhen(when)fn withWithItems(withItems)fn withWithItemsMixin(withItems)fn withWithParam(withParam)obj argumentsobj continueOnobj inlinefn withActiveDeadlineSeconds(activeDeadlineSeconds)fn withAutomountServiceAccountToken(automountServiceAccountToken)fn withDaemon(daemon)fn withFailFast(failFast)fn withHostAliases(hostAliases)fn withHostAliasesMixin(hostAliases)fn withInitContainers(initContainers)fn withInitContainersMixin(initContainers)fn withName(name)fn withNodeSelector(nodeSelector)fn withNodeSelectorMixin(nodeSelector)fn withParallelism(parallelism)fn withPodSpecPatch(podSpecPatch)fn withPriority(priority)fn withPriorityClassName(priorityClassName)fn withSchedulerName(schedulerName)fn withServiceAccountName(serviceAccountName)fn withSidecars(sidecars)fn withSidecarsMixin(sidecars)fn withSteps(steps)fn withStepsMixin(steps)fn withTimeout(timeout)fn withTolerations(tolerations)fn withTolerationsMixin(tolerations)fn withVolumes(volumes)fn withVolumesMixin(volumes)obj inline.affinityobj inline.affinity.nodeAffinityobj inline.affinity.podAffinityfn withPreferredDuringSchedulingIgnoredDuringExecution(preferredDuringSchedulingIgnoredDuringExecution)fn withPreferredDuringSchedulingIgnoredDuringExecutionMixin(preferredDuringSchedulingIgnoredDuringExecution)fn withRequiredDuringSchedulingIgnoredDuringExecution(requiredDuringSchedulingIgnoredDuringExecution)fn withRequiredDuringSchedulingIgnoredDuringExecutionMixin(requiredDuringSchedulingIgnoredDuringExecution)
obj inline.affinity.podAntiAffinityfn withPreferredDuringSchedulingIgnoredDuringExecution(preferredDuringSchedulingIgnoredDuringExecution)fn withPreferredDuringSchedulingIgnoredDuringExecutionMixin(preferredDuringSchedulingIgnoredDuringExecution)fn withRequiredDuringSchedulingIgnoredDuringExecution(requiredDuringSchedulingIgnoredDuringExecution)fn withRequiredDuringSchedulingIgnoredDuringExecutionMixin(requiredDuringSchedulingIgnoredDuringExecution)
obj inline.archiveLocationfn withArchiveLogs(archiveLogs)obj inline.archiveLocation.artifactoryobj inline.archiveLocation.gcsobj inline.archiveLocation.gitfn withDepth(depth)fn withDisableSubmodules(disableSubmodules)fn withFetch(fetch)fn withFetchMixin(fetch)fn withInsecureIgnoreHostKey(insecureIgnoreHostKey)fn withRepo(repo)fn withRevision(revision)obj inline.archiveLocation.git.passwordSecretobj inline.archiveLocation.git.sshPrivateKeySecretobj inline.archiveLocation.git.usernameSecret
obj inline.archiveLocation.hdfsfn withAddresses(addresses)fn withAddressesMixin(addresses)fn withForce(force)fn withHdfsUser(hdfsUser)fn withKrbRealm(krbRealm)fn withKrbServicePrincipalName(krbServicePrincipalName)fn withKrbUsername(krbUsername)fn withPath(path)obj inline.archiveLocation.hdfs.krbCCacheSecretobj inline.archiveLocation.hdfs.krbConfigConfigMapobj inline.archiveLocation.hdfs.krbKeytabSecret
obj inline.archiveLocation.httpobj inline.archiveLocation.ossobj inline.archiveLocation.rawobj inline.archiveLocation.s3fn withBucket(bucket)fn withEndpoint(endpoint)fn withInsecure(insecure)fn withKey(key)fn withRegion(region)fn withRoleARN(roleARN)fn withUseSDKCreds(useSDKCreds)obj inline.archiveLocation.s3.accessKeySecretobj inline.archiveLocation.s3.createBucketIfNotPresentobj inline.archiveLocation.s3.encryptionOptionsobj inline.archiveLocation.s3.secretKeySecret
obj inline.containerfn withArgs(args)fn withArgsMixin(args)fn withCommand(command)fn withCommandMixin(command)fn withEnv(env)fn withEnvFrom(envFrom)fn withEnvFromMixin(envFrom)fn withEnvMixin(env)fn withImage(image)fn withImagePullPolicy(imagePullPolicy)fn withName(name)fn withPorts(ports)fn withPortsMixin(ports)fn withStdin(stdin)fn withStdinOnce(stdinOnce)fn withTerminationMessagePath(terminationMessagePath)fn withTerminationMessagePolicy(terminationMessagePolicy)fn withTty(tty)fn withVolumeDevices(volumeDevices)fn withVolumeDevicesMixin(volumeDevices)fn withVolumeMounts(volumeMounts)fn withVolumeMountsMixin(volumeMounts)fn withWorkingDir(workingDir)obj inline.container.lifecycleobj inline.container.lifecycle.postStartobj inline.container.lifecycle.preStop
obj inline.container.livenessProbefn withFailureThreshold(failureThreshold)fn withInitialDelaySeconds(initialDelaySeconds)fn withPeriodSeconds(periodSeconds)fn withSuccessThreshold(successThreshold)fn withTimeoutSeconds(timeoutSeconds)obj inline.container.livenessProbe.execobj inline.container.livenessProbe.httpGetobj inline.container.livenessProbe.tcpSocket
obj inline.container.readinessProbefn withFailureThreshold(failureThreshold)fn withInitialDelaySeconds(initialDelaySeconds)fn withPeriodSeconds(periodSeconds)fn withSuccessThreshold(successThreshold)fn withTimeoutSeconds(timeoutSeconds)obj inline.container.readinessProbe.execobj inline.container.readinessProbe.httpGetobj inline.container.readinessProbe.tcpSocket
obj inline.container.resourcesobj inline.container.securityContextfn withAllowPrivilegeEscalation(allowPrivilegeEscalation)fn withPrivileged(privileged)fn withProcMount(procMount)fn withReadOnlyRootFilesystem(readOnlyRootFilesystem)fn withRunAsGroup(runAsGroup)fn withRunAsNonRoot(runAsNonRoot)fn withRunAsUser(runAsUser)obj inline.container.securityContext.capabilitiesobj inline.container.securityContext.seLinuxOptionsobj inline.container.securityContext.windowsOptions
obj inline.container.startupProbefn withFailureThreshold(failureThreshold)fn withInitialDelaySeconds(initialDelaySeconds)fn withPeriodSeconds(periodSeconds)fn withSuccessThreshold(successThreshold)fn withTimeoutSeconds(timeoutSeconds)obj inline.container.startupProbe.execobj inline.container.startupProbe.httpGetobj inline.container.startupProbe.tcpSocket
obj inline.containerSetobj inline.dagobj inline.datafn withTransformation(transformation)fn withTransformationMixin(transformation)obj inline.data.sourceobj inline.data.source.artifactPathsfn withArchiveLogs(archiveLogs)fn withFrom(from)fn withFromExpression(fromExpression)fn withGlobalName(globalName)fn withMode(mode)fn withName(name)fn withOptional(optional)fn withPath(path)fn withRecurseMode(recurseMode)fn withSubPath(subPath)obj inline.data.source.artifactPaths.archiveobj inline.data.source.artifactPaths.artifactoryobj inline.data.source.artifactPaths.gcsobj inline.data.source.artifactPaths.gitfn withDepth(depth)fn withDisableSubmodules(disableSubmodules)fn withFetch(fetch)fn withFetchMixin(fetch)fn withInsecureIgnoreHostKey(insecureIgnoreHostKey)fn withRepo(repo)fn withRevision(revision)obj inline.data.source.artifactPaths.git.passwordSecretobj inline.data.source.artifactPaths.git.sshPrivateKeySecretobj inline.data.source.artifactPaths.git.usernameSecret
obj inline.data.source.artifactPaths.hdfsfn withAddresses(addresses)fn withAddressesMixin(addresses)fn withForce(force)fn withHdfsUser(hdfsUser)fn withKrbRealm(krbRealm)fn withKrbServicePrincipalName(krbServicePrincipalName)fn withKrbUsername(krbUsername)fn withPath(path)obj inline.data.source.artifactPaths.hdfs.krbCCacheSecretobj inline.data.source.artifactPaths.hdfs.krbConfigConfigMapobj inline.data.source.artifactPaths.hdfs.krbKeytabSecret
obj inline.data.source.artifactPaths.httpobj inline.data.source.artifactPaths.ossfn withBucket(bucket)fn withCreateBucketIfNotPresent(createBucketIfNotPresent)fn withEndpoint(endpoint)fn withKey(key)fn withSecurityToken(securityToken)obj inline.data.source.artifactPaths.oss.accessKeySecretobj inline.data.source.artifactPaths.oss.lifecycleRuleobj inline.data.source.artifactPaths.oss.secretKeySecret
obj inline.data.source.artifactPaths.rawobj inline.data.source.artifactPaths.s3fn withBucket(bucket)fn withEndpoint(endpoint)fn withInsecure(insecure)fn withKey(key)fn withRegion(region)fn withRoleARN(roleARN)fn withUseSDKCreds(useSDKCreds)obj inline.data.source.artifactPaths.s3.accessKeySecretobj inline.data.source.artifactPaths.s3.createBucketIfNotPresentobj inline.data.source.artifactPaths.s3.encryptionOptionsobj inline.data.source.artifactPaths.s3.secretKeySecret
obj inline.executorobj inline.httpobj inline.inputsobj inline.memoizeobj inline.metadataobj inline.metricsobj inline.outputsobj inline.resourceobj inline.retryStrategyobj inline.scriptfn withArgs(args)fn withArgsMixin(args)fn withCommand(command)fn withCommandMixin(command)fn withEnv(env)fn withEnvFrom(envFrom)fn withEnvFromMixin(envFrom)fn withEnvMixin(env)fn withImage(image)fn withImagePullPolicy(imagePullPolicy)fn withName(name)fn withPorts(ports)fn withPortsMixin(ports)fn withSource(source)fn withStdin(stdin)fn withStdinOnce(stdinOnce)fn withTerminationMessagePath(terminationMessagePath)fn withTerminationMessagePolicy(terminationMessagePolicy)fn withTty(tty)fn withVolumeDevices(volumeDevices)fn withVolumeDevicesMixin(volumeDevices)fn withVolumeMounts(volumeMounts)fn withVolumeMountsMixin(volumeMounts)fn withWorkingDir(workingDir)obj inline.script.lifecycleobj inline.script.lifecycle.postStartobj inline.script.lifecycle.preStop
obj inline.script.livenessProbefn withFailureThreshold(failureThreshold)fn withInitialDelaySeconds(initialDelaySeconds)fn withPeriodSeconds(periodSeconds)fn withSuccessThreshold(successThreshold)fn withTimeoutSeconds(timeoutSeconds)obj inline.script.livenessProbe.execobj inline.script.livenessProbe.httpGetobj inline.script.livenessProbe.tcpSocket
obj inline.script.readinessProbefn withFailureThreshold(failureThreshold)fn withInitialDelaySeconds(initialDelaySeconds)fn withPeriodSeconds(periodSeconds)fn withSuccessThreshold(successThreshold)fn withTimeoutSeconds(timeoutSeconds)obj inline.script.readinessProbe.execobj inline.script.readinessProbe.httpGetobj inline.script.readinessProbe.tcpSocket
obj inline.script.resourcesobj inline.script.securityContextfn withAllowPrivilegeEscalation(allowPrivilegeEscalation)fn withPrivileged(privileged)fn withProcMount(procMount)fn withReadOnlyRootFilesystem(readOnlyRootFilesystem)fn withRunAsGroup(runAsGroup)fn withRunAsNonRoot(runAsNonRoot)fn withRunAsUser(runAsUser)obj inline.script.securityContext.capabilitiesobj inline.script.securityContext.seLinuxOptionsobj inline.script.securityContext.windowsOptions
obj inline.script.startupProbefn withFailureThreshold(failureThreshold)fn withInitialDelaySeconds(initialDelaySeconds)fn withPeriodSeconds(periodSeconds)fn withSuccessThreshold(successThreshold)fn withTimeoutSeconds(timeoutSeconds)obj inline.script.startupProbe.execobj inline.script.startupProbe.httpGetobj inline.script.startupProbe.tcpSocket
obj inline.securityContextfn withFsGroup(fsGroup)fn withRunAsGroup(runAsGroup)fn withRunAsNonRoot(runAsNonRoot)fn withRunAsUser(runAsUser)fn withSupplementalGroups(supplementalGroups)fn withSupplementalGroupsMixin(supplementalGroups)fn withSysctls(sysctls)fn withSysctlsMixin(sysctls)obj inline.securityContext.seLinuxOptionsobj inline.securityContext.windowsOptions
obj inline.suspendobj inline.synchronization
obj templateRefobj withSequence
Fields
fn withDependencies
withDependencies(dependencies)
"Dependencies are name of other targets which this depends on"
fn withDependenciesMixin
withDependenciesMixin(dependencies)
"Dependencies are name of other targets which this depends on"
Note: This function appends passed data to existing values
fn withDepends
withDepends(depends)
"Depends are name of other targets which this depends on"
fn withHooks
withHooks(hooks)
"Hooks hold the lifecycle hook which is invoked at lifecycle of task, irrespective of the success, failure, or error status of the primary task"
fn withHooksMixin
withHooksMixin(hooks)
"Hooks hold the lifecycle hook which is invoked at lifecycle of task, irrespective of the success, failure, or error status of the primary task"
Note: This function appends passed data to existing values
fn withName
withName(name)
"Name is the name of the target"
fn withOnExit
withOnExit(onExit)
"OnExit is a template reference which is invoked at the end of the template, irrespective of the success, failure, or error of the primary template. DEPRECATED: Use Hooks[exit].Template instead."
fn withTemplate
withTemplate(template)
"Name of template to execute"
fn withWhen
withWhen(when)
"When is an expression in which the task should conditionally execute"
fn withWithItems
withWithItems(withItems)
"WithItems expands a task into multiple parallel tasks from the items in the list"
fn withWithItemsMixin
withWithItemsMixin(withItems)
"WithItems expands a task into multiple parallel tasks from the items in the list"
Note: This function appends passed data to existing values
fn withWithParam
withWithParam(withParam)
"WithParam expands a task into multiple parallel tasks from the value in the parameter, which is expected to be a JSON list."
obj arguments
"Arguments to a template"
fn arguments.withArtifacts
withArtifacts(artifacts)
"Artifacts is the list of artifacts to pass to the template or workflow"
fn 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 arguments.withParameters
withParameters(parameters)
"Parameters is the list of parameters to pass to the template or workflow"
fn 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 continueOn
"ContinueOn defines if a workflow should continue even if a task or step fails/errors. It can be specified if the workflow should continue when the pod errors, fails or both."
fn continueOn.withError
withError(err)
fn continueOn.withFailed
withFailed(failed)
obj inline
"Template is a reusable and composable unit of execution in a workflow"
fn inline.withActiveDeadlineSeconds
withActiveDeadlineSeconds(activeDeadlineSeconds)
fn inline.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 inline.withDaemon
withDaemon(daemon)
"Deamon will allow a workflow to proceed to the next step so long as the container reaches readiness"
fn inline.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 inline.withHostAliases
withHostAliases(hostAliases)
"HostAliases is an optional list of hosts and IPs that will be injected into the pod spec"
fn inline.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 inline.withInitContainers
withInitContainers(initContainers)
"InitContainers is a list of containers which run before the main container."
fn inline.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 inline.withName
withName(name)
"Name is the name of the template"
fn inline.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 inline.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 inline.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 inline.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 inline.withPriority
withPriority(priority)
"Priority to apply to workflow pods."
fn inline.withPriorityClassName
withPriorityClassName(priorityClassName)
"PriorityClassName to apply to workflow pods."
fn inline.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 inline.withServiceAccountName
withServiceAccountName(serviceAccountName)
"ServiceAccountName to apply to workflow pods"
fn inline.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 inline.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 inline.withSteps
withSteps(steps)
"Steps define a series of sequential/parallel workflow steps"
fn inline.withStepsMixin
withStepsMixin(steps)
"Steps define a series of sequential/parallel workflow steps"
Note: This function appends passed data to existing values
fn inline.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 inline.withTolerations
withTolerations(tolerations)
"Tolerations to apply to workflow pods."
fn inline.withTolerationsMixin
withTolerationsMixin(tolerations)
"Tolerations to apply to workflow pods."
Note: This function appends passed data to existing values
fn inline.withVolumes
withVolumes(volumes)
"Volumes is a list of volumes that can be mounted by containers in a template."
fn inline.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 inline.affinity
"Affinity is a group of affinity scheduling rules."
obj inline.affinity.nodeAffinity
"Node affinity is a group of node affinity scheduling rules."
fn inline.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 inline.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 inline.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 inline.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.withNodeSelectorTerms
withNodeSelectorTerms(nodeSelectorTerms)
"Required. A list of node selector terms. The terms are ORed."
fn inline.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 inline.affinity.podAffinity
"Pod affinity is a group of inter pod affinity scheduling rules."
fn inline.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 inline.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 inline.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 inline.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 inline.affinity.podAntiAffinity
"Pod anti affinity is a group of inter pod anti affinity scheduling rules."
fn inline.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 inline.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 inline.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 inline.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 inline.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 inline.archiveLocation.withArchiveLogs
withArchiveLogs(archiveLogs)
"ArchiveLogs indicates if the container logs should be archived"
obj inline.archiveLocation.artifactory
"ArtifactoryArtifact is the location of an artifactory artifact"
fn inline.archiveLocation.artifactory.withUrl
withUrl(url)
"URL of the artifact"
obj inline.archiveLocation.artifactory.passwordSecret
"SecretKeySelector selects a key of a Secret."
fn inline.archiveLocation.artifactory.passwordSecret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn inline.archiveLocation.artifactory.passwordSecret.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn inline.archiveLocation.artifactory.passwordSecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj inline.archiveLocation.artifactory.usernameSecret
"SecretKeySelector selects a key of a Secret."
fn inline.archiveLocation.artifactory.usernameSecret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn inline.archiveLocation.artifactory.usernameSecret.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn inline.archiveLocation.artifactory.usernameSecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj inline.archiveLocation.gcs
"GCSArtifact is the location of a GCS artifact"
fn inline.archiveLocation.gcs.withBucket
withBucket(bucket)
"Bucket is the name of the bucket"
fn inline.archiveLocation.gcs.withKey
withKey(key)
"Key is the path in the bucket where the artifact resides"
obj inline.archiveLocation.gcs.serviceAccountKeySecret
"SecretKeySelector selects a key of a Secret."
fn inline.archiveLocation.gcs.serviceAccountKeySecret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn inline.archiveLocation.gcs.serviceAccountKeySecret.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn inline.archiveLocation.gcs.serviceAccountKeySecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj inline.archiveLocation.git
"GitArtifact is the location of an git artifact"
fn inline.archiveLocation.git.withDepth
withDepth(depth)
"Depth specifies clones/fetches should be shallow and include the given number of commits from the branch tip"
fn inline.archiveLocation.git.withDisableSubmodules
withDisableSubmodules(disableSubmodules)
"DisableSubmodules disables submodules during git clone"
fn inline.archiveLocation.git.withFetch
withFetch(fetch)
"Fetch specifies a number of refs that should be fetched before checkout"
fn inline.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 inline.archiveLocation.git.withInsecureIgnoreHostKey
withInsecureIgnoreHostKey(insecureIgnoreHostKey)
"InsecureIgnoreHostKey disables SSH strict host key checking during git clone"
fn inline.archiveLocation.git.withRepo
withRepo(repo)
"Repo is the git repository"
fn inline.archiveLocation.git.withRevision
withRevision(revision)
"Revision is the git commit, tag, branch to checkout"
obj inline.archiveLocation.git.passwordSecret
"SecretKeySelector selects a key of a Secret."
fn inline.archiveLocation.git.passwordSecret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn inline.archiveLocation.git.passwordSecret.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn inline.archiveLocation.git.passwordSecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj inline.archiveLocation.git.sshPrivateKeySecret
"SecretKeySelector selects a key of a Secret."
fn inline.archiveLocation.git.sshPrivateKeySecret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn inline.archiveLocation.git.sshPrivateKeySecret.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn inline.archiveLocation.git.sshPrivateKeySecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj inline.archiveLocation.git.usernameSecret
"SecretKeySelector selects a key of a Secret."
fn inline.archiveLocation.git.usernameSecret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn inline.archiveLocation.git.usernameSecret.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn inline.archiveLocation.git.usernameSecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj inline.archiveLocation.hdfs
"HDFSArtifact is the location of an HDFS artifact"
fn inline.archiveLocation.hdfs.withAddresses
withAddresses(addresses)
"Addresses is accessible addresses of HDFS name nodes"
fn inline.archiveLocation.hdfs.withAddressesMixin
withAddressesMixin(addresses)
"Addresses is accessible addresses of HDFS name nodes"
Note: This function appends passed data to existing values
fn inline.archiveLocation.hdfs.withForce
withForce(force)
"Force copies a file forcibly even if it exists (default: false)"
fn inline.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 inline.archiveLocation.hdfs.withKrbRealm
withKrbRealm(krbRealm)
"KrbRealm is the Kerberos realm used with Kerberos keytab It must be set if keytab is used."
fn inline.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 inline.archiveLocation.hdfs.withKrbUsername
withKrbUsername(krbUsername)
"KrbUsername is the Kerberos username used with Kerberos keytab It must be set if keytab is used."
fn inline.archiveLocation.hdfs.withPath
withPath(path)
"Path is a file path in HDFS"
obj inline.archiveLocation.hdfs.krbCCacheSecret
"SecretKeySelector selects a key of a Secret."
fn inline.archiveLocation.hdfs.krbCCacheSecret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn inline.archiveLocation.hdfs.krbCCacheSecret.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn inline.archiveLocation.hdfs.krbCCacheSecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj inline.archiveLocation.hdfs.krbConfigConfigMap
"Selects a key from a ConfigMap."
fn inline.archiveLocation.hdfs.krbConfigConfigMap.withKey
withKey(key)
"The key to select."
fn inline.archiveLocation.hdfs.krbConfigConfigMap.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn inline.archiveLocation.hdfs.krbConfigConfigMap.withOptional
withOptional(optional)
"Specify whether the ConfigMap or its key must be defined"
obj inline.archiveLocation.hdfs.krbKeytabSecret
"SecretKeySelector selects a key of a Secret."
fn inline.archiveLocation.hdfs.krbKeytabSecret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn inline.archiveLocation.hdfs.krbKeytabSecret.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn inline.archiveLocation.hdfs.krbKeytabSecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj inline.archiveLocation.http
"HTTPArtifact allows an file served on HTTP to be placed as an input artifact in a container"
fn inline.archiveLocation.http.withHeaders
withHeaders(headers)
"Headers are an optional list of headers to send with HTTP requests for artifacts"
fn inline.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 inline.archiveLocation.http.withUrl
withUrl(url)
"URL of the artifact"
obj inline.archiveLocation.oss
"OSSArtifact is the location of an Alibaba Cloud OSS artifact"
fn inline.archiveLocation.oss.withBucket
withBucket(bucket)
"Bucket is the name of the bucket"
fn inline.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 inline.archiveLocation.oss.withEndpoint
withEndpoint(endpoint)
"Endpoint is the hostname of the bucket endpoint"
fn inline.archiveLocation.oss.withKey
withKey(key)
"Key is the path in the bucket where the artifact resides"
fn inline.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 inline.archiveLocation.oss.accessKeySecret
"SecretKeySelector selects a key of a Secret."
fn inline.archiveLocation.oss.accessKeySecret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn inline.archiveLocation.oss.accessKeySecret.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn inline.archiveLocation.oss.accessKeySecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj inline.archiveLocation.oss.lifecycleRule
"OSSLifecycleRule specifies how to manage bucket's lifecycle"
fn inline.archiveLocation.oss.lifecycleRule.withMarkDeletionAfterDays
withMarkDeletionAfterDays(markDeletionAfterDays)
"MarkDeletionAfterDays is the number of days before we delete objects in the bucket"
fn inline.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 inline.archiveLocation.oss.secretKeySecret
"SecretKeySelector selects a key of a Secret."
fn inline.archiveLocation.oss.secretKeySecret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn inline.archiveLocation.oss.secretKeySecret.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn inline.archiveLocation.oss.secretKeySecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj inline.archiveLocation.raw
"RawArtifact allows raw string content to be placed as an artifact in a container"
fn inline.archiveLocation.raw.withData
withData(data)
"Data is the string contents of the artifact"
obj inline.archiveLocation.s3
"S3Artifact is the location of an S3 artifact"
fn inline.archiveLocation.s3.withBucket
withBucket(bucket)
"Bucket is the name of the bucket"
fn inline.archiveLocation.s3.withEndpoint
withEndpoint(endpoint)
"Endpoint is the hostname of the bucket endpoint"
fn inline.archiveLocation.s3.withInsecure
withInsecure(insecure)
"Insecure will connect to the service with TLS"
fn inline.archiveLocation.s3.withKey
withKey(key)
"Key is the key in the bucket where the artifact resides"
fn inline.archiveLocation.s3.withRegion
withRegion(region)
"Region contains the optional bucket region"
fn inline.archiveLocation.s3.withRoleARN
withRoleARN(roleARN)
"RoleARN is the Amazon Resource Name (ARN) of the role to assume."
fn inline.archiveLocation.s3.withUseSDKCreds
withUseSDKCreds(useSDKCreds)
"UseSDKCreds tells the driver to figure out credentials based on sdk defaults."
obj inline.archiveLocation.s3.accessKeySecret
"SecretKeySelector selects a key of a Secret."
fn inline.archiveLocation.s3.accessKeySecret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn inline.archiveLocation.s3.accessKeySecret.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn inline.archiveLocation.s3.accessKeySecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj inline.archiveLocation.s3.createBucketIfNotPresent
"CreateS3BucketOptions options used to determine automatic automatic bucket-creation process"
fn inline.archiveLocation.s3.createBucketIfNotPresent.withObjectLocking
withObjectLocking(objectLocking)
"ObjectLocking Enable object locking"
obj inline.archiveLocation.s3.encryptionOptions
"S3EncryptionOptions used to determine encryption options during s3 operations"
fn inline.archiveLocation.s3.encryptionOptions.withEnableEncryption
withEnableEncryption(enableEncryption)
"EnableEncryption tells the driver to encrypt objects if set to true. If kmsKeyId and serverSideCustomerKeySecret are not set, SSE-S3 will be used"
fn inline.archiveLocation.s3.encryptionOptions.withKmsEncryptionContext
withKmsEncryptionContext(kmsEncryptionContext)
"KmsEncryptionContext is a json blob that contains an encryption context. See https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context for more information"
fn inline.archiveLocation.s3.encryptionOptions.withKmsKeyId
withKmsKeyId(kmsKeyId)
"KMSKeyId tells the driver to encrypt the object using the specified KMS Key."
obj inline.archiveLocation.s3.encryptionOptions.serverSideCustomerKeySecret
"SecretKeySelector selects a key of a Secret."
fn inline.archiveLocation.s3.encryptionOptions.serverSideCustomerKeySecret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn inline.archiveLocation.s3.encryptionOptions.serverSideCustomerKeySecret.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn inline.archiveLocation.s3.encryptionOptions.serverSideCustomerKeySecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj inline.archiveLocation.s3.secretKeySecret
"SecretKeySelector selects a key of a Secret."
fn inline.archiveLocation.s3.secretKeySecret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn inline.archiveLocation.s3.secretKeySecret.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn inline.archiveLocation.s3.secretKeySecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj inline.container
"A single application container that you want to run within a pod."
fn inline.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 inline.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 inline.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 inline.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 inline.container.withEnv
withEnv(env)
"List of environment variables to set in the container. Cannot be updated."
fn inline.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 inline.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 inline.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 inline.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 inline.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 inline.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 inline.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 inline.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 inline.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 inline.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 inline.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 inline.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 inline.container.withTty
withTty(tty)
"Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false."
fn inline.container.withVolumeDevices
withVolumeDevices(volumeDevices)
"volumeDevices is the list of block devices to be used by the container. This is a beta feature."
fn inline.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 inline.container.withVolumeMounts
withVolumeMounts(volumeMounts)
"Pod volumes to mount into the container's filesystem. Cannot be updated."
fn inline.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 inline.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 inline.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 inline.container.lifecycle.postStart
"Handler defines a specific action that should be taken"
obj inline.container.lifecycle.postStart.exec
"ExecAction describes a \"run in container\" action."
fn inline.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 inline.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 inline.container.lifecycle.postStart.httpGet
"HTTPGetAction describes an action based on HTTP Get requests."
fn inline.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 inline.container.lifecycle.postStart.httpGet.withHttpHeaders
withHttpHeaders(httpHeaders)
"Custom headers to set in the request. HTTP allows repeated headers."
fn inline.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 inline.container.lifecycle.postStart.httpGet.withPath
withPath(path)
"Path to access on the HTTP server."
fn inline.container.lifecycle.postStart.httpGet.withPort
withPort(port)
fn inline.container.lifecycle.postStart.httpGet.withScheme
withScheme(scheme)
"Scheme to use for connecting to the host. Defaults to HTTP."
obj inline.container.lifecycle.postStart.tcpSocket
"TCPSocketAction describes an action based on opening a socket"
fn inline.container.lifecycle.postStart.tcpSocket.withHost
withHost(host)
"Optional: Host name to connect to, defaults to the pod IP."
fn inline.container.lifecycle.postStart.tcpSocket.withPort
withPort(port)
obj inline.container.lifecycle.preStop
"Handler defines a specific action that should be taken"
obj inline.container.lifecycle.preStop.exec
"ExecAction describes a \"run in container\" action."
fn inline.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 inline.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 inline.container.lifecycle.preStop.httpGet
"HTTPGetAction describes an action based on HTTP Get requests."
fn inline.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 inline.container.lifecycle.preStop.httpGet.withHttpHeaders
withHttpHeaders(httpHeaders)
"Custom headers to set in the request. HTTP allows repeated headers."
fn inline.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 inline.container.lifecycle.preStop.httpGet.withPath
withPath(path)
"Path to access on the HTTP server."
fn inline.container.lifecycle.preStop.httpGet.withPort
withPort(port)
fn inline.container.lifecycle.preStop.httpGet.withScheme
withScheme(scheme)
"Scheme to use for connecting to the host. Defaults to HTTP."
obj inline.container.lifecycle.preStop.tcpSocket
"TCPSocketAction describes an action based on opening a socket"
fn inline.container.lifecycle.preStop.tcpSocket.withHost
withHost(host)
"Optional: Host name to connect to, defaults to the pod IP."
fn inline.container.lifecycle.preStop.tcpSocket.withPort
withPort(port)
obj inline.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 inline.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 inline.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 inline.container.livenessProbe.withPeriodSeconds
withPeriodSeconds(periodSeconds)
"How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1."
fn inline.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 inline.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 inline.container.livenessProbe.exec
"ExecAction describes a \"run in container\" action."
fn inline.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 inline.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 inline.container.livenessProbe.httpGet
"HTTPGetAction describes an action based on HTTP Get requests."
fn inline.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 inline.container.livenessProbe.httpGet.withHttpHeaders
withHttpHeaders(httpHeaders)
"Custom headers to set in the request. HTTP allows repeated headers."
fn inline.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 inline.container.livenessProbe.httpGet.withPath
withPath(path)
"Path to access on the HTTP server."
fn inline.container.livenessProbe.httpGet.withPort
withPort(port)
fn inline.container.livenessProbe.httpGet.withScheme
withScheme(scheme)
"Scheme to use for connecting to the host. Defaults to HTTP."
obj inline.container.livenessProbe.tcpSocket
"TCPSocketAction describes an action based on opening a socket"
fn inline.container.livenessProbe.tcpSocket.withHost
withHost(host)
"Optional: Host name to connect to, defaults to the pod IP."
fn inline.container.livenessProbe.tcpSocket.withPort
withPort(port)
obj inline.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 inline.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 inline.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 inline.container.readinessProbe.withPeriodSeconds
withPeriodSeconds(periodSeconds)
"How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1."
fn inline.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 inline.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 inline.container.readinessProbe.exec
"ExecAction describes a \"run in container\" action."
fn inline.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 inline.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 inline.container.readinessProbe.httpGet
"HTTPGetAction describes an action based on HTTP Get requests."
fn inline.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 inline.container.readinessProbe.httpGet.withHttpHeaders
withHttpHeaders(httpHeaders)
"Custom headers to set in the request. HTTP allows repeated headers."
fn inline.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 inline.container.readinessProbe.httpGet.withPath
withPath(path)
"Path to access on the HTTP server."
fn inline.container.readinessProbe.httpGet.withPort
withPort(port)
fn inline.container.readinessProbe.httpGet.withScheme
withScheme(scheme)
"Scheme to use for connecting to the host. Defaults to HTTP."
obj inline.container.readinessProbe.tcpSocket
"TCPSocketAction describes an action based on opening a socket"
fn inline.container.readinessProbe.tcpSocket.withHost
withHost(host)
"Optional: Host name to connect to, defaults to the pod IP."
fn inline.container.readinessProbe.tcpSocket.withPort
withPort(port)
obj inline.container.resources
"ResourceRequirements describes the compute resource requirements."
fn inline.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 inline.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 inline.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 inline.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 inline.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 inline.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 inline.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 inline.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 inline.container.securityContext.withReadOnlyRootFilesystem
withReadOnlyRootFilesystem(readOnlyRootFilesystem)
"Whether this container has a read-only root filesystem. Default is false."
fn inline.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 inline.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 inline.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 inline.container.securityContext.capabilities
"Adds and removes POSIX capabilities from running containers."
fn inline.container.securityContext.capabilities.withAdd
withAdd(add)
"Added capabilities"
fn inline.container.securityContext.capabilities.withAddMixin
withAddMixin(add)
"Added capabilities"
Note: This function appends passed data to existing values
fn inline.container.securityContext.capabilities.withDrop
withDrop(drop)
"Removed capabilities"
fn inline.container.securityContext.capabilities.withDropMixin
withDropMixin(drop)
"Removed capabilities"
Note: This function appends passed data to existing values
obj inline.container.securityContext.seLinuxOptions
"SELinuxOptions are the labels to be applied to the container"
fn inline.container.securityContext.seLinuxOptions.withLevel
withLevel(level)
"Level is SELinux level label that applies to the container."
fn inline.container.securityContext.seLinuxOptions.withRole
withRole(role)
"Role is a SELinux role label that applies to the container."
fn inline.container.securityContext.seLinuxOptions.withType
withType(type)
"Type is a SELinux type label that applies to the container."
fn inline.container.securityContext.seLinuxOptions.withUser
withUser(user)
"User is a SELinux user label that applies to the container."
obj inline.container.securityContext.windowsOptions
"WindowsSecurityContextOptions contain Windows-specific options and credentials."
fn inline.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 inline.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 inline.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 inline.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 inline.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 inline.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 inline.container.startupProbe.withPeriodSeconds
withPeriodSeconds(periodSeconds)
"How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1."
fn inline.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 inline.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 inline.container.startupProbe.exec
"ExecAction describes a \"run in container\" action."
fn inline.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 inline.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 inline.container.startupProbe.httpGet
"HTTPGetAction describes an action based on HTTP Get requests."
fn inline.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 inline.container.startupProbe.httpGet.withHttpHeaders
withHttpHeaders(httpHeaders)
"Custom headers to set in the request. HTTP allows repeated headers."
fn inline.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 inline.container.startupProbe.httpGet.withPath
withPath(path)
"Path to access on the HTTP server."
fn inline.container.startupProbe.httpGet.withPort
withPort(port)
fn inline.container.startupProbe.httpGet.withScheme
withScheme(scheme)
"Scheme to use for connecting to the host. Defaults to HTTP."
obj inline.container.startupProbe.tcpSocket
"TCPSocketAction describes an action based on opening a socket"
fn inline.container.startupProbe.tcpSocket.withHost
withHost(host)
"Optional: Host name to connect to, defaults to the pod IP."
fn inline.container.startupProbe.tcpSocket.withPort
withPort(port)
obj inline.containerSet
fn inline.containerSet.withContainers
withContainers(containers)
fn inline.containerSet.withContainersMixin
withContainersMixin(containers)
Note: This function appends passed data to existing values
fn inline.containerSet.withVolumeMounts
withVolumeMounts(volumeMounts)
fn inline.containerSet.withVolumeMountsMixin
withVolumeMountsMixin(volumeMounts)
Note: This function appends passed data to existing values
obj inline.dag
"DAGTemplate is a template subtype for directed acyclic graph templates"
fn inline.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 inline.dag.withTarget
withTarget(target)
"Target are one or more names of targets to execute in a DAG"
fn inline.dag.withTasks
withTasks(tasks)
"Tasks are a list of DAG tasks"
fn inline.dag.withTasksMixin
withTasksMixin(tasks)
"Tasks are a list of DAG tasks"
Note: This function appends passed data to existing values
obj inline.data
"Data is a data template"
fn inline.data.withTransformation
withTransformation(transformation)
"Transformation applies a set of transformations"
fn inline.data.withTransformationMixin
withTransformationMixin(transformation)
"Transformation applies a set of transformations"
Note: This function appends passed data to existing values
obj inline.data.source
"DataSource sources external data into a data template"
obj inline.data.source.artifactPaths
"ArtifactPaths expands a step from a collection of artifacts"
fn inline.data.source.artifactPaths.withArchiveLogs
withArchiveLogs(archiveLogs)
"ArchiveLogs indicates if the container logs should be archived"
fn inline.data.source.artifactPaths.withFrom
withFrom(from)
"From allows an artifact to reference an artifact from a previous step"
fn inline.data.source.artifactPaths.withFromExpression
withFromExpression(fromExpression)
"FromExpression, if defined, is evaluated to specify the value for the artifact"
fn inline.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 inline.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 inline.data.source.artifactPaths.withName
withName(name)
"name of the artifact. must be unique within a template's inputs/outputs."
fn inline.data.source.artifactPaths.withOptional
withOptional(optional)
"Make Artifacts optional, if Artifacts doesn't generate or exist"
fn inline.data.source.artifactPaths.withPath
withPath(path)
"Path is the container path to the artifact"
fn inline.data.source.artifactPaths.withRecurseMode
withRecurseMode(recurseMode)
"If mode is set, apply the permission recursively into the artifact if it is a folder"
fn inline.data.source.artifactPaths.withSubPath
withSubPath(subPath)
"SubPath allows an artifact to be sourced from a subpath within the specified source"
obj inline.data.source.artifactPaths.archive
"ArchiveStrategy describes how to archive files/directory when saving artifacts"
fn inline.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 inline.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 inline.data.source.artifactPaths.archive.withZip
withZip(zip)
"ZipStrategy will unzip zipped input artifacts"
fn inline.data.source.artifactPaths.archive.withZipMixin
withZipMixin(zip)
"ZipStrategy will unzip zipped input artifacts"
Note: This function appends passed data to existing values
obj inline.data.source.artifactPaths.archive.tar
"TarStrategy will tar and gzip the file or directory when saving"
fn inline.data.source.artifactPaths.archive.tar.withCompressionLevel
withCompressionLevel(compressionLevel)
"CompressionLevel specifies the gzip compression level to use for the artifact. Defaults to gzip.DefaultCompression."
obj inline.data.source.artifactPaths.artifactory
"ArtifactoryArtifact is the location of an artifactory artifact"
fn inline.data.source.artifactPaths.artifactory.withUrl
withUrl(url)
"URL of the artifact"
obj inline.data.source.artifactPaths.artifactory.passwordSecret
"SecretKeySelector selects a key of a Secret."
fn inline.data.source.artifactPaths.artifactory.passwordSecret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn inline.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 inline.data.source.artifactPaths.artifactory.passwordSecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj inline.data.source.artifactPaths.artifactory.usernameSecret
"SecretKeySelector selects a key of a Secret."
fn inline.data.source.artifactPaths.artifactory.usernameSecret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn inline.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 inline.data.source.artifactPaths.artifactory.usernameSecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj inline.data.source.artifactPaths.gcs
"GCSArtifact is the location of a GCS artifact"
fn inline.data.source.artifactPaths.gcs.withBucket
withBucket(bucket)
"Bucket is the name of the bucket"
fn inline.data.source.artifactPaths.gcs.withKey
withKey(key)
"Key is the path in the bucket where the artifact resides"
obj inline.data.source.artifactPaths.gcs.serviceAccountKeySecret
"SecretKeySelector selects a key of a Secret."
fn inline.data.source.artifactPaths.gcs.serviceAccountKeySecret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn inline.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 inline.data.source.artifactPaths.gcs.serviceAccountKeySecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj inline.data.source.artifactPaths.git
"GitArtifact is the location of an git artifact"
fn inline.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 inline.data.source.artifactPaths.git.withDisableSubmodules
withDisableSubmodules(disableSubmodules)
"DisableSubmodules disables submodules during git clone"
fn inline.data.source.artifactPaths.git.withFetch
withFetch(fetch)
"Fetch specifies a number of refs that should be fetched before checkout"
fn inline.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 inline.data.source.artifactPaths.git.withInsecureIgnoreHostKey
withInsecureIgnoreHostKey(insecureIgnoreHostKey)
"InsecureIgnoreHostKey disables SSH strict host key checking during git clone"
fn inline.data.source.artifactPaths.git.withRepo
withRepo(repo)
"Repo is the git repository"
fn inline.data.source.artifactPaths.git.withRevision
withRevision(revision)
"Revision is the git commit, tag, branch to checkout"
obj inline.data.source.artifactPaths.git.passwordSecret
"SecretKeySelector selects a key of a Secret."
fn inline.data.source.artifactPaths.git.passwordSecret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn inline.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 inline.data.source.artifactPaths.git.passwordSecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj inline.data.source.artifactPaths.git.sshPrivateKeySecret
"SecretKeySelector selects a key of a Secret."
fn inline.data.source.artifactPaths.git.sshPrivateKeySecret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn inline.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 inline.data.source.artifactPaths.git.sshPrivateKeySecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj inline.data.source.artifactPaths.git.usernameSecret
"SecretKeySelector selects a key of a Secret."
fn inline.data.source.artifactPaths.git.usernameSecret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn inline.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 inline.data.source.artifactPaths.git.usernameSecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj inline.data.source.artifactPaths.hdfs
"HDFSArtifact is the location of an HDFS artifact"
fn inline.data.source.artifactPaths.hdfs.withAddresses
withAddresses(addresses)
"Addresses is accessible addresses of HDFS name nodes"
fn inline.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 inline.data.source.artifactPaths.hdfs.withForce
withForce(force)
"Force copies a file forcibly even if it exists (default: false)"
fn inline.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 inline.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 inline.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 inline.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 inline.data.source.artifactPaths.hdfs.withPath
withPath(path)
"Path is a file path in HDFS"
obj inline.data.source.artifactPaths.hdfs.krbCCacheSecret
"SecretKeySelector selects a key of a Secret."
fn inline.data.source.artifactPaths.hdfs.krbCCacheSecret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn inline.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 inline.data.source.artifactPaths.hdfs.krbCCacheSecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj inline.data.source.artifactPaths.hdfs.krbConfigConfigMap
"Selects a key from a ConfigMap."
fn inline.data.source.artifactPaths.hdfs.krbConfigConfigMap.withKey
withKey(key)
"The key to select."
fn inline.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 inline.data.source.artifactPaths.hdfs.krbConfigConfigMap.withOptional
withOptional(optional)
"Specify whether the ConfigMap or its key must be defined"
obj inline.data.source.artifactPaths.hdfs.krbKeytabSecret
"SecretKeySelector selects a key of a Secret."
fn inline.data.source.artifactPaths.hdfs.krbKeytabSecret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn inline.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 inline.data.source.artifactPaths.hdfs.krbKeytabSecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj inline.data.source.artifactPaths.http
"HTTPArtifact allows an file served on HTTP to be placed as an input artifact in a container"
fn inline.data.source.artifactPaths.http.withHeaders
withHeaders(headers)
"Headers are an optional list of headers to send with HTTP requests for artifacts"
fn inline.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 inline.data.source.artifactPaths.http.withUrl
withUrl(url)
"URL of the artifact"
obj inline.data.source.artifactPaths.oss
"OSSArtifact is the location of an Alibaba Cloud OSS artifact"
fn inline.data.source.artifactPaths.oss.withBucket
withBucket(bucket)
"Bucket is the name of the bucket"
fn inline.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 inline.data.source.artifactPaths.oss.withEndpoint
withEndpoint(endpoint)
"Endpoint is the hostname of the bucket endpoint"
fn inline.data.source.artifactPaths.oss.withKey
withKey(key)
"Key is the path in the bucket where the artifact resides"
fn inline.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 inline.data.source.artifactPaths.oss.accessKeySecret
"SecretKeySelector selects a key of a Secret."
fn inline.data.source.artifactPaths.oss.accessKeySecret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn inline.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 inline.data.source.artifactPaths.oss.accessKeySecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj inline.data.source.artifactPaths.oss.lifecycleRule
"OSSLifecycleRule specifies how to manage bucket's lifecycle"
fn inline.data.source.artifactPaths.oss.lifecycleRule.withMarkDeletionAfterDays
withMarkDeletionAfterDays(markDeletionAfterDays)
"MarkDeletionAfterDays is the number of days before we delete objects in the bucket"
fn inline.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 inline.data.source.artifactPaths.oss.secretKeySecret
"SecretKeySelector selects a key of a Secret."
fn inline.data.source.artifactPaths.oss.secretKeySecret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn inline.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 inline.data.source.artifactPaths.oss.secretKeySecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj inline.data.source.artifactPaths.raw
"RawArtifact allows raw string content to be placed as an artifact in a container"
fn inline.data.source.artifactPaths.raw.withData
withData(data)
"Data is the string contents of the artifact"
obj inline.data.source.artifactPaths.s3
"S3Artifact is the location of an S3 artifact"
fn inline.data.source.artifactPaths.s3.withBucket
withBucket(bucket)
"Bucket is the name of the bucket"
fn inline.data.source.artifactPaths.s3.withEndpoint
withEndpoint(endpoint)
"Endpoint is the hostname of the bucket endpoint"
fn inline.data.source.artifactPaths.s3.withInsecure
withInsecure(insecure)
"Insecure will connect to the service with TLS"
fn inline.data.source.artifactPaths.s3.withKey
withKey(key)
"Key is the key in the bucket where the artifact resides"
fn inline.data.source.artifactPaths.s3.withRegion
withRegion(region)
"Region contains the optional bucket region"
fn inline.data.source.artifactPaths.s3.withRoleARN
withRoleARN(roleARN)
"RoleARN is the Amazon Resource Name (ARN) of the role to assume."
fn inline.data.source.artifactPaths.s3.withUseSDKCreds
withUseSDKCreds(useSDKCreds)
"UseSDKCreds tells the driver to figure out credentials based on sdk defaults."
obj inline.data.source.artifactPaths.s3.accessKeySecret
"SecretKeySelector selects a key of a Secret."
fn inline.data.source.artifactPaths.s3.accessKeySecret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn inline.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 inline.data.source.artifactPaths.s3.accessKeySecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj inline.data.source.artifactPaths.s3.createBucketIfNotPresent
"CreateS3BucketOptions options used to determine automatic automatic bucket-creation process"
fn inline.data.source.artifactPaths.s3.createBucketIfNotPresent.withObjectLocking
withObjectLocking(objectLocking)
"ObjectLocking Enable object locking"
obj inline.data.source.artifactPaths.s3.encryptionOptions
"S3EncryptionOptions used to determine encryption options during s3 operations"
fn inline.data.source.artifactPaths.s3.encryptionOptions.withEnableEncryption
withEnableEncryption(enableEncryption)
"EnableEncryption tells the driver to encrypt objects if set to true. If kmsKeyId and serverSideCustomerKeySecret are not set, SSE-S3 will be used"
fn inline.data.source.artifactPaths.s3.encryptionOptions.withKmsEncryptionContext
withKmsEncryptionContext(kmsEncryptionContext)
"KmsEncryptionContext is a json blob that contains an encryption context. See https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context for more information"
fn inline.data.source.artifactPaths.s3.encryptionOptions.withKmsKeyId
withKmsKeyId(kmsKeyId)
"KMSKeyId tells the driver to encrypt the object using the specified KMS Key."
obj inline.data.source.artifactPaths.s3.encryptionOptions.serverSideCustomerKeySecret
"SecretKeySelector selects a key of a Secret."
fn inline.data.source.artifactPaths.s3.encryptionOptions.serverSideCustomerKeySecret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn inline.data.source.artifactPaths.s3.encryptionOptions.serverSideCustomerKeySecret.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn inline.data.source.artifactPaths.s3.encryptionOptions.serverSideCustomerKeySecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj inline.data.source.artifactPaths.s3.secretKeySecret
"SecretKeySelector selects a key of a Secret."
fn inline.data.source.artifactPaths.s3.secretKeySecret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn inline.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 inline.data.source.artifactPaths.s3.secretKeySecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj inline.executor
"ExecutorConfig holds configurations of an executor container."
fn inline.executor.withServiceAccountName
withServiceAccountName(serviceAccountName)
"ServiceAccountName specifies the service account name of the executor container."
obj inline.http
fn inline.http.withBody
withBody(body)
"Body is content of the HTTP Request"
fn inline.http.withHeaders
withHeaders(headers)
"Headers are an optional list of headers to send with HTTP requests"
fn inline.http.withHeadersMixin
withHeadersMixin(headers)
"Headers are an optional list of headers to send with HTTP requests"
Note: This function appends passed data to existing values
fn inline.http.withMethod
withMethod(method)
"Method is HTTP methods for HTTP Request"
fn inline.http.withTimeoutSeconds
withTimeoutSeconds(timeoutSeconds)
"TimeoutSeconds is request timeout for HTTP Request. Default is 30 seconds"
fn inline.http.withUrl
withUrl(url)
"URL of the HTTP Request"
obj inline.inputs
"Inputs are the mechanism for passing parameters, artifacts, volumes from one template to another"
fn inline.inputs.withArtifacts
withArtifacts(artifacts)
"Artifact are a list of artifacts passed as inputs"
fn inline.inputs.withArtifactsMixin
withArtifactsMixin(artifacts)
"Artifact are a list of artifacts passed as inputs"
Note: This function appends passed data to existing values
fn inline.inputs.withParameters
withParameters(parameters)
"Parameters are a list of parameters passed as inputs"
fn inline.inputs.withParametersMixin
withParametersMixin(parameters)
"Parameters are a list of parameters passed as inputs"
Note: This function appends passed data to existing values
obj inline.memoize
"Memoization enables caching for the Outputs of the template"
fn inline.memoize.withKey
withKey(key)
"Key is the key to use as the caching key"
fn inline.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 inline.memoize.cache
"Cache is the configuration for the type of cache to be used"
obj inline.memoize.cache.configMap
"Selects a key from a ConfigMap."
fn inline.memoize.cache.configMap.withKey
withKey(key)
"The key to select."
fn inline.memoize.cache.configMap.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn inline.memoize.cache.configMap.withOptional
withOptional(optional)
"Specify whether the ConfigMap or its key must be defined"
obj inline.metadata
"Pod metdata"
fn inline.metadata.withAnnotations
withAnnotations(annotations)
fn inline.metadata.withAnnotationsMixin
withAnnotationsMixin(annotations)
Note: This function appends passed data to existing values
fn inline.metadata.withLabels
withLabels(labels)
fn inline.metadata.withLabelsMixin
withLabelsMixin(labels)
Note: This function appends passed data to existing values
obj inline.metrics
"Metrics are a list of metrics emitted from a Workflow/Template"
fn inline.metrics.withPrometheus
withPrometheus(prometheus)
"Prometheus is a list of prometheus metrics to be emitted"
fn inline.metrics.withPrometheusMixin
withPrometheusMixin(prometheus)
"Prometheus is a list of prometheus metrics to be emitted"
Note: This function appends passed data to existing values
obj inline.outputs
"Outputs hold parameters, artifacts, and results from a step"
fn inline.outputs.withArtifacts
withArtifacts(artifacts)
"Artifacts holds the list of output artifacts produced by a step"
fn inline.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 inline.outputs.withExitCode
withExitCode(exitCode)
"ExitCode holds the exit code of a script template"
fn inline.outputs.withParameters
withParameters(parameters)
"Parameters holds the list of output parameters produced by a step"
fn inline.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 inline.outputs.withResult
withResult(result)
"Result holds the result (stdout) of a script template"
obj inline.resource
"ResourceTemplate is a template subtype to manipulate kubernetes resources"
fn inline.resource.withAction
withAction(action)
"Action is the action to perform to the resource. Must be one of: get, create, apply, delete, replace, patch"
fn inline.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 inline.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 inline.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 inline.resource.withManifest
withManifest(manifest)
"Manifest contains the kubernetes manifest"
fn inline.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 inline.resource.withSetOwnerReference
withSetOwnerReference(setOwnerReference)
"SetOwnerReference sets the reference to the workflow on the OwnerReference of generated resource."
fn inline.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 inline.retryStrategy
"RetryStrategy provides controls on how to retry a workflow step"
fn inline.retryStrategy.withExpression
withExpression(expression)
"Expression is a condition expression for when a node will be retried. If it evaluates to false, the node will not be retried and the retry strategy will be ignored/"
fn inline.retryStrategy.withLimit
withLimit(limit)
fn inline.retryStrategy.withRetryPolicy
withRetryPolicy(retryPolicy)
"RetryPolicy is a policy of NodePhase statuses that will be retried"
obj inline.retryStrategy.affinity
"RetryAffinity prevents running steps on the same host."
fn inline.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 inline.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 inline.retryStrategy.backoff
"Backoff is a backoff strategy to use within retryStrategy"
fn inline.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 inline.retryStrategy.backoff.withFactor
withFactor(factor)
fn inline.retryStrategy.backoff.withMaxDuration
withMaxDuration(maxDuration)
"MaxDuration is the maximum amount of time allowed for the backoff strategy"
obj inline.script
"ScriptTemplate is a template subtype to enable scripting through code steps"
fn inline.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 inline.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 inline.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 inline.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 inline.script.withEnv
withEnv(env)
"List of environment variables to set in the container. Cannot be updated."
fn inline.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 inline.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 inline.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 inline.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 inline.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 inline.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 inline.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 inline.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 inline.script.withSource
withSource(source)
"Source contains the source code of the script to execute"
fn inline.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 inline.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 inline.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 inline.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 inline.script.withTty
withTty(tty)
"Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false."
fn inline.script.withVolumeDevices
withVolumeDevices(volumeDevices)
"volumeDevices is the list of block devices to be used by the container."
fn inline.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 inline.script.withVolumeMounts
withVolumeMounts(volumeMounts)
"Pod volumes to mount into the container's filesystem. Cannot be updated."
fn inline.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 inline.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 inline.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 inline.script.lifecycle.postStart
"Handler defines a specific action that should be taken"
obj inline.script.lifecycle.postStart.exec
"ExecAction describes a \"run in container\" action."
fn inline.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 inline.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 inline.script.lifecycle.postStart.httpGet
"HTTPGetAction describes an action based on HTTP Get requests."
fn inline.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 inline.script.lifecycle.postStart.httpGet.withHttpHeaders
withHttpHeaders(httpHeaders)
"Custom headers to set in the request. HTTP allows repeated headers."
fn inline.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 inline.script.lifecycle.postStart.httpGet.withPath
withPath(path)
"Path to access on the HTTP server."
fn inline.script.lifecycle.postStart.httpGet.withPort
withPort(port)
fn inline.script.lifecycle.postStart.httpGet.withScheme
withScheme(scheme)
"Scheme to use for connecting to the host. Defaults to HTTP."
obj inline.script.lifecycle.postStart.tcpSocket
"TCPSocketAction describes an action based on opening a socket"
fn inline.script.lifecycle.postStart.tcpSocket.withHost
withHost(host)
"Optional: Host name to connect to, defaults to the pod IP."
fn inline.script.lifecycle.postStart.tcpSocket.withPort
withPort(port)
obj inline.script.lifecycle.preStop
"Handler defines a specific action that should be taken"
obj inline.script.lifecycle.preStop.exec
"ExecAction describes a \"run in container\" action."
fn inline.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 inline.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 inline.script.lifecycle.preStop.httpGet
"HTTPGetAction describes an action based on HTTP Get requests."
fn inline.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 inline.script.lifecycle.preStop.httpGet.withHttpHeaders
withHttpHeaders(httpHeaders)
"Custom headers to set in the request. HTTP allows repeated headers."
fn inline.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 inline.script.lifecycle.preStop.httpGet.withPath
withPath(path)
"Path to access on the HTTP server."
fn inline.script.lifecycle.preStop.httpGet.withPort
withPort(port)
fn inline.script.lifecycle.preStop.httpGet.withScheme
withScheme(scheme)
"Scheme to use for connecting to the host. Defaults to HTTP."
obj inline.script.lifecycle.preStop.tcpSocket
"TCPSocketAction describes an action based on opening a socket"
fn inline.script.lifecycle.preStop.tcpSocket.withHost
withHost(host)
"Optional: Host name to connect to, defaults to the pod IP."
fn inline.script.lifecycle.preStop.tcpSocket.withPort
withPort(port)
obj inline.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 inline.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 inline.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 inline.script.livenessProbe.withPeriodSeconds
withPeriodSeconds(periodSeconds)
"How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1."
fn inline.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 inline.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 inline.script.livenessProbe.exec
"ExecAction describes a \"run in container\" action."
fn inline.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 inline.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 inline.script.livenessProbe.httpGet
"HTTPGetAction describes an action based on HTTP Get requests."
fn inline.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 inline.script.livenessProbe.httpGet.withHttpHeaders
withHttpHeaders(httpHeaders)
"Custom headers to set in the request. HTTP allows repeated headers."
fn inline.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 inline.script.livenessProbe.httpGet.withPath
withPath(path)
"Path to access on the HTTP server."
fn inline.script.livenessProbe.httpGet.withPort
withPort(port)
fn inline.script.livenessProbe.httpGet.withScheme
withScheme(scheme)
"Scheme to use for connecting to the host. Defaults to HTTP."
obj inline.script.livenessProbe.tcpSocket
"TCPSocketAction describes an action based on opening a socket"
fn inline.script.livenessProbe.tcpSocket.withHost
withHost(host)
"Optional: Host name to connect to, defaults to the pod IP."
fn inline.script.livenessProbe.tcpSocket.withPort
withPort(port)
obj inline.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 inline.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 inline.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 inline.script.readinessProbe.withPeriodSeconds
withPeriodSeconds(periodSeconds)
"How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1."
fn inline.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 inline.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 inline.script.readinessProbe.exec
"ExecAction describes a \"run in container\" action."
fn inline.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 inline.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 inline.script.readinessProbe.httpGet
"HTTPGetAction describes an action based on HTTP Get requests."
fn inline.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 inline.script.readinessProbe.httpGet.withHttpHeaders
withHttpHeaders(httpHeaders)
"Custom headers to set in the request. HTTP allows repeated headers."
fn inline.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 inline.script.readinessProbe.httpGet.withPath
withPath(path)
"Path to access on the HTTP server."
fn inline.script.readinessProbe.httpGet.withPort
withPort(port)
fn inline.script.readinessProbe.httpGet.withScheme
withScheme(scheme)
"Scheme to use for connecting to the host. Defaults to HTTP."
obj inline.script.readinessProbe.tcpSocket
"TCPSocketAction describes an action based on opening a socket"
fn inline.script.readinessProbe.tcpSocket.withHost
withHost(host)
"Optional: Host name to connect to, defaults to the pod IP."
fn inline.script.readinessProbe.tcpSocket.withPort
withPort(port)
obj inline.script.resources
"ResourceRequirements describes the compute resource requirements."
fn inline.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 inline.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 inline.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 inline.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 inline.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 inline.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 inline.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 inline.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 inline.script.securityContext.withReadOnlyRootFilesystem
withReadOnlyRootFilesystem(readOnlyRootFilesystem)
"Whether this container has a read-only root filesystem. Default is false."
fn inline.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 inline.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 inline.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 inline.script.securityContext.capabilities
"Adds and removes POSIX capabilities from running containers."
fn inline.script.securityContext.capabilities.withAdd
withAdd(add)
"Added capabilities"
fn inline.script.securityContext.capabilities.withAddMixin
withAddMixin(add)
"Added capabilities"
Note: This function appends passed data to existing values
fn inline.script.securityContext.capabilities.withDrop
withDrop(drop)
"Removed capabilities"
fn inline.script.securityContext.capabilities.withDropMixin
withDropMixin(drop)
"Removed capabilities"
Note: This function appends passed data to existing values
obj inline.script.securityContext.seLinuxOptions
"SELinuxOptions are the labels to be applied to the container"
fn inline.script.securityContext.seLinuxOptions.withLevel
withLevel(level)
"Level is SELinux level label that applies to the container."
fn inline.script.securityContext.seLinuxOptions.withRole
withRole(role)
"Role is a SELinux role label that applies to the container."
fn inline.script.securityContext.seLinuxOptions.withType
withType(type)
"Type is a SELinux type label that applies to the container."
fn inline.script.securityContext.seLinuxOptions.withUser
withUser(user)
"User is a SELinux user label that applies to the container."
obj inline.script.securityContext.windowsOptions
"WindowsSecurityContextOptions contain Windows-specific options and credentials."
fn inline.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 inline.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 inline.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 inline.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 inline.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 inline.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 inline.script.startupProbe.withPeriodSeconds
withPeriodSeconds(periodSeconds)
"How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1."
fn inline.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 inline.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 inline.script.startupProbe.exec
"ExecAction describes a \"run in container\" action."
fn inline.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 inline.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 inline.script.startupProbe.httpGet
"HTTPGetAction describes an action based on HTTP Get requests."
fn inline.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 inline.script.startupProbe.httpGet.withHttpHeaders
withHttpHeaders(httpHeaders)
"Custom headers to set in the request. HTTP allows repeated headers."
fn inline.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 inline.script.startupProbe.httpGet.withPath
withPath(path)
"Path to access on the HTTP server."
fn inline.script.startupProbe.httpGet.withPort
withPort(port)
fn inline.script.startupProbe.httpGet.withScheme
withScheme(scheme)
"Scheme to use for connecting to the host. Defaults to HTTP."
obj inline.script.startupProbe.tcpSocket
"TCPSocketAction describes an action based on opening a socket"
fn inline.script.startupProbe.tcpSocket.withHost
withHost(host)
"Optional: Host name to connect to, defaults to the pod IP."
fn inline.script.startupProbe.tcpSocket.withPort
withPort(port)
obj inline.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 inline.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 inline.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 inline.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 inline.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 inline.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 inline.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 inline.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 inline.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 inline.securityContext.seLinuxOptions
"SELinuxOptions are the labels to be applied to the container"
fn inline.securityContext.seLinuxOptions.withLevel
withLevel(level)
"Level is SELinux level label that applies to the container."
fn inline.securityContext.seLinuxOptions.withRole
withRole(role)
"Role is a SELinux role label that applies to the container."
fn inline.securityContext.seLinuxOptions.withType
withType(type)
"Type is a SELinux type label that applies to the container."
fn inline.securityContext.seLinuxOptions.withUser
withUser(user)
"User is a SELinux user label that applies to the container."
obj inline.securityContext.windowsOptions
"WindowsSecurityContextOptions contain Windows-specific options and credentials."
fn inline.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 inline.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 inline.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 inline.suspend
"SuspendTemplate is a template subtype to suspend a workflow at a predetermined point in time"
fn inline.suspend.withDuration
withDuration(duration)
"Duration is the seconds to wait before automatically resuming a template"
obj inline.synchronization
"Synchronization holds synchronization lock configuration"
obj inline.synchronization.mutex
"Mutex holds Mutex configuration"
fn inline.synchronization.mutex.withName
withName(name)
"name of the mutex"
obj inline.synchronization.semaphore
"SemaphoreRef is a reference of Semaphore"
obj inline.synchronization.semaphore.configMapKeyRef
"Selects a key from a ConfigMap."
fn inline.synchronization.semaphore.configMapKeyRef.withKey
withKey(key)
"The key to select."
fn inline.synchronization.semaphore.configMapKeyRef.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn inline.synchronization.semaphore.configMapKeyRef.withOptional
withOptional(optional)
"Specify whether the ConfigMap or its key must be defined"
obj templateRef
"TemplateRef is a reference of template resource."
fn templateRef.withClusterScope
withClusterScope(clusterScope)
"ClusterScope indicates the referred template is cluster scoped (i.e. a ClusterWorkflowTemplate)."
fn templateRef.withName
withName(name)
"Name is the resource name of the template."
fn templateRef.withTemplate
withTemplate(template)
"Template is the name of referred template in the resource."
obj withSequence
"Sequence expands a workflow step into numeric range"
fn withSequence.withCount
withCount(count)
fn withSequence.withEnd
withEnd(end)
fn withSequence.withFormat
withFormat(format)
"Format is a printf format string to format the value in the sequence"
fn withSequence.withStart
withStart(start)