workflow.v1alpha1.workflowStatus
"WorkflowStatus contains overall status information about a workflow"
Index
fn withCompressedNodes(compressedNodes)
fn withConditions(conditions)
fn withConditionsMixin(conditions)
fn withEstimatedDuration(estimatedDuration)
fn withFinishedAt(finishedAt)
fn withMessage(message)
fn withNodes(nodes)
fn withNodesMixin(nodes)
fn withOffloadNodeStatusVersion(offloadNodeStatusVersion)
fn withPersistentVolumeClaims(persistentVolumeClaims)
fn withPersistentVolumeClaimsMixin(persistentVolumeClaims)
fn withPhase(phase)
fn withProgress(progress)
fn withResourcesDuration(resourcesDuration)
fn withResourcesDurationMixin(resourcesDuration)
fn withStartedAt(startedAt)
fn withStoredTemplates(storedTemplates)
fn withStoredTemplatesMixin(storedTemplates)
obj artifactRepositoryRef
fn withConfigMap(configMap)
fn withDefault(default)
fn withKey(key)
fn withNamespace(namespace)
obj artifactRepositoryRef.artifactRepository
fn withArchiveLogs(archiveLogs)
obj artifactRepositoryRef.artifactRepository.artifactory
obj artifactRepositoryRef.artifactRepository.gcs
obj artifactRepositoryRef.artifactRepository.hdfs
fn withAddresses(addresses)
fn withAddressesMixin(addresses)
fn withForce(force)
fn withHdfsUser(hdfsUser)
fn withKrbRealm(krbRealm)
fn withKrbServicePrincipalName(krbServicePrincipalName)
fn withKrbUsername(krbUsername)
fn withPathFormat(pathFormat)
obj artifactRepositoryRef.artifactRepository.hdfs.krbCCacheSecret
obj artifactRepositoryRef.artifactRepository.hdfs.krbConfigConfigMap
obj artifactRepositoryRef.artifactRepository.hdfs.krbKeytabSecret
obj artifactRepositoryRef.artifactRepository.oss
fn withBucket(bucket)
fn withCreateBucketIfNotPresent(createBucketIfNotPresent)
fn withEndpoint(endpoint)
fn withKeyFormat(keyFormat)
fn withSecurityToken(securityToken)
obj artifactRepositoryRef.artifactRepository.oss.accessKeySecret
obj artifactRepositoryRef.artifactRepository.oss.lifecycleRule
obj artifactRepositoryRef.artifactRepository.oss.secretKeySecret
obj artifactRepositoryRef.artifactRepository.s3
fn withBucket(bucket)
fn withEndpoint(endpoint)
fn withInsecure(insecure)
fn withKeyFormat(keyFormat)
fn withKeyPrefix(keyPrefix)
fn withRegion(region)
fn withRoleARN(roleARN)
fn withUseSDKCreds(useSDKCreds)
obj artifactRepositoryRef.artifactRepository.s3.accessKeySecret
obj artifactRepositoryRef.artifactRepository.s3.createBucketIfNotPresent
obj artifactRepositoryRef.artifactRepository.s3.secretKeySecret
obj outputs
obj storedWorkflowTemplateSpec
fn withActiveDeadlineSeconds(activeDeadlineSeconds)
fn withAutomountServiceAccountToken(automountServiceAccountToken)
fn withDnsPolicy(dnsPolicy)
fn withEntrypoint(entrypoint)
fn withHostAliases(hostAliases)
fn withHostAliasesMixin(hostAliases)
fn withHostNetwork(hostNetwork)
fn withImagePullSecrets(imagePullSecrets)
fn withImagePullSecretsMixin(imagePullSecrets)
fn withNodeSelector(nodeSelector)
fn withNodeSelectorMixin(nodeSelector)
fn withOnExit(onExit)
fn withParallelism(parallelism)
fn withPodPriority(podPriority)
fn withPodPriorityClassName(podPriorityClassName)
fn withPodSpecPatch(podSpecPatch)
fn withPriority(priority)
fn withSchedulerName(schedulerName)
fn withServiceAccountName(serviceAccountName)
fn withShutdown(shutdown)
fn withSuspend(suspend)
fn withTemplates(templates)
fn withTemplatesMixin(templates)
fn withTolerations(tolerations)
fn withTolerationsMixin(tolerations)
fn withVolumeClaimTemplates(volumeClaimTemplates)
fn withVolumeClaimTemplatesMixin(volumeClaimTemplates)
fn withVolumes(volumes)
fn withVolumesMixin(volumes)
obj storedWorkflowTemplateSpec.affinity
obj storedWorkflowTemplateSpec.affinity.nodeAffinity
fn withPreferredDuringSchedulingIgnoredDuringExecution(preferredDuringSchedulingIgnoredDuringExecution)
fn withPreferredDuringSchedulingIgnoredDuringExecutionMixin(preferredDuringSchedulingIgnoredDuringExecution)
obj storedWorkflowTemplateSpec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution
obj storedWorkflowTemplateSpec.affinity.podAffinity
fn withPreferredDuringSchedulingIgnoredDuringExecution(preferredDuringSchedulingIgnoredDuringExecution)
fn withPreferredDuringSchedulingIgnoredDuringExecutionMixin(preferredDuringSchedulingIgnoredDuringExecution)
fn withRequiredDuringSchedulingIgnoredDuringExecution(requiredDuringSchedulingIgnoredDuringExecution)
fn withRequiredDuringSchedulingIgnoredDuringExecutionMixin(requiredDuringSchedulingIgnoredDuringExecution)
obj storedWorkflowTemplateSpec.affinity.podAntiAffinity
fn withPreferredDuringSchedulingIgnoredDuringExecution(preferredDuringSchedulingIgnoredDuringExecution)
fn withPreferredDuringSchedulingIgnoredDuringExecutionMixin(preferredDuringSchedulingIgnoredDuringExecution)
fn withRequiredDuringSchedulingIgnoredDuringExecution(requiredDuringSchedulingIgnoredDuringExecution)
fn withRequiredDuringSchedulingIgnoredDuringExecutionMixin(requiredDuringSchedulingIgnoredDuringExecution)
obj storedWorkflowTemplateSpec.arguments
obj storedWorkflowTemplateSpec.artifactRepositoryRef
obj storedWorkflowTemplateSpec.dnsConfig
obj storedWorkflowTemplateSpec.executor
obj storedWorkflowTemplateSpec.metrics
obj storedWorkflowTemplateSpec.podDisruptionBudget
obj storedWorkflowTemplateSpec.podGC
obj storedWorkflowTemplateSpec.podMetadata
obj storedWorkflowTemplateSpec.retryStrategy
obj storedWorkflowTemplateSpec.securityContext
fn withFsGroup(fsGroup)
fn withRunAsGroup(runAsGroup)
fn withRunAsNonRoot(runAsNonRoot)
fn withRunAsUser(runAsUser)
fn withSupplementalGroups(supplementalGroups)
fn withSupplementalGroupsMixin(supplementalGroups)
fn withSysctls(sysctls)
fn withSysctlsMixin(sysctls)
obj storedWorkflowTemplateSpec.securityContext.seLinuxOptions
obj storedWorkflowTemplateSpec.securityContext.windowsOptions
obj storedWorkflowTemplateSpec.synchronization
obj storedWorkflowTemplateSpec.templateDefaults
fn 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 storedWorkflowTemplateSpec.templateDefaults.affinity
obj storedWorkflowTemplateSpec.templateDefaults.affinity.nodeAffinity
fn withPreferredDuringSchedulingIgnoredDuringExecution(preferredDuringSchedulingIgnoredDuringExecution)
fn withPreferredDuringSchedulingIgnoredDuringExecutionMixin(preferredDuringSchedulingIgnoredDuringExecution)
obj storedWorkflowTemplateSpec.templateDefaults.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution
obj storedWorkflowTemplateSpec.templateDefaults.affinity.podAffinity
fn withPreferredDuringSchedulingIgnoredDuringExecution(preferredDuringSchedulingIgnoredDuringExecution)
fn withPreferredDuringSchedulingIgnoredDuringExecutionMixin(preferredDuringSchedulingIgnoredDuringExecution)
fn withRequiredDuringSchedulingIgnoredDuringExecution(requiredDuringSchedulingIgnoredDuringExecution)
fn withRequiredDuringSchedulingIgnoredDuringExecutionMixin(requiredDuringSchedulingIgnoredDuringExecution)
obj storedWorkflowTemplateSpec.templateDefaults.affinity.podAntiAffinity
fn withPreferredDuringSchedulingIgnoredDuringExecution(preferredDuringSchedulingIgnoredDuringExecution)
fn withPreferredDuringSchedulingIgnoredDuringExecutionMixin(preferredDuringSchedulingIgnoredDuringExecution)
fn withRequiredDuringSchedulingIgnoredDuringExecution(requiredDuringSchedulingIgnoredDuringExecution)
fn withRequiredDuringSchedulingIgnoredDuringExecutionMixin(requiredDuringSchedulingIgnoredDuringExecution)
obj storedWorkflowTemplateSpec.templateDefaults.archiveLocation
fn withArchiveLogs(archiveLogs)
obj storedWorkflowTemplateSpec.templateDefaults.archiveLocation.artifactory
obj storedWorkflowTemplateSpec.templateDefaults.archiveLocation.gcs
obj storedWorkflowTemplateSpec.templateDefaults.archiveLocation.git
fn withDepth(depth)
fn withDisableSubmodules(disableSubmodules)
fn withFetch(fetch)
fn withFetchMixin(fetch)
fn withInsecureIgnoreHostKey(insecureIgnoreHostKey)
fn withRepo(repo)
fn withRevision(revision)
obj storedWorkflowTemplateSpec.templateDefaults.archiveLocation.git.passwordSecret
obj storedWorkflowTemplateSpec.templateDefaults.archiveLocation.git.sshPrivateKeySecret
obj storedWorkflowTemplateSpec.templateDefaults.archiveLocation.git.usernameSecret
obj storedWorkflowTemplateSpec.templateDefaults.archiveLocation.hdfs
fn withAddresses(addresses)
fn withAddressesMixin(addresses)
fn withForce(force)
fn withHdfsUser(hdfsUser)
fn withKrbRealm(krbRealm)
fn withKrbServicePrincipalName(krbServicePrincipalName)
fn withKrbUsername(krbUsername)
fn withPath(path)
obj storedWorkflowTemplateSpec.templateDefaults.archiveLocation.hdfs.krbCCacheSecret
obj storedWorkflowTemplateSpec.templateDefaults.archiveLocation.hdfs.krbConfigConfigMap
obj storedWorkflowTemplateSpec.templateDefaults.archiveLocation.hdfs.krbKeytabSecret
obj storedWorkflowTemplateSpec.templateDefaults.archiveLocation.http
obj storedWorkflowTemplateSpec.templateDefaults.archiveLocation.oss
fn withBucket(bucket)
fn withCreateBucketIfNotPresent(createBucketIfNotPresent)
fn withEndpoint(endpoint)
fn withKey(key)
fn withSecurityToken(securityToken)
obj storedWorkflowTemplateSpec.templateDefaults.archiveLocation.oss.accessKeySecret
obj storedWorkflowTemplateSpec.templateDefaults.archiveLocation.oss.lifecycleRule
obj storedWorkflowTemplateSpec.templateDefaults.archiveLocation.oss.secretKeySecret
obj storedWorkflowTemplateSpec.templateDefaults.archiveLocation.raw
obj storedWorkflowTemplateSpec.templateDefaults.archiveLocation.s3
fn withBucket(bucket)
fn withEndpoint(endpoint)
fn withInsecure(insecure)
fn withKey(key)
fn withRegion(region)
fn withRoleARN(roleARN)
fn withUseSDKCreds(useSDKCreds)
obj storedWorkflowTemplateSpec.templateDefaults.archiveLocation.s3.accessKeySecret
obj storedWorkflowTemplateSpec.templateDefaults.archiveLocation.s3.createBucketIfNotPresent
obj storedWorkflowTemplateSpec.templateDefaults.archiveLocation.s3.secretKeySecret
obj storedWorkflowTemplateSpec.templateDefaults.container
fn 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 storedWorkflowTemplateSpec.templateDefaults.container.lifecycle
obj storedWorkflowTemplateSpec.templateDefaults.container.lifecycle.postStart
obj storedWorkflowTemplateSpec.templateDefaults.container.lifecycle.preStop
obj storedWorkflowTemplateSpec.templateDefaults.container.livenessProbe
fn withFailureThreshold(failureThreshold)
fn withInitialDelaySeconds(initialDelaySeconds)
fn withPeriodSeconds(periodSeconds)
fn withSuccessThreshold(successThreshold)
fn withTimeoutSeconds(timeoutSeconds)
obj storedWorkflowTemplateSpec.templateDefaults.container.livenessProbe.exec
obj storedWorkflowTemplateSpec.templateDefaults.container.livenessProbe.httpGet
obj storedWorkflowTemplateSpec.templateDefaults.container.livenessProbe.tcpSocket
obj storedWorkflowTemplateSpec.templateDefaults.container.readinessProbe
fn withFailureThreshold(failureThreshold)
fn withInitialDelaySeconds(initialDelaySeconds)
fn withPeriodSeconds(periodSeconds)
fn withSuccessThreshold(successThreshold)
fn withTimeoutSeconds(timeoutSeconds)
obj storedWorkflowTemplateSpec.templateDefaults.container.readinessProbe.exec
obj storedWorkflowTemplateSpec.templateDefaults.container.readinessProbe.httpGet
obj storedWorkflowTemplateSpec.templateDefaults.container.readinessProbe.tcpSocket
obj storedWorkflowTemplateSpec.templateDefaults.container.resources
obj storedWorkflowTemplateSpec.templateDefaults.container.securityContext
fn withAllowPrivilegeEscalation(allowPrivilegeEscalation)
fn withPrivileged(privileged)
fn withProcMount(procMount)
fn withReadOnlyRootFilesystem(readOnlyRootFilesystem)
fn withRunAsGroup(runAsGroup)
fn withRunAsNonRoot(runAsNonRoot)
fn withRunAsUser(runAsUser)
obj storedWorkflowTemplateSpec.templateDefaults.container.securityContext.capabilities
obj storedWorkflowTemplateSpec.templateDefaults.container.securityContext.seLinuxOptions
obj storedWorkflowTemplateSpec.templateDefaults.container.securityContext.windowsOptions
obj storedWorkflowTemplateSpec.templateDefaults.container.startupProbe
fn withFailureThreshold(failureThreshold)
fn withInitialDelaySeconds(initialDelaySeconds)
fn withPeriodSeconds(periodSeconds)
fn withSuccessThreshold(successThreshold)
fn withTimeoutSeconds(timeoutSeconds)
obj storedWorkflowTemplateSpec.templateDefaults.container.startupProbe.exec
obj storedWorkflowTemplateSpec.templateDefaults.container.startupProbe.httpGet
obj storedWorkflowTemplateSpec.templateDefaults.container.startupProbe.tcpSocket
obj storedWorkflowTemplateSpec.templateDefaults.containerSet
obj storedWorkflowTemplateSpec.templateDefaults.dag
obj storedWorkflowTemplateSpec.templateDefaults.data
fn withTransformation(transformation)
fn withTransformationMixin(transformation)
obj storedWorkflowTemplateSpec.templateDefaults.data.source
obj storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths
fn 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 storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.archive
obj storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.artifactory
obj storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.gcs
obj storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.git
fn withDepth(depth)
fn withDisableSubmodules(disableSubmodules)
fn withFetch(fetch)
fn withFetchMixin(fetch)
fn withInsecureIgnoreHostKey(insecureIgnoreHostKey)
fn withRepo(repo)
fn withRevision(revision)
obj storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.git.passwordSecret
obj storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.git.sshPrivateKeySecret
obj storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.git.usernameSecret
obj storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.hdfs
fn withAddresses(addresses)
fn withAddressesMixin(addresses)
fn withForce(force)
fn withHdfsUser(hdfsUser)
fn withKrbRealm(krbRealm)
fn withKrbServicePrincipalName(krbServicePrincipalName)
fn withKrbUsername(krbUsername)
fn withPath(path)
obj storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.hdfs.krbCCacheSecret
obj storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.hdfs.krbConfigConfigMap
obj storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.hdfs.krbKeytabSecret
obj storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.http
obj storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.oss
fn withBucket(bucket)
fn withCreateBucketIfNotPresent(createBucketIfNotPresent)
fn withEndpoint(endpoint)
fn withKey(key)
fn withSecurityToken(securityToken)
obj storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.oss.accessKeySecret
obj storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.oss.lifecycleRule
obj storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.oss.secretKeySecret
obj storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.raw
obj storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.s3
fn withBucket(bucket)
fn withEndpoint(endpoint)
fn withInsecure(insecure)
fn withKey(key)
fn withRegion(region)
fn withRoleARN(roleARN)
fn withUseSDKCreds(useSDKCreds)
obj storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.s3.accessKeySecret
obj storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.s3.createBucketIfNotPresent
obj storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.s3.secretKeySecret
obj storedWorkflowTemplateSpec.templateDefaults.executor
obj storedWorkflowTemplateSpec.templateDefaults.inputs
obj storedWorkflowTemplateSpec.templateDefaults.memoize
obj storedWorkflowTemplateSpec.templateDefaults.metadata
obj storedWorkflowTemplateSpec.templateDefaults.metrics
obj storedWorkflowTemplateSpec.templateDefaults.outputs
obj storedWorkflowTemplateSpec.templateDefaults.resource
obj storedWorkflowTemplateSpec.templateDefaults.retryStrategy
obj storedWorkflowTemplateSpec.templateDefaults.script
fn 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 storedWorkflowTemplateSpec.templateDefaults.script.lifecycle
obj storedWorkflowTemplateSpec.templateDefaults.script.lifecycle.postStart
obj storedWorkflowTemplateSpec.templateDefaults.script.lifecycle.preStop
obj storedWorkflowTemplateSpec.templateDefaults.script.livenessProbe
fn withFailureThreshold(failureThreshold)
fn withInitialDelaySeconds(initialDelaySeconds)
fn withPeriodSeconds(periodSeconds)
fn withSuccessThreshold(successThreshold)
fn withTimeoutSeconds(timeoutSeconds)
obj storedWorkflowTemplateSpec.templateDefaults.script.livenessProbe.exec
obj storedWorkflowTemplateSpec.templateDefaults.script.livenessProbe.httpGet
obj storedWorkflowTemplateSpec.templateDefaults.script.livenessProbe.tcpSocket
obj storedWorkflowTemplateSpec.templateDefaults.script.readinessProbe
fn withFailureThreshold(failureThreshold)
fn withInitialDelaySeconds(initialDelaySeconds)
fn withPeriodSeconds(periodSeconds)
fn withSuccessThreshold(successThreshold)
fn withTimeoutSeconds(timeoutSeconds)
obj storedWorkflowTemplateSpec.templateDefaults.script.readinessProbe.exec
obj storedWorkflowTemplateSpec.templateDefaults.script.readinessProbe.httpGet
obj storedWorkflowTemplateSpec.templateDefaults.script.readinessProbe.tcpSocket
obj storedWorkflowTemplateSpec.templateDefaults.script.resources
obj storedWorkflowTemplateSpec.templateDefaults.script.securityContext
fn withAllowPrivilegeEscalation(allowPrivilegeEscalation)
fn withPrivileged(privileged)
fn withProcMount(procMount)
fn withReadOnlyRootFilesystem(readOnlyRootFilesystem)
fn withRunAsGroup(runAsGroup)
fn withRunAsNonRoot(runAsNonRoot)
fn withRunAsUser(runAsUser)
obj storedWorkflowTemplateSpec.templateDefaults.script.securityContext.capabilities
obj storedWorkflowTemplateSpec.templateDefaults.script.securityContext.seLinuxOptions
obj storedWorkflowTemplateSpec.templateDefaults.script.securityContext.windowsOptions
obj storedWorkflowTemplateSpec.templateDefaults.script.startupProbe
fn withFailureThreshold(failureThreshold)
fn withInitialDelaySeconds(initialDelaySeconds)
fn withPeriodSeconds(periodSeconds)
fn withSuccessThreshold(successThreshold)
fn withTimeoutSeconds(timeoutSeconds)
obj storedWorkflowTemplateSpec.templateDefaults.script.startupProbe.exec
obj storedWorkflowTemplateSpec.templateDefaults.script.startupProbe.httpGet
obj storedWorkflowTemplateSpec.templateDefaults.script.startupProbe.tcpSocket
obj storedWorkflowTemplateSpec.templateDefaults.securityContext
fn withFsGroup(fsGroup)
fn withRunAsGroup(runAsGroup)
fn withRunAsNonRoot(runAsNonRoot)
fn withRunAsUser(runAsUser)
fn withSupplementalGroups(supplementalGroups)
fn withSupplementalGroupsMixin(supplementalGroups)
fn withSysctls(sysctls)
fn withSysctlsMixin(sysctls)
obj storedWorkflowTemplateSpec.templateDefaults.securityContext.seLinuxOptions
obj storedWorkflowTemplateSpec.templateDefaults.securityContext.windowsOptions
obj storedWorkflowTemplateSpec.templateDefaults.suspend
obj storedWorkflowTemplateSpec.templateDefaults.synchronization
obj storedWorkflowTemplateSpec.ttlStrategy
obj storedWorkflowTemplateSpec.volumeClaimGC
obj storedWorkflowTemplateSpec.workflowTemplateRef
obj synchronization
Fields
fn withCompressedNodes
withCompressedNodes(compressedNodes)
"Compressed and base64 decoded Nodes map"
fn withConditions
withConditions(conditions)
"Conditions is a list of conditions the Workflow may have"
fn withConditionsMixin
withConditionsMixin(conditions)
"Conditions is a list of conditions the Workflow may have"
Note: This function appends passed data to existing values
fn withEstimatedDuration
withEstimatedDuration(estimatedDuration)
"EstimatedDuration in seconds."
fn withFinishedAt
withFinishedAt(finishedAt)
"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."
fn withMessage
withMessage(message)
"A human readable message indicating details about why the workflow is in this condition."
fn withNodes
withNodes(nodes)
"Nodes is a mapping between a node ID and the node's status."
fn withNodesMixin
withNodesMixin(nodes)
"Nodes is a mapping between a node ID and the node's status."
Note: This function appends passed data to existing values
fn withOffloadNodeStatusVersion
withOffloadNodeStatusVersion(offloadNodeStatusVersion)
"Whether on not node status has been offloaded to a database. If exists, then Nodes and CompressedNodes will be empty. This will actually be populated with a hash of the offloaded data."
fn withPersistentVolumeClaims
withPersistentVolumeClaims(persistentVolumeClaims)
"PersistentVolumeClaims tracks all PVCs that were created as part of the io.argoproj.workflow.v1alpha1. The contents of this list are drained at the end of the workflow."
fn withPersistentVolumeClaimsMixin
withPersistentVolumeClaimsMixin(persistentVolumeClaims)
"PersistentVolumeClaims tracks all PVCs that were created as part of the io.argoproj.workflow.v1alpha1. The contents of this list are drained at the end of the workflow."
Note: This function appends passed data to existing values
fn withPhase
withPhase(phase)
"Phase a simple, high-level summary of where the workflow is in its lifecycle."
fn withProgress
withProgress(progress)
"Progress to completion"
fn withResourcesDuration
withResourcesDuration(resourcesDuration)
"ResourcesDuration is the total for the workflow"
fn withResourcesDurationMixin
withResourcesDurationMixin(resourcesDuration)
"ResourcesDuration is the total for the workflow"
Note: This function appends passed data to existing values
fn withStartedAt
withStartedAt(startedAt)
"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."
fn withStoredTemplates
withStoredTemplates(storedTemplates)
"StoredTemplates is a mapping between a template ref and the node's status."
fn withStoredTemplatesMixin
withStoredTemplatesMixin(storedTemplates)
"StoredTemplates is a mapping between a template ref and the node's status."
Note: This function appends passed data to existing values
obj artifactRepositoryRef
fn artifactRepositoryRef.withConfigMap
withConfigMap(configMap)
"The name of the config map. Defaults to \"artifact-repositories\"."
fn artifactRepositoryRef.withDefault
withDefault(default)
"If this ref represents the default artifact repository, rather than a config map."
fn artifactRepositoryRef.withKey
withKey(key)
"The config map key. Defaults to the value of the \"workflows.argoproj.io/default-artifact-repository\" annotation."
fn artifactRepositoryRef.withNamespace
withNamespace(namespace)
"The namespace of the config map. Defaults to the workflow's namespace, or the controller's namespace (if found)."
obj artifactRepositoryRef.artifactRepository
"ArtifactRepository represents an artifact repository in which a controller will store its artifacts"
fn artifactRepositoryRef.artifactRepository.withArchiveLogs
withArchiveLogs(archiveLogs)
"ArchiveLogs enables log archiving"
obj artifactRepositoryRef.artifactRepository.artifactory
"ArtifactoryArtifactRepository defines the controller configuration for an artifactory artifact repository"
fn artifactRepositoryRef.artifactRepository.artifactory.withRepoURL
withRepoURL(repoURL)
"RepoURL is the url for artifactory repo."
obj artifactRepositoryRef.artifactRepository.artifactory.passwordSecret
"SecretKeySelector selects a key of a Secret."
fn artifactRepositoryRef.artifactRepository.artifactory.passwordSecret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn artifactRepositoryRef.artifactRepository.artifactory.passwordSecret.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn artifactRepositoryRef.artifactRepository.artifactory.passwordSecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj artifactRepositoryRef.artifactRepository.artifactory.usernameSecret
"SecretKeySelector selects a key of a Secret."
fn artifactRepositoryRef.artifactRepository.artifactory.usernameSecret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn artifactRepositoryRef.artifactRepository.artifactory.usernameSecret.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn artifactRepositoryRef.artifactRepository.artifactory.usernameSecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj artifactRepositoryRef.artifactRepository.gcs
"GCSArtifactRepository defines the controller configuration for a GCS artifact repository"
fn artifactRepositoryRef.artifactRepository.gcs.withBucket
withBucket(bucket)
"Bucket is the name of the bucket"
fn artifactRepositoryRef.artifactRepository.gcs.withKeyFormat
withKeyFormat(keyFormat)
"KeyFormat is defines the format of how to store keys. Can reference workflow variables"
obj artifactRepositoryRef.artifactRepository.gcs.serviceAccountKeySecret
"SecretKeySelector selects a key of a Secret."
fn artifactRepositoryRef.artifactRepository.gcs.serviceAccountKeySecret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn artifactRepositoryRef.artifactRepository.gcs.serviceAccountKeySecret.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn artifactRepositoryRef.artifactRepository.gcs.serviceAccountKeySecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj artifactRepositoryRef.artifactRepository.hdfs
"HDFSArtifactRepository defines the controller configuration for an HDFS artifact repository"
fn artifactRepositoryRef.artifactRepository.hdfs.withAddresses
withAddresses(addresses)
"Addresses is accessible addresses of HDFS name nodes"
fn artifactRepositoryRef.artifactRepository.hdfs.withAddressesMixin
withAddressesMixin(addresses)
"Addresses is accessible addresses of HDFS name nodes"
Note: This function appends passed data to existing values
fn artifactRepositoryRef.artifactRepository.hdfs.withForce
withForce(force)
"Force copies a file forcibly even if it exists (default: false)"
fn artifactRepositoryRef.artifactRepository.hdfs.withHdfsUser
withHdfsUser(hdfsUser)
"HDFSUser is the user to access HDFS file system. It is ignored if either ccache or keytab is used."
fn artifactRepositoryRef.artifactRepository.hdfs.withKrbRealm
withKrbRealm(krbRealm)
"KrbRealm is the Kerberos realm used with Kerberos keytab It must be set if keytab is used."
fn artifactRepositoryRef.artifactRepository.hdfs.withKrbServicePrincipalName
withKrbServicePrincipalName(krbServicePrincipalName)
"KrbServicePrincipalName is the principal name of Kerberos service It must be set if either ccache or keytab is used."
fn artifactRepositoryRef.artifactRepository.hdfs.withKrbUsername
withKrbUsername(krbUsername)
"KrbUsername is the Kerberos username used with Kerberos keytab It must be set if keytab is used."
fn artifactRepositoryRef.artifactRepository.hdfs.withPathFormat
withPathFormat(pathFormat)
"PathFormat is defines the format of path to store a file. Can reference workflow variables"
obj artifactRepositoryRef.artifactRepository.hdfs.krbCCacheSecret
"SecretKeySelector selects a key of a Secret."
fn artifactRepositoryRef.artifactRepository.hdfs.krbCCacheSecret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn artifactRepositoryRef.artifactRepository.hdfs.krbCCacheSecret.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn artifactRepositoryRef.artifactRepository.hdfs.krbCCacheSecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj artifactRepositoryRef.artifactRepository.hdfs.krbConfigConfigMap
"Selects a key from a ConfigMap."
fn artifactRepositoryRef.artifactRepository.hdfs.krbConfigConfigMap.withKey
withKey(key)
"The key to select."
fn artifactRepositoryRef.artifactRepository.hdfs.krbConfigConfigMap.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn artifactRepositoryRef.artifactRepository.hdfs.krbConfigConfigMap.withOptional
withOptional(optional)
"Specify whether the ConfigMap or its key must be defined"
obj artifactRepositoryRef.artifactRepository.hdfs.krbKeytabSecret
"SecretKeySelector selects a key of a Secret."
fn artifactRepositoryRef.artifactRepository.hdfs.krbKeytabSecret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn artifactRepositoryRef.artifactRepository.hdfs.krbKeytabSecret.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn artifactRepositoryRef.artifactRepository.hdfs.krbKeytabSecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj artifactRepositoryRef.artifactRepository.oss
"OSSArtifactRepository defines the controller configuration for an OSS artifact repository"
fn artifactRepositoryRef.artifactRepository.oss.withBucket
withBucket(bucket)
"Bucket is the name of the bucket"
fn artifactRepositoryRef.artifactRepository.oss.withCreateBucketIfNotPresent
withCreateBucketIfNotPresent(createBucketIfNotPresent)
"CreateBucketIfNotPresent tells the driver to attempt to create the OSS bucket for output artifacts, if it doesn't exist"
fn artifactRepositoryRef.artifactRepository.oss.withEndpoint
withEndpoint(endpoint)
"Endpoint is the hostname of the bucket endpoint"
fn artifactRepositoryRef.artifactRepository.oss.withKeyFormat
withKeyFormat(keyFormat)
"KeyFormat is defines the format of how to store keys. Can reference workflow variables"
fn artifactRepositoryRef.artifactRepository.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 artifactRepositoryRef.artifactRepository.oss.accessKeySecret
"SecretKeySelector selects a key of a Secret."
fn artifactRepositoryRef.artifactRepository.oss.accessKeySecret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn artifactRepositoryRef.artifactRepository.oss.accessKeySecret.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn artifactRepositoryRef.artifactRepository.oss.accessKeySecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj artifactRepositoryRef.artifactRepository.oss.lifecycleRule
"OSSLifecycleRule specifies how to manage bucket's lifecycle"
fn artifactRepositoryRef.artifactRepository.oss.lifecycleRule.withMarkDeletionAfterDays
withMarkDeletionAfterDays(markDeletionAfterDays)
"MarkDeletionAfterDays is the number of days before we delete objects in the bucket"
fn artifactRepositoryRef.artifactRepository.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 artifactRepositoryRef.artifactRepository.oss.secretKeySecret
"SecretKeySelector selects a key of a Secret."
fn artifactRepositoryRef.artifactRepository.oss.secretKeySecret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn artifactRepositoryRef.artifactRepository.oss.secretKeySecret.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn artifactRepositoryRef.artifactRepository.oss.secretKeySecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj artifactRepositoryRef.artifactRepository.s3
"S3ArtifactRepository defines the controller configuration for an S3 artifact repository"
fn artifactRepositoryRef.artifactRepository.s3.withBucket
withBucket(bucket)
"Bucket is the name of the bucket"
fn artifactRepositoryRef.artifactRepository.s3.withEndpoint
withEndpoint(endpoint)
"Endpoint is the hostname of the bucket endpoint"
fn artifactRepositoryRef.artifactRepository.s3.withInsecure
withInsecure(insecure)
"Insecure will connect to the service with TLS"
fn artifactRepositoryRef.artifactRepository.s3.withKeyFormat
withKeyFormat(keyFormat)
"KeyFormat is defines the format of how to store keys. Can reference workflow variables"
fn artifactRepositoryRef.artifactRepository.s3.withKeyPrefix
withKeyPrefix(keyPrefix)
"KeyPrefix is prefix used as part of the bucket key in which the controller will store artifacts. DEPRECATED. Use KeyFormat instead"
fn artifactRepositoryRef.artifactRepository.s3.withRegion
withRegion(region)
"Region contains the optional bucket region"
fn artifactRepositoryRef.artifactRepository.s3.withRoleARN
withRoleARN(roleARN)
"RoleARN is the Amazon Resource Name (ARN) of the role to assume."
fn artifactRepositoryRef.artifactRepository.s3.withUseSDKCreds
withUseSDKCreds(useSDKCreds)
"UseSDKCreds tells the driver to figure out credentials based on sdk defaults."
obj artifactRepositoryRef.artifactRepository.s3.accessKeySecret
"SecretKeySelector selects a key of a Secret."
fn artifactRepositoryRef.artifactRepository.s3.accessKeySecret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn artifactRepositoryRef.artifactRepository.s3.accessKeySecret.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn artifactRepositoryRef.artifactRepository.s3.accessKeySecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj artifactRepositoryRef.artifactRepository.s3.createBucketIfNotPresent
"CreateS3BucketOptions options used to determine automatic automatic bucket-creation process"
fn artifactRepositoryRef.artifactRepository.s3.createBucketIfNotPresent.withObjectLocking
withObjectLocking(objectLocking)
"ObjectLocking Enable object locking"
obj artifactRepositoryRef.artifactRepository.s3.secretKeySecret
"SecretKeySelector selects a key of a Secret."
fn artifactRepositoryRef.artifactRepository.s3.secretKeySecret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn artifactRepositoryRef.artifactRepository.s3.secretKeySecret.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn artifactRepositoryRef.artifactRepository.s3.secretKeySecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj outputs
"Outputs hold parameters, artifacts, and results from a step"
fn outputs.withArtifacts
withArtifacts(artifacts)
"Artifacts holds the list of output artifacts produced by a step"
fn 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 outputs.withExitCode
withExitCode(exitCode)
"ExitCode holds the exit code of a script template"
fn outputs.withParameters
withParameters(parameters)
"Parameters holds the list of output parameters produced by a step"
fn 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 outputs.withResult
withResult(result)
"Result holds the result (stdout) of a script template"
obj storedWorkflowTemplateSpec
"WorkflowSpec is the specification of a Workflow."
fn storedWorkflowTemplateSpec.withActiveDeadlineSeconds
withActiveDeadlineSeconds(activeDeadlineSeconds)
"Optional duration in seconds relative to the workflow start time which the workflow is allowed to run before the controller terminates the io.argoproj.workflow.v1alpha1. A value of zero is used to terminate a Running workflow"
fn storedWorkflowTemplateSpec.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 storedWorkflowTemplateSpec.withDnsPolicy
withDnsPolicy(dnsPolicy)
"Set DNS policy for the pod. Defaults to \"ClusterFirst\". Valid values are 'ClusterFirstWithHostNet', 'ClusterFirst', 'Default' or 'None'. DNS parameters given in DNSConfig will be merged with the policy selected with DNSPolicy. To have DNS options set along with hostNetwork, you have to specify DNS policy explicitly to 'ClusterFirstWithHostNet'."
fn storedWorkflowTemplateSpec.withEntrypoint
withEntrypoint(entrypoint)
"Entrypoint is a template reference to the starting point of the io.argoproj.workflow.v1alpha1."
fn storedWorkflowTemplateSpec.withHostAliases
withHostAliases(hostAliases)
fn storedWorkflowTemplateSpec.withHostAliasesMixin
withHostAliasesMixin(hostAliases)
Note: This function appends passed data to existing values
fn storedWorkflowTemplateSpec.withHostNetwork
withHostNetwork(hostNetwork)
"Host networking requested for this workflow pod. Default to false."
fn storedWorkflowTemplateSpec.withImagePullSecrets
withImagePullSecrets(imagePullSecrets)
"ImagePullSecrets is a list of references to secrets in the same namespace to use for pulling any images in pods that reference this ServiceAccount. ImagePullSecrets are distinct from Secrets because Secrets can be mounted in the pod, but ImagePullSecrets are only accessed by the kubelet. More info: https://kubernetes.io/docs/concepts/containers/images/#specifying-imagepullsecrets-on-a-pod"
fn storedWorkflowTemplateSpec.withImagePullSecretsMixin
withImagePullSecretsMixin(imagePullSecrets)
"ImagePullSecrets is a list of references to secrets in the same namespace to use for pulling any images in pods that reference this ServiceAccount. ImagePullSecrets are distinct from Secrets because Secrets can be mounted in the pod, but ImagePullSecrets are only accessed by the kubelet. More info: https://kubernetes.io/docs/concepts/containers/images/#specifying-imagepullsecrets-on-a-pod"
Note: This function appends passed data to existing values
fn storedWorkflowTemplateSpec.withNodeSelector
withNodeSelector(nodeSelector)
"NodeSelector is a selector which will result in all pods of the workflow to be scheduled on the selected node(s). This is able to be overridden by a nodeSelector specified in the template."
fn storedWorkflowTemplateSpec.withNodeSelectorMixin
withNodeSelectorMixin(nodeSelector)
"NodeSelector is a selector which will result in all pods of the workflow to be scheduled on the selected node(s). This is able to be overridden by a nodeSelector specified in the template."
Note: This function appends passed data to existing values
fn storedWorkflowTemplateSpec.withOnExit
withOnExit(onExit)
"OnExit is a template reference which is invoked at the end of the workflow, irrespective of the success, failure, or error of the primary io.argoproj.workflow.v1alpha1."
fn storedWorkflowTemplateSpec.withParallelism
withParallelism(parallelism)
"Parallelism limits the max total parallel pods that can execute at the same time in a workflow"
fn storedWorkflowTemplateSpec.withPodPriority
withPodPriority(podPriority)
"Priority to apply to workflow pods."
fn storedWorkflowTemplateSpec.withPodPriorityClassName
withPodPriorityClassName(podPriorityClassName)
"PriorityClassName to apply to workflow pods."
fn storedWorkflowTemplateSpec.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 storedWorkflowTemplateSpec.withPriority
withPriority(priority)
"Priority is used if controller is configured to process limited number of workflows in parallel. Workflows with higher priority are processed first."
fn storedWorkflowTemplateSpec.withSchedulerName
withSchedulerName(schedulerName)
"Set scheduler name for all pods. Will be overridden if container/script template's scheduler name is set. Default scheduler will be used if neither specified."
fn storedWorkflowTemplateSpec.withServiceAccountName
withServiceAccountName(serviceAccountName)
"ServiceAccountName is the name of the ServiceAccount to run all pods of the workflow as."
fn storedWorkflowTemplateSpec.withShutdown
withShutdown(shutdown)
"Shutdown will shutdown the workflow according to its ShutdownStrategy"
fn storedWorkflowTemplateSpec.withSuspend
withSuspend(suspend)
"Suspend will suspend the workflow and prevent execution of any future steps in the workflow"
fn storedWorkflowTemplateSpec.withTemplates
withTemplates(templates)
"Templates is a list of workflow templates used in a workflow"
fn storedWorkflowTemplateSpec.withTemplatesMixin
withTemplatesMixin(templates)
"Templates is a list of workflow templates used in a workflow"
Note: This function appends passed data to existing values
fn storedWorkflowTemplateSpec.withTolerations
withTolerations(tolerations)
"Tolerations to apply to workflow pods."
fn storedWorkflowTemplateSpec.withTolerationsMixin
withTolerationsMixin(tolerations)
"Tolerations to apply to workflow pods."
Note: This function appends passed data to existing values
fn storedWorkflowTemplateSpec.withVolumeClaimTemplates
withVolumeClaimTemplates(volumeClaimTemplates)
"VolumeClaimTemplates is a list of claims that containers are allowed to reference. The Workflow controller will create the claims at the beginning of the workflow and delete the claims upon completion of the workflow"
fn storedWorkflowTemplateSpec.withVolumeClaimTemplatesMixin
withVolumeClaimTemplatesMixin(volumeClaimTemplates)
"VolumeClaimTemplates is a list of claims that containers are allowed to reference. The Workflow controller will create the claims at the beginning of the workflow and delete the claims upon completion of the workflow"
Note: This function appends passed data to existing values
fn storedWorkflowTemplateSpec.withVolumes
withVolumes(volumes)
"Volumes is a list of volumes that can be mounted by containers in a io.argoproj.workflow.v1alpha1."
fn storedWorkflowTemplateSpec.withVolumesMixin
withVolumesMixin(volumes)
"Volumes is a list of volumes that can be mounted by containers in a io.argoproj.workflow.v1alpha1."
Note: This function appends passed data to existing values
obj storedWorkflowTemplateSpec.affinity
"Affinity is a group of affinity scheduling rules."
obj storedWorkflowTemplateSpec.affinity.nodeAffinity
"Node affinity is a group of node affinity scheduling rules."
fn storedWorkflowTemplateSpec.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 storedWorkflowTemplateSpec.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 storedWorkflowTemplateSpec.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 storedWorkflowTemplateSpec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.withNodeSelectorTerms
withNodeSelectorTerms(nodeSelectorTerms)
"Required. A list of node selector terms. The terms are ORed."
fn storedWorkflowTemplateSpec.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 storedWorkflowTemplateSpec.affinity.podAffinity
"Pod affinity is a group of inter pod affinity scheduling rules."
fn storedWorkflowTemplateSpec.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 storedWorkflowTemplateSpec.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 storedWorkflowTemplateSpec.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 storedWorkflowTemplateSpec.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 storedWorkflowTemplateSpec.affinity.podAntiAffinity
"Pod anti affinity is a group of inter pod anti affinity scheduling rules."
fn storedWorkflowTemplateSpec.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 storedWorkflowTemplateSpec.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 storedWorkflowTemplateSpec.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 storedWorkflowTemplateSpec.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 storedWorkflowTemplateSpec.arguments
"Arguments to a template"
fn storedWorkflowTemplateSpec.arguments.withArtifacts
withArtifacts(artifacts)
"Artifacts is the list of artifacts to pass to the template or workflow"
fn storedWorkflowTemplateSpec.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 storedWorkflowTemplateSpec.arguments.withParameters
withParameters(parameters)
"Parameters is the list of parameters to pass to the template or workflow"
fn storedWorkflowTemplateSpec.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 storedWorkflowTemplateSpec.artifactRepositoryRef
fn storedWorkflowTemplateSpec.artifactRepositoryRef.withConfigMap
withConfigMap(configMap)
"The name of the config map. Defaults to \"artifact-repositories\"."
fn storedWorkflowTemplateSpec.artifactRepositoryRef.withKey
withKey(key)
"The config map key. Defaults to the value of the \"workflows.argoproj.io/default-artifact-repository\" annotation."
obj storedWorkflowTemplateSpec.dnsConfig
"PodDNSConfig defines the DNS parameters of a pod in addition to those generated from DNSPolicy."
fn storedWorkflowTemplateSpec.dnsConfig.withNameservers
withNameservers(nameservers)
"A list of DNS name server IP addresses. This will be appended to the base nameservers generated from DNSPolicy. Duplicated nameservers will be removed."
fn storedWorkflowTemplateSpec.dnsConfig.withNameserversMixin
withNameserversMixin(nameservers)
"A list of DNS name server IP addresses. This will be appended to the base nameservers generated from DNSPolicy. Duplicated nameservers will be removed."
Note: This function appends passed data to existing values
fn storedWorkflowTemplateSpec.dnsConfig.withOptions
withOptions(options)
"A list of DNS resolver options. This will be merged with the base options generated from DNSPolicy. Duplicated entries will be removed. Resolution options given in Options will override those that appear in the base DNSPolicy."
fn storedWorkflowTemplateSpec.dnsConfig.withOptionsMixin
withOptionsMixin(options)
"A list of DNS resolver options. This will be merged with the base options generated from DNSPolicy. Duplicated entries will be removed. Resolution options given in Options will override those that appear in the base DNSPolicy."
Note: This function appends passed data to existing values
fn storedWorkflowTemplateSpec.dnsConfig.withSearches
withSearches(searches)
"A list of DNS search domains for host-name lookup. This will be appended to the base search paths generated from DNSPolicy. Duplicated search paths will be removed."
fn storedWorkflowTemplateSpec.dnsConfig.withSearchesMixin
withSearchesMixin(searches)
"A list of DNS search domains for host-name lookup. This will be appended to the base search paths generated from DNSPolicy. Duplicated search paths will be removed."
Note: This function appends passed data to existing values
obj storedWorkflowTemplateSpec.executor
"ExecutorConfig holds configurations of an executor container."
fn storedWorkflowTemplateSpec.executor.withServiceAccountName
withServiceAccountName(serviceAccountName)
"ServiceAccountName specifies the service account name of the executor container."
obj storedWorkflowTemplateSpec.metrics
"Metrics are a list of metrics emitted from a Workflow/Template"
fn storedWorkflowTemplateSpec.metrics.withPrometheus
withPrometheus(prometheus)
"Prometheus is a list of prometheus metrics to be emitted"
fn storedWorkflowTemplateSpec.metrics.withPrometheusMixin
withPrometheusMixin(prometheus)
"Prometheus is a list of prometheus metrics to be emitted"
Note: This function appends passed data to existing values
obj storedWorkflowTemplateSpec.podDisruptionBudget
"PodDisruptionBudgetSpec is a description of a PodDisruptionBudget."
fn storedWorkflowTemplateSpec.podDisruptionBudget.withMaxUnavailable
withMaxUnavailable(maxUnavailable)
fn storedWorkflowTemplateSpec.podDisruptionBudget.withMinAvailable
withMinAvailable(minAvailable)
obj storedWorkflowTemplateSpec.podDisruptionBudget.selector
"A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects."
fn storedWorkflowTemplateSpec.podDisruptionBudget.selector.withMatchExpressions
withMatchExpressions(matchExpressions)
"matchExpressions is a list of label selector requirements. The requirements are ANDed."
fn storedWorkflowTemplateSpec.podDisruptionBudget.selector.withMatchExpressionsMixin
withMatchExpressionsMixin(matchExpressions)
"matchExpressions is a list of label selector requirements. The requirements are ANDed."
Note: This function appends passed data to existing values
fn storedWorkflowTemplateSpec.podDisruptionBudget.selector.withMatchLabels
withMatchLabels(matchLabels)
"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is \"key\", the operator is \"In\", and the values array contains only \"value\". The requirements are ANDed."
fn storedWorkflowTemplateSpec.podDisruptionBudget.selector.withMatchLabelsMixin
withMatchLabelsMixin(matchLabels)
"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is \"key\", the operator is \"In\", and the values array contains only \"value\". The requirements are ANDed."
Note: This function appends passed data to existing values
obj storedWorkflowTemplateSpec.podGC
"PodGC describes how to delete completed pods as they complete"
fn storedWorkflowTemplateSpec.podGC.withStrategy
withStrategy(strategy)
"Strategy is the strategy to use. One of \"OnPodCompletion\", \"OnPodSuccess\", \"OnWorkflowCompletion\", \"OnWorkflowSuccess\
obj storedWorkflowTemplateSpec.podGC.labelSelector
"A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects."
fn storedWorkflowTemplateSpec.podGC.labelSelector.withMatchExpressions
withMatchExpressions(matchExpressions)
"matchExpressions is a list of label selector requirements. The requirements are ANDed."
fn storedWorkflowTemplateSpec.podGC.labelSelector.withMatchExpressionsMixin
withMatchExpressionsMixin(matchExpressions)
"matchExpressions is a list of label selector requirements. The requirements are ANDed."
Note: This function appends passed data to existing values
fn storedWorkflowTemplateSpec.podGC.labelSelector.withMatchLabels
withMatchLabels(matchLabels)
"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is \"key\", the operator is \"In\", and the values array contains only \"value\". The requirements are ANDed."
fn storedWorkflowTemplateSpec.podGC.labelSelector.withMatchLabelsMixin
withMatchLabelsMixin(matchLabels)
"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is \"key\", the operator is \"In\", and the values array contains only \"value\". The requirements are ANDed."
Note: This function appends passed data to existing values
obj storedWorkflowTemplateSpec.podMetadata
"Pod metdata"
fn storedWorkflowTemplateSpec.podMetadata.withAnnotations
withAnnotations(annotations)
fn storedWorkflowTemplateSpec.podMetadata.withAnnotationsMixin
withAnnotationsMixin(annotations)
Note: This function appends passed data to existing values
fn storedWorkflowTemplateSpec.podMetadata.withLabels
withLabels(labels)
fn storedWorkflowTemplateSpec.podMetadata.withLabelsMixin
withLabelsMixin(labels)
Note: This function appends passed data to existing values
obj storedWorkflowTemplateSpec.retryStrategy
"RetryStrategy provides controls on how to retry a workflow step"
fn storedWorkflowTemplateSpec.retryStrategy.withLimit
withLimit(limit)
fn storedWorkflowTemplateSpec.retryStrategy.withRetryPolicy
withRetryPolicy(retryPolicy)
"RetryPolicy is a policy of NodePhase statuses that will be retried"
obj storedWorkflowTemplateSpec.retryStrategy.affinity
"RetryAffinity prevents running steps on the same host."
fn storedWorkflowTemplateSpec.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 storedWorkflowTemplateSpec.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 storedWorkflowTemplateSpec.retryStrategy.backoff
"Backoff is a backoff strategy to use within retryStrategy"
fn storedWorkflowTemplateSpec.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 storedWorkflowTemplateSpec.retryStrategy.backoff.withFactor
withFactor(factor)
fn storedWorkflowTemplateSpec.retryStrategy.backoff.withMaxDuration
withMaxDuration(maxDuration)
"MaxDuration is the maximum amount of time allowed for the backoff strategy"
obj storedWorkflowTemplateSpec.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 storedWorkflowTemplateSpec.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 storedWorkflowTemplateSpec.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 storedWorkflowTemplateSpec.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 storedWorkflowTemplateSpec.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 storedWorkflowTemplateSpec.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 storedWorkflowTemplateSpec.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 storedWorkflowTemplateSpec.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 storedWorkflowTemplateSpec.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 storedWorkflowTemplateSpec.securityContext.seLinuxOptions
"SELinuxOptions are the labels to be applied to the container"
fn storedWorkflowTemplateSpec.securityContext.seLinuxOptions.withLevel
withLevel(level)
"Level is SELinux level label that applies to the container."
fn storedWorkflowTemplateSpec.securityContext.seLinuxOptions.withRole
withRole(role)
"Role is a SELinux role label that applies to the container."
fn storedWorkflowTemplateSpec.securityContext.seLinuxOptions.withType
withType(type)
"Type is a SELinux type label that applies to the container."
fn storedWorkflowTemplateSpec.securityContext.seLinuxOptions.withUser
withUser(user)
"User is a SELinux user label that applies to the container."
obj storedWorkflowTemplateSpec.securityContext.windowsOptions
"WindowsSecurityContextOptions contain Windows-specific options and credentials."
fn storedWorkflowTemplateSpec.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 storedWorkflowTemplateSpec.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 storedWorkflowTemplateSpec.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 storedWorkflowTemplateSpec.synchronization
"Synchronization holds synchronization lock configuration"
obj storedWorkflowTemplateSpec.synchronization.mutex
"Mutex holds Mutex configuration"
fn storedWorkflowTemplateSpec.synchronization.mutex.withName
withName(name)
"name of the mutex"
obj storedWorkflowTemplateSpec.synchronization.semaphore
"SemaphoreRef is a reference of Semaphore"
obj storedWorkflowTemplateSpec.synchronization.semaphore.configMapKeyRef
"Selects a key from a ConfigMap."
fn storedWorkflowTemplateSpec.synchronization.semaphore.configMapKeyRef.withKey
withKey(key)
"The key to select."
fn storedWorkflowTemplateSpec.synchronization.semaphore.configMapKeyRef.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn storedWorkflowTemplateSpec.synchronization.semaphore.configMapKeyRef.withOptional
withOptional(optional)
"Specify whether the ConfigMap or its key must be defined"
obj storedWorkflowTemplateSpec.templateDefaults
"Template is a reusable and composable unit of execution in a workflow"
fn storedWorkflowTemplateSpec.templateDefaults.withActiveDeadlineSeconds
withActiveDeadlineSeconds(activeDeadlineSeconds)
fn storedWorkflowTemplateSpec.templateDefaults.withAutomountServiceAccountToken
withAutomountServiceAccountToken(automountServiceAccountToken)
"AutomountServiceAccountToken indicates whether a service account token should be automatically mounted in pods. ServiceAccountName of ExecutorConfig must be specified if this value is false."
fn storedWorkflowTemplateSpec.templateDefaults.withDaemon
withDaemon(daemon)
"Deamon will allow a workflow to proceed to the next step so long as the container reaches readiness"
fn storedWorkflowTemplateSpec.templateDefaults.withFailFast
withFailFast(failFast)
"FailFast, if specified, will fail this template if any of its child pods has failed. This is useful for when this template is expanded with withItems
, etc."
fn storedWorkflowTemplateSpec.templateDefaults.withHostAliases
withHostAliases(hostAliases)
"HostAliases is an optional list of hosts and IPs that will be injected into the pod spec"
fn storedWorkflowTemplateSpec.templateDefaults.withHostAliasesMixin
withHostAliasesMixin(hostAliases)
"HostAliases is an optional list of hosts and IPs that will be injected into the pod spec"
Note: This function appends passed data to existing values
fn storedWorkflowTemplateSpec.templateDefaults.withInitContainers
withInitContainers(initContainers)
"InitContainers is a list of containers which run before the main container."
fn storedWorkflowTemplateSpec.templateDefaults.withInitContainersMixin
withInitContainersMixin(initContainers)
"InitContainers is a list of containers which run before the main container."
Note: This function appends passed data to existing values
fn storedWorkflowTemplateSpec.templateDefaults.withName
withName(name)
"Name is the name of the template"
fn storedWorkflowTemplateSpec.templateDefaults.withNodeSelector
withNodeSelector(nodeSelector)
"NodeSelector is a selector to schedule this step of the workflow to be run on the selected node(s). Overrides the selector set at the workflow level."
fn storedWorkflowTemplateSpec.templateDefaults.withNodeSelectorMixin
withNodeSelectorMixin(nodeSelector)
"NodeSelector is a selector to schedule this step of the workflow to be run on the selected node(s). Overrides the selector set at the workflow level."
Note: This function appends passed data to existing values
fn storedWorkflowTemplateSpec.templateDefaults.withParallelism
withParallelism(parallelism)
"Parallelism limits the max total parallel pods that can execute at the same time within the boundaries of this template invocation. If additional steps/dag templates are invoked, the pods created by those templates will not be counted towards this total."
fn storedWorkflowTemplateSpec.templateDefaults.withPodSpecPatch
withPodSpecPatch(podSpecPatch)
"PodSpecPatch holds strategic merge patch to apply against the pod spec. Allows parameterization of container fields which are not strings (e.g. resource limits)."
fn storedWorkflowTemplateSpec.templateDefaults.withPriority
withPriority(priority)
"Priority to apply to workflow pods."
fn storedWorkflowTemplateSpec.templateDefaults.withPriorityClassName
withPriorityClassName(priorityClassName)
"PriorityClassName to apply to workflow pods."
fn storedWorkflowTemplateSpec.templateDefaults.withSchedulerName
withSchedulerName(schedulerName)
"If specified, the pod will be dispatched by specified scheduler. Or it will be dispatched by workflow scope scheduler if specified. If neither specified, the pod will be dispatched by default scheduler."
fn storedWorkflowTemplateSpec.templateDefaults.withServiceAccountName
withServiceAccountName(serviceAccountName)
"ServiceAccountName to apply to workflow pods"
fn storedWorkflowTemplateSpec.templateDefaults.withSidecars
withSidecars(sidecars)
"Sidecars is a list of containers which run alongside the main container Sidecars are automatically killed when the main container completes"
fn storedWorkflowTemplateSpec.templateDefaults.withSidecarsMixin
withSidecarsMixin(sidecars)
"Sidecars is a list of containers which run alongside the main container Sidecars are automatically killed when the main container completes"
Note: This function appends passed data to existing values
fn storedWorkflowTemplateSpec.templateDefaults.withSteps
withSteps(steps)
"Steps define a series of sequential/parallel workflow steps"
fn storedWorkflowTemplateSpec.templateDefaults.withStepsMixin
withStepsMixin(steps)
"Steps define a series of sequential/parallel workflow steps"
Note: This function appends passed data to existing values
fn storedWorkflowTemplateSpec.templateDefaults.withTimeout
withTimeout(timeout)
"Timout allows to set the total node execution timeout duration counting from the node's start time. This duration also includes time in which the node spends in Pending state. This duration may not be applied to Step or DAG templates."
fn storedWorkflowTemplateSpec.templateDefaults.withTolerations
withTolerations(tolerations)
"Tolerations to apply to workflow pods."
fn storedWorkflowTemplateSpec.templateDefaults.withTolerationsMixin
withTolerationsMixin(tolerations)
"Tolerations to apply to workflow pods."
Note: This function appends passed data to existing values
fn storedWorkflowTemplateSpec.templateDefaults.withVolumes
withVolumes(volumes)
"Volumes is a list of volumes that can be mounted by containers in a template."
fn storedWorkflowTemplateSpec.templateDefaults.withVolumesMixin
withVolumesMixin(volumes)
"Volumes is a list of volumes that can be mounted by containers in a template."
Note: This function appends passed data to existing values
obj storedWorkflowTemplateSpec.templateDefaults.affinity
"Affinity is a group of affinity scheduling rules."
obj storedWorkflowTemplateSpec.templateDefaults.affinity.nodeAffinity
"Node affinity is a group of node affinity scheduling rules."
fn storedWorkflowTemplateSpec.templateDefaults.affinity.nodeAffinity.withPreferredDuringSchedulingIgnoredDuringExecution
withPreferredDuringSchedulingIgnoredDuringExecution(preferredDuringSchedulingIgnoredDuringExecution)
"The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding \"weight\" to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred."
fn storedWorkflowTemplateSpec.templateDefaults.affinity.nodeAffinity.withPreferredDuringSchedulingIgnoredDuringExecutionMixin
withPreferredDuringSchedulingIgnoredDuringExecutionMixin(preferredDuringSchedulingIgnoredDuringExecution)
"The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding \"weight\" to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred."
Note: This function appends passed data to existing values
obj storedWorkflowTemplateSpec.templateDefaults.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution
"A node selector represents the union of the results of one or more label queries over a set of nodes; that is, it represents the OR of the selectors represented by the node selector terms."
fn storedWorkflowTemplateSpec.templateDefaults.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.withNodeSelectorTerms
withNodeSelectorTerms(nodeSelectorTerms)
"Required. A list of node selector terms. The terms are ORed."
fn storedWorkflowTemplateSpec.templateDefaults.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.withNodeSelectorTermsMixin
withNodeSelectorTermsMixin(nodeSelectorTerms)
"Required. A list of node selector terms. The terms are ORed."
Note: This function appends passed data to existing values
obj storedWorkflowTemplateSpec.templateDefaults.affinity.podAffinity
"Pod affinity is a group of inter pod affinity scheduling rules."
fn storedWorkflowTemplateSpec.templateDefaults.affinity.podAffinity.withPreferredDuringSchedulingIgnoredDuringExecution
withPreferredDuringSchedulingIgnoredDuringExecution(preferredDuringSchedulingIgnoredDuringExecution)
"The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding \"weight\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred."
fn storedWorkflowTemplateSpec.templateDefaults.affinity.podAffinity.withPreferredDuringSchedulingIgnoredDuringExecutionMixin
withPreferredDuringSchedulingIgnoredDuringExecutionMixin(preferredDuringSchedulingIgnoredDuringExecution)
"The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding \"weight\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred."
Note: This function appends passed data to existing values
fn storedWorkflowTemplateSpec.templateDefaults.affinity.podAffinity.withRequiredDuringSchedulingIgnoredDuringExecution
withRequiredDuringSchedulingIgnoredDuringExecution(requiredDuringSchedulingIgnoredDuringExecution)
"If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied."
fn storedWorkflowTemplateSpec.templateDefaults.affinity.podAffinity.withRequiredDuringSchedulingIgnoredDuringExecutionMixin
withRequiredDuringSchedulingIgnoredDuringExecutionMixin(requiredDuringSchedulingIgnoredDuringExecution)
"If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied."
Note: This function appends passed data to existing values
obj storedWorkflowTemplateSpec.templateDefaults.affinity.podAntiAffinity
"Pod anti affinity is a group of inter pod anti affinity scheduling rules."
fn storedWorkflowTemplateSpec.templateDefaults.affinity.podAntiAffinity.withPreferredDuringSchedulingIgnoredDuringExecution
withPreferredDuringSchedulingIgnoredDuringExecution(preferredDuringSchedulingIgnoredDuringExecution)
"The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding \"weight\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred."
fn storedWorkflowTemplateSpec.templateDefaults.affinity.podAntiAffinity.withPreferredDuringSchedulingIgnoredDuringExecutionMixin
withPreferredDuringSchedulingIgnoredDuringExecutionMixin(preferredDuringSchedulingIgnoredDuringExecution)
"The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding \"weight\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred."
Note: This function appends passed data to existing values
fn storedWorkflowTemplateSpec.templateDefaults.affinity.podAntiAffinity.withRequiredDuringSchedulingIgnoredDuringExecution
withRequiredDuringSchedulingIgnoredDuringExecution(requiredDuringSchedulingIgnoredDuringExecution)
"If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied."
fn storedWorkflowTemplateSpec.templateDefaults.affinity.podAntiAffinity.withRequiredDuringSchedulingIgnoredDuringExecutionMixin
withRequiredDuringSchedulingIgnoredDuringExecutionMixin(requiredDuringSchedulingIgnoredDuringExecution)
"If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied."
Note: This function appends passed data to existing values
obj storedWorkflowTemplateSpec.templateDefaults.archiveLocation
"ArtifactLocation describes a location for a single or multiple artifacts. It is used as single artifact in the context of inputs/outputs (e.g. outputs.artifacts.artname). It is also used to describe the location of multiple artifacts such as the archive location of a single workflow step, which the executor will use as a default location to store its files."
fn storedWorkflowTemplateSpec.templateDefaults.archiveLocation.withArchiveLogs
withArchiveLogs(archiveLogs)
"ArchiveLogs indicates if the container logs should be archived"
obj storedWorkflowTemplateSpec.templateDefaults.archiveLocation.artifactory
"ArtifactoryArtifact is the location of an artifactory artifact"
fn storedWorkflowTemplateSpec.templateDefaults.archiveLocation.artifactory.withUrl
withUrl(url)
"URL of the artifact"
obj storedWorkflowTemplateSpec.templateDefaults.archiveLocation.artifactory.passwordSecret
"SecretKeySelector selects a key of a Secret."
fn storedWorkflowTemplateSpec.templateDefaults.archiveLocation.artifactory.passwordSecret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn storedWorkflowTemplateSpec.templateDefaults.archiveLocation.artifactory.passwordSecret.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn storedWorkflowTemplateSpec.templateDefaults.archiveLocation.artifactory.passwordSecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj storedWorkflowTemplateSpec.templateDefaults.archiveLocation.artifactory.usernameSecret
"SecretKeySelector selects a key of a Secret."
fn storedWorkflowTemplateSpec.templateDefaults.archiveLocation.artifactory.usernameSecret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn storedWorkflowTemplateSpec.templateDefaults.archiveLocation.artifactory.usernameSecret.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn storedWorkflowTemplateSpec.templateDefaults.archiveLocation.artifactory.usernameSecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj storedWorkflowTemplateSpec.templateDefaults.archiveLocation.gcs
"GCSArtifact is the location of a GCS artifact"
fn storedWorkflowTemplateSpec.templateDefaults.archiveLocation.gcs.withBucket
withBucket(bucket)
"Bucket is the name of the bucket"
fn storedWorkflowTemplateSpec.templateDefaults.archiveLocation.gcs.withKey
withKey(key)
"Key is the path in the bucket where the artifact resides"
obj storedWorkflowTemplateSpec.templateDefaults.archiveLocation.gcs.serviceAccountKeySecret
"SecretKeySelector selects a key of a Secret."
fn storedWorkflowTemplateSpec.templateDefaults.archiveLocation.gcs.serviceAccountKeySecret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn storedWorkflowTemplateSpec.templateDefaults.archiveLocation.gcs.serviceAccountKeySecret.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn storedWorkflowTemplateSpec.templateDefaults.archiveLocation.gcs.serviceAccountKeySecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj storedWorkflowTemplateSpec.templateDefaults.archiveLocation.git
"GitArtifact is the location of an git artifact"
fn storedWorkflowTemplateSpec.templateDefaults.archiveLocation.git.withDepth
withDepth(depth)
"Depth specifies clones/fetches should be shallow and include the given number of commits from the branch tip"
fn storedWorkflowTemplateSpec.templateDefaults.archiveLocation.git.withDisableSubmodules
withDisableSubmodules(disableSubmodules)
"DisableSubmodules disables submodules during git clone"
fn storedWorkflowTemplateSpec.templateDefaults.archiveLocation.git.withFetch
withFetch(fetch)
"Fetch specifies a number of refs that should be fetched before checkout"
fn storedWorkflowTemplateSpec.templateDefaults.archiveLocation.git.withFetchMixin
withFetchMixin(fetch)
"Fetch specifies a number of refs that should be fetched before checkout"
Note: This function appends passed data to existing values
fn storedWorkflowTemplateSpec.templateDefaults.archiveLocation.git.withInsecureIgnoreHostKey
withInsecureIgnoreHostKey(insecureIgnoreHostKey)
"InsecureIgnoreHostKey disables SSH strict host key checking during git clone"
fn storedWorkflowTemplateSpec.templateDefaults.archiveLocation.git.withRepo
withRepo(repo)
"Repo is the git repository"
fn storedWorkflowTemplateSpec.templateDefaults.archiveLocation.git.withRevision
withRevision(revision)
"Revision is the git commit, tag, branch to checkout"
obj storedWorkflowTemplateSpec.templateDefaults.archiveLocation.git.passwordSecret
"SecretKeySelector selects a key of a Secret."
fn storedWorkflowTemplateSpec.templateDefaults.archiveLocation.git.passwordSecret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn storedWorkflowTemplateSpec.templateDefaults.archiveLocation.git.passwordSecret.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn storedWorkflowTemplateSpec.templateDefaults.archiveLocation.git.passwordSecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj storedWorkflowTemplateSpec.templateDefaults.archiveLocation.git.sshPrivateKeySecret
"SecretKeySelector selects a key of a Secret."
fn storedWorkflowTemplateSpec.templateDefaults.archiveLocation.git.sshPrivateKeySecret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn storedWorkflowTemplateSpec.templateDefaults.archiveLocation.git.sshPrivateKeySecret.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn storedWorkflowTemplateSpec.templateDefaults.archiveLocation.git.sshPrivateKeySecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj storedWorkflowTemplateSpec.templateDefaults.archiveLocation.git.usernameSecret
"SecretKeySelector selects a key of a Secret."
fn storedWorkflowTemplateSpec.templateDefaults.archiveLocation.git.usernameSecret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn storedWorkflowTemplateSpec.templateDefaults.archiveLocation.git.usernameSecret.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn storedWorkflowTemplateSpec.templateDefaults.archiveLocation.git.usernameSecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj storedWorkflowTemplateSpec.templateDefaults.archiveLocation.hdfs
"HDFSArtifact is the location of an HDFS artifact"
fn storedWorkflowTemplateSpec.templateDefaults.archiveLocation.hdfs.withAddresses
withAddresses(addresses)
"Addresses is accessible addresses of HDFS name nodes"
fn storedWorkflowTemplateSpec.templateDefaults.archiveLocation.hdfs.withAddressesMixin
withAddressesMixin(addresses)
"Addresses is accessible addresses of HDFS name nodes"
Note: This function appends passed data to existing values
fn storedWorkflowTemplateSpec.templateDefaults.archiveLocation.hdfs.withForce
withForce(force)
"Force copies a file forcibly even if it exists (default: false)"
fn storedWorkflowTemplateSpec.templateDefaults.archiveLocation.hdfs.withHdfsUser
withHdfsUser(hdfsUser)
"HDFSUser is the user to access HDFS file system. It is ignored if either ccache or keytab is used."
fn storedWorkflowTemplateSpec.templateDefaults.archiveLocation.hdfs.withKrbRealm
withKrbRealm(krbRealm)
"KrbRealm is the Kerberos realm used with Kerberos keytab It must be set if keytab is used."
fn storedWorkflowTemplateSpec.templateDefaults.archiveLocation.hdfs.withKrbServicePrincipalName
withKrbServicePrincipalName(krbServicePrincipalName)
"KrbServicePrincipalName is the principal name of Kerberos service It must be set if either ccache or keytab is used."
fn storedWorkflowTemplateSpec.templateDefaults.archiveLocation.hdfs.withKrbUsername
withKrbUsername(krbUsername)
"KrbUsername is the Kerberos username used with Kerberos keytab It must be set if keytab is used."
fn storedWorkflowTemplateSpec.templateDefaults.archiveLocation.hdfs.withPath
withPath(path)
"Path is a file path in HDFS"
obj storedWorkflowTemplateSpec.templateDefaults.archiveLocation.hdfs.krbCCacheSecret
"SecretKeySelector selects a key of a Secret."
fn storedWorkflowTemplateSpec.templateDefaults.archiveLocation.hdfs.krbCCacheSecret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn storedWorkflowTemplateSpec.templateDefaults.archiveLocation.hdfs.krbCCacheSecret.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn storedWorkflowTemplateSpec.templateDefaults.archiveLocation.hdfs.krbCCacheSecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj storedWorkflowTemplateSpec.templateDefaults.archiveLocation.hdfs.krbConfigConfigMap
"Selects a key from a ConfigMap."
fn storedWorkflowTemplateSpec.templateDefaults.archiveLocation.hdfs.krbConfigConfigMap.withKey
withKey(key)
"The key to select."
fn storedWorkflowTemplateSpec.templateDefaults.archiveLocation.hdfs.krbConfigConfigMap.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn storedWorkflowTemplateSpec.templateDefaults.archiveLocation.hdfs.krbConfigConfigMap.withOptional
withOptional(optional)
"Specify whether the ConfigMap or its key must be defined"
obj storedWorkflowTemplateSpec.templateDefaults.archiveLocation.hdfs.krbKeytabSecret
"SecretKeySelector selects a key of a Secret."
fn storedWorkflowTemplateSpec.templateDefaults.archiveLocation.hdfs.krbKeytabSecret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn storedWorkflowTemplateSpec.templateDefaults.archiveLocation.hdfs.krbKeytabSecret.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn storedWorkflowTemplateSpec.templateDefaults.archiveLocation.hdfs.krbKeytabSecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj storedWorkflowTemplateSpec.templateDefaults.archiveLocation.http
"HTTPArtifact allows an file served on HTTP to be placed as an input artifact in a container"
fn storedWorkflowTemplateSpec.templateDefaults.archiveLocation.http.withHeaders
withHeaders(headers)
"Headers are an optional list of headers to send with HTTP requests for artifacts"
fn storedWorkflowTemplateSpec.templateDefaults.archiveLocation.http.withHeadersMixin
withHeadersMixin(headers)
"Headers are an optional list of headers to send with HTTP requests for artifacts"
Note: This function appends passed data to existing values
fn storedWorkflowTemplateSpec.templateDefaults.archiveLocation.http.withUrl
withUrl(url)
"URL of the artifact"
obj storedWorkflowTemplateSpec.templateDefaults.archiveLocation.oss
"OSSArtifact is the location of an Alibaba Cloud OSS artifact"
fn storedWorkflowTemplateSpec.templateDefaults.archiveLocation.oss.withBucket
withBucket(bucket)
"Bucket is the name of the bucket"
fn storedWorkflowTemplateSpec.templateDefaults.archiveLocation.oss.withCreateBucketIfNotPresent
withCreateBucketIfNotPresent(createBucketIfNotPresent)
"CreateBucketIfNotPresent tells the driver to attempt to create the OSS bucket for output artifacts, if it doesn't exist"
fn storedWorkflowTemplateSpec.templateDefaults.archiveLocation.oss.withEndpoint
withEndpoint(endpoint)
"Endpoint is the hostname of the bucket endpoint"
fn storedWorkflowTemplateSpec.templateDefaults.archiveLocation.oss.withKey
withKey(key)
"Key is the path in the bucket where the artifact resides"
fn storedWorkflowTemplateSpec.templateDefaults.archiveLocation.oss.withSecurityToken
withSecurityToken(securityToken)
"SecurityToken is the user's temporary security token. For more details, check out: https://www.alibabacloud.com/help/doc-detail/100624.htm"
obj storedWorkflowTemplateSpec.templateDefaults.archiveLocation.oss.accessKeySecret
"SecretKeySelector selects a key of a Secret."
fn storedWorkflowTemplateSpec.templateDefaults.archiveLocation.oss.accessKeySecret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn storedWorkflowTemplateSpec.templateDefaults.archiveLocation.oss.accessKeySecret.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn storedWorkflowTemplateSpec.templateDefaults.archiveLocation.oss.accessKeySecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj storedWorkflowTemplateSpec.templateDefaults.archiveLocation.oss.lifecycleRule
"OSSLifecycleRule specifies how to manage bucket's lifecycle"
fn storedWorkflowTemplateSpec.templateDefaults.archiveLocation.oss.lifecycleRule.withMarkDeletionAfterDays
withMarkDeletionAfterDays(markDeletionAfterDays)
"MarkDeletionAfterDays is the number of days before we delete objects in the bucket"
fn storedWorkflowTemplateSpec.templateDefaults.archiveLocation.oss.lifecycleRule.withMarkInfrequentAccessAfterDays
withMarkInfrequentAccessAfterDays(markInfrequentAccessAfterDays)
"MarkInfrequentAccessAfterDays is the number of days before we convert the objects in the bucket to Infrequent Access (IA) storage type"
obj storedWorkflowTemplateSpec.templateDefaults.archiveLocation.oss.secretKeySecret
"SecretKeySelector selects a key of a Secret."
fn storedWorkflowTemplateSpec.templateDefaults.archiveLocation.oss.secretKeySecret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn storedWorkflowTemplateSpec.templateDefaults.archiveLocation.oss.secretKeySecret.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn storedWorkflowTemplateSpec.templateDefaults.archiveLocation.oss.secretKeySecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj storedWorkflowTemplateSpec.templateDefaults.archiveLocation.raw
"RawArtifact allows raw string content to be placed as an artifact in a container"
fn storedWorkflowTemplateSpec.templateDefaults.archiveLocation.raw.withData
withData(data)
"Data is the string contents of the artifact"
obj storedWorkflowTemplateSpec.templateDefaults.archiveLocation.s3
"S3Artifact is the location of an S3 artifact"
fn storedWorkflowTemplateSpec.templateDefaults.archiveLocation.s3.withBucket
withBucket(bucket)
"Bucket is the name of the bucket"
fn storedWorkflowTemplateSpec.templateDefaults.archiveLocation.s3.withEndpoint
withEndpoint(endpoint)
"Endpoint is the hostname of the bucket endpoint"
fn storedWorkflowTemplateSpec.templateDefaults.archiveLocation.s3.withInsecure
withInsecure(insecure)
"Insecure will connect to the service with TLS"
fn storedWorkflowTemplateSpec.templateDefaults.archiveLocation.s3.withKey
withKey(key)
"Key is the key in the bucket where the artifact resides"
fn storedWorkflowTemplateSpec.templateDefaults.archiveLocation.s3.withRegion
withRegion(region)
"Region contains the optional bucket region"
fn storedWorkflowTemplateSpec.templateDefaults.archiveLocation.s3.withRoleARN
withRoleARN(roleARN)
"RoleARN is the Amazon Resource Name (ARN) of the role to assume."
fn storedWorkflowTemplateSpec.templateDefaults.archiveLocation.s3.withUseSDKCreds
withUseSDKCreds(useSDKCreds)
"UseSDKCreds tells the driver to figure out credentials based on sdk defaults."
obj storedWorkflowTemplateSpec.templateDefaults.archiveLocation.s3.accessKeySecret
"SecretKeySelector selects a key of a Secret."
fn storedWorkflowTemplateSpec.templateDefaults.archiveLocation.s3.accessKeySecret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn storedWorkflowTemplateSpec.templateDefaults.archiveLocation.s3.accessKeySecret.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn storedWorkflowTemplateSpec.templateDefaults.archiveLocation.s3.accessKeySecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj storedWorkflowTemplateSpec.templateDefaults.archiveLocation.s3.createBucketIfNotPresent
"CreateS3BucketOptions options used to determine automatic automatic bucket-creation process"
fn storedWorkflowTemplateSpec.templateDefaults.archiveLocation.s3.createBucketIfNotPresent.withObjectLocking
withObjectLocking(objectLocking)
"ObjectLocking Enable object locking"
obj storedWorkflowTemplateSpec.templateDefaults.archiveLocation.s3.secretKeySecret
"SecretKeySelector selects a key of a Secret."
fn storedWorkflowTemplateSpec.templateDefaults.archiveLocation.s3.secretKeySecret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn storedWorkflowTemplateSpec.templateDefaults.archiveLocation.s3.secretKeySecret.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn storedWorkflowTemplateSpec.templateDefaults.archiveLocation.s3.secretKeySecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj storedWorkflowTemplateSpec.templateDefaults.container
"A single application container that you want to run within a pod."
fn storedWorkflowTemplateSpec.templateDefaults.container.withArgs
withArgs(args)
"Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell"
fn storedWorkflowTemplateSpec.templateDefaults.container.withArgsMixin
withArgsMixin(args)
"Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell"
Note: This function appends passed data to existing values
fn storedWorkflowTemplateSpec.templateDefaults.container.withCommand
withCommand(command)
"Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell"
fn storedWorkflowTemplateSpec.templateDefaults.container.withCommandMixin
withCommandMixin(command)
"Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell"
Note: This function appends passed data to existing values
fn storedWorkflowTemplateSpec.templateDefaults.container.withEnv
withEnv(env)
"List of environment variables to set in the container. Cannot be updated."
fn storedWorkflowTemplateSpec.templateDefaults.container.withEnvFrom
withEnvFrom(envFrom)
"List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated."
fn storedWorkflowTemplateSpec.templateDefaults.container.withEnvFromMixin
withEnvFromMixin(envFrom)
"List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated."
Note: This function appends passed data to existing values
fn storedWorkflowTemplateSpec.templateDefaults.container.withEnvMixin
withEnvMixin(env)
"List of environment variables to set in the container. Cannot be updated."
Note: This function appends passed data to existing values
fn storedWorkflowTemplateSpec.templateDefaults.container.withImage
withImage(image)
"Docker image name. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets."
fn storedWorkflowTemplateSpec.templateDefaults.container.withImagePullPolicy
withImagePullPolicy(imagePullPolicy)
"Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images"
fn storedWorkflowTemplateSpec.templateDefaults.container.withName
withName(name)
"Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated."
fn storedWorkflowTemplateSpec.templateDefaults.container.withPorts
withPorts(ports)
"List of ports to expose from the container. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default \"0.0.0.0\" address inside a container will be accessible from the network. Cannot be updated."
fn storedWorkflowTemplateSpec.templateDefaults.container.withPortsMixin
withPortsMixin(ports)
"List of ports to expose from the container. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default \"0.0.0.0\" address inside a container will be accessible from the network. Cannot be updated."
Note: This function appends passed data to existing values
fn storedWorkflowTemplateSpec.templateDefaults.container.withStdin
withStdin(stdin)
"Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false."
fn storedWorkflowTemplateSpec.templateDefaults.container.withStdinOnce
withStdinOnce(stdinOnce)
"Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false"
fn storedWorkflowTemplateSpec.templateDefaults.container.withTerminationMessagePath
withTerminationMessagePath(terminationMessagePath)
"Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated."
fn storedWorkflowTemplateSpec.templateDefaults.container.withTerminationMessagePolicy
withTerminationMessagePolicy(terminationMessagePolicy)
"Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated."
fn storedWorkflowTemplateSpec.templateDefaults.container.withTty
withTty(tty)
"Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false."
fn storedWorkflowTemplateSpec.templateDefaults.container.withVolumeDevices
withVolumeDevices(volumeDevices)
"volumeDevices is the list of block devices to be used by the container. This is a beta feature."
fn storedWorkflowTemplateSpec.templateDefaults.container.withVolumeDevicesMixin
withVolumeDevicesMixin(volumeDevices)
"volumeDevices is the list of block devices to be used by the container. This is a beta feature."
Note: This function appends passed data to existing values
fn storedWorkflowTemplateSpec.templateDefaults.container.withVolumeMounts
withVolumeMounts(volumeMounts)
"Pod volumes to mount into the container's filesystem. Cannot be updated."
fn storedWorkflowTemplateSpec.templateDefaults.container.withVolumeMountsMixin
withVolumeMountsMixin(volumeMounts)
"Pod volumes to mount into the container's filesystem. Cannot be updated."
Note: This function appends passed data to existing values
fn storedWorkflowTemplateSpec.templateDefaults.container.withWorkingDir
withWorkingDir(workingDir)
"Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated."
obj storedWorkflowTemplateSpec.templateDefaults.container.lifecycle
"Lifecycle describes actions that the management system should take in response to container lifecycle events. For the PostStart and PreStop lifecycle handlers, management of the container blocks until the action is complete, unless the container process fails, in which case the handler is aborted."
obj storedWorkflowTemplateSpec.templateDefaults.container.lifecycle.postStart
"Handler defines a specific action that should be taken"
obj storedWorkflowTemplateSpec.templateDefaults.container.lifecycle.postStart.exec
"ExecAction describes a \"run in container\" action."
fn storedWorkflowTemplateSpec.templateDefaults.container.lifecycle.postStart.exec.withCommand
withCommand(command)
"Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy."
fn storedWorkflowTemplateSpec.templateDefaults.container.lifecycle.postStart.exec.withCommandMixin
withCommandMixin(command)
"Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy."
Note: This function appends passed data to existing values
obj storedWorkflowTemplateSpec.templateDefaults.container.lifecycle.postStart.httpGet
"HTTPGetAction describes an action based on HTTP Get requests."
fn storedWorkflowTemplateSpec.templateDefaults.container.lifecycle.postStart.httpGet.withHost
withHost(host)
"Host name to connect to, defaults to the pod IP. You probably want to set \"Host\" in httpHeaders instead."
fn storedWorkflowTemplateSpec.templateDefaults.container.lifecycle.postStart.httpGet.withHttpHeaders
withHttpHeaders(httpHeaders)
"Custom headers to set in the request. HTTP allows repeated headers."
fn storedWorkflowTemplateSpec.templateDefaults.container.lifecycle.postStart.httpGet.withHttpHeadersMixin
withHttpHeadersMixin(httpHeaders)
"Custom headers to set in the request. HTTP allows repeated headers."
Note: This function appends passed data to existing values
fn storedWorkflowTemplateSpec.templateDefaults.container.lifecycle.postStart.httpGet.withPath
withPath(path)
"Path to access on the HTTP server."
fn storedWorkflowTemplateSpec.templateDefaults.container.lifecycle.postStart.httpGet.withPort
withPort(port)
fn storedWorkflowTemplateSpec.templateDefaults.container.lifecycle.postStart.httpGet.withScheme
withScheme(scheme)
"Scheme to use for connecting to the host. Defaults to HTTP."
obj storedWorkflowTemplateSpec.templateDefaults.container.lifecycle.postStart.tcpSocket
"TCPSocketAction describes an action based on opening a socket"
fn storedWorkflowTemplateSpec.templateDefaults.container.lifecycle.postStart.tcpSocket.withHost
withHost(host)
"Optional: Host name to connect to, defaults to the pod IP."
fn storedWorkflowTemplateSpec.templateDefaults.container.lifecycle.postStart.tcpSocket.withPort
withPort(port)
obj storedWorkflowTemplateSpec.templateDefaults.container.lifecycle.preStop
"Handler defines a specific action that should be taken"
obj storedWorkflowTemplateSpec.templateDefaults.container.lifecycle.preStop.exec
"ExecAction describes a \"run in container\" action."
fn storedWorkflowTemplateSpec.templateDefaults.container.lifecycle.preStop.exec.withCommand
withCommand(command)
"Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy."
fn storedWorkflowTemplateSpec.templateDefaults.container.lifecycle.preStop.exec.withCommandMixin
withCommandMixin(command)
"Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy."
Note: This function appends passed data to existing values
obj storedWorkflowTemplateSpec.templateDefaults.container.lifecycle.preStop.httpGet
"HTTPGetAction describes an action based on HTTP Get requests."
fn storedWorkflowTemplateSpec.templateDefaults.container.lifecycle.preStop.httpGet.withHost
withHost(host)
"Host name to connect to, defaults to the pod IP. You probably want to set \"Host\" in httpHeaders instead."
fn storedWorkflowTemplateSpec.templateDefaults.container.lifecycle.preStop.httpGet.withHttpHeaders
withHttpHeaders(httpHeaders)
"Custom headers to set in the request. HTTP allows repeated headers."
fn storedWorkflowTemplateSpec.templateDefaults.container.lifecycle.preStop.httpGet.withHttpHeadersMixin
withHttpHeadersMixin(httpHeaders)
"Custom headers to set in the request. HTTP allows repeated headers."
Note: This function appends passed data to existing values
fn storedWorkflowTemplateSpec.templateDefaults.container.lifecycle.preStop.httpGet.withPath
withPath(path)
"Path to access on the HTTP server."
fn storedWorkflowTemplateSpec.templateDefaults.container.lifecycle.preStop.httpGet.withPort
withPort(port)
fn storedWorkflowTemplateSpec.templateDefaults.container.lifecycle.preStop.httpGet.withScheme
withScheme(scheme)
"Scheme to use for connecting to the host. Defaults to HTTP."
obj storedWorkflowTemplateSpec.templateDefaults.container.lifecycle.preStop.tcpSocket
"TCPSocketAction describes an action based on opening a socket"
fn storedWorkflowTemplateSpec.templateDefaults.container.lifecycle.preStop.tcpSocket.withHost
withHost(host)
"Optional: Host name to connect to, defaults to the pod IP."
fn storedWorkflowTemplateSpec.templateDefaults.container.lifecycle.preStop.tcpSocket.withPort
withPort(port)
obj storedWorkflowTemplateSpec.templateDefaults.container.livenessProbe
"Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic."
fn storedWorkflowTemplateSpec.templateDefaults.container.livenessProbe.withFailureThreshold
withFailureThreshold(failureThreshold)
"Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1."
fn storedWorkflowTemplateSpec.templateDefaults.container.livenessProbe.withInitialDelaySeconds
withInitialDelaySeconds(initialDelaySeconds)
"Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"
fn storedWorkflowTemplateSpec.templateDefaults.container.livenessProbe.withPeriodSeconds
withPeriodSeconds(periodSeconds)
"How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1."
fn storedWorkflowTemplateSpec.templateDefaults.container.livenessProbe.withSuccessThreshold
withSuccessThreshold(successThreshold)
"Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1."
fn storedWorkflowTemplateSpec.templateDefaults.container.livenessProbe.withTimeoutSeconds
withTimeoutSeconds(timeoutSeconds)
"Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"
obj storedWorkflowTemplateSpec.templateDefaults.container.livenessProbe.exec
"ExecAction describes a \"run in container\" action."
fn storedWorkflowTemplateSpec.templateDefaults.container.livenessProbe.exec.withCommand
withCommand(command)
"Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy."
fn storedWorkflowTemplateSpec.templateDefaults.container.livenessProbe.exec.withCommandMixin
withCommandMixin(command)
"Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy."
Note: This function appends passed data to existing values
obj storedWorkflowTemplateSpec.templateDefaults.container.livenessProbe.httpGet
"HTTPGetAction describes an action based on HTTP Get requests."
fn storedWorkflowTemplateSpec.templateDefaults.container.livenessProbe.httpGet.withHost
withHost(host)
"Host name to connect to, defaults to the pod IP. You probably want to set \"Host\" in httpHeaders instead."
fn storedWorkflowTemplateSpec.templateDefaults.container.livenessProbe.httpGet.withHttpHeaders
withHttpHeaders(httpHeaders)
"Custom headers to set in the request. HTTP allows repeated headers."
fn storedWorkflowTemplateSpec.templateDefaults.container.livenessProbe.httpGet.withHttpHeadersMixin
withHttpHeadersMixin(httpHeaders)
"Custom headers to set in the request. HTTP allows repeated headers."
Note: This function appends passed data to existing values
fn storedWorkflowTemplateSpec.templateDefaults.container.livenessProbe.httpGet.withPath
withPath(path)
"Path to access on the HTTP server."
fn storedWorkflowTemplateSpec.templateDefaults.container.livenessProbe.httpGet.withPort
withPort(port)
fn storedWorkflowTemplateSpec.templateDefaults.container.livenessProbe.httpGet.withScheme
withScheme(scheme)
"Scheme to use for connecting to the host. Defaults to HTTP."
obj storedWorkflowTemplateSpec.templateDefaults.container.livenessProbe.tcpSocket
"TCPSocketAction describes an action based on opening a socket"
fn storedWorkflowTemplateSpec.templateDefaults.container.livenessProbe.tcpSocket.withHost
withHost(host)
"Optional: Host name to connect to, defaults to the pod IP."
fn storedWorkflowTemplateSpec.templateDefaults.container.livenessProbe.tcpSocket.withPort
withPort(port)
obj storedWorkflowTemplateSpec.templateDefaults.container.readinessProbe
"Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic."
fn storedWorkflowTemplateSpec.templateDefaults.container.readinessProbe.withFailureThreshold
withFailureThreshold(failureThreshold)
"Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1."
fn storedWorkflowTemplateSpec.templateDefaults.container.readinessProbe.withInitialDelaySeconds
withInitialDelaySeconds(initialDelaySeconds)
"Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"
fn storedWorkflowTemplateSpec.templateDefaults.container.readinessProbe.withPeriodSeconds
withPeriodSeconds(periodSeconds)
"How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1."
fn storedWorkflowTemplateSpec.templateDefaults.container.readinessProbe.withSuccessThreshold
withSuccessThreshold(successThreshold)
"Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1."
fn storedWorkflowTemplateSpec.templateDefaults.container.readinessProbe.withTimeoutSeconds
withTimeoutSeconds(timeoutSeconds)
"Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"
obj storedWorkflowTemplateSpec.templateDefaults.container.readinessProbe.exec
"ExecAction describes a \"run in container\" action."
fn storedWorkflowTemplateSpec.templateDefaults.container.readinessProbe.exec.withCommand
withCommand(command)
"Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy."
fn storedWorkflowTemplateSpec.templateDefaults.container.readinessProbe.exec.withCommandMixin
withCommandMixin(command)
"Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy."
Note: This function appends passed data to existing values
obj storedWorkflowTemplateSpec.templateDefaults.container.readinessProbe.httpGet
"HTTPGetAction describes an action based on HTTP Get requests."
fn storedWorkflowTemplateSpec.templateDefaults.container.readinessProbe.httpGet.withHost
withHost(host)
"Host name to connect to, defaults to the pod IP. You probably want to set \"Host\" in httpHeaders instead."
fn storedWorkflowTemplateSpec.templateDefaults.container.readinessProbe.httpGet.withHttpHeaders
withHttpHeaders(httpHeaders)
"Custom headers to set in the request. HTTP allows repeated headers."
fn storedWorkflowTemplateSpec.templateDefaults.container.readinessProbe.httpGet.withHttpHeadersMixin
withHttpHeadersMixin(httpHeaders)
"Custom headers to set in the request. HTTP allows repeated headers."
Note: This function appends passed data to existing values
fn storedWorkflowTemplateSpec.templateDefaults.container.readinessProbe.httpGet.withPath
withPath(path)
"Path to access on the HTTP server."
fn storedWorkflowTemplateSpec.templateDefaults.container.readinessProbe.httpGet.withPort
withPort(port)
fn storedWorkflowTemplateSpec.templateDefaults.container.readinessProbe.httpGet.withScheme
withScheme(scheme)
"Scheme to use for connecting to the host. Defaults to HTTP."
obj storedWorkflowTemplateSpec.templateDefaults.container.readinessProbe.tcpSocket
"TCPSocketAction describes an action based on opening a socket"
fn storedWorkflowTemplateSpec.templateDefaults.container.readinessProbe.tcpSocket.withHost
withHost(host)
"Optional: Host name to connect to, defaults to the pod IP."
fn storedWorkflowTemplateSpec.templateDefaults.container.readinessProbe.tcpSocket.withPort
withPort(port)
obj storedWorkflowTemplateSpec.templateDefaults.container.resources
"ResourceRequirements describes the compute resource requirements."
fn storedWorkflowTemplateSpec.templateDefaults.container.resources.withLimits
withLimits(limits)
"Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/"
fn storedWorkflowTemplateSpec.templateDefaults.container.resources.withLimitsMixin
withLimitsMixin(limits)
"Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/"
Note: This function appends passed data to existing values
fn storedWorkflowTemplateSpec.templateDefaults.container.resources.withRequests
withRequests(requests)
"Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/"
fn storedWorkflowTemplateSpec.templateDefaults.container.resources.withRequestsMixin
withRequestsMixin(requests)
"Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/"
Note: This function appends passed data to existing values
obj storedWorkflowTemplateSpec.templateDefaults.container.securityContext
"SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence."
fn storedWorkflowTemplateSpec.templateDefaults.container.securityContext.withAllowPrivilegeEscalation
withAllowPrivilegeEscalation(allowPrivilegeEscalation)
"AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN"
fn storedWorkflowTemplateSpec.templateDefaults.container.securityContext.withPrivileged
withPrivileged(privileged)
"Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false."
fn storedWorkflowTemplateSpec.templateDefaults.container.securityContext.withProcMount
withProcMount(procMount)
"procMount denotes the type of proc mount to use for the containers. The default is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled."
fn storedWorkflowTemplateSpec.templateDefaults.container.securityContext.withReadOnlyRootFilesystem
withReadOnlyRootFilesystem(readOnlyRootFilesystem)
"Whether this container has a read-only root filesystem. Default is false."
fn storedWorkflowTemplateSpec.templateDefaults.container.securityContext.withRunAsGroup
withRunAsGroup(runAsGroup)
"The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence."
fn storedWorkflowTemplateSpec.templateDefaults.container.securityContext.withRunAsNonRoot
withRunAsNonRoot(runAsNonRoot)
"Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence."
fn storedWorkflowTemplateSpec.templateDefaults.container.securityContext.withRunAsUser
withRunAsUser(runAsUser)
"The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence."
obj storedWorkflowTemplateSpec.templateDefaults.container.securityContext.capabilities
"Adds and removes POSIX capabilities from running containers."
fn storedWorkflowTemplateSpec.templateDefaults.container.securityContext.capabilities.withAdd
withAdd(add)
"Added capabilities"
fn storedWorkflowTemplateSpec.templateDefaults.container.securityContext.capabilities.withAddMixin
withAddMixin(add)
"Added capabilities"
Note: This function appends passed data to existing values
fn storedWorkflowTemplateSpec.templateDefaults.container.securityContext.capabilities.withDrop
withDrop(drop)
"Removed capabilities"
fn storedWorkflowTemplateSpec.templateDefaults.container.securityContext.capabilities.withDropMixin
withDropMixin(drop)
"Removed capabilities"
Note: This function appends passed data to existing values
obj storedWorkflowTemplateSpec.templateDefaults.container.securityContext.seLinuxOptions
"SELinuxOptions are the labels to be applied to the container"
fn storedWorkflowTemplateSpec.templateDefaults.container.securityContext.seLinuxOptions.withLevel
withLevel(level)
"Level is SELinux level label that applies to the container."
fn storedWorkflowTemplateSpec.templateDefaults.container.securityContext.seLinuxOptions.withRole
withRole(role)
"Role is a SELinux role label that applies to the container."
fn storedWorkflowTemplateSpec.templateDefaults.container.securityContext.seLinuxOptions.withType
withType(type)
"Type is a SELinux type label that applies to the container."
fn storedWorkflowTemplateSpec.templateDefaults.container.securityContext.seLinuxOptions.withUser
withUser(user)
"User is a SELinux user label that applies to the container."
obj storedWorkflowTemplateSpec.templateDefaults.container.securityContext.windowsOptions
"WindowsSecurityContextOptions contain Windows-specific options and credentials."
fn storedWorkflowTemplateSpec.templateDefaults.container.securityContext.windowsOptions.withGmsaCredentialSpec
withGmsaCredentialSpec(gmsaCredentialSpec)
"GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field. This field is alpha-level and is only honored by servers that enable the WindowsGMSA feature flag."
fn storedWorkflowTemplateSpec.templateDefaults.container.securityContext.windowsOptions.withGmsaCredentialSpecName
withGmsaCredentialSpecName(gmsaCredentialSpecName)
"GMSACredentialSpecName is the name of the GMSA credential spec to use. This field is alpha-level and is only honored by servers that enable the WindowsGMSA feature flag."
fn storedWorkflowTemplateSpec.templateDefaults.container.securityContext.windowsOptions.withRunAsUserName
withRunAsUserName(runAsUserName)
"The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. This field is beta-level and may be disabled with the WindowsRunAsUserName feature flag."
obj storedWorkflowTemplateSpec.templateDefaults.container.startupProbe
"Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic."
fn storedWorkflowTemplateSpec.templateDefaults.container.startupProbe.withFailureThreshold
withFailureThreshold(failureThreshold)
"Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1."
fn storedWorkflowTemplateSpec.templateDefaults.container.startupProbe.withInitialDelaySeconds
withInitialDelaySeconds(initialDelaySeconds)
"Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"
fn storedWorkflowTemplateSpec.templateDefaults.container.startupProbe.withPeriodSeconds
withPeriodSeconds(periodSeconds)
"How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1."
fn storedWorkflowTemplateSpec.templateDefaults.container.startupProbe.withSuccessThreshold
withSuccessThreshold(successThreshold)
"Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1."
fn storedWorkflowTemplateSpec.templateDefaults.container.startupProbe.withTimeoutSeconds
withTimeoutSeconds(timeoutSeconds)
"Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"
obj storedWorkflowTemplateSpec.templateDefaults.container.startupProbe.exec
"ExecAction describes a \"run in container\" action."
fn storedWorkflowTemplateSpec.templateDefaults.container.startupProbe.exec.withCommand
withCommand(command)
"Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy."
fn storedWorkflowTemplateSpec.templateDefaults.container.startupProbe.exec.withCommandMixin
withCommandMixin(command)
"Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy."
Note: This function appends passed data to existing values
obj storedWorkflowTemplateSpec.templateDefaults.container.startupProbe.httpGet
"HTTPGetAction describes an action based on HTTP Get requests."
fn storedWorkflowTemplateSpec.templateDefaults.container.startupProbe.httpGet.withHost
withHost(host)
"Host name to connect to, defaults to the pod IP. You probably want to set \"Host\" in httpHeaders instead."
fn storedWorkflowTemplateSpec.templateDefaults.container.startupProbe.httpGet.withHttpHeaders
withHttpHeaders(httpHeaders)
"Custom headers to set in the request. HTTP allows repeated headers."
fn storedWorkflowTemplateSpec.templateDefaults.container.startupProbe.httpGet.withHttpHeadersMixin
withHttpHeadersMixin(httpHeaders)
"Custom headers to set in the request. HTTP allows repeated headers."
Note: This function appends passed data to existing values
fn storedWorkflowTemplateSpec.templateDefaults.container.startupProbe.httpGet.withPath
withPath(path)
"Path to access on the HTTP server."
fn storedWorkflowTemplateSpec.templateDefaults.container.startupProbe.httpGet.withPort
withPort(port)
fn storedWorkflowTemplateSpec.templateDefaults.container.startupProbe.httpGet.withScheme
withScheme(scheme)
"Scheme to use for connecting to the host. Defaults to HTTP."
obj storedWorkflowTemplateSpec.templateDefaults.container.startupProbe.tcpSocket
"TCPSocketAction describes an action based on opening a socket"
fn storedWorkflowTemplateSpec.templateDefaults.container.startupProbe.tcpSocket.withHost
withHost(host)
"Optional: Host name to connect to, defaults to the pod IP."
fn storedWorkflowTemplateSpec.templateDefaults.container.startupProbe.tcpSocket.withPort
withPort(port)
obj storedWorkflowTemplateSpec.templateDefaults.containerSet
fn storedWorkflowTemplateSpec.templateDefaults.containerSet.withContainers
withContainers(containers)
fn storedWorkflowTemplateSpec.templateDefaults.containerSet.withContainersMixin
withContainersMixin(containers)
Note: This function appends passed data to existing values
fn storedWorkflowTemplateSpec.templateDefaults.containerSet.withVolumeMounts
withVolumeMounts(volumeMounts)
fn storedWorkflowTemplateSpec.templateDefaults.containerSet.withVolumeMountsMixin
withVolumeMountsMixin(volumeMounts)
Note: This function appends passed data to existing values
obj storedWorkflowTemplateSpec.templateDefaults.dag
"DAGTemplate is a template subtype for directed acyclic graph templates"
fn storedWorkflowTemplateSpec.templateDefaults.dag.withFailFast
withFailFast(failFast)
"This flag is for DAG logic. The DAG logic has a built-in \"fail fast\" feature to stop scheduling new steps, as soon as it detects that one of the DAG nodes is failed. Then it waits until all DAG nodes are completed before failing the DAG itself. The FailFast flag default is true, if set to false, it will allow a DAG to run all branches of the DAG to completion (either success or failure), regardless of the failed outcomes of branches in the DAG. More info and example about this feature at https://github.com/argoproj/argo-workflows/issues/1442"
fn storedWorkflowTemplateSpec.templateDefaults.dag.withTarget
withTarget(target)
"Target are one or more names of targets to execute in a DAG"
fn storedWorkflowTemplateSpec.templateDefaults.dag.withTasks
withTasks(tasks)
"Tasks are a list of DAG tasks"
fn storedWorkflowTemplateSpec.templateDefaults.dag.withTasksMixin
withTasksMixin(tasks)
"Tasks are a list of DAG tasks"
Note: This function appends passed data to existing values
obj storedWorkflowTemplateSpec.templateDefaults.data
"Data is a data template"
fn storedWorkflowTemplateSpec.templateDefaults.data.withTransformation
withTransformation(transformation)
"Transformation applies a set of transformations"
fn storedWorkflowTemplateSpec.templateDefaults.data.withTransformationMixin
withTransformationMixin(transformation)
"Transformation applies a set of transformations"
Note: This function appends passed data to existing values
obj storedWorkflowTemplateSpec.templateDefaults.data.source
"DataSource sources external data into a data template"
obj storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths
"ArtifactPaths expands a step from a collection of artifacts"
fn storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.withArchiveLogs
withArchiveLogs(archiveLogs)
"ArchiveLogs indicates if the container logs should be archived"
fn storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.withFrom
withFrom(from)
"From allows an artifact to reference an artifact from a previous step"
fn storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.withFromExpression
withFromExpression(fromExpression)
"FromExpression, if defined, is evaluated to specify the value for the artifact"
fn storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.withGlobalName
withGlobalName(globalName)
"GlobalName exports an output artifact to the global scope, making it available as '{{io.argoproj.workflow.v1alpha1.outputs.artifacts.XXXX}} and in workflow.status.outputs.artifacts"
fn storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.withMode
withMode(mode)
"mode bits to use on this file, must be a value between 0 and 0777 set when loading input artifacts."
fn storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.withName
withName(name)
"name of the artifact. must be unique within a template's inputs/outputs."
fn storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.withOptional
withOptional(optional)
"Make Artifacts optional, if Artifacts doesn't generate or exist"
fn storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.withPath
withPath(path)
"Path is the container path to the artifact"
fn storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.withRecurseMode
withRecurseMode(recurseMode)
"If mode is set, apply the permission recursively into the artifact if it is a folder"
fn storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.withSubPath
withSubPath(subPath)
"SubPath allows an artifact to be sourced from a subpath within the specified source"
obj storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.archive
"ArchiveStrategy describes how to archive files/directory when saving artifacts"
fn storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.archive.withNone
withNone(none)
"NoneStrategy indicates to skip tar process and upload the files or directory tree as independent files. Note that if the artifact is a directory, the artifact driver must support the ability to save/load the directory appropriately."
fn storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.archive.withNoneMixin
withNoneMixin(none)
"NoneStrategy indicates to skip tar process and upload the files or directory tree as independent files. Note that if the artifact is a directory, the artifact driver must support the ability to save/load the directory appropriately."
Note: This function appends passed data to existing values
fn storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.archive.withZip
withZip(zip)
"ZipStrategy will unzip zipped input artifacts"
fn storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.archive.withZipMixin
withZipMixin(zip)
"ZipStrategy will unzip zipped input artifacts"
Note: This function appends passed data to existing values
obj storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.archive.tar
"TarStrategy will tar and gzip the file or directory when saving"
fn storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.archive.tar.withCompressionLevel
withCompressionLevel(compressionLevel)
"CompressionLevel specifies the gzip compression level to use for the artifact. Defaults to gzip.DefaultCompression."
obj storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.artifactory
"ArtifactoryArtifact is the location of an artifactory artifact"
fn storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.artifactory.withUrl
withUrl(url)
"URL of the artifact"
obj storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.artifactory.passwordSecret
"SecretKeySelector selects a key of a Secret."
fn storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.artifactory.passwordSecret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.artifactory.passwordSecret.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.artifactory.passwordSecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.artifactory.usernameSecret
"SecretKeySelector selects a key of a Secret."
fn storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.artifactory.usernameSecret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.artifactory.usernameSecret.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.artifactory.usernameSecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.gcs
"GCSArtifact is the location of a GCS artifact"
fn storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.gcs.withBucket
withBucket(bucket)
"Bucket is the name of the bucket"
fn storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.gcs.withKey
withKey(key)
"Key is the path in the bucket where the artifact resides"
obj storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.gcs.serviceAccountKeySecret
"SecretKeySelector selects a key of a Secret."
fn storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.gcs.serviceAccountKeySecret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.gcs.serviceAccountKeySecret.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.gcs.serviceAccountKeySecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.git
"GitArtifact is the location of an git artifact"
fn storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.git.withDepth
withDepth(depth)
"Depth specifies clones/fetches should be shallow and include the given number of commits from the branch tip"
fn storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.git.withDisableSubmodules
withDisableSubmodules(disableSubmodules)
"DisableSubmodules disables submodules during git clone"
fn storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.git.withFetch
withFetch(fetch)
"Fetch specifies a number of refs that should be fetched before checkout"
fn storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.git.withFetchMixin
withFetchMixin(fetch)
"Fetch specifies a number of refs that should be fetched before checkout"
Note: This function appends passed data to existing values
fn storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.git.withInsecureIgnoreHostKey
withInsecureIgnoreHostKey(insecureIgnoreHostKey)
"InsecureIgnoreHostKey disables SSH strict host key checking during git clone"
fn storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.git.withRepo
withRepo(repo)
"Repo is the git repository"
fn storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.git.withRevision
withRevision(revision)
"Revision is the git commit, tag, branch to checkout"
obj storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.git.passwordSecret
"SecretKeySelector selects a key of a Secret."
fn storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.git.passwordSecret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.git.passwordSecret.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.git.passwordSecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.git.sshPrivateKeySecret
"SecretKeySelector selects a key of a Secret."
fn storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.git.sshPrivateKeySecret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.git.sshPrivateKeySecret.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.git.sshPrivateKeySecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.git.usernameSecret
"SecretKeySelector selects a key of a Secret."
fn storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.git.usernameSecret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.git.usernameSecret.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.git.usernameSecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.hdfs
"HDFSArtifact is the location of an HDFS artifact"
fn storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.hdfs.withAddresses
withAddresses(addresses)
"Addresses is accessible addresses of HDFS name nodes"
fn storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.hdfs.withAddressesMixin
withAddressesMixin(addresses)
"Addresses is accessible addresses of HDFS name nodes"
Note: This function appends passed data to existing values
fn storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.hdfs.withForce
withForce(force)
"Force copies a file forcibly even if it exists (default: false)"
fn storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.hdfs.withHdfsUser
withHdfsUser(hdfsUser)
"HDFSUser is the user to access HDFS file system. It is ignored if either ccache or keytab is used."
fn storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.hdfs.withKrbRealm
withKrbRealm(krbRealm)
"KrbRealm is the Kerberos realm used with Kerberos keytab It must be set if keytab is used."
fn storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.hdfs.withKrbServicePrincipalName
withKrbServicePrincipalName(krbServicePrincipalName)
"KrbServicePrincipalName is the principal name of Kerberos service It must be set if either ccache or keytab is used."
fn storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.hdfs.withKrbUsername
withKrbUsername(krbUsername)
"KrbUsername is the Kerberos username used with Kerberos keytab It must be set if keytab is used."
fn storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.hdfs.withPath
withPath(path)
"Path is a file path in HDFS"
obj storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.hdfs.krbCCacheSecret
"SecretKeySelector selects a key of a Secret."
fn storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.hdfs.krbCCacheSecret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.hdfs.krbCCacheSecret.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.hdfs.krbCCacheSecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.hdfs.krbConfigConfigMap
"Selects a key from a ConfigMap."
fn storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.hdfs.krbConfigConfigMap.withKey
withKey(key)
"The key to select."
fn storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.hdfs.krbConfigConfigMap.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.hdfs.krbConfigConfigMap.withOptional
withOptional(optional)
"Specify whether the ConfigMap or its key must be defined"
obj storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.hdfs.krbKeytabSecret
"SecretKeySelector selects a key of a Secret."
fn storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.hdfs.krbKeytabSecret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.hdfs.krbKeytabSecret.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.hdfs.krbKeytabSecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.http
"HTTPArtifact allows an file served on HTTP to be placed as an input artifact in a container"
fn storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.http.withHeaders
withHeaders(headers)
"Headers are an optional list of headers to send with HTTP requests for artifacts"
fn storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.http.withHeadersMixin
withHeadersMixin(headers)
"Headers are an optional list of headers to send with HTTP requests for artifacts"
Note: This function appends passed data to existing values
fn storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.http.withUrl
withUrl(url)
"URL of the artifact"
obj storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.oss
"OSSArtifact is the location of an Alibaba Cloud OSS artifact"
fn storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.oss.withBucket
withBucket(bucket)
"Bucket is the name of the bucket"
fn storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.oss.withCreateBucketIfNotPresent
withCreateBucketIfNotPresent(createBucketIfNotPresent)
"CreateBucketIfNotPresent tells the driver to attempt to create the OSS bucket for output artifacts, if it doesn't exist"
fn storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.oss.withEndpoint
withEndpoint(endpoint)
"Endpoint is the hostname of the bucket endpoint"
fn storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.oss.withKey
withKey(key)
"Key is the path in the bucket where the artifact resides"
fn storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.oss.withSecurityToken
withSecurityToken(securityToken)
"SecurityToken is the user's temporary security token. For more details, check out: https://www.alibabacloud.com/help/doc-detail/100624.htm"
obj storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.oss.accessKeySecret
"SecretKeySelector selects a key of a Secret."
fn storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.oss.accessKeySecret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.oss.accessKeySecret.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.oss.accessKeySecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.oss.lifecycleRule
"OSSLifecycleRule specifies how to manage bucket's lifecycle"
fn storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.oss.lifecycleRule.withMarkDeletionAfterDays
withMarkDeletionAfterDays(markDeletionAfterDays)
"MarkDeletionAfterDays is the number of days before we delete objects in the bucket"
fn storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.oss.lifecycleRule.withMarkInfrequentAccessAfterDays
withMarkInfrequentAccessAfterDays(markInfrequentAccessAfterDays)
"MarkInfrequentAccessAfterDays is the number of days before we convert the objects in the bucket to Infrequent Access (IA) storage type"
obj storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.oss.secretKeySecret
"SecretKeySelector selects a key of a Secret."
fn storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.oss.secretKeySecret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.oss.secretKeySecret.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.oss.secretKeySecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.raw
"RawArtifact allows raw string content to be placed as an artifact in a container"
fn storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.raw.withData
withData(data)
"Data is the string contents of the artifact"
obj storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.s3
"S3Artifact is the location of an S3 artifact"
fn storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.s3.withBucket
withBucket(bucket)
"Bucket is the name of the bucket"
fn storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.s3.withEndpoint
withEndpoint(endpoint)
"Endpoint is the hostname of the bucket endpoint"
fn storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.s3.withInsecure
withInsecure(insecure)
"Insecure will connect to the service with TLS"
fn storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.s3.withKey
withKey(key)
"Key is the key in the bucket where the artifact resides"
fn storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.s3.withRegion
withRegion(region)
"Region contains the optional bucket region"
fn storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.s3.withRoleARN
withRoleARN(roleARN)
"RoleARN is the Amazon Resource Name (ARN) of the role to assume."
fn storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.s3.withUseSDKCreds
withUseSDKCreds(useSDKCreds)
"UseSDKCreds tells the driver to figure out credentials based on sdk defaults."
obj storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.s3.accessKeySecret
"SecretKeySelector selects a key of a Secret."
fn storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.s3.accessKeySecret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.s3.accessKeySecret.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.s3.accessKeySecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.s3.createBucketIfNotPresent
"CreateS3BucketOptions options used to determine automatic automatic bucket-creation process"
fn storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.s3.createBucketIfNotPresent.withObjectLocking
withObjectLocking(objectLocking)
"ObjectLocking Enable object locking"
obj storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.s3.secretKeySecret
"SecretKeySelector selects a key of a Secret."
fn storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.s3.secretKeySecret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.s3.secretKeySecret.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn storedWorkflowTemplateSpec.templateDefaults.data.source.artifactPaths.s3.secretKeySecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj storedWorkflowTemplateSpec.templateDefaults.executor
"ExecutorConfig holds configurations of an executor container."
fn storedWorkflowTemplateSpec.templateDefaults.executor.withServiceAccountName
withServiceAccountName(serviceAccountName)
"ServiceAccountName specifies the service account name of the executor container."
obj storedWorkflowTemplateSpec.templateDefaults.inputs
"Inputs are the mechanism for passing parameters, artifacts, volumes from one template to another"
fn storedWorkflowTemplateSpec.templateDefaults.inputs.withArtifacts
withArtifacts(artifacts)
"Artifact are a list of artifacts passed as inputs"
fn storedWorkflowTemplateSpec.templateDefaults.inputs.withArtifactsMixin
withArtifactsMixin(artifacts)
"Artifact are a list of artifacts passed as inputs"
Note: This function appends passed data to existing values
fn storedWorkflowTemplateSpec.templateDefaults.inputs.withParameters
withParameters(parameters)
"Parameters are a list of parameters passed as inputs"
fn storedWorkflowTemplateSpec.templateDefaults.inputs.withParametersMixin
withParametersMixin(parameters)
"Parameters are a list of parameters passed as inputs"
Note: This function appends passed data to existing values
obj storedWorkflowTemplateSpec.templateDefaults.memoize
"Memoization enables caching for the Outputs of the template"
fn storedWorkflowTemplateSpec.templateDefaults.memoize.withKey
withKey(key)
"Key is the key to use as the caching key"
fn storedWorkflowTemplateSpec.templateDefaults.memoize.withMaxAge
withMaxAge(maxAge)
"MaxAge is the maximum age (e.g. \"180s\", \"24h\") of an entry that is still considered valid. If an entry is older than the MaxAge, it will be ignored."
obj storedWorkflowTemplateSpec.templateDefaults.memoize.cache
"Cache is the configuration for the type of cache to be used"
obj storedWorkflowTemplateSpec.templateDefaults.memoize.cache.configMap
"Selects a key from a ConfigMap."
fn storedWorkflowTemplateSpec.templateDefaults.memoize.cache.configMap.withKey
withKey(key)
"The key to select."
fn storedWorkflowTemplateSpec.templateDefaults.memoize.cache.configMap.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn storedWorkflowTemplateSpec.templateDefaults.memoize.cache.configMap.withOptional
withOptional(optional)
"Specify whether the ConfigMap or its key must be defined"
obj storedWorkflowTemplateSpec.templateDefaults.metadata
"Pod metdata"
fn storedWorkflowTemplateSpec.templateDefaults.metadata.withAnnotations
withAnnotations(annotations)
fn storedWorkflowTemplateSpec.templateDefaults.metadata.withAnnotationsMixin
withAnnotationsMixin(annotations)
Note: This function appends passed data to existing values
fn storedWorkflowTemplateSpec.templateDefaults.metadata.withLabels
withLabels(labels)
fn storedWorkflowTemplateSpec.templateDefaults.metadata.withLabelsMixin
withLabelsMixin(labels)
Note: This function appends passed data to existing values
obj storedWorkflowTemplateSpec.templateDefaults.metrics
"Metrics are a list of metrics emitted from a Workflow/Template"
fn storedWorkflowTemplateSpec.templateDefaults.metrics.withPrometheus
withPrometheus(prometheus)
"Prometheus is a list of prometheus metrics to be emitted"
fn storedWorkflowTemplateSpec.templateDefaults.metrics.withPrometheusMixin
withPrometheusMixin(prometheus)
"Prometheus is a list of prometheus metrics to be emitted"
Note: This function appends passed data to existing values
obj storedWorkflowTemplateSpec.templateDefaults.outputs
"Outputs hold parameters, artifacts, and results from a step"
fn storedWorkflowTemplateSpec.templateDefaults.outputs.withArtifacts
withArtifacts(artifacts)
"Artifacts holds the list of output artifacts produced by a step"
fn storedWorkflowTemplateSpec.templateDefaults.outputs.withArtifactsMixin
withArtifactsMixin(artifacts)
"Artifacts holds the list of output artifacts produced by a step"
Note: This function appends passed data to existing values
fn storedWorkflowTemplateSpec.templateDefaults.outputs.withExitCode
withExitCode(exitCode)
"ExitCode holds the exit code of a script template"
fn storedWorkflowTemplateSpec.templateDefaults.outputs.withParameters
withParameters(parameters)
"Parameters holds the list of output parameters produced by a step"
fn storedWorkflowTemplateSpec.templateDefaults.outputs.withParametersMixin
withParametersMixin(parameters)
"Parameters holds the list of output parameters produced by a step"
Note: This function appends passed data to existing values
fn storedWorkflowTemplateSpec.templateDefaults.outputs.withResult
withResult(result)
"Result holds the result (stdout) of a script template"
obj storedWorkflowTemplateSpec.templateDefaults.resource
"ResourceTemplate is a template subtype to manipulate kubernetes resources"
fn storedWorkflowTemplateSpec.templateDefaults.resource.withAction
withAction(action)
"Action is the action to perform to the resource. Must be one of: get, create, apply, delete, replace, patch"
fn storedWorkflowTemplateSpec.templateDefaults.resource.withFailureCondition
withFailureCondition(failureCondition)
"FailureCondition is a label selector expression which describes the conditions of the k8s resource in which the step was considered failed"
fn storedWorkflowTemplateSpec.templateDefaults.resource.withFlags
withFlags(flags)
"Flags is a set of additional options passed to kubectl before submitting a resource I.e. to disable resource validation: flags: [\n\t\"--validate=false\" # disable resource validation\n]"
fn storedWorkflowTemplateSpec.templateDefaults.resource.withFlagsMixin
withFlagsMixin(flags)
"Flags is a set of additional options passed to kubectl before submitting a resource I.e. to disable resource validation: flags: [\n\t\"--validate=false\" # disable resource validation\n]"
Note: This function appends passed data to existing values
fn storedWorkflowTemplateSpec.templateDefaults.resource.withManifest
withManifest(manifest)
"Manifest contains the kubernetes manifest"
fn storedWorkflowTemplateSpec.templateDefaults.resource.withMergeStrategy
withMergeStrategy(mergeStrategy)
"MergeStrategy is the strategy used to merge a patch. It defaults to \"strategic\" Must be one of: strategic, merge, json"
fn storedWorkflowTemplateSpec.templateDefaults.resource.withSetOwnerReference
withSetOwnerReference(setOwnerReference)
"SetOwnerReference sets the reference to the workflow on the OwnerReference of generated resource."
fn storedWorkflowTemplateSpec.templateDefaults.resource.withSuccessCondition
withSuccessCondition(successCondition)
"SuccessCondition is a label selector expression which describes the conditions of the k8s resource in which it is acceptable to proceed to the following step"
obj storedWorkflowTemplateSpec.templateDefaults.retryStrategy
"RetryStrategy provides controls on how to retry a workflow step"
fn storedWorkflowTemplateSpec.templateDefaults.retryStrategy.withLimit
withLimit(limit)
fn storedWorkflowTemplateSpec.templateDefaults.retryStrategy.withRetryPolicy
withRetryPolicy(retryPolicy)
"RetryPolicy is a policy of NodePhase statuses that will be retried"
obj storedWorkflowTemplateSpec.templateDefaults.retryStrategy.affinity
"RetryAffinity prevents running steps on the same host."
fn storedWorkflowTemplateSpec.templateDefaults.retryStrategy.affinity.withNodeAntiAffinity
withNodeAntiAffinity(nodeAntiAffinity)
"RetryNodeAntiAffinity is a placeholder for future expansion, only empty nodeAntiAffinity is allowed. In order to prevent running steps on the same host, it uses \"kubernetes.io/hostname\"."
fn storedWorkflowTemplateSpec.templateDefaults.retryStrategy.affinity.withNodeAntiAffinityMixin
withNodeAntiAffinityMixin(nodeAntiAffinity)
"RetryNodeAntiAffinity is a placeholder for future expansion, only empty nodeAntiAffinity is allowed. In order to prevent running steps on the same host, it uses \"kubernetes.io/hostname\"."
Note: This function appends passed data to existing values
obj storedWorkflowTemplateSpec.templateDefaults.retryStrategy.backoff
"Backoff is a backoff strategy to use within retryStrategy"
fn storedWorkflowTemplateSpec.templateDefaults.retryStrategy.backoff.withDuration
withDuration(duration)
"Duration is the amount to back off. Default unit is seconds, but could also be a duration (e.g. \"2m\", \"1h\")"
fn storedWorkflowTemplateSpec.templateDefaults.retryStrategy.backoff.withFactor
withFactor(factor)
fn storedWorkflowTemplateSpec.templateDefaults.retryStrategy.backoff.withMaxDuration
withMaxDuration(maxDuration)
"MaxDuration is the maximum amount of time allowed for the backoff strategy"
obj storedWorkflowTemplateSpec.templateDefaults.script
"ScriptTemplate is a template subtype to enable scripting through code steps"
fn storedWorkflowTemplateSpec.templateDefaults.script.withArgs
withArgs(args)
"Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell"
fn storedWorkflowTemplateSpec.templateDefaults.script.withArgsMixin
withArgsMixin(args)
"Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell"
Note: This function appends passed data to existing values
fn storedWorkflowTemplateSpec.templateDefaults.script.withCommand
withCommand(command)
"Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell"
fn storedWorkflowTemplateSpec.templateDefaults.script.withCommandMixin
withCommandMixin(command)
"Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell"
Note: This function appends passed data to existing values
fn storedWorkflowTemplateSpec.templateDefaults.script.withEnv
withEnv(env)
"List of environment variables to set in the container. Cannot be updated."
fn storedWorkflowTemplateSpec.templateDefaults.script.withEnvFrom
withEnvFrom(envFrom)
"List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated."
fn storedWorkflowTemplateSpec.templateDefaults.script.withEnvFromMixin
withEnvFromMixin(envFrom)
"List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated."
Note: This function appends passed data to existing values
fn storedWorkflowTemplateSpec.templateDefaults.script.withEnvMixin
withEnvMixin(env)
"List of environment variables to set in the container. Cannot be updated."
Note: This function appends passed data to existing values
fn storedWorkflowTemplateSpec.templateDefaults.script.withImage
withImage(image)
"Docker image name. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets."
fn storedWorkflowTemplateSpec.templateDefaults.script.withImagePullPolicy
withImagePullPolicy(imagePullPolicy)
"Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images"
fn storedWorkflowTemplateSpec.templateDefaults.script.withName
withName(name)
"Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated."
fn storedWorkflowTemplateSpec.templateDefaults.script.withPorts
withPorts(ports)
"List of ports to expose from the container. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default \"0.0.0.0\" address inside a container will be accessible from the network. Cannot be updated."
fn storedWorkflowTemplateSpec.templateDefaults.script.withPortsMixin
withPortsMixin(ports)
"List of ports to expose from the container. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default \"0.0.0.0\" address inside a container will be accessible from the network. Cannot be updated."
Note: This function appends passed data to existing values
fn storedWorkflowTemplateSpec.templateDefaults.script.withSource
withSource(source)
"Source contains the source code of the script to execute"
fn storedWorkflowTemplateSpec.templateDefaults.script.withStdin
withStdin(stdin)
"Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false."
fn storedWorkflowTemplateSpec.templateDefaults.script.withStdinOnce
withStdinOnce(stdinOnce)
"Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false"
fn storedWorkflowTemplateSpec.templateDefaults.script.withTerminationMessagePath
withTerminationMessagePath(terminationMessagePath)
"Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated."
fn storedWorkflowTemplateSpec.templateDefaults.script.withTerminationMessagePolicy
withTerminationMessagePolicy(terminationMessagePolicy)
"Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated."
fn storedWorkflowTemplateSpec.templateDefaults.script.withTty
withTty(tty)
"Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false."
fn storedWorkflowTemplateSpec.templateDefaults.script.withVolumeDevices
withVolumeDevices(volumeDevices)
"volumeDevices is the list of block devices to be used by the container."
fn storedWorkflowTemplateSpec.templateDefaults.script.withVolumeDevicesMixin
withVolumeDevicesMixin(volumeDevices)
"volumeDevices is the list of block devices to be used by the container."
Note: This function appends passed data to existing values
fn storedWorkflowTemplateSpec.templateDefaults.script.withVolumeMounts
withVolumeMounts(volumeMounts)
"Pod volumes to mount into the container's filesystem. Cannot be updated."
fn storedWorkflowTemplateSpec.templateDefaults.script.withVolumeMountsMixin
withVolumeMountsMixin(volumeMounts)
"Pod volumes to mount into the container's filesystem. Cannot be updated."
Note: This function appends passed data to existing values
fn storedWorkflowTemplateSpec.templateDefaults.script.withWorkingDir
withWorkingDir(workingDir)
"Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated."
obj storedWorkflowTemplateSpec.templateDefaults.script.lifecycle
"Lifecycle describes actions that the management system should take in response to container lifecycle events. For the PostStart and PreStop lifecycle handlers, management of the container blocks until the action is complete, unless the container process fails, in which case the handler is aborted."
obj storedWorkflowTemplateSpec.templateDefaults.script.lifecycle.postStart
"Handler defines a specific action that should be taken"
obj storedWorkflowTemplateSpec.templateDefaults.script.lifecycle.postStart.exec
"ExecAction describes a \"run in container\" action."
fn storedWorkflowTemplateSpec.templateDefaults.script.lifecycle.postStart.exec.withCommand
withCommand(command)
"Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy."
fn storedWorkflowTemplateSpec.templateDefaults.script.lifecycle.postStart.exec.withCommandMixin
withCommandMixin(command)
"Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy."
Note: This function appends passed data to existing values
obj storedWorkflowTemplateSpec.templateDefaults.script.lifecycle.postStart.httpGet
"HTTPGetAction describes an action based on HTTP Get requests."
fn storedWorkflowTemplateSpec.templateDefaults.script.lifecycle.postStart.httpGet.withHost
withHost(host)
"Host name to connect to, defaults to the pod IP. You probably want to set \"Host\" in httpHeaders instead."
fn storedWorkflowTemplateSpec.templateDefaults.script.lifecycle.postStart.httpGet.withHttpHeaders
withHttpHeaders(httpHeaders)
"Custom headers to set in the request. HTTP allows repeated headers."
fn storedWorkflowTemplateSpec.templateDefaults.script.lifecycle.postStart.httpGet.withHttpHeadersMixin
withHttpHeadersMixin(httpHeaders)
"Custom headers to set in the request. HTTP allows repeated headers."
Note: This function appends passed data to existing values
fn storedWorkflowTemplateSpec.templateDefaults.script.lifecycle.postStart.httpGet.withPath
withPath(path)
"Path to access on the HTTP server."
fn storedWorkflowTemplateSpec.templateDefaults.script.lifecycle.postStart.httpGet.withPort
withPort(port)
fn storedWorkflowTemplateSpec.templateDefaults.script.lifecycle.postStart.httpGet.withScheme
withScheme(scheme)
"Scheme to use for connecting to the host. Defaults to HTTP."
obj storedWorkflowTemplateSpec.templateDefaults.script.lifecycle.postStart.tcpSocket
"TCPSocketAction describes an action based on opening a socket"
fn storedWorkflowTemplateSpec.templateDefaults.script.lifecycle.postStart.tcpSocket.withHost
withHost(host)
"Optional: Host name to connect to, defaults to the pod IP."
fn storedWorkflowTemplateSpec.templateDefaults.script.lifecycle.postStart.tcpSocket.withPort
withPort(port)
obj storedWorkflowTemplateSpec.templateDefaults.script.lifecycle.preStop
"Handler defines a specific action that should be taken"
obj storedWorkflowTemplateSpec.templateDefaults.script.lifecycle.preStop.exec
"ExecAction describes a \"run in container\" action."
fn storedWorkflowTemplateSpec.templateDefaults.script.lifecycle.preStop.exec.withCommand
withCommand(command)
"Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy."
fn storedWorkflowTemplateSpec.templateDefaults.script.lifecycle.preStop.exec.withCommandMixin
withCommandMixin(command)
"Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy."
Note: This function appends passed data to existing values
obj storedWorkflowTemplateSpec.templateDefaults.script.lifecycle.preStop.httpGet
"HTTPGetAction describes an action based on HTTP Get requests."
fn storedWorkflowTemplateSpec.templateDefaults.script.lifecycle.preStop.httpGet.withHost
withHost(host)
"Host name to connect to, defaults to the pod IP. You probably want to set \"Host\" in httpHeaders instead."
fn storedWorkflowTemplateSpec.templateDefaults.script.lifecycle.preStop.httpGet.withHttpHeaders
withHttpHeaders(httpHeaders)
"Custom headers to set in the request. HTTP allows repeated headers."
fn storedWorkflowTemplateSpec.templateDefaults.script.lifecycle.preStop.httpGet.withHttpHeadersMixin
withHttpHeadersMixin(httpHeaders)
"Custom headers to set in the request. HTTP allows repeated headers."
Note: This function appends passed data to existing values
fn storedWorkflowTemplateSpec.templateDefaults.script.lifecycle.preStop.httpGet.withPath
withPath(path)
"Path to access on the HTTP server."
fn storedWorkflowTemplateSpec.templateDefaults.script.lifecycle.preStop.httpGet.withPort
withPort(port)
fn storedWorkflowTemplateSpec.templateDefaults.script.lifecycle.preStop.httpGet.withScheme
withScheme(scheme)
"Scheme to use for connecting to the host. Defaults to HTTP."
obj storedWorkflowTemplateSpec.templateDefaults.script.lifecycle.preStop.tcpSocket
"TCPSocketAction describes an action based on opening a socket"
fn storedWorkflowTemplateSpec.templateDefaults.script.lifecycle.preStop.tcpSocket.withHost
withHost(host)
"Optional: Host name to connect to, defaults to the pod IP."
fn storedWorkflowTemplateSpec.templateDefaults.script.lifecycle.preStop.tcpSocket.withPort
withPort(port)
obj storedWorkflowTemplateSpec.templateDefaults.script.livenessProbe
"Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic."
fn storedWorkflowTemplateSpec.templateDefaults.script.livenessProbe.withFailureThreshold
withFailureThreshold(failureThreshold)
"Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1."
fn storedWorkflowTemplateSpec.templateDefaults.script.livenessProbe.withInitialDelaySeconds
withInitialDelaySeconds(initialDelaySeconds)
"Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"
fn storedWorkflowTemplateSpec.templateDefaults.script.livenessProbe.withPeriodSeconds
withPeriodSeconds(periodSeconds)
"How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1."
fn storedWorkflowTemplateSpec.templateDefaults.script.livenessProbe.withSuccessThreshold
withSuccessThreshold(successThreshold)
"Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1."
fn storedWorkflowTemplateSpec.templateDefaults.script.livenessProbe.withTimeoutSeconds
withTimeoutSeconds(timeoutSeconds)
"Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"
obj storedWorkflowTemplateSpec.templateDefaults.script.livenessProbe.exec
"ExecAction describes a \"run in container\" action."
fn storedWorkflowTemplateSpec.templateDefaults.script.livenessProbe.exec.withCommand
withCommand(command)
"Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy."
fn storedWorkflowTemplateSpec.templateDefaults.script.livenessProbe.exec.withCommandMixin
withCommandMixin(command)
"Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy."
Note: This function appends passed data to existing values
obj storedWorkflowTemplateSpec.templateDefaults.script.livenessProbe.httpGet
"HTTPGetAction describes an action based on HTTP Get requests."
fn storedWorkflowTemplateSpec.templateDefaults.script.livenessProbe.httpGet.withHost
withHost(host)
"Host name to connect to, defaults to the pod IP. You probably want to set \"Host\" in httpHeaders instead."
fn storedWorkflowTemplateSpec.templateDefaults.script.livenessProbe.httpGet.withHttpHeaders
withHttpHeaders(httpHeaders)
"Custom headers to set in the request. HTTP allows repeated headers."
fn storedWorkflowTemplateSpec.templateDefaults.script.livenessProbe.httpGet.withHttpHeadersMixin
withHttpHeadersMixin(httpHeaders)
"Custom headers to set in the request. HTTP allows repeated headers."
Note: This function appends passed data to existing values
fn storedWorkflowTemplateSpec.templateDefaults.script.livenessProbe.httpGet.withPath
withPath(path)
"Path to access on the HTTP server."
fn storedWorkflowTemplateSpec.templateDefaults.script.livenessProbe.httpGet.withPort
withPort(port)
fn storedWorkflowTemplateSpec.templateDefaults.script.livenessProbe.httpGet.withScheme
withScheme(scheme)
"Scheme to use for connecting to the host. Defaults to HTTP."
obj storedWorkflowTemplateSpec.templateDefaults.script.livenessProbe.tcpSocket
"TCPSocketAction describes an action based on opening a socket"
fn storedWorkflowTemplateSpec.templateDefaults.script.livenessProbe.tcpSocket.withHost
withHost(host)
"Optional: Host name to connect to, defaults to the pod IP."
fn storedWorkflowTemplateSpec.templateDefaults.script.livenessProbe.tcpSocket.withPort
withPort(port)
obj storedWorkflowTemplateSpec.templateDefaults.script.readinessProbe
"Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic."
fn storedWorkflowTemplateSpec.templateDefaults.script.readinessProbe.withFailureThreshold
withFailureThreshold(failureThreshold)
"Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1."
fn storedWorkflowTemplateSpec.templateDefaults.script.readinessProbe.withInitialDelaySeconds
withInitialDelaySeconds(initialDelaySeconds)
"Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"
fn storedWorkflowTemplateSpec.templateDefaults.script.readinessProbe.withPeriodSeconds
withPeriodSeconds(periodSeconds)
"How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1."
fn storedWorkflowTemplateSpec.templateDefaults.script.readinessProbe.withSuccessThreshold
withSuccessThreshold(successThreshold)
"Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1."
fn storedWorkflowTemplateSpec.templateDefaults.script.readinessProbe.withTimeoutSeconds
withTimeoutSeconds(timeoutSeconds)
"Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"
obj storedWorkflowTemplateSpec.templateDefaults.script.readinessProbe.exec
"ExecAction describes a \"run in container\" action."
fn storedWorkflowTemplateSpec.templateDefaults.script.readinessProbe.exec.withCommand
withCommand(command)
"Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy."
fn storedWorkflowTemplateSpec.templateDefaults.script.readinessProbe.exec.withCommandMixin
withCommandMixin(command)
"Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy."
Note: This function appends passed data to existing values
obj storedWorkflowTemplateSpec.templateDefaults.script.readinessProbe.httpGet
"HTTPGetAction describes an action based on HTTP Get requests."
fn storedWorkflowTemplateSpec.templateDefaults.script.readinessProbe.httpGet.withHost
withHost(host)
"Host name to connect to, defaults to the pod IP. You probably want to set \"Host\" in httpHeaders instead."
fn storedWorkflowTemplateSpec.templateDefaults.script.readinessProbe.httpGet.withHttpHeaders
withHttpHeaders(httpHeaders)
"Custom headers to set in the request. HTTP allows repeated headers."
fn storedWorkflowTemplateSpec.templateDefaults.script.readinessProbe.httpGet.withHttpHeadersMixin
withHttpHeadersMixin(httpHeaders)
"Custom headers to set in the request. HTTP allows repeated headers."
Note: This function appends passed data to existing values
fn storedWorkflowTemplateSpec.templateDefaults.script.readinessProbe.httpGet.withPath
withPath(path)
"Path to access on the HTTP server."
fn storedWorkflowTemplateSpec.templateDefaults.script.readinessProbe.httpGet.withPort
withPort(port)
fn storedWorkflowTemplateSpec.templateDefaults.script.readinessProbe.httpGet.withScheme
withScheme(scheme)
"Scheme to use for connecting to the host. Defaults to HTTP."
obj storedWorkflowTemplateSpec.templateDefaults.script.readinessProbe.tcpSocket
"TCPSocketAction describes an action based on opening a socket"
fn storedWorkflowTemplateSpec.templateDefaults.script.readinessProbe.tcpSocket.withHost
withHost(host)
"Optional: Host name to connect to, defaults to the pod IP."
fn storedWorkflowTemplateSpec.templateDefaults.script.readinessProbe.tcpSocket.withPort
withPort(port)
obj storedWorkflowTemplateSpec.templateDefaults.script.resources
"ResourceRequirements describes the compute resource requirements."
fn storedWorkflowTemplateSpec.templateDefaults.script.resources.withLimits
withLimits(limits)
"Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/"
fn storedWorkflowTemplateSpec.templateDefaults.script.resources.withLimitsMixin
withLimitsMixin(limits)
"Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/"
Note: This function appends passed data to existing values
fn storedWorkflowTemplateSpec.templateDefaults.script.resources.withRequests
withRequests(requests)
"Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/"
fn storedWorkflowTemplateSpec.templateDefaults.script.resources.withRequestsMixin
withRequestsMixin(requests)
"Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/"
Note: This function appends passed data to existing values
obj storedWorkflowTemplateSpec.templateDefaults.script.securityContext
"SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence."
fn storedWorkflowTemplateSpec.templateDefaults.script.securityContext.withAllowPrivilegeEscalation
withAllowPrivilegeEscalation(allowPrivilegeEscalation)
"AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN"
fn storedWorkflowTemplateSpec.templateDefaults.script.securityContext.withPrivileged
withPrivileged(privileged)
"Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false."
fn storedWorkflowTemplateSpec.templateDefaults.script.securityContext.withProcMount
withProcMount(procMount)
"procMount denotes the type of proc mount to use for the containers. The default is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled."
fn storedWorkflowTemplateSpec.templateDefaults.script.securityContext.withReadOnlyRootFilesystem
withReadOnlyRootFilesystem(readOnlyRootFilesystem)
"Whether this container has a read-only root filesystem. Default is false."
fn storedWorkflowTemplateSpec.templateDefaults.script.securityContext.withRunAsGroup
withRunAsGroup(runAsGroup)
"The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence."
fn storedWorkflowTemplateSpec.templateDefaults.script.securityContext.withRunAsNonRoot
withRunAsNonRoot(runAsNonRoot)
"Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence."
fn storedWorkflowTemplateSpec.templateDefaults.script.securityContext.withRunAsUser
withRunAsUser(runAsUser)
"The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence."
obj storedWorkflowTemplateSpec.templateDefaults.script.securityContext.capabilities
"Adds and removes POSIX capabilities from running containers."
fn storedWorkflowTemplateSpec.templateDefaults.script.securityContext.capabilities.withAdd
withAdd(add)
"Added capabilities"
fn storedWorkflowTemplateSpec.templateDefaults.script.securityContext.capabilities.withAddMixin
withAddMixin(add)
"Added capabilities"
Note: This function appends passed data to existing values
fn storedWorkflowTemplateSpec.templateDefaults.script.securityContext.capabilities.withDrop
withDrop(drop)
"Removed capabilities"
fn storedWorkflowTemplateSpec.templateDefaults.script.securityContext.capabilities.withDropMixin
withDropMixin(drop)
"Removed capabilities"
Note: This function appends passed data to existing values
obj storedWorkflowTemplateSpec.templateDefaults.script.securityContext.seLinuxOptions
"SELinuxOptions are the labels to be applied to the container"
fn storedWorkflowTemplateSpec.templateDefaults.script.securityContext.seLinuxOptions.withLevel
withLevel(level)
"Level is SELinux level label that applies to the container."
fn storedWorkflowTemplateSpec.templateDefaults.script.securityContext.seLinuxOptions.withRole
withRole(role)
"Role is a SELinux role label that applies to the container."
fn storedWorkflowTemplateSpec.templateDefaults.script.securityContext.seLinuxOptions.withType
withType(type)
"Type is a SELinux type label that applies to the container."
fn storedWorkflowTemplateSpec.templateDefaults.script.securityContext.seLinuxOptions.withUser
withUser(user)
"User is a SELinux user label that applies to the container."
obj storedWorkflowTemplateSpec.templateDefaults.script.securityContext.windowsOptions
"WindowsSecurityContextOptions contain Windows-specific options and credentials."
fn storedWorkflowTemplateSpec.templateDefaults.script.securityContext.windowsOptions.withGmsaCredentialSpec
withGmsaCredentialSpec(gmsaCredentialSpec)
"GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field. This field is alpha-level and is only honored by servers that enable the WindowsGMSA feature flag."
fn storedWorkflowTemplateSpec.templateDefaults.script.securityContext.windowsOptions.withGmsaCredentialSpecName
withGmsaCredentialSpecName(gmsaCredentialSpecName)
"GMSACredentialSpecName is the name of the GMSA credential spec to use. This field is alpha-level and is only honored by servers that enable the WindowsGMSA feature flag."
fn storedWorkflowTemplateSpec.templateDefaults.script.securityContext.windowsOptions.withRunAsUserName
withRunAsUserName(runAsUserName)
"The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. This field is beta-level and may be disabled with the WindowsRunAsUserName feature flag."
obj storedWorkflowTemplateSpec.templateDefaults.script.startupProbe
"Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic."
fn storedWorkflowTemplateSpec.templateDefaults.script.startupProbe.withFailureThreshold
withFailureThreshold(failureThreshold)
"Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1."
fn storedWorkflowTemplateSpec.templateDefaults.script.startupProbe.withInitialDelaySeconds
withInitialDelaySeconds(initialDelaySeconds)
"Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"
fn storedWorkflowTemplateSpec.templateDefaults.script.startupProbe.withPeriodSeconds
withPeriodSeconds(periodSeconds)
"How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1."
fn storedWorkflowTemplateSpec.templateDefaults.script.startupProbe.withSuccessThreshold
withSuccessThreshold(successThreshold)
"Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1."
fn storedWorkflowTemplateSpec.templateDefaults.script.startupProbe.withTimeoutSeconds
withTimeoutSeconds(timeoutSeconds)
"Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"
obj storedWorkflowTemplateSpec.templateDefaults.script.startupProbe.exec
"ExecAction describes a \"run in container\" action."
fn storedWorkflowTemplateSpec.templateDefaults.script.startupProbe.exec.withCommand
withCommand(command)
"Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy."
fn storedWorkflowTemplateSpec.templateDefaults.script.startupProbe.exec.withCommandMixin
withCommandMixin(command)
"Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy."
Note: This function appends passed data to existing values
obj storedWorkflowTemplateSpec.templateDefaults.script.startupProbe.httpGet
"HTTPGetAction describes an action based on HTTP Get requests."
fn storedWorkflowTemplateSpec.templateDefaults.script.startupProbe.httpGet.withHost
withHost(host)
"Host name to connect to, defaults to the pod IP. You probably want to set \"Host\" in httpHeaders instead."
fn storedWorkflowTemplateSpec.templateDefaults.script.startupProbe.httpGet.withHttpHeaders
withHttpHeaders(httpHeaders)
"Custom headers to set in the request. HTTP allows repeated headers."
fn storedWorkflowTemplateSpec.templateDefaults.script.startupProbe.httpGet.withHttpHeadersMixin
withHttpHeadersMixin(httpHeaders)
"Custom headers to set in the request. HTTP allows repeated headers."
Note: This function appends passed data to existing values
fn storedWorkflowTemplateSpec.templateDefaults.script.startupProbe.httpGet.withPath
withPath(path)
"Path to access on the HTTP server."
fn storedWorkflowTemplateSpec.templateDefaults.script.startupProbe.httpGet.withPort
withPort(port)
fn storedWorkflowTemplateSpec.templateDefaults.script.startupProbe.httpGet.withScheme
withScheme(scheme)
"Scheme to use for connecting to the host. Defaults to HTTP."
obj storedWorkflowTemplateSpec.templateDefaults.script.startupProbe.tcpSocket
"TCPSocketAction describes an action based on opening a socket"
fn storedWorkflowTemplateSpec.templateDefaults.script.startupProbe.tcpSocket.withHost
withHost(host)
"Optional: Host name to connect to, defaults to the pod IP."
fn storedWorkflowTemplateSpec.templateDefaults.script.startupProbe.tcpSocket.withPort
withPort(port)
obj storedWorkflowTemplateSpec.templateDefaults.securityContext
"PodSecurityContext holds pod-level security attributes and common container settings. Some fields are also present in container.securityContext. Field values of container.securityContext take precedence over field values of PodSecurityContext."
fn storedWorkflowTemplateSpec.templateDefaults.securityContext.withFsGroup
withFsGroup(fsGroup)
"A special supplemental group that applies to all containers in a pod. Some volume types allow the Kubelet to change the ownership of that volume to be owned by the pod:\n\n1. The owning GID will be the FSGroup 2. The setgid bit is set (new files created in the volume will be owned by FSGroup) 3. The permission bits are OR'd with rw-rw----\n\nIf unset, the Kubelet will not modify the ownership and permissions of any volume."
fn storedWorkflowTemplateSpec.templateDefaults.securityContext.withRunAsGroup
withRunAsGroup(runAsGroup)
"The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container."
fn storedWorkflowTemplateSpec.templateDefaults.securityContext.withRunAsNonRoot
withRunAsNonRoot(runAsNonRoot)
"Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence."
fn storedWorkflowTemplateSpec.templateDefaults.securityContext.withRunAsUser
withRunAsUser(runAsUser)
"The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container."
fn storedWorkflowTemplateSpec.templateDefaults.securityContext.withSupplementalGroups
withSupplementalGroups(supplementalGroups)
"A list of groups applied to the first process run in each container, in addition to the container's primary GID. If unspecified, no groups will be added to any container."
fn storedWorkflowTemplateSpec.templateDefaults.securityContext.withSupplementalGroupsMixin
withSupplementalGroupsMixin(supplementalGroups)
"A list of groups applied to the first process run in each container, in addition to the container's primary GID. If unspecified, no groups will be added to any container."
Note: This function appends passed data to existing values
fn storedWorkflowTemplateSpec.templateDefaults.securityContext.withSysctls
withSysctls(sysctls)
"Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported sysctls (by the container runtime) might fail to launch."
fn storedWorkflowTemplateSpec.templateDefaults.securityContext.withSysctlsMixin
withSysctlsMixin(sysctls)
"Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported sysctls (by the container runtime) might fail to launch."
Note: This function appends passed data to existing values
obj storedWorkflowTemplateSpec.templateDefaults.securityContext.seLinuxOptions
"SELinuxOptions are the labels to be applied to the container"
fn storedWorkflowTemplateSpec.templateDefaults.securityContext.seLinuxOptions.withLevel
withLevel(level)
"Level is SELinux level label that applies to the container."
fn storedWorkflowTemplateSpec.templateDefaults.securityContext.seLinuxOptions.withRole
withRole(role)
"Role is a SELinux role label that applies to the container."
fn storedWorkflowTemplateSpec.templateDefaults.securityContext.seLinuxOptions.withType
withType(type)
"Type is a SELinux type label that applies to the container."
fn storedWorkflowTemplateSpec.templateDefaults.securityContext.seLinuxOptions.withUser
withUser(user)
"User is a SELinux user label that applies to the container."
obj storedWorkflowTemplateSpec.templateDefaults.securityContext.windowsOptions
"WindowsSecurityContextOptions contain Windows-specific options and credentials."
fn storedWorkflowTemplateSpec.templateDefaults.securityContext.windowsOptions.withGmsaCredentialSpec
withGmsaCredentialSpec(gmsaCredentialSpec)
"GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field. This field is alpha-level and is only honored by servers that enable the WindowsGMSA feature flag."
fn storedWorkflowTemplateSpec.templateDefaults.securityContext.windowsOptions.withGmsaCredentialSpecName
withGmsaCredentialSpecName(gmsaCredentialSpecName)
"GMSACredentialSpecName is the name of the GMSA credential spec to use. This field is alpha-level and is only honored by servers that enable the WindowsGMSA feature flag."
fn storedWorkflowTemplateSpec.templateDefaults.securityContext.windowsOptions.withRunAsUserName
withRunAsUserName(runAsUserName)
"The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. This field is beta-level and may be disabled with the WindowsRunAsUserName feature flag."
obj storedWorkflowTemplateSpec.templateDefaults.suspend
"SuspendTemplate is a template subtype to suspend a workflow at a predetermined point in time"
fn storedWorkflowTemplateSpec.templateDefaults.suspend.withDuration
withDuration(duration)
"Duration is the seconds to wait before automatically resuming a template"
obj storedWorkflowTemplateSpec.templateDefaults.synchronization
"Synchronization holds synchronization lock configuration"
obj storedWorkflowTemplateSpec.templateDefaults.synchronization.mutex
"Mutex holds Mutex configuration"
fn storedWorkflowTemplateSpec.templateDefaults.synchronization.mutex.withName
withName(name)
"name of the mutex"
obj storedWorkflowTemplateSpec.templateDefaults.synchronization.semaphore
"SemaphoreRef is a reference of Semaphore"
obj storedWorkflowTemplateSpec.templateDefaults.synchronization.semaphore.configMapKeyRef
"Selects a key from a ConfigMap."
fn storedWorkflowTemplateSpec.templateDefaults.synchronization.semaphore.configMapKeyRef.withKey
withKey(key)
"The key to select."
fn storedWorkflowTemplateSpec.templateDefaults.synchronization.semaphore.configMapKeyRef.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn storedWorkflowTemplateSpec.templateDefaults.synchronization.semaphore.configMapKeyRef.withOptional
withOptional(optional)
"Specify whether the ConfigMap or its key must be defined"
obj storedWorkflowTemplateSpec.ttlStrategy
"TTLStrategy is the strategy for the time to live depending on if the workflow succeeded or failed"
fn storedWorkflowTemplateSpec.ttlStrategy.withSecondsAfterCompletion
withSecondsAfterCompletion(secondsAfterCompletion)
"SecondsAfterCompletion is the number of seconds to live after completion"
fn storedWorkflowTemplateSpec.ttlStrategy.withSecondsAfterFailure
withSecondsAfterFailure(secondsAfterFailure)
"SecondsAfterFailure is the number of seconds to live after failure"
fn storedWorkflowTemplateSpec.ttlStrategy.withSecondsAfterSuccess
withSecondsAfterSuccess(secondsAfterSuccess)
"SecondsAfterSuccess is the number of seconds to live after success"
obj storedWorkflowTemplateSpec.volumeClaimGC
"VolumeClaimGC describes how to delete volumes from completed Workflows"
fn storedWorkflowTemplateSpec.volumeClaimGC.withStrategy
withStrategy(strategy)
"Strategy is the strategy to use. One of \"OnWorkflowCompletion\", \"OnWorkflowSuccess\
obj storedWorkflowTemplateSpec.workflowTemplateRef
"WorkflowTemplateRef is a reference to a WorkflowTemplate resource."
fn storedWorkflowTemplateSpec.workflowTemplateRef.withClusterScope
withClusterScope(clusterScope)
"ClusterScope indicates the referred template is cluster scoped (i.e. a ClusterWorkflowTemplate)."
fn storedWorkflowTemplateSpec.workflowTemplateRef.withName
withName(name)
"Name is the resource name of the workflow template."
obj synchronization
"SynchronizationStatus stores the status of semaphore and mutex."
obj synchronization.mutex
"MutexStatus contains which objects hold mutex locks, and which objects this workflow is waiting on to release locks."
fn synchronization.mutex.withHolding
withHolding(holding)
"Holding is a list of mutexes and their respective objects that are held by mutex lock for this io.argoproj.workflow.v1alpha1."
fn synchronization.mutex.withHoldingMixin
withHoldingMixin(holding)
"Holding is a list of mutexes and their respective objects that are held by mutex lock for this io.argoproj.workflow.v1alpha1."
Note: This function appends passed data to existing values
fn synchronization.mutex.withWaiting
withWaiting(waiting)
"Waiting is a list of mutexes and their respective objects this workflow is waiting for."
fn synchronization.mutex.withWaitingMixin
withWaitingMixin(waiting)
"Waiting is a list of mutexes and their respective objects this workflow is waiting for."
Note: This function appends passed data to existing values
obj synchronization.semaphore
fn synchronization.semaphore.withHolding
withHolding(holding)
"Holding stores the list of resource acquired synchronization lock for workflows."
fn synchronization.semaphore.withHoldingMixin
withHoldingMixin(holding)
"Holding stores the list of resource acquired synchronization lock for workflows."
Note: This function appends passed data to existing values
fn synchronization.semaphore.withWaiting
withWaiting(waiting)
"Waiting indicates the list of current synchronization lock holders."
fn synchronization.semaphore.withWaitingMixin
withWaitingMixin(waiting)
"Waiting indicates the list of current synchronization lock holders."
Note: This function appends passed data to existing values