Skip to content

workflow.v1alpha1.artifact

"Artifact indicates an artifact to place at a specified path"

Index

Fields

fn withArchiveLogs

withArchiveLogs(archiveLogs)

"ArchiveLogs indicates if the container logs should be archived"

fn withDeleted

withDeleted(deleted)

"Has this been deleted?"

fn withFrom

withFrom(from)

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

fn withFromExpression

withFromExpression(fromExpression)

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

fn 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 withMode

withMode(mode)

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

fn withName

withName(name)

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

fn withOptional

withOptional(optional)

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

fn withPath

withPath(path)

"Path is the container path to the artifact"

fn withRecurseMode

withRecurseMode(recurseMode)

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

fn withSubPath

withSubPath(subPath)

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

obj archive

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

fn 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 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 archive.withZip

withZip(zip)

"ZipStrategy will unzip zipped input artifacts"

fn archive.withZipMixin

withZipMixin(zip)

"ZipStrategy will unzip zipped input artifacts"

Note: This function appends passed data to existing values

obj archive.tar

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

fn archive.tar.withCompressionLevel

withCompressionLevel(compressionLevel)

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

obj artifactGC

"ArtifactGC describes how to delete artifacts from completed Workflows - this is embedded into the WorkflowLevelArtifactGC, and also used for individual Artifacts to override that as needed"

fn artifactGC.withServiceAccountName

withServiceAccountName(serviceAccountName)

"ServiceAccountName is an optional field for specifying the Service Account that should be assigned to the Pod doing the deletion"

fn artifactGC.withStrategy

withStrategy(strategy)

"Strategy is the strategy to use."

obj artifactGC.podMetadata

"Pod metdata"

fn artifactGC.podMetadata.withAnnotations

withAnnotations(annotations)

fn artifactGC.podMetadata.withAnnotationsMixin

withAnnotationsMixin(annotations)

Note: This function appends passed data to existing values

fn artifactGC.podMetadata.withLabels

withLabels(labels)

fn artifactGC.podMetadata.withLabelsMixin

withLabelsMixin(labels)

Note: This function appends passed data to existing values

obj artifactory

"ArtifactoryArtifact is the location of an artifactory artifact"

fn artifactory.withUrl

withUrl(url)

"URL of the artifact"

obj artifactory.passwordSecret

"SecretKeySelector selects a key of a Secret."

fn artifactory.passwordSecret.withKey

withKey(key)

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

fn artifactory.passwordSecret.withName

withName(name)

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

fn artifactory.passwordSecret.withOptional

withOptional(optional)

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

obj artifactory.usernameSecret

"SecretKeySelector selects a key of a Secret."

fn artifactory.usernameSecret.withKey

withKey(key)

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

fn artifactory.usernameSecret.withName

withName(name)

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

fn artifactory.usernameSecret.withOptional

withOptional(optional)

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

obj azure

"AzureArtifact is the location of a an Azure Storage artifact"

fn azure.withBlob

withBlob(blob)

"Blob is the blob name (i.e., path) in the container where the artifact resides"

fn azure.withContainer

withContainer(container)

"Container is the container where resources will be stored"

fn azure.withEndpoint

withEndpoint(endpoint)

"Endpoint is the service url associated with an account. It is most likely \"https://.blob.core.windows.net\

fn azure.withUseSDKCreds

withUseSDKCreds(useSDKCreds)

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

obj azure.accountKeySecret

"SecretKeySelector selects a key of a Secret."

fn azure.accountKeySecret.withKey

withKey(key)

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

fn azure.accountKeySecret.withName

withName(name)

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

fn azure.accountKeySecret.withOptional

withOptional(optional)

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

obj gcs

"GCSArtifact is the location of a GCS artifact"

fn gcs.withBucket

withBucket(bucket)

"Bucket is the name of the bucket"

fn gcs.withKey

withKey(key)

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

obj gcs.serviceAccountKeySecret

"SecretKeySelector selects a key of a Secret."

fn gcs.serviceAccountKeySecret.withKey

withKey(key)

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

fn gcs.serviceAccountKeySecret.withName

withName(name)

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

fn gcs.serviceAccountKeySecret.withOptional

withOptional(optional)

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

obj git

"GitArtifact is the location of an git artifact"

fn git.withBranch

withBranch(branch)

"Branch is the branch to fetch when SingleBranch is enabled"

fn git.withDepth

withDepth(depth)

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

fn git.withDisableSubmodules

withDisableSubmodules(disableSubmodules)

"DisableSubmodules disables submodules during git clone"

fn git.withFetch

withFetch(fetch)

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

fn 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 git.withInsecureIgnoreHostKey

withInsecureIgnoreHostKey(insecureIgnoreHostKey)

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

fn git.withRepo

withRepo(repo)

"Repo is the git repository"

fn git.withRevision

withRevision(revision)

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

fn git.withSingleBranch

withSingleBranch(singleBranch)

"SingleBranch enables single branch clone, using the branch parameter"

obj git.passwordSecret

"SecretKeySelector selects a key of a Secret."

fn git.passwordSecret.withKey

withKey(key)

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

fn git.passwordSecret.withName

withName(name)

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

fn git.passwordSecret.withOptional

withOptional(optional)

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

obj git.sshPrivateKeySecret

"SecretKeySelector selects a key of a Secret."

fn git.sshPrivateKeySecret.withKey

withKey(key)

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

fn git.sshPrivateKeySecret.withName

withName(name)

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

fn git.sshPrivateKeySecret.withOptional

withOptional(optional)

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

obj git.usernameSecret

"SecretKeySelector selects a key of a Secret."

fn git.usernameSecret.withKey

withKey(key)

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

fn git.usernameSecret.withName

withName(name)

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

fn git.usernameSecret.withOptional

withOptional(optional)

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

obj hdfs

"HDFSArtifact is the location of an HDFS artifact"

fn hdfs.withAddresses

withAddresses(addresses)

"Addresses is accessible addresses of HDFS name nodes"

fn hdfs.withAddressesMixin

withAddressesMixin(addresses)

"Addresses is accessible addresses of HDFS name nodes"

Note: This function appends passed data to existing values

fn hdfs.withForce

withForce(force)

"Force copies a file forcibly even if it exists"

fn hdfs.withHdfsUser

withHdfsUser(hdfsUser)

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

fn hdfs.withKrbRealm

withKrbRealm(krbRealm)

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

fn hdfs.withKrbServicePrincipalName

withKrbServicePrincipalName(krbServicePrincipalName)

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

fn hdfs.withKrbUsername

withKrbUsername(krbUsername)

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

fn hdfs.withPath

withPath(path)

"Path is a file path in HDFS"

obj hdfs.krbCCacheSecret

"SecretKeySelector selects a key of a Secret."

fn hdfs.krbCCacheSecret.withKey

withKey(key)

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

fn hdfs.krbCCacheSecret.withName

withName(name)

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

fn hdfs.krbCCacheSecret.withOptional

withOptional(optional)

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

obj hdfs.krbConfigConfigMap

"Selects a key from a ConfigMap."

fn hdfs.krbConfigConfigMap.withKey

withKey(key)

"The key to select."

fn hdfs.krbConfigConfigMap.withName

withName(name)

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

fn hdfs.krbConfigConfigMap.withOptional

withOptional(optional)

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

obj hdfs.krbKeytabSecret

"SecretKeySelector selects a key of a Secret."

fn hdfs.krbKeytabSecret.withKey

withKey(key)

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

fn hdfs.krbKeytabSecret.withName

withName(name)

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

fn hdfs.krbKeytabSecret.withOptional

withOptional(optional)

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

obj http

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

fn http.withHeaders

withHeaders(headers)

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

fn 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 http.withUrl

withUrl(url)

"URL of the artifact"

obj http.auth

obj http.auth.basicAuth

"BasicAuth describes the secret selectors required for basic authentication"

obj http.auth.basicAuth.passwordSecret

"SecretKeySelector selects a key of a Secret."

fn http.auth.basicAuth.passwordSecret.withKey

withKey(key)

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

fn http.auth.basicAuth.passwordSecret.withName

withName(name)

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

fn http.auth.basicAuth.passwordSecret.withOptional

withOptional(optional)

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

obj http.auth.basicAuth.usernameSecret

"SecretKeySelector selects a key of a Secret."

fn http.auth.basicAuth.usernameSecret.withKey

withKey(key)

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

fn http.auth.basicAuth.usernameSecret.withName

withName(name)

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

fn http.auth.basicAuth.usernameSecret.withOptional

withOptional(optional)

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

obj http.auth.clientCert

"ClientCertAuth holds necessary information for client authentication via certificates"

obj http.auth.clientCert.clientCertSecret

"SecretKeySelector selects a key of a Secret."

fn http.auth.clientCert.clientCertSecret.withKey

withKey(key)

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

fn http.auth.clientCert.clientCertSecret.withName

withName(name)

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

fn http.auth.clientCert.clientCertSecret.withOptional

withOptional(optional)

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

obj http.auth.clientCert.clientKeySecret

"SecretKeySelector selects a key of a Secret."

fn http.auth.clientCert.clientKeySecret.withKey

withKey(key)

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

fn http.auth.clientCert.clientKeySecret.withName

withName(name)

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

fn http.auth.clientCert.clientKeySecret.withOptional

withOptional(optional)

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

obj http.auth.oauth2

"OAuth2Auth holds all information for client authentication via OAuth2 tokens"

fn http.auth.oauth2.withEndpointParams

withEndpointParams(endpointParams)

fn http.auth.oauth2.withEndpointParamsMixin

withEndpointParamsMixin(endpointParams)

Note: This function appends passed data to existing values

fn http.auth.oauth2.withScopes

withScopes(scopes)

fn http.auth.oauth2.withScopesMixin

withScopesMixin(scopes)

Note: This function appends passed data to existing values

obj http.auth.oauth2.clientIDSecret

"SecretKeySelector selects a key of a Secret."

fn http.auth.oauth2.clientIDSecret.withKey

withKey(key)

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

fn http.auth.oauth2.clientIDSecret.withName

withName(name)

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

fn http.auth.oauth2.clientIDSecret.withOptional

withOptional(optional)

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

obj http.auth.oauth2.clientSecretSecret

"SecretKeySelector selects a key of a Secret."

fn http.auth.oauth2.clientSecretSecret.withKey

withKey(key)

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

fn http.auth.oauth2.clientSecretSecret.withName

withName(name)

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

fn http.auth.oauth2.clientSecretSecret.withOptional

withOptional(optional)

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

obj http.auth.oauth2.tokenURLSecret

"SecretKeySelector selects a key of a Secret."

fn http.auth.oauth2.tokenURLSecret.withKey

withKey(key)

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

fn http.auth.oauth2.tokenURLSecret.withName

withName(name)

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

fn http.auth.oauth2.tokenURLSecret.withOptional

withOptional(optional)

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

obj oss

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

fn oss.withBucket

withBucket(bucket)

"Bucket is the name of the bucket"

fn oss.withCreateBucketIfNotPresent

withCreateBucketIfNotPresent(createBucketIfNotPresent)

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

fn oss.withEndpoint

withEndpoint(endpoint)

"Endpoint is the hostname of the bucket endpoint"

fn oss.withKey

withKey(key)

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

fn 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"

fn oss.withUseSDKCreds

withUseSDKCreds(useSDKCreds)

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

obj oss.accessKeySecret

"SecretKeySelector selects a key of a Secret."

fn oss.accessKeySecret.withKey

withKey(key)

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

fn oss.accessKeySecret.withName

withName(name)

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

fn oss.accessKeySecret.withOptional

withOptional(optional)

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

obj oss.lifecycleRule

"OSSLifecycleRule specifies how to manage bucket's lifecycle"

fn oss.lifecycleRule.withMarkDeletionAfterDays

withMarkDeletionAfterDays(markDeletionAfterDays)

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

fn 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 oss.secretKeySecret

"SecretKeySelector selects a key of a Secret."

fn oss.secretKeySecret.withKey

withKey(key)

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

fn oss.secretKeySecret.withName

withName(name)

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

fn oss.secretKeySecret.withOptional

withOptional(optional)

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

obj raw

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

fn raw.withData

withData(data)

"Data is the string contents of the artifact"

obj s3

"S3Artifact is the location of an S3 artifact"

fn s3.withBucket

withBucket(bucket)

"Bucket is the name of the bucket"

fn s3.withEndpoint

withEndpoint(endpoint)

"Endpoint is the hostname of the bucket endpoint"

fn s3.withInsecure

withInsecure(insecure)

"Insecure will connect to the service with TLS"

fn s3.withKey

withKey(key)

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

fn s3.withRegion

withRegion(region)

"Region contains the optional bucket region"

fn s3.withRoleARN

withRoleARN(roleARN)

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

fn s3.withUseSDKCreds

withUseSDKCreds(useSDKCreds)

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

obj s3.accessKeySecret

"SecretKeySelector selects a key of a Secret."

fn s3.accessKeySecret.withKey

withKey(key)

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

fn s3.accessKeySecret.withName

withName(name)

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

fn s3.accessKeySecret.withOptional

withOptional(optional)

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

obj s3.caSecret

"SecretKeySelector selects a key of a Secret."

fn s3.caSecret.withKey

withKey(key)

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

fn s3.caSecret.withName

withName(name)

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

fn s3.caSecret.withOptional

withOptional(optional)

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

obj s3.createBucketIfNotPresent

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

fn s3.createBucketIfNotPresent.withObjectLocking

withObjectLocking(objectLocking)

"ObjectLocking Enable object locking"

obj s3.encryptionOptions

"S3EncryptionOptions used to determine encryption options during s3 operations"

fn s3.encryptionOptions.withEnableEncryption

withEnableEncryption(enableEncryption)

"EnableEncryption tells the driver to encrypt objects if set to true. If kmsKeyId and serverSideCustomerKeySecret are not set, SSE-S3 will be used"

fn s3.encryptionOptions.withKmsEncryptionContext

withKmsEncryptionContext(kmsEncryptionContext)

"KmsEncryptionContext is a json blob that contains an encryption context. See https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context for more information"

fn s3.encryptionOptions.withKmsKeyId

withKmsKeyId(kmsKeyId)

"KMSKeyId tells the driver to encrypt the object using the specified KMS Key."

obj s3.encryptionOptions.serverSideCustomerKeySecret

"SecretKeySelector selects a key of a Secret."

fn s3.encryptionOptions.serverSideCustomerKeySecret.withKey

withKey(key)

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

fn s3.encryptionOptions.serverSideCustomerKeySecret.withName

withName(name)

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

fn s3.encryptionOptions.serverSideCustomerKeySecret.withOptional

withOptional(optional)

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

obj s3.secretKeySecret

"SecretKeySelector selects a key of a Secret."

fn s3.secretKeySecret.withKey

withKey(key)

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

fn s3.secretKeySecret.withName

withName(name)

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

fn s3.secretKeySecret.withOptional

withOptional(optional)

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