Hera Workflows
hera.workflows
Hera classes.
AWSElasticBlockStoreVolumeVolume
Representation of AWS elastic block store volume.
Source code in src/hera/workflows/volume.py
fs_type
class-attribute
instance-attribute
fs_type = Field(default=None, alias='fsType', description='Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore')
mount_propagation
class-attribute
instance-attribute
mount_propagation = Field(default=None, alias='mountPropagation', description='mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10.')
partition
class-attribute
instance-attribute
partition = Field(default=None, description='The partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty).')
read_only
class-attribute
instance-attribute
read_only = Field(default=None, alias='readOnly', description='Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.')
sub_path
class-attribute
instance-attribute
sub_path = Field(default=None, alias='subPath', description='Path within the volume from which the container\'s volume should be mounted. Defaults to "" (volume\'s root).')
sub_path_expr
class-attribute
instance-attribute
sub_path_expr = Field(default=None, alias='subPathExpr', description='Expanded path within the volume from which the container\'s volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container\'s environment. Defaults to "" (volume\'s root). SubPathExpr and SubPath are mutually exclusive.')
volume_id
class-attribute
instance-attribute
volume_id = Field(..., alias='volumeID', description='Unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore')
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
AccessMode
A representations of the volume access modes for Kubernetes.
Notes
See: access modes docs for more information.
Source code in src/hera/workflows/volume.py
read_only_many
class-attribute
instance-attribute
The volume can be mounted as read-only by many nodes
read_write_many
class-attribute
instance-attribute
The volume can be mounted as read-write by many nodes
read_write_once
class-attribute
instance-attribute
The volume can be mounted as read-write by a single node. ReadWriteOnce access mode still can allow multiple pods to access the volume when the pods are running on the same node
read_write_once_pod
class-attribute
instance-attribute
The volume can be mounted as read-write by a single Pod. Use ReadWriteOncePod access mode if you want to ensure that only one pod across whole cluster can read that PVC or write to it. This is only supported for CSI volumes and Kubernetes version 1.22+.
ArchiveStrategy
Base archive strategy model.
Source code in src/hera/workflows/archive.py
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
Artifact
Base artifact representation.
Source code in src/hera/workflows/artifact.py
43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 |
|
archive_logs
class-attribute
instance-attribute
whether to log the archive object
artifact_gc
class-attribute
instance-attribute
artifact garbage collection configuration
from_expression
class-attribute
instance-attribute
an expression that dictates where to obtain the artifact from
loader
class-attribute
instance-attribute
used for input Artifact annotations for determining how to load the data.
Note: A loader value of ‘None’ must be used with an underlying type of ‘str’ or Path-like class.
mode
class-attribute
instance-attribute
mode bits to use on the artifact, must be a value between 0 and 0777 set when loading input artifacts.
optional
class-attribute
instance-attribute
whether the Artifact is optional. For an input Artifact, this means it may possibly not exist at the specified path during the template’s runtime. For an output Artifact, it may possibly not be generated during the step/task and available as an output to subsequent steps/tasks.
output
class-attribute
instance-attribute
used to specify artifact as an output in function signature annotations
path
class-attribute
instance-attribute
path where the artifact should be placed/loaded from
recurse_mode
class-attribute
instance-attribute
recursion mode when applying the permissions of the artifact if it is an artifact folder
sub_path
class-attribute
instance-attribute
allows the specification of an artifact from a subpath within the main source.
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
as_name
DEPRECATED, use with_name.
Returns a ‘built’ copy of the current artifact, renamed using the specified name
.
Source code in src/hera/workflows/artifact.py
with_name
Returns a copy of the current artifact, renamed using the specified name
.
ArtifactLoader
ArtifactoryArtifact
An artifact sourced from Artifactory.
Source code in src/hera/workflows/artifact.py
archive_logs
class-attribute
instance-attribute
whether to log the archive object
artifact_gc
class-attribute
instance-attribute
artifact garbage collection configuration
from_expression
class-attribute
instance-attribute
an expression that dictates where to obtain the artifact from
loader
class-attribute
instance-attribute
used for input Artifact annotations for determining how to load the data.
Note: A loader value of ‘None’ must be used with an underlying type of ‘str’ or Path-like class.
mode
class-attribute
instance-attribute
mode bits to use on the artifact, must be a value between 0 and 0777 set when loading input artifacts.
optional
class-attribute
instance-attribute
whether the Artifact is optional. For an input Artifact, this means it may possibly not exist at the specified path during the template’s runtime. For an output Artifact, it may possibly not be generated during the step/task and available as an output to subsequent steps/tasks.
output
class-attribute
instance-attribute
used to specify artifact as an output in function signature annotations
password_secret
class-attribute
instance-attribute
password_secret = Field(default=None, alias='passwordSecret', description='PasswordSecret is the secret selector to the repository password')
path
class-attribute
instance-attribute
path where the artifact should be placed/loaded from
recurse_mode
class-attribute
instance-attribute
recursion mode when applying the permissions of the artifact if it is an artifact folder
sub_path
class-attribute
instance-attribute
allows the specification of an artifact from a subpath within the main source.
username_secret
class-attribute
instance-attribute
username_secret = Field(default=None, alias='usernameSecret', description='UsernameSecret is the secret selector to the repository username')
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
as_name
DEPRECATED, use with_name.
Returns a ‘built’ copy of the current artifact, renamed using the specified name
.
Source code in src/hera/workflows/artifact.py
with_name
Returns a copy of the current artifact, renamed using the specified name
.
AzureArtifact
An artifact sourced from Microsoft Azure.
Source code in src/hera/workflows/artifact.py
account_key_secret
class-attribute
instance-attribute
account_key_secret = Field(default=None, alias='accountKeySecret', description='AccountKeySecret is the secret selector to the Azure Blob Storage account access key')
archive_logs
class-attribute
instance-attribute
whether to log the archive object
artifact_gc
class-attribute
instance-attribute
artifact garbage collection configuration
blob
class-attribute
instance-attribute
blob = Field(..., description='Blob is the blob name (i.e., path) in the container where the artifact resides')
container
class-attribute
instance-attribute
endpoint
class-attribute
instance-attribute
endpoint = Field(..., description='Endpoint is the service url associated with an account. It is most likely "https://<ACCOUNT_NAME>.blob.core.windows.net"')
from_expression
class-attribute
instance-attribute
an expression that dictates where to obtain the artifact from
loader
class-attribute
instance-attribute
used for input Artifact annotations for determining how to load the data.
Note: A loader value of ‘None’ must be used with an underlying type of ‘str’ or Path-like class.
mode
class-attribute
instance-attribute
mode bits to use on the artifact, must be a value between 0 and 0777 set when loading input artifacts.
optional
class-attribute
instance-attribute
whether the Artifact is optional. For an input Artifact, this means it may possibly not exist at the specified path during the template’s runtime. For an output Artifact, it may possibly not be generated during the step/task and available as an output to subsequent steps/tasks.
output
class-attribute
instance-attribute
used to specify artifact as an output in function signature annotations
path
class-attribute
instance-attribute
path where the artifact should be placed/loaded from
recurse_mode
class-attribute
instance-attribute
recursion mode when applying the permissions of the artifact if it is an artifact folder
sub_path
class-attribute
instance-attribute
allows the specification of an artifact from a subpath within the main source.
use_sdk_creds
class-attribute
instance-attribute
use_sdk_creds = Field(default=None, alias='useSDKCreds', description='UseSDKCreds tells the driver to figure out credentials based on sdk defaults.')
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
as_name
DEPRECATED, use with_name.
Returns a ‘built’ copy of the current artifact, renamed using the specified name
.
Source code in src/hera/workflows/artifact.py
with_name
Returns a copy of the current artifact, renamed using the specified name
.
AzureDiskVolumeVolume
Representation of an Azure disk volume.
Source code in src/hera/workflows/volume.py
caching_mode
class-attribute
instance-attribute
caching_mode = Field(default=None, alias='cachingMode', description='Host Caching mode: None, Read Only, Read Write.')
disk_name
class-attribute
instance-attribute
disk_name = Field(..., alias='diskName', description='The Name of the data disk in the blob storage')
disk_uri
class-attribute
instance-attribute
fs_type
class-attribute
instance-attribute
fs_type = Field(default=None, alias='fsType', description='Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.')
kind
class-attribute
instance-attribute
kind = Field(default=None, description='Expected values Shared: multiple blob disks per storage account Dedicated: single blob disk per storage account Managed: azure managed data disk (only in managed availability set). defaults to shared')
mount_propagation
class-attribute
instance-attribute
mount_propagation = Field(default=None, alias='mountPropagation', description='mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10.')
read_only
class-attribute
instance-attribute
read_only = Field(default=None, alias='readOnly', description='Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.')
sub_path
class-attribute
instance-attribute
sub_path = Field(default=None, alias='subPath', description='Path within the volume from which the container\'s volume should be mounted. Defaults to "" (volume\'s root).')
sub_path_expr
class-attribute
instance-attribute
sub_path_expr = Field(default=None, alias='subPathExpr', description='Expanded path within the volume from which the container\'s volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container\'s environment. Defaults to "" (volume\'s root). SubPathExpr and SubPath are mutually exclusive.')
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
AzureFileVolumeVolume
Representation of an Azure file that can be mounted as a volume.
Source code in src/hera/workflows/volume.py
mount_propagation
class-attribute
instance-attribute
mount_propagation = Field(default=None, alias='mountPropagation', description='mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10.')
read_only
class-attribute
instance-attribute
read_only = Field(default=None, alias='readOnly', description='Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.')
secret_name
class-attribute
instance-attribute
secret_name = Field(..., alias='secretName', description='the name of secret that contains Azure Storage Account Name and Key')
share_name
class-attribute
instance-attribute
sub_path
class-attribute
instance-attribute
sub_path = Field(default=None, alias='subPath', description='Path within the volume from which the container\'s volume should be mounted. Defaults to "" (volume\'s root).')
sub_path_expr
class-attribute
instance-attribute
sub_path_expr = Field(default=None, alias='subPathExpr', description='Expanded path within the volume from which the container\'s volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container\'s environment. Defaults to "" (volume\'s root). SubPathExpr and SubPath are mutually exclusive.')
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
CSIVolume
Representation of a container service interface volume.
Source code in src/hera/workflows/volume.py
driver
class-attribute
instance-attribute
driver = Field(..., description='Driver is the name of the CSI driver that handles this volume. Consult with your admin for the correct name as registered in the cluster.')
fs_type
class-attribute
instance-attribute
fs_type = Field(default=None, alias='fsType', description='Filesystem type to mount. Ex. "ext4", "xfs", "ntfs". If not provided, the empty value is passed to the associated CSI driver which will determine the default filesystem to apply.')
mount_propagation
class-attribute
instance-attribute
mount_propagation = Field(default=None, alias='mountPropagation', description='mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10.')
node_publish_secret_ref
class-attribute
instance-attribute
node_publish_secret_ref = Field(default=None, alias='nodePublishSecretRef', description='NodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secret references are passed.')
read_only
class-attribute
instance-attribute
read_only = Field(default=None, alias='readOnly', description='Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.')
sub_path
class-attribute
instance-attribute
sub_path = Field(default=None, alias='subPath', description='Path within the volume from which the container\'s volume should be mounted. Defaults to "" (volume\'s root).')
sub_path_expr
class-attribute
instance-attribute
sub_path_expr = Field(default=None, alias='subPathExpr', description='Expanded path within the volume from which the container\'s volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container\'s environment. Defaults to "" (volume\'s root). SubPathExpr and SubPath are mutually exclusive.')
volume_attributes
class-attribute
instance-attribute
volume_attributes = Field(default=None, alias='volumeAttributes', description="VolumeAttributes stores driver-specific properties that are passed to the CSI driver. Consult your driver's documentation for supported values.")
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
CephFSVolumeVolume
Representation of a Ceph file system volume.
Source code in src/hera/workflows/volume.py
monitors
class-attribute
instance-attribute
monitors = Field(..., description='Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it')
mount_propagation
class-attribute
instance-attribute
mount_propagation = Field(default=None, alias='mountPropagation', description='mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10.')
path
class-attribute
instance-attribute
path = Field(default=None, description='Optional: Used as the mounted root, rather than the full Ceph tree, default is /')
read_only
class-attribute
instance-attribute
read_only = Field(default=None, alias='readOnly', description='Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.')
secret_file
class-attribute
instance-attribute
secret_file = Field(default=None, alias='secretFile', description='Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it')
secret_ref
class-attribute
instance-attribute
secret_ref = Field(default=None, alias='secretRef', description='Optional: SecretRef is reference to the authentication secret for User, default is empty. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it')
sub_path
class-attribute
instance-attribute
sub_path = Field(default=None, alias='subPath', description='Path within the volume from which the container\'s volume should be mounted. Defaults to "" (volume\'s root).')
sub_path_expr
class-attribute
instance-attribute
sub_path_expr = Field(default=None, alias='subPathExpr', description='Expanded path within the volume from which the container\'s volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container\'s environment. Defaults to "" (volume\'s root). SubPathExpr and SubPath are mutually exclusive.')
user
class-attribute
instance-attribute
user = Field(default=None, description='Optional: User is the rados user name, default is admin More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it')
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
CinderVolume
Representation of a Cinder volume.
Source code in src/hera/workflows/volume.py
fs_type
class-attribute
instance-attribute
fs_type = Field(default=None, alias='fsType', description='Filesystem type to mount. Must be a filesystem type supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://examples.k8s.io/mysql-cinder-pd/README.md')
mount_propagation
class-attribute
instance-attribute
mount_propagation = Field(default=None, alias='mountPropagation', description='mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10.')
read_only
class-attribute
instance-attribute
read_only = Field(default=None, alias='readOnly', description='Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.')
secret_ref
class-attribute
instance-attribute
secret_ref = Field(default=None, alias='secretRef', description='Optional: points to a secret object containing parameters used to connect to OpenStack.')
sub_path
class-attribute
instance-attribute
sub_path = Field(default=None, alias='subPath', description='Path within the volume from which the container\'s volume should be mounted. Defaults to "" (volume\'s root).')
sub_path_expr
class-attribute
instance-attribute
sub_path_expr = Field(default=None, alias='subPathExpr', description='Expanded path within the volume from which the container\'s volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container\'s environment. Defaults to "" (volume\'s root). SubPathExpr and SubPath are mutually exclusive.')
volume_id
class-attribute
instance-attribute
volume_id = Field(..., alias='volumeID', description='volume id used to identify the volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md')
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
ClusterWorkflowTemplate
ClusterWorkflowTemplates are cluster scoped templates.
Since cluster workflow templates are scoped at the cluster level, they are available globally in the cluster.
Source code in src/hera/workflows/cluster_workflow_template.py
automount_service_account_token
class-attribute
instance-attribute
deletion_grace_period_seconds
class-attribute
instance-attribute
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
ModelMapper
Source code in src/hera/workflows/_mixins.py
build_model
classmethod
Source code in src/hera/workflows/_mixins.py
build
Builds the ClusterWorkflowTemplate and its components into an Argo schema ClusterWorkflowTemplate object.
Source code in src/hera/workflows/cluster_workflow_template.py
create
Creates the ClusterWorkflowTemplate on the Argo cluster.
Source code in src/hera/workflows/cluster_workflow_template.py
create_as_workflow
Run this WorkflowTemplate instantly as a Workflow.
If generate_name is given, the workflow created uses generate_name as a prefix, as per the usual for hera.workflows.Workflow.generate_name. If not given, the WorkflowTemplate’s name will be used, truncated to 57 chars and appended with a hyphen.
Note: this function does not require the WorkflowTemplate to already exist on the cluster
Source code in src/hera/workflows/workflow_template.py
from_dict
classmethod
Create a WorkflowTemplate from a WorkflowTemplate contained in a dict.
Examples:
>>> my_workflow_template = WorkflowTemplate(name="my-wft")
>>> my_workflow_template == WorkflowTemplate.from_dict(my_workflow_template.to_dict())
True
Source code in src/hera/workflows/workflow_template.py
from_file
classmethod
Create a WorkflowTemplate from a WorkflowTemplate contained in a YAML file.
Examples:
Source code in src/hera/workflows/workflow_template.py
from_yaml
classmethod
Create a WorkflowTemplate from a WorkflowTemplate contained in a YAML string.
Examples:
Source code in src/hera/workflows/workflow_template.py
get
Attempts to get a workflow template based on the parameters of this template e.g. name + namespace.
Source code in src/hera/workflows/cluster_workflow_template.py
get_parameter
Attempts to find and return a Parameter
of the specified name.
Source code in src/hera/workflows/workflow.py
get_workflow_link
Returns the workflow link for the workflow.
Source code in src/hera/workflows/workflow.py
lint
Lints the ClusterWorkflowTemplate using the Argo cluster.
Source code in src/hera/workflows/cluster_workflow_template.py
to_dict
Builds the Workflow as an Argo schema Workflow object and returns it as a dictionary.
to_file
Writes the Workflow as an Argo schema Workflow object to a YAML file and returns the path to the file.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
output_directory |
Union[Path, str]
|
The directory to write the file to. Defaults to the current working directory. |
'.'
|
name |
str
|
The name of the file to write without the file extension. Defaults to the Workflow’s name or a generated name. |
''
|
*args |
Additional arguments to pass to |
()
|
|
**kwargs |
Additional keyword arguments to pass to |
{}
|
Source code in src/hera/workflows/workflow.py
to_yaml
Builds the Workflow as an Argo schema Workflow object and returns it as yaml string.
Source code in src/hera/workflows/workflow.py
update
Attempts to perform a workflow template update based on the parameters of this template.
Note that this creates the template if it does not exist. In addition, this performs
a get prior to updating to get the resource version to update in the first place. If you know the template
does not exist ahead of time, it is more efficient to use create()
directly to avoid one round trip.
Source code in src/hera/workflows/cluster_workflow_template.py
wait
Waits for the Workflow to complete execution.
Parameters
poll_interval: int = 5 The interval in seconds to poll the workflow status.
Source code in src/hera/workflows/workflow.py
ConfigMapEnv
ConfigMapEnv
is an environment variable whose value originates from a Kubernetes config map.
Source code in src/hera/workflows/env.py
config_map_key
instance-attribute
the name of the field key whole value should be registered as an environment variable
config_map_name
instance-attribute
the name of the config map to reference in Kubernetes
name
instance-attribute
the name of the environment variable. This is universally required irrespective of the type of env variable
optional
class-attribute
instance-attribute
whether the existence of the config map is optional
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
build
Constructs and returns the Argo environment specification.
Source code in src/hera/workflows/env.py
ConfigMapEnvFrom
Exposes a K8s config map’s value as an environment variable.
Source code in src/hera/workflows/env_from.py
name
class-attribute
instance-attribute
name = Field(default=None, description='Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names')
optional
class-attribute
instance-attribute
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
build
Constructs and returns the Argo EnvFrom specification.
Source code in src/hera/workflows/env_from.py
ConfigMapVolume
Representation of a config map volume.
Source code in src/hera/workflows/volume.py
default_mode
class-attribute
instance-attribute
default_mode = Field(default=None, alias='defaultMode', description='Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.')
items
class-attribute
instance-attribute
items = Field(default=None, description="If unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.")
mount_propagation
class-attribute
instance-attribute
mount_propagation = Field(default=None, alias='mountPropagation', description='mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10.')
optional
class-attribute
instance-attribute
optional = Field(default=None, description='Specify whether the ConfigMap or its keys must be defined')
read_only
class-attribute
instance-attribute
read_only = Field(default=None, alias='readOnly', description='Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.')
sub_path
class-attribute
instance-attribute
sub_path = Field(default=None, alias='subPath', description='Path within the volume from which the container\'s volume should be mounted. Defaults to "" (volume\'s root).')
sub_path_expr
class-attribute
instance-attribute
sub_path_expr = Field(default=None, alias='subPathExpr', description='Expanded path within the volume from which the container\'s volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container\'s environment. Defaults to "" (volume\'s root). SubPathExpr and SubPath are mutually exclusive.')
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
Container
The Container template type defines a container to run on Argo.
The container generally consists of running a Docker container remotely, which is configured via fields such as
command
(the command to run to start the container), args
(arguments for the container), working_dir
(for
setting the active working directory relative to container execution), etc.
Source code in src/hera/workflows/container.py
automount_service_account_token
class-attribute
instance-attribute
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
get_parameter
Finds and returns the parameter with the supplied name.
Note that this method will raise an error if the parameter is not found.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
name |
str
|
name of the input parameter to find and return. |
required |
Returns:
Name | Type | Description |
---|---|---|
Parameter |
Parameter
|
the parameter with the supplied name. |
Raises:
Type | Description |
---|---|
KeyError
|
if the parameter is not found. |
Source code in src/hera/workflows/_mixins.py
ContainerNode
A regular container that can be used as part of a hera.workflows.ContainerSet
.
See Also
Source code in src/hera/workflows/container_set.py
28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 |
|
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
next
Sets the given container as a dependency of this container and returns the given container.
Examples:
>>> from hera.workflows import ContainerNode
>>> a, b = ContainerNode(name="a"), ContainerNode(name="b")
>>> a.next(b)
>>> b.dependencies
['a']
Source code in src/hera/workflows/container_set.py
ContainerSet
ContainerSet
is the implementation of a set of containers that can be run in parallel on Kubernetes.
The containers are run within the same pod.
Examples:
Source code in src/hera/workflows/container_set.py
automount_service_account_token
class-attribute
instance-attribute
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
get_parameter
Finds and returns the parameter with the supplied name.
Note that this method will raise an error if the parameter is not found.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
name |
str
|
name of the input parameter to find and return. |
required |
Returns:
Name | Type | Description |
---|---|---|
Parameter |
Parameter
|
the parameter with the supplied name. |
Raises:
Type | Description |
---|---|
KeyError
|
if the parameter is not found. |
Source code in src/hera/workflows/_mixins.py
Counter
Counter metric component used to count specific events based on the given value.
Notes
See https://argoproj.github.io/argo-workflows/metrics/#grafana-dashboard-for-argo-controller-metrics
Source code in src/hera/workflows/metrics.py
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
CronWorkflow
CronWorkflow allows a user to run a Workflow on a recurring basis.
Note
Hera’s CronWorkflow is a subclass of Workflow which means certain fields are renamed
for compatibility, see cron_suspend
and cron_status
which are different from the Argo
spec. See CronWorkflowSpec for more details.
Source code in src/hera/workflows/cron_workflow.py
65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 |
|
automount_service_account_token
class-attribute
instance-attribute
deletion_grace_period_seconds
class-attribute
instance-attribute
successful_jobs_history_limit
class-attribute
instance-attribute
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
ModelMapper
Source code in src/hera/workflows/_mixins.py
build_model
classmethod
Source code in src/hera/workflows/_mixins.py
build
Builds the CronWorkflow and its components into an Argo schema CronWorkflow object.
Source code in src/hera/workflows/cron_workflow.py
create
Creates the CronWorkflow on the Argo cluster.
Source code in src/hera/workflows/cron_workflow.py
from_dict
classmethod
Create a CronWorkflow from a CronWorkflow contained in a dict.
Examples:
>>> my_cron_workflow = CronWorkflow(name="my-cron-wf")
>>> my_cron_workflow == CronWorkflow.from_dict(my_cron_workflow.to_dict())
True
Source code in src/hera/workflows/cron_workflow.py
from_file
classmethod
Create a CronWorkflow from a CronWorkflow contained in a YAML file.
Examples:
Source code in src/hera/workflows/cron_workflow.py
from_yaml
classmethod
Create a CronWorkflow from a CronWorkflow contained in a YAML string.
Examples:
Source code in src/hera/workflows/cron_workflow.py
get
Attempts to get a cron workflow based on the parameters of this template e.g. name + namespace.
Source code in src/hera/workflows/cron_workflow.py
get_parameter
Attempts to find and return a Parameter
of the specified name.
Source code in src/hera/workflows/workflow.py
get_workflow_link
Returns the workflow link for the workflow.
Source code in src/hera/workflows/cron_workflow.py
lint
Lints the CronWorkflow using the Argo cluster.
Source code in src/hera/workflows/cron_workflow.py
to_dict
Builds the Workflow as an Argo schema Workflow object and returns it as a dictionary.
to_file
Writes the Workflow as an Argo schema Workflow object to a YAML file and returns the path to the file.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
output_directory |
Union[Path, str]
|
The directory to write the file to. Defaults to the current working directory. |
'.'
|
name |
str
|
The name of the file to write without the file extension. Defaults to the Workflow’s name or a generated name. |
''
|
*args |
Additional arguments to pass to |
()
|
|
**kwargs |
Additional keyword arguments to pass to |
{}
|
Source code in src/hera/workflows/workflow.py
to_yaml
Builds the Workflow as an Argo schema Workflow object and returns it as yaml string.
Source code in src/hera/workflows/workflow.py
update
Attempts to perform a workflow template update based on the parameters of this template.
Note that this creates the template if it does not exist. In addition, this performs
a get prior to updating to get the resource version to update in the first place. If you know the template
does not exist ahead of time, it is more efficient to use create()
directly to avoid one round trip.
Source code in src/hera/workflows/cron_workflow.py
wait
Waits for the Workflow to complete execution.
Parameters
poll_interval: int = 5 The interval in seconds to poll the workflow status.
Source code in src/hera/workflows/workflow.py
DAG
A DAG template invocator is used to define Task dependencies as an acyclic graph.
DAG implements the contextmanager interface so allows usage of with
, under which any
hera.workflows.task.Task
objects instantiated will be added to the DAG’s list of Tasks.
Examples:
Source code in src/hera/workflows/dag.py
automount_service_account_token
class-attribute
instance-attribute
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
get_parameter
Finds and returns the parameter with the supplied name.
Note that this method will raise an error if the parameter is not found.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
name |
str
|
name of the input parameter to find and return. |
required |
Returns:
Name | Type | Description |
---|---|---|
Parameter |
Parameter
|
the parameter with the supplied name. |
Raises:
Type | Description |
---|---|
KeyError
|
if the parameter is not found. |
Source code in src/hera/workflows/_mixins.py
Data
Data
implements the Argo data template representation.
Data can be used to indicate that some data, identified by a source
, should be processed via the specified
transformations
. The transformations
field can be either expressed via a pure str
or via a hera.expr
,
which transpiles the expression into a statement that can be processed by Argo.
Source code in src/hera/workflows/data.py
automount_service_account_token
class-attribute
instance-attribute
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
get_parameter
Finds and returns the parameter with the supplied name.
Note that this method will raise an error if the parameter is not found.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
name |
str
|
name of the input parameter to find and return. |
required |
Returns:
Name | Type | Description |
---|---|---|
Parameter |
Parameter
|
the parameter with the supplied name. |
Raises:
Type | Description |
---|---|
KeyError
|
if the parameter is not found. |
Source code in src/hera/workflows/_mixins.py
DownwardAPIVolume
Representation of a volume passed via the downward API.
Source code in src/hera/workflows/volume.py
default_mode
class-attribute
instance-attribute
default_mode = Field(default=None, alias='defaultMode', description='Optional: mode bits to use on created files by default. Must be a Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.')
items
class-attribute
instance-attribute
mount_propagation
class-attribute
instance-attribute
mount_propagation = Field(default=None, alias='mountPropagation', description='mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10.')
read_only
class-attribute
instance-attribute
read_only = Field(default=None, alias='readOnly', description='Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.')
sub_path
class-attribute
instance-attribute
sub_path = Field(default=None, alias='subPath', description='Path within the volume from which the container\'s volume should be mounted. Defaults to "" (volume\'s root).')
sub_path_expr
class-attribute
instance-attribute
sub_path_expr = Field(default=None, alias='subPathExpr', description='Expanded path within the volume from which the container\'s volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container\'s environment. Defaults to "" (volume\'s root). SubPathExpr and SubPath are mutually exclusive.')
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
EmptyDirVolume
Representation of an empty dir volume from K8s.
Source code in src/hera/workflows/volume.py
medium
class-attribute
instance-attribute
medium = Field(default=None, description='What type of storage medium should back this directory. The default is "" which means to use the node\'s default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir')
mount_propagation
class-attribute
instance-attribute
mount_propagation = Field(default=None, alias='mountPropagation', description='mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10.')
read_only
class-attribute
instance-attribute
read_only = Field(default=None, alias='readOnly', description='Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.')
size_limit
class-attribute
instance-attribute
size_limit = Field(default=None, alias='sizeLimit', description='Total amount of local storage required for this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers in a pod. The default is nil which means that the limit is undefined. More info: http://kubernetes.io/docs/user-guide/volumes#emptydir')
sub_path
class-attribute
instance-attribute
sub_path = Field(default=None, alias='subPath', description='Path within the volume from which the container\'s volume should be mounted. Defaults to "" (volume\'s root).')
sub_path_expr
class-attribute
instance-attribute
sub_path_expr = Field(default=None, alias='subPathExpr', description='Expanded path within the volume from which the container\'s volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container\'s environment. Defaults to "" (volume\'s root). SubPathExpr and SubPath are mutually exclusive.')
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
Env
A variable implementation that can expose a plain value
or value from input
as an env variable.
Source code in src/hera/workflows/env.py
name
instance-attribute
the name of the environment variable. This is universally required irrespective of the type of env variable
param_name
property
Returns the parameter name of the environment variable, conditioned on the use of value_from_input
.
value_from_input
class-attribute
instance-attribute
an optional str
or Parameter
representation of the origin of the environment variable value
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
build
Constructs and returns the Argo environment specification.
Source code in src/hera/workflows/env.py
EphemeralVolume
Representation of a volume that uses ephemeral storage shared with the K8s node a pod is scheduled on.
Source code in src/hera/workflows/volume.py
mount_propagation
class-attribute
instance-attribute
mount_propagation = Field(default=None, alias='mountPropagation', description='mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10.')
read_only
class-attribute
instance-attribute
read_only = Field(default=None, alias='readOnly', description='Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.')
sub_path
class-attribute
instance-attribute
sub_path = Field(default=None, alias='subPath', description='Path within the volume from which the container\'s volume should be mounted. Defaults to "" (volume\'s root).')
sub_path_expr
class-attribute
instance-attribute
sub_path_expr = Field(default=None, alias='subPathExpr', description='Expanded path within the volume from which the container\'s volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container\'s environment. Defaults to "" (volume\'s root). SubPathExpr and SubPath are mutually exclusive.')
volume_claim_template
class-attribute
instance-attribute
volume_claim_template = Field(default=None, alias='volumeClaimTemplate', description='Will be used to create a stand-alone PVC to provision the volume. The pod in which this EphemeralVolumeSource is embedded will be the owner of the PVC, i.e. the PVC will be deleted together with the pod. The name of the PVC will be `<pod name>-<volume name>` where `<volume name>` is the name from the `PodSpec.Volumes` array entry. Pod validation will reject the pod if the concatenated name is not valid for a PVC (for example, too long).\n\nAn existing PVC with that name that is not owned by the pod will *not* be used for the pod to avoid using an unrelated volume by mistake. Starting the pod is then blocked until the unrelated PVC is removed. If such a pre-created PVC is meant to be used by the pod, the PVC has to updated with an owner reference to the pod once the pod exists. Normally this should not be necessary, but it may be useful when manually reconstructing a broken cluster.\n\nThis field is read-only and no changes will be made by Kubernetes to the PVC after it has been created.\n\nRequired, must not be nil.')
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
ExistingVolume
ExistingVolume
is a representation of an existing volume in K8s.
The existing volume is mounted based on the supplied claim name. This tells K8s that the specified persistent volume claim should be used to mount a volume to a pod.
Source code in src/hera/workflows/volume.py
claim_name
class-attribute
instance-attribute
claim_name = Field(..., alias='claimName', description='ClaimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims')
mount_propagation
class-attribute
instance-attribute
mount_propagation = Field(default=None, alias='mountPropagation', description='mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10.')
read_only
class-attribute
instance-attribute
read_only = Field(default=None, alias='readOnly', description='Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.')
sub_path
class-attribute
instance-attribute
sub_path = Field(default=None, alias='subPath', description='Path within the volume from which the container\'s volume should be mounted. Defaults to "" (volume\'s root).')
sub_path_expr
class-attribute
instance-attribute
sub_path_expr = Field(default=None, alias='subPathExpr', description='Expanded path within the volume from which the container\'s volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container\'s environment. Defaults to "" (volume\'s root). SubPathExpr and SubPath are mutually exclusive.')
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
FCVolume
An FV volume representation.
Source code in src/hera/workflows/volume.py
fs_type
class-attribute
instance-attribute
fs_type = Field(default=None, alias='fsType', description='Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.')
lun
class-attribute
instance-attribute
mount_propagation
class-attribute
instance-attribute
mount_propagation = Field(default=None, alias='mountPropagation', description='mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10.')
read_only
class-attribute
instance-attribute
read_only = Field(default=None, alias='readOnly', description='Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.')
sub_path
class-attribute
instance-attribute
sub_path = Field(default=None, alias='subPath', description='Path within the volume from which the container\'s volume should be mounted. Defaults to "" (volume\'s root).')
sub_path_expr
class-attribute
instance-attribute
sub_path_expr = Field(default=None, alias='subPathExpr', description='Expanded path within the volume from which the container\'s volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container\'s environment. Defaults to "" (volume\'s root). SubPathExpr and SubPath are mutually exclusive.')
target_ww_ns
class-attribute
instance-attribute
target_ww_ns = Field(default=None, alias='targetWWNs', description='Optional: FC target worldwide names (WWNs)')
wwids
class-attribute
instance-attribute
wwids = Field(default=None, description='Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously.')
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
FieldEnv
FieldEnv
is an environment variable whose origin is in a field specification.
The field path specification points to a particular field within the workflow/container YAML specification. For instance, if there’s a YAML that has 3 fields like so
then a reference to the field a must be encoded asspec.a
in order for the value of 42
to be extracted and set
as an environment variable.
Source code in src/hera/workflows/env.py
api_version
class-attribute
instance-attribute
optionally, an API version specification. This defaults to the Hera global config api_version
field_path
instance-attribute
the path to the field whose value should be extracted into an environment variable
name
instance-attribute
the name of the environment variable. This is universally required irrespective of the type of env variable
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
build
Constructs and returns the Argo environment specification.
Source code in src/hera/workflows/env.py
FlexVolume
A Flex volume representation.
Source code in src/hera/workflows/volume.py
driver
class-attribute
instance-attribute
fs_type
class-attribute
instance-attribute
fs_type = Field(default=None, alias='fsType', description='Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". The default filesystem depends on FlexVolume script.')
mount_propagation
class-attribute
instance-attribute
mount_propagation = Field(default=None, alias='mountPropagation', description='mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10.')
options
class-attribute
instance-attribute
read_only
class-attribute
instance-attribute
read_only = Field(default=None, alias='readOnly', description='Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.')
secret_ref
class-attribute
instance-attribute
secret_ref = Field(default=None, alias='secretRef', description='Optional: SecretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified. If the secret object contains more than one secret, all secrets are passed to the plugin scripts.')
sub_path
class-attribute
instance-attribute
sub_path = Field(default=None, alias='subPath', description='Path within the volume from which the container\'s volume should be mounted. Defaults to "" (volume\'s root).')
sub_path_expr
class-attribute
instance-attribute
sub_path_expr = Field(default=None, alias='subPathExpr', description='Expanded path within the volume from which the container\'s volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container\'s environment. Defaults to "" (volume\'s root). SubPathExpr and SubPath are mutually exclusive.')
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
FlockerVolume
A Flocker volume representation.
Source code in src/hera/workflows/volume.py
dataset_name
class-attribute
instance-attribute
dataset_name = Field(default=None, alias='datasetName', description='Name of the dataset stored as metadata -> name on the dataset for Flocker should be considered as deprecated')
dataset_uuid
class-attribute
instance-attribute
dataset_uuid = Field(default=None, alias='datasetUUID', description='UUID of the dataset. This is unique identifier of a Flocker dataset')
mount_propagation
class-attribute
instance-attribute
mount_propagation = Field(default=None, alias='mountPropagation', description='mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10.')
read_only
class-attribute
instance-attribute
read_only = Field(default=None, alias='readOnly', description='Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.')
sub_path
class-attribute
instance-attribute
sub_path = Field(default=None, alias='subPath', description='Path within the volume from which the container\'s volume should be mounted. Defaults to "" (volume\'s root).')
sub_path_expr
class-attribute
instance-attribute
sub_path_expr = Field(default=None, alias='subPathExpr', description='Expanded path within the volume from which the container\'s volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container\'s environment. Defaults to "" (volume\'s root). SubPathExpr and SubPath are mutually exclusive.')
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
GCEPersistentDiskVolume
A representation of a Google Cloud Compute Enginer persistent disk.
Notes
The volume must exist on GCE before a request to mount it to a pod is performed.
Source code in src/hera/workflows/volume.py
fs_type
class-attribute
instance-attribute
fs_type = Field(default=None, alias='fsType', description='Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk')
mount_propagation
class-attribute
instance-attribute
mount_propagation = Field(default=None, alias='mountPropagation', description='mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10.')
partition
class-attribute
instance-attribute
partition = Field(default=None, description='The partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk')
pd_name
class-attribute
instance-attribute
pd_name = Field(..., alias='pdName', description='Unique name of the PD resource in GCE. Used to identify the disk in GCE. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk')
read_only
class-attribute
instance-attribute
read_only = Field(default=None, alias='readOnly', description='Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.')
sub_path
class-attribute
instance-attribute
sub_path = Field(default=None, alias='subPath', description='Path within the volume from which the container\'s volume should be mounted. Defaults to "" (volume\'s root).')
sub_path_expr
class-attribute
instance-attribute
sub_path_expr = Field(default=None, alias='subPathExpr', description='Expanded path within the volume from which the container\'s volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container\'s environment. Defaults to "" (volume\'s root). SubPathExpr and SubPath are mutually exclusive.')
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
GCSArtifact
An artifact sourced from Google Cloud Storage.
Source code in src/hera/workflows/artifact.py
archive_logs
class-attribute
instance-attribute
whether to log the archive object
artifact_gc
class-attribute
instance-attribute
artifact garbage collection configuration
bucket
class-attribute
instance-attribute
from_expression
class-attribute
instance-attribute
an expression that dictates where to obtain the artifact from
key
class-attribute
instance-attribute
loader
class-attribute
instance-attribute
used for input Artifact annotations for determining how to load the data.
Note: A loader value of ‘None’ must be used with an underlying type of ‘str’ or Path-like class.
mode
class-attribute
instance-attribute
mode bits to use on the artifact, must be a value between 0 and 0777 set when loading input artifacts.
optional
class-attribute
instance-attribute
whether the Artifact is optional. For an input Artifact, this means it may possibly not exist at the specified path during the template’s runtime. For an output Artifact, it may possibly not be generated during the step/task and available as an output to subsequent steps/tasks.
output
class-attribute
instance-attribute
used to specify artifact as an output in function signature annotations
path
class-attribute
instance-attribute
path where the artifact should be placed/loaded from
recurse_mode
class-attribute
instance-attribute
recursion mode when applying the permissions of the artifact if it is an artifact folder
service_account_key_secret
class-attribute
instance-attribute
service_account_key_secret = Field(default=None, alias='serviceAccountKeySecret', description="ServiceAccountKeySecret is the secret selector to the bucket's service account key")
sub_path
class-attribute
instance-attribute
allows the specification of an artifact from a subpath within the main source.
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
as_name
DEPRECATED, use with_name.
Returns a ‘built’ copy of the current artifact, renamed using the specified name
.
Source code in src/hera/workflows/artifact.py
with_name
Returns a copy of the current artifact, renamed using the specified name
.
Gauge
Gauge metric component used to record intervals based on the given value.
Notes
See https://argoproj.github.io/argo-workflows/metrics/#grafana-dashboard-for-argo-controller-metrics
Source code in src/hera/workflows/metrics.py
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
GitArtifact
An artifact sourced from GitHub.
Source code in src/hera/workflows/artifact.py
archive_logs
class-attribute
instance-attribute
whether to log the archive object
artifact_gc
class-attribute
instance-attribute
artifact garbage collection configuration
branch
class-attribute
instance-attribute
branch = Field(default=None, description='Branch is the branch to fetch when `SingleBranch` is enabled')
depth
class-attribute
instance-attribute
depth = Field(default=None, description='Depth specifies clones/fetches should be shallow and include the given number of commits from the branch tip')
disable_submodules
class-attribute
instance-attribute
disable_submodules = Field(default=None, alias='disableSubmodules', description='DisableSubmodules disables submodules during git clone')
fetch
class-attribute
instance-attribute
fetch = Field(default=None, description='Fetch specifies a number of refs that should be fetched before checkout')
from_expression
class-attribute
instance-attribute
an expression that dictates where to obtain the artifact from
insecure_ignore_host_key
class-attribute
instance-attribute
insecure_ignore_host_key = Field(default=None, alias='insecureIgnoreHostKey', description='InsecureIgnoreHostKey disables SSH strict host key checking during git clone')
loader
class-attribute
instance-attribute
used for input Artifact annotations for determining how to load the data.
Note: A loader value of ‘None’ must be used with an underlying type of ‘str’ or Path-like class.
mode
class-attribute
instance-attribute
mode bits to use on the artifact, must be a value between 0 and 0777 set when loading input artifacts.
optional
class-attribute
instance-attribute
whether the Artifact is optional. For an input Artifact, this means it may possibly not exist at the specified path during the template’s runtime. For an output Artifact, it may possibly not be generated during the step/task and available as an output to subsequent steps/tasks.
output
class-attribute
instance-attribute
used to specify artifact as an output in function signature annotations
password_secret
class-attribute
instance-attribute
password_secret = Field(default=None, alias='passwordSecret', description='PasswordSecret is the secret selector to the repository password')
path
class-attribute
instance-attribute
path where the artifact should be placed/loaded from
recurse_mode
class-attribute
instance-attribute
recursion mode when applying the permissions of the artifact if it is an artifact folder
revision
class-attribute
instance-attribute
single_branch
class-attribute
instance-attribute
single_branch = Field(default=None, alias='singleBranch', description='SingleBranch enables single branch clone, using the `branch` parameter')
ssh_private_key_secret
class-attribute
instance-attribute
ssh_private_key_secret = Field(default=None, alias='sshPrivateKeySecret', description='SSHPrivateKeySecret is the secret selector to the repository ssh private key')
sub_path
class-attribute
instance-attribute
allows the specification of an artifact from a subpath within the main source.
username_secret
class-attribute
instance-attribute
username_secret = Field(default=None, alias='usernameSecret', description='UsernameSecret is the secret selector to the repository username')
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
as_name
DEPRECATED, use with_name.
Returns a ‘built’ copy of the current artifact, renamed using the specified name
.
Source code in src/hera/workflows/artifact.py
with_name
Returns a copy of the current artifact, renamed using the specified name
.
GitRepoVolume
A representation of a Git repo that can be mounted as a volume.
Source code in src/hera/workflows/volume.py
directory
class-attribute
instance-attribute
directory = Field(default=None, description="Target directory name. Must not contain or start with '..'. If '.' is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name.")
mount_propagation
class-attribute
instance-attribute
mount_propagation = Field(default=None, alias='mountPropagation', description='mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10.')
read_only
class-attribute
instance-attribute
read_only = Field(default=None, alias='readOnly', description='Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.')
revision
class-attribute
instance-attribute
sub_path
class-attribute
instance-attribute
sub_path = Field(default=None, alias='subPath', description='Path within the volume from which the container\'s volume should be mounted. Defaults to "" (volume\'s root).')
sub_path_expr
class-attribute
instance-attribute
sub_path_expr = Field(default=None, alias='subPathExpr', description='Expanded path within the volume from which the container\'s volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container\'s environment. Defaults to "" (volume\'s root). SubPathExpr and SubPath are mutually exclusive.')
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
GlusterfsVolume
A representation for a Gluster filesystem volume.
Source code in src/hera/workflows/volume.py
endpoints
class-attribute
instance-attribute
endpoints = Field(..., description='EndpointsName is the endpoint name that details Glusterfs topology. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod')
mount_propagation
class-attribute
instance-attribute
mount_propagation = Field(default=None, alias='mountPropagation', description='mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10.')
path
class-attribute
instance-attribute
path = Field(..., description='Path is the Glusterfs volume path. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod')
read_only
class-attribute
instance-attribute
read_only = Field(default=None, alias='readOnly', description='Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.')
sub_path
class-attribute
instance-attribute
sub_path = Field(default=None, alias='subPath', description='Path within the volume from which the container\'s volume should be mounted. Defaults to "" (volume\'s root).')
sub_path_expr
class-attribute
instance-attribute
sub_path_expr = Field(default=None, alias='subPathExpr', description='Expanded path within the volume from which the container\'s volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container\'s environment. Defaults to "" (volume\'s root). SubPathExpr and SubPath are mutually exclusive.')
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
HDFSArtifact
A Hadoop File System artifact.
Note that HDFSArtifact
does not inherit from the auto-generated HDFSArtifact
because there’s a
conflict in path
with the base class Artifact
. Here, we redefine the HDFS path
to hdfs_path
to
differentiate between the parent class and the child class path
.
Source code in src/hera/workflows/artifact.py
archive_logs
class-attribute
instance-attribute
whether to log the archive object
artifact_gc
class-attribute
instance-attribute
artifact garbage collection configuration
from_expression
class-attribute
instance-attribute
an expression that dictates where to obtain the artifact from
loader
class-attribute
instance-attribute
used for input Artifact annotations for determining how to load the data.
Note: A loader value of ‘None’ must be used with an underlying type of ‘str’ or Path-like class.
mode
class-attribute
instance-attribute
mode bits to use on the artifact, must be a value between 0 and 0777 set when loading input artifacts.
optional
class-attribute
instance-attribute
whether the Artifact is optional. For an input Artifact, this means it may possibly not exist at the specified path during the template’s runtime. For an output Artifact, it may possibly not be generated during the step/task and available as an output to subsequent steps/tasks.
output
class-attribute
instance-attribute
used to specify artifact as an output in function signature annotations
path
class-attribute
instance-attribute
path where the artifact should be placed/loaded from
recurse_mode
class-attribute
instance-attribute
recursion mode when applying the permissions of the artifact if it is an artifact folder
sub_path
class-attribute
instance-attribute
allows the specification of an artifact from a subpath within the main source.
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
as_name
DEPRECATED, use with_name.
Returns a ‘built’ copy of the current artifact, renamed using the specified name
.
Source code in src/hera/workflows/artifact.py
with_name
Returns a copy of the current artifact, renamed using the specified name
.
HTTP
HTTP
is an implementation of the HTTP template that supports executing HTTP actions in a step/task.
Source code in src/hera/workflows/http_template.py
automount_service_account_token
class-attribute
instance-attribute
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
get_parameter
Finds and returns the parameter with the supplied name.
Note that this method will raise an error if the parameter is not found.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
name |
str
|
name of the input parameter to find and return. |
required |
Returns:
Name | Type | Description |
---|---|---|
Parameter |
Parameter
|
the parameter with the supplied name. |
Raises:
Type | Description |
---|---|
KeyError
|
if the parameter is not found. |
Source code in src/hera/workflows/_mixins.py
HTTPArtifact
An artifact sourced from an HTTP URL.
Source code in src/hera/workflows/artifact.py
archive_logs
class-attribute
instance-attribute
whether to log the archive object
artifact_gc
class-attribute
instance-attribute
artifact garbage collection configuration
auth
class-attribute
instance-attribute
from_expression
class-attribute
instance-attribute
an expression that dictates where to obtain the artifact from
headers
class-attribute
instance-attribute
headers = Field(default=None, description='Headers are an optional list of headers to send with HTTP requests for artifacts')
loader
class-attribute
instance-attribute
used for input Artifact annotations for determining how to load the data.
Note: A loader value of ‘None’ must be used with an underlying type of ‘str’ or Path-like class.
mode
class-attribute
instance-attribute
mode bits to use on the artifact, must be a value between 0 and 0777 set when loading input artifacts.
optional
class-attribute
instance-attribute
whether the Artifact is optional. For an input Artifact, this means it may possibly not exist at the specified path during the template’s runtime. For an output Artifact, it may possibly not be generated during the step/task and available as an output to subsequent steps/tasks.
output
class-attribute
instance-attribute
used to specify artifact as an output in function signature annotations
path
class-attribute
instance-attribute
path where the artifact should be placed/loaded from
recurse_mode
class-attribute
instance-attribute
recursion mode when applying the permissions of the artifact if it is an artifact folder
sub_path
class-attribute
instance-attribute
allows the specification of an artifact from a subpath within the main source.
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
as_name
DEPRECATED, use with_name.
Returns a ‘built’ copy of the current artifact, renamed using the specified name
.
Source code in src/hera/workflows/artifact.py
with_name
Returns a copy of the current artifact, renamed using the specified name
.
Histogram
Histogram metric that records the value at the specified bucket intervals.
Notes
See https://argoproj.github.io/argo-workflows/metrics/#grafana-dashboard-for-argo-controller-metrics
Source code in src/hera/workflows/metrics.py
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
HostPathVolume
Representation for a volume that can be mounted from a host path/node location.
Source code in src/hera/workflows/volume.py
mount_propagation
class-attribute
instance-attribute
mount_propagation = Field(default=None, alias='mountPropagation', description='mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10.')
path
class-attribute
instance-attribute
path = Field(..., description='Path of the directory on the host. If the path is a symlink, it will follow the link to the real path. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath')
read_only
class-attribute
instance-attribute
read_only = Field(default=None, alias='readOnly', description='Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.')
sub_path
class-attribute
instance-attribute
sub_path = Field(default=None, alias='subPath', description='Path within the volume from which the container\'s volume should be mounted. Defaults to "" (volume\'s root).')
sub_path_expr
class-attribute
instance-attribute
sub_path_expr = Field(default=None, alias='subPathExpr', description='Expanded path within the volume from which the container\'s volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container\'s environment. Defaults to "" (volume\'s root). SubPathExpr and SubPath are mutually exclusive.')
type
class-attribute
instance-attribute
type = Field(default=None, description='Type for HostPath Volume Defaults to "" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath')
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
ISCSIVolume
Representation of ISCSI volume.
Source code in src/hera/workflows/volume.py
chap_auth_discovery
class-attribute
instance-attribute
chap_auth_discovery = Field(default=None, alias='chapAuthDiscovery', description='whether support iSCSI Discovery CHAP authentication')
chap_auth_session
class-attribute
instance-attribute
chap_auth_session = Field(default=None, alias='chapAuthSession', description='whether support iSCSI Session CHAP authentication')
fs_type
class-attribute
instance-attribute
fs_type = Field(default=None, alias='fsType', description='Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi')
initiator_name
class-attribute
instance-attribute
initiator_name = Field(default=None, alias='initiatorName', description='Custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface <target portal>:<volume name> will be created for the connection.')
iscsi_interface
class-attribute
instance-attribute
iscsi_interface = Field(default=None, alias='iscsiInterface', description="iSCSI Interface Name that uses an iSCSI transport. Defaults to 'default' (tcp).")
mount_propagation
class-attribute
instance-attribute
mount_propagation = Field(default=None, alias='mountPropagation', description='mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10.')
portals
class-attribute
instance-attribute
portals = Field(default=None, description='iSCSI Target Portal List. The portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).')
read_only
class-attribute
instance-attribute
read_only = Field(default=None, alias='readOnly', description='Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.')
secret_ref
class-attribute
instance-attribute
secret_ref = Field(default=None, alias='secretRef', description='CHAP Secret for iSCSI target and initiator authentication')
sub_path
class-attribute
instance-attribute
sub_path = Field(default=None, alias='subPath', description='Path within the volume from which the container\'s volume should be mounted. Defaults to "" (volume\'s root).')
sub_path_expr
class-attribute
instance-attribute
sub_path_expr = Field(default=None, alias='subPathExpr', description='Expanded path within the volume from which the container\'s volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container\'s environment. Defaults to "" (volume\'s root). SubPathExpr and SubPath are mutually exclusive.')
target_portal
class-attribute
instance-attribute
target_portal = Field(..., alias='targetPortal', description='iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).')
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
InlineScriptConstructor
InlineScriptConstructor
is a script constructor that submits a script as a source
to Argo.
This script constructor is focused on taking a Python script/function “as is” for remote execution. The
constructor processes the script to infer what parameters it needs to deserialize so the script can execute.
The submitted script will contain prefixes such as new imports, e.g. import os
, import json
, etc. and
will contain the necessary json.loads
calls to deserialize the parameters so they are usable by the script just
like a normal Python script/function.
Source code in src/hera/workflows/script.py
612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 |
|
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
generate_source
Assembles and returns a script representation of the given function.
This also assembles any extra script material prefixed to the string source.
The script is expected to be a callable function the client is interested in submitting
for execution on Argo and the script_extra
material represents the parameter loading part obtained, likely,
through get_param_script_portion
.
Returns:
str Final formatted script.
Source code in src/hera/workflows/script.py
transform_script_template_post_build
A hook to transform the generated script template.
transform_template_post_build
transform_values
InvalidDispatchType
InvalidTemplateCall
InvalidType
Metric
Prometheus metric that can be used at the workflow or task/template level.
Notes
See https://argoproj.github.io/argo-workflows/metrics/#grafana-dashboard-for-argo-controller-metrics
Source code in src/hera/workflows/metrics.py
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
Metrics
A collection of Prometheus metrics.
Notes
See https://argoproj.github.io/argo-workflows/metrics/#grafana-dashboard-for-argo-controller-metrics
Source code in src/hera/workflows/metrics.py
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
NFSVolume
A network file system volume representation.
Source code in src/hera/workflows/volume.py
mount_propagation
class-attribute
instance-attribute
mount_propagation = Field(default=None, alias='mountPropagation', description='mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10.')
path
class-attribute
instance-attribute
path = Field(..., description='Path that is exported by the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs')
read_only
class-attribute
instance-attribute
read_only = Field(default=None, alias='readOnly', description='Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.')
server
class-attribute
instance-attribute
server = Field(..., description='Server is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs')
sub_path
class-attribute
instance-attribute
sub_path = Field(default=None, alias='subPath', description='Path within the volume from which the container\'s volume should be mounted. Defaults to "" (volume\'s root).')
sub_path_expr
class-attribute
instance-attribute
sub_path_expr = Field(default=None, alias='subPathExpr', description='Expanded path within the volume from which the container\'s volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container\'s environment. Defaults to "" (volume\'s root). SubPathExpr and SubPath are mutually exclusive.')
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
NoneArchiveStrategy
NoneArchiveStrategy
indicates artifacts should skip serialization.
Source code in src/hera/workflows/archive.py
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
OSSArtifact
An artifact sourced from OSS.
Source code in src/hera/workflows/artifact.py
access_key_secret
class-attribute
instance-attribute
access_key_secret = Field(default=None, alias='accessKeySecret', description="AccessKeySecret is the secret selector to the bucket's access key")
archive_logs
class-attribute
instance-attribute
whether to log the archive object
artifact_gc
class-attribute
instance-attribute
artifact garbage collection configuration
bucket
class-attribute
instance-attribute
create_bucket_if_not_present
class-attribute
instance-attribute
create_bucket_if_not_present = Field(default=None, alias='createBucketIfNotPresent', description="CreateBucketIfNotPresent tells the driver to attempt to create the OSS bucket for output artifacts, if it doesn't exist")
endpoint
class-attribute
instance-attribute
from_expression
class-attribute
instance-attribute
an expression that dictates where to obtain the artifact from
key
class-attribute
instance-attribute
lifecycle_rule
class-attribute
instance-attribute
lifecycle_rule = Field(default=None, alias='lifecycleRule', description="LifecycleRule specifies how to manage bucket's lifecycle")
loader
class-attribute
instance-attribute
used for input Artifact annotations for determining how to load the data.
Note: A loader value of ‘None’ must be used with an underlying type of ‘str’ or Path-like class.
mode
class-attribute
instance-attribute
mode bits to use on the artifact, must be a value between 0 and 0777 set when loading input artifacts.
optional
class-attribute
instance-attribute
whether the Artifact is optional. For an input Artifact, this means it may possibly not exist at the specified path during the template’s runtime. For an output Artifact, it may possibly not be generated during the step/task and available as an output to subsequent steps/tasks.
output
class-attribute
instance-attribute
used to specify artifact as an output in function signature annotations
path
class-attribute
instance-attribute
path where the artifact should be placed/loaded from
recurse_mode
class-attribute
instance-attribute
recursion mode when applying the permissions of the artifact if it is an artifact folder
secret_key_secret
class-attribute
instance-attribute
secret_key_secret = Field(default=None, alias='secretKeySecret', description="SecretKeySecret is the secret selector to the bucket's secret key")
security_token
class-attribute
instance-attribute
security_token = Field(default=None, alias='securityToken', description="SecurityToken is the user's temporary security token. For more details, check out: https://www.alibabacloud.com/help/doc-detail/100624.htm")
sub_path
class-attribute
instance-attribute
allows the specification of an artifact from a subpath within the main source.
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
as_name
DEPRECATED, use with_name.
Returns a ‘built’ copy of the current artifact, renamed using the specified name
.
Source code in src/hera/workflows/artifact.py
with_name
Returns a copy of the current artifact, renamed using the specified name
.
Operator
Operator is a representation of mathematical comparison symbols.
This can be used on tasks that execute conditionally based on the output of another task.
Notes
The task that outputs its result needs to do so using stdout. See examples
for a sample workflow.
Source code in src/hera/workflows/operator.py
Parallel
Parallel is used to add a list of steps which will run in parallel.
Parallel implements the contextmanager interface so allows usage of with
, under which any
hera.workflows.steps.Step
objects instantiated will be added to Parallel’s list of sub_steps.
Source code in src/hera/workflows/steps.py
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
Parameter
A Parameter
is used to pass values in and out of templates.
They are to declare input and output parameters in the case of templates, and are used for Steps and Tasks to assign values.
Source code in src/hera/workflows/parameter.py
16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 |
|
description
class-attribute
instance-attribute
enum
class-attribute
instance-attribute
enum = Field(default=None, description='Enum holds a list of string values to choose from, for the actual value of the parameter')
global_name
class-attribute
instance-attribute
global_name = Field(default=None, alias='globalName', description="GlobalName exports an output parameter to the global scope, making it available as '{{io.argoproj.workflow.v1alpha1.outputs.parameters.XXXX}} and in workflow.status.outputs.parameters")
output
class-attribute
instance-attribute
used to specify parameter as an output in function signature annotations
value_from
class-attribute
instance-attribute
value_from = Field(default=None, alias='valueFrom', description="ValueFrom is the source for the output parameter's value")
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
as_argument
Assembles the parameter for use as an argument of a step or a task.
Source code in src/hera/workflows/parameter.py
as_input
Assembles the parameter for use as an input of a template.
Source code in src/hera/workflows/parameter.py
as_output
Assembles the parameter for use as an output of a template.
Source code in src/hera/workflows/parameter.py
from_model
classmethod
with_name
PhotonPersistentDiskVolume
A Photon Persisten Disk representation.
Source code in src/hera/workflows/volume.py
fs_type
class-attribute
instance-attribute
fs_type = Field(default=None, alias='fsType', description='Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.')
mount_propagation
class-attribute
instance-attribute
mount_propagation = Field(default=None, alias='mountPropagation', description='mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10.')
pd_id
class-attribute
instance-attribute
pd_id = Field(..., alias='pdID', description='ID that identifies Photon Controller persistent disk')
read_only
class-attribute
instance-attribute
read_only = Field(default=None, alias='readOnly', description='Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.')
sub_path
class-attribute
instance-attribute
sub_path = Field(default=None, alias='subPath', description='Path within the volume from which the container\'s volume should be mounted. Defaults to "" (volume\'s root).')
sub_path_expr
class-attribute
instance-attribute
sub_path_expr = Field(default=None, alias='subPathExpr', description='Expanded path within the volume from which the container\'s volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container\'s environment. Defaults to "" (volume\'s root). SubPathExpr and SubPath are mutually exclusive.')
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
PortworxVolume
PortworxVolume
represents a Portworx volume to mount to a container.
Source code in src/hera/workflows/volume.py
fs_type
class-attribute
instance-attribute
fs_type = Field(default=None, alias='fsType', description='FSType represents the filesystem type to mount Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs". Implicitly inferred to be "ext4" if unspecified.')
mount_propagation
class-attribute
instance-attribute
mount_propagation = Field(default=None, alias='mountPropagation', description='mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10.')
read_only
class-attribute
instance-attribute
read_only = Field(default=None, alias='readOnly', description='Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.')
sub_path
class-attribute
instance-attribute
sub_path = Field(default=None, alias='subPath', description='Path within the volume from which the container\'s volume should be mounted. Defaults to "" (volume\'s root).')
sub_path_expr
class-attribute
instance-attribute
sub_path_expr = Field(default=None, alias='subPathExpr', description='Expanded path within the volume from which the container\'s volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container\'s environment. Defaults to "" (volume\'s root). SubPathExpr and SubPath are mutually exclusive.')
volume_id
class-attribute
instance-attribute
volume_id = Field(..., alias='volumeID', description='VolumeID uniquely identifies a Portworx volume')
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
ProjectedVolume
ProjectedVolume
represents a projected volume to mount to a container.
Source code in src/hera/workflows/volume.py
default_mode
class-attribute
instance-attribute
default_mode = Field(default=None, alias='defaultMode', description='Mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.')
mount_propagation
class-attribute
instance-attribute
mount_propagation = Field(default=None, alias='mountPropagation', description='mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10.')
read_only
class-attribute
instance-attribute
read_only = Field(default=None, alias='readOnly', description='Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.')
sources
class-attribute
instance-attribute
sub_path
class-attribute
instance-attribute
sub_path = Field(default=None, alias='subPath', description='Path within the volume from which the container\'s volume should be mounted. Defaults to "" (volume\'s root).')
sub_path_expr
class-attribute
instance-attribute
sub_path_expr = Field(default=None, alias='subPathExpr', description='Expanded path within the volume from which the container\'s volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container\'s environment. Defaults to "" (volume\'s root). SubPathExpr and SubPath are mutually exclusive.')
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
QuobyteVolume
QuobyteVolume
represents a Quobyte volume to mount to a container.
Source code in src/hera/workflows/volume.py
group
class-attribute
instance-attribute
mount_propagation
class-attribute
instance-attribute
mount_propagation = Field(default=None, alias='mountPropagation', description='mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10.')
read_only
class-attribute
instance-attribute
read_only = Field(default=None, alias='readOnly', description='Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.')
registry
class-attribute
instance-attribute
registry = Field(..., description='Registry represents a single or multiple Quobyte Registry services specified as a string as host:port pair (multiple entries are separated with commas) which acts as the central registry for volumes')
sub_path
class-attribute
instance-attribute
sub_path = Field(default=None, alias='subPath', description='Path within the volume from which the container\'s volume should be mounted. Defaults to "" (volume\'s root).')
sub_path_expr
class-attribute
instance-attribute
sub_path_expr = Field(default=None, alias='subPathExpr', description='Expanded path within the volume from which the container\'s volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container\'s environment. Defaults to "" (volume\'s root). SubPathExpr and SubPath are mutually exclusive.')
tenant
class-attribute
instance-attribute
tenant = Field(default=None, description='Tenant owning the given Quobyte volume in the Backend Used with dynamically provisioned Quobyte volumes, value is set by the plugin')
user
class-attribute
instance-attribute
user = Field(default=None, description='User to map volume access to Defaults to serivceaccount user')
volume
class-attribute
instance-attribute
volume = Field(..., description='Volume is a string that references an already created Quobyte volume by name.')
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
RBDVolume
An RDB volume representation.
Source code in src/hera/workflows/volume.py
fs_type
class-attribute
instance-attribute
fs_type = Field(default=None, alias='fsType', description='Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#rbd')
image
class-attribute
instance-attribute
image = Field(..., description='The rados image name. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it')
keyring
class-attribute
instance-attribute
keyring = Field(default=None, description='Keyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it')
monitors
class-attribute
instance-attribute
monitors = Field(..., description='A collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it')
mount_propagation
class-attribute
instance-attribute
mount_propagation = Field(default=None, alias='mountPropagation', description='mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10.')
pool
class-attribute
instance-attribute
pool = Field(default=None, description='The rados pool name. Default is rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it')
read_only
class-attribute
instance-attribute
read_only = Field(default=None, alias='readOnly', description='Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.')
secret_ref
class-attribute
instance-attribute
secret_ref = Field(default=None, alias='secretRef', description='SecretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it')
sub_path
class-attribute
instance-attribute
sub_path = Field(default=None, alias='subPath', description='Path within the volume from which the container\'s volume should be mounted. Defaults to "" (volume\'s root).')
sub_path_expr
class-attribute
instance-attribute
sub_path_expr = Field(default=None, alias='subPathExpr', description='Expanded path within the volume from which the container\'s volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container\'s environment. Defaults to "" (volume\'s root). SubPathExpr and SubPath are mutually exclusive.')
user
class-attribute
instance-attribute
user = Field(default=None, description='The rados user name. Default is admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it')
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
RawArtifact
A raw bytes artifact representation.
Source code in src/hera/workflows/artifact.py
archive_logs
class-attribute
instance-attribute
whether to log the archive object
artifact_gc
class-attribute
instance-attribute
artifact garbage collection configuration
data
class-attribute
instance-attribute
from_expression
class-attribute
instance-attribute
an expression that dictates where to obtain the artifact from
loader
class-attribute
instance-attribute
used for input Artifact annotations for determining how to load the data.
Note: A loader value of ‘None’ must be used with an underlying type of ‘str’ or Path-like class.
mode
class-attribute
instance-attribute
mode bits to use on the artifact, must be a value between 0 and 0777 set when loading input artifacts.
optional
class-attribute
instance-attribute
whether the Artifact is optional. For an input Artifact, this means it may possibly not exist at the specified path during the template’s runtime. For an output Artifact, it may possibly not be generated during the step/task and available as an output to subsequent steps/tasks.
output
class-attribute
instance-attribute
used to specify artifact as an output in function signature annotations
path
class-attribute
instance-attribute
path where the artifact should be placed/loaded from
recurse_mode
class-attribute
instance-attribute
recursion mode when applying the permissions of the artifact if it is an artifact folder
sub_path
class-attribute
instance-attribute
allows the specification of an artifact from a subpath within the main source.
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
as_name
DEPRECATED, use with_name.
Returns a ‘built’ copy of the current artifact, renamed using the specified name
.
Source code in src/hera/workflows/artifact.py
with_name
Returns a copy of the current artifact, renamed using the specified name
.
Resource
Resource
is a representation of a K8s resource that can be created by Argo.
The resource is a callable step that can be invoked in a DAG/Workflow. The resource can create any K8s resource,
such as other workflows, workflow templates, daemons, etc, as specified by the manifest
field of the resource.
The manifest field is a canonical YAML that is submitted to K8s by Argo. Note that the manifest is a union of
multiple types. The manifest can be a string, in which case it is assume to be YAML. Otherwise, if it’s a Hera
objects, it is automatically converted to the corresponding YAML representation.
Source code in src/hera/workflows/resource.py
automount_service_account_token
class-attribute
instance-attribute
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
get_parameter
Finds and returns the parameter with the supplied name.
Note that this method will raise an error if the parameter is not found.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
name |
str
|
name of the input parameter to find and return. |
required |
Returns:
Name | Type | Description |
---|---|---|
Parameter |
Parameter
|
the parameter with the supplied name. |
Raises:
Type | Description |
---|---|
KeyError
|
if the parameter is not found. |
Source code in src/hera/workflows/_mixins.py
ResourceEnv
ResourceEnv
exposes a resource field as an environment variable.
Only resources limits and requests such as limits.cpu
, limits.memory
, limits.ephemeral-storage
,
requests.cpu
, requests.memory
and requests.ephemeral-storage
are currently supported.
Source code in src/hera/workflows/env.py
container_name
class-attribute
instance-attribute
a pod can contain multiple containers, so this field helps select the right container whose resources should be exposed as an env variable.
divisor
class-attribute
instance-attribute
Specifies the output format of the exposed resources, defaults to 1
on Argo’s side
name
instance-attribute
the name of the environment variable. This is universally required irrespective of the type of env variable
resource
instance-attribute
the name of the resource to select, such as limit.cpu
, limits.memory
, etc.
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
build
Builds the ResourceEnv
into a Hera auto-generated environment variable model.
Source code in src/hera/workflows/env.py
Resources
A representation of a collection of resources that are requested to be consumed by a task for execution.
This follow the K8S definition for resources.
Attributes:
Name | Type | Description |
---|---|---|
cpu_request |
Optional[Union[float, int, str]]
|
The number of CPUs to request, either as a fraction (millicpu), whole number, or a string. |
cpu_limit |
Optional[Union[float, int, str]]
|
The limit of CPUs to request, either as a fraction (millicpu), whole number, or a string. |
memory_request |
Optional[str]
|
The amount of memory to request. |
memory_limit |
Optional[str]
|
The memory limit of the pod. |
ephemeral_request |
Optional[str]
|
The amount of ephemeral storage to request. |
ephemeral_limit |
Optional[str]
|
The ephemeral storage limit of the pod. |
gpus |
Optional[Union[int, str]]
|
The number of GPUs to request. |
gpu_flag |
Optional[str]
|
The GPU flag to use for identifying how many GPUs to mount to a pod. This is dependent on the cloud provider. |
custom_resources |
Optional[Dict]
|
Any custom resources to request. This is dependent on the cloud provider. |
Notes
Most of the fields that support a union of int
and str
support either specifying a number for the resource,
such as 1 CPU, 2 GPU, etc., a str
representation of that numerical resource, such as ‘1’ CPU, ‘2’ GPU, etc., but
also supports specifying a to be computed value, such as {{inputs.parameters.cpu_request}}
. This means tasks,
steps, etc., can be stitched together in a way to have a task/step that computes the resource requirements, and
then outputs
them to the next step/task.
Source code in src/hera/workflows/resources.py
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
build
Builds the resource requirements of the pod.
Source code in src/hera/workflows/resources.py
RetryPolicy
An enum that holds options for retry policy.
Source code in src/hera/workflows/retry_strategy.py
on_error
class-attribute
instance-attribute
Retry steps that encounter Argo controller errors, or whose init or wait containers fail
on_failure
class-attribute
instance-attribute
Retry steps whose main container is marked as failed in Kubernetes
RetryStrategy
RetryStrategy
configures how an Argo job should retry.
Source code in src/hera/workflows/retry_strategy.py
affinity
class-attribute
instance-attribute
affinity dictates the affinity of the retried jobs
backoff
class-attribute
instance-attribute
backoff dictates how long should a job wait for before retrying
expression
class-attribute
instance-attribute
the expression field supports the expression of complex rules regarding retry behavior
limit
class-attribute
instance-attribute
the hard numeric limit of how many times a jobs should retry
retry_policy
class-attribute
instance-attribute
the policy dictates, at a high level, under what conditions should a job retry
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
build
Builds the generated RetryStrategy
representation of the retry strategy.
Source code in src/hera/workflows/retry_strategy.py
RunnerScriptConstructor
RunnerScriptConstructor
is a script constructor that runs a script in a container.
The runner script, also known as “The Hera runner”, takes a script/Python function definition, infers the path
to the function (module import), assembles a path to invoke the function, and passes any specified parameters
to the function. This helps users “save” on the source
space required for submitting a function for remote
execution on Argo. Execution within the container requires the executing container to include the file that
contains the submitted script. More specifically, the container must be created in some process (e.g. CI), so that
it conains the script to run remotely.
Source code in src/hera/workflows/script.py
DEFAULT_HERA_OUTPUTS_DIRECTORY
class-attribute
instance-attribute
Used as the default value for when the outputs_directory is not set
outputs_directory
class-attribute
instance-attribute
Used for saving outputs when defined using annotations.
volume_for_outputs
class-attribute
instance-attribute
Volume to use if saving outputs when defined using annotations.
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
generate_source
A function that can inspect the Script instance and generate the source field.
transform_script_template_post_build
A hook to transform the generated script template.
Source code in src/hera/workflows/script.py
transform_template_post_build
transform_values
A function that can inspect the Script instance and generate the source field.
Source code in src/hera/workflows/script.py
S3Artifact
An artifact sourced from AWS S3.
Source code in src/hera/workflows/artifact.py
access_key_secret
class-attribute
instance-attribute
access_key_secret = Field(default=None, alias='accessKeySecret', description="AccessKeySecret is the secret selector to the bucket's access key")
archive_logs
class-attribute
instance-attribute
whether to log the archive object
artifact_gc
class-attribute
instance-attribute
artifact garbage collection configuration
bucket
class-attribute
instance-attribute
create_bucket_if_not_present
class-attribute
instance-attribute
create_bucket_if_not_present = Field(default=None, alias='createBucketIfNotPresent', description="CreateBucketIfNotPresent tells the driver to attempt to create the S3 bucket for output artifacts, if it doesn't exist. Setting Enabled Encryption will apply either SSE-S3 to the bucket if KmsKeyId is not set or SSE-KMS if it is.")
encryption_options
class-attribute
instance-attribute
endpoint
class-attribute
instance-attribute
from_expression
class-attribute
instance-attribute
an expression that dictates where to obtain the artifact from
insecure
class-attribute
instance-attribute
key
class-attribute
instance-attribute
loader
class-attribute
instance-attribute
used for input Artifact annotations for determining how to load the data.
Note: A loader value of ‘None’ must be used with an underlying type of ‘str’ or Path-like class.
mode
class-attribute
instance-attribute
mode bits to use on the artifact, must be a value between 0 and 0777 set when loading input artifacts.
optional
class-attribute
instance-attribute
whether the Artifact is optional. For an input Artifact, this means it may possibly not exist at the specified path during the template’s runtime. For an output Artifact, it may possibly not be generated during the step/task and available as an output to subsequent steps/tasks.
output
class-attribute
instance-attribute
used to specify artifact as an output in function signature annotations
path
class-attribute
instance-attribute
path where the artifact should be placed/loaded from
recurse_mode
class-attribute
instance-attribute
recursion mode when applying the permissions of the artifact if it is an artifact folder
region
class-attribute
instance-attribute
role_arn
class-attribute
instance-attribute
role_arn = Field(default=None, alias='roleARN', description='RoleARN is the Amazon Resource Name (ARN) of the role to assume.')
secret_key_secret
class-attribute
instance-attribute
secret_key_secret = Field(default=None, alias='secretKeySecret', description="SecretKeySecret is the secret selector to the bucket's secret key")
sub_path
class-attribute
instance-attribute
allows the specification of an artifact from a subpath within the main source.
use_sdk_creds
class-attribute
instance-attribute
use_sdk_creds = Field(default=None, alias='useSDKCreds', description='UseSDKCreds tells the driver to figure out credentials based on sdk defaults.')
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
as_name
DEPRECATED, use with_name.
Returns a ‘built’ copy of the current artifact, renamed using the specified name
.
Source code in src/hera/workflows/artifact.py
with_name
Returns a copy of the current artifact, renamed using the specified name
.
ScaleIOVolume
ScaleIOVolume
represents a ScaleIO volume to mount to the container.
Source code in src/hera/workflows/volume.py
fs_type
class-attribute
instance-attribute
fs_type = Field(default=None, alias='fsType', description='Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Default is "xfs".')
gateway
class-attribute
instance-attribute
mount_propagation
class-attribute
instance-attribute
mount_propagation = Field(default=None, alias='mountPropagation', description='mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10.')
protection_domain
class-attribute
instance-attribute
protection_domain = Field(default=None, alias='protectionDomain', description='The name of the ScaleIO Protection Domain for the configured storage.')
read_only
class-attribute
instance-attribute
read_only = Field(default=None, alias='readOnly', description='Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.')
secret_ref
class-attribute
instance-attribute
secret_ref = Field(..., alias='secretRef', description='SecretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail.')
ssl_enabled
class-attribute
instance-attribute
ssl_enabled = Field(default=None, alias='sslEnabled', description='Flag to enable/disable SSL communication with Gateway, default false')
storage_mode
class-attribute
instance-attribute
storage_mode = Field(default=None, alias='storageMode', description='Indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned.')
storage_pool
class-attribute
instance-attribute
storage_pool = Field(default=None, alias='storagePool', description='The ScaleIO Storage Pool associated with the protection domain.')
sub_path
class-attribute
instance-attribute
sub_path = Field(default=None, alias='subPath', description='Path within the volume from which the container\'s volume should be mounted. Defaults to "" (volume\'s root).')
sub_path_expr
class-attribute
instance-attribute
sub_path_expr = Field(default=None, alias='subPathExpr', description='Expanded path within the volume from which the container\'s volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container\'s environment. Defaults to "" (volume\'s root). SubPathExpr and SubPath are mutually exclusive.')
system
class-attribute
instance-attribute
volume_name
class-attribute
instance-attribute
volume_name = Field(default=None, alias='volumeName', description='The name of a volume already created in the ScaleIO system that is associated with this volume source.')
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
Script
A Script acts as a wrapper around a container.
In Hera this defaults to a “python:3.8” image specified by global_config.image, which runs a python source
specified by Script.source
.
Source code in src/hera/workflows/script.py
93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 |
|
automount_service_account_token
class-attribute
instance-attribute
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
get_parameter
Finds and returns the parameter with the supplied name.
Note that this method will raise an error if the parameter is not found.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
name |
str
|
name of the input parameter to find and return. |
required |
Returns:
Name | Type | Description |
---|---|---|
Parameter |
Parameter
|
the parameter with the supplied name. |
Raises:
Type | Description |
---|---|
KeyError
|
if the parameter is not found. |
Source code in src/hera/workflows/_mixins.py
ScriptConstructor
A ScriptConstructor is responsible for generating the source code for a Script given a python callable.
This allows users to customize the behaviour of the template that hera generates when a python callable is passed to the Script class.
In order to use your custom ScriptConstructor implementation, you can set it as the Script.constructor field.
Source code in src/hera/workflows/script.py
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
generate_source
abstractmethod
A function that can inspect the Script instance and generate the source field.
transform_script_template_post_build
A hook to transform the generated script template.
transform_template_post_build
transform_values
SecretEnv
SecretEnv
is an environment variable whose value originates from a Kubernetes secret.
Source code in src/hera/workflows/env.py
name
instance-attribute
the name of the environment variable. This is universally required irrespective of the type of env variable
optional
class-attribute
instance-attribute
whether the existence of the secret is optional
secret_key
instance-attribute
the field key within the secret that points to the value to extract and set as an env variable
secret_name
class-attribute
instance-attribute
the name of the Kubernetes secret to extract the value from
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
build
Constructs and returns the Argo environment specification.
Source code in src/hera/workflows/env.py
SecretEnvFrom
Exposes a K8s secret as an environment variable.
Source code in src/hera/workflows/env_from.py
name
class-attribute
instance-attribute
name = Field(default=None, description='Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names')
optional
class-attribute
instance-attribute
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
build
Constructs and returns the Argo EnvFrom specification.
SecretVolume
SecretVolume
supports mounting a K8s secret as a container volume.
Source code in src/hera/workflows/volume.py
default_mode
class-attribute
instance-attribute
default_mode = Field(default=None, alias='defaultMode', description='Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.')
items
class-attribute
instance-attribute
items = Field(default=None, description="If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.")
mount_propagation
class-attribute
instance-attribute
mount_propagation = Field(default=None, alias='mountPropagation', description='mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10.')
optional
class-attribute
instance-attribute
optional = Field(default=None, description='Specify whether the Secret or its keys must be defined')
read_only
class-attribute
instance-attribute
read_only = Field(default=None, alias='readOnly', description='Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.')
secret_name
class-attribute
instance-attribute
secret_name = Field(default=None, alias='secretName', description="Name of the secret in the pod's namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret")
sub_path
class-attribute
instance-attribute
sub_path = Field(default=None, alias='subPath', description='Path within the volume from which the container\'s volume should be mounted. Defaults to "" (volume\'s root).')
sub_path_expr
class-attribute
instance-attribute
sub_path_expr = Field(default=None, alias='subPathExpr', description='Expanded path within the volume from which the container\'s volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container\'s environment. Defaults to "" (volume\'s root). SubPathExpr and SubPath are mutually exclusive.')
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
Step
Step is used to run a given template.
Must be instantiated under a Steps or Parallel context, or outside a Workflow.
Source code in src/hera/workflows/steps.py
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
get_artifact
get_parameter
get_parameters_as
Returns a Parameter
that represents all the outputs of this subnode.
Parameters
name: str The name of the parameter to search for.
Returns:
Parameter
The parameter, named based on the given name
, along with a value that references all outputs.
Source code in src/hera/workflows/_mixins.py
get_result_as
Returns a Parameter
specification with the given name containing the results
of self
.
Steps
A Steps template invocator is used to define a sequence of steps which can run sequentially or in parallel.
Steps implements the contextmanager interface so allows usage of with
, under which any
hera.workflows.steps.Step
objects instantiated will be added to the Steps’ list of sub_steps.
- Step and Parallel objects initialised within a Steps context will be added to the list of sub_steps in the order they are initialised.
- All Step objects initialised within a Parallel context will run in parallel.
Source code in src/hera/workflows/steps.py
106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 |
|
automount_service_account_token
class-attribute
instance-attribute
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
get_parameter
Finds and returns the parameter with the supplied name.
Note that this method will raise an error if the parameter is not found.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
name |
str
|
name of the input parameter to find and return. |
required |
Returns:
Name | Type | Description |
---|---|---|
Parameter |
Parameter
|
the parameter with the supplied name. |
Raises:
Type | Description |
---|---|
KeyError
|
if the parameter is not found. |
Source code in src/hera/workflows/_mixins.py
StorageOSVolume
StorageOSVolume
represents a Storage OS volume to mount.
Source code in src/hera/workflows/volume.py
fs_type
class-attribute
instance-attribute
fs_type = Field(default=None, alias='fsType', description='Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.')
mount_propagation
class-attribute
instance-attribute
mount_propagation = Field(default=None, alias='mountPropagation', description='mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10.')
read_only
class-attribute
instance-attribute
read_only = Field(default=None, alias='readOnly', description='Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.')
secret_ref
class-attribute
instance-attribute
secret_ref = Field(default=None, alias='secretRef', description='SecretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted.')
sub_path
class-attribute
instance-attribute
sub_path = Field(default=None, alias='subPath', description='Path within the volume from which the container\'s volume should be mounted. Defaults to "" (volume\'s root).')
sub_path_expr
class-attribute
instance-attribute
sub_path_expr = Field(default=None, alias='subPathExpr', description='Expanded path within the volume from which the container\'s volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container\'s environment. Defaults to "" (volume\'s root). SubPathExpr and SubPath are mutually exclusive.')
volume_name
class-attribute
instance-attribute
volume_name = Field(default=None, alias='volumeName', description='VolumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace.')
volume_namespace
class-attribute
instance-attribute
volume_namespace = Field(default=None, alias='volumeNamespace', description='VolumeNamespace specifies the scope of the volume within StorageOS. If no namespace is specified then the Pod\'s namespace will be used. This allows the Kubernetes name scoping to be mirrored within StorageOS for tighter integration. Set VolumeName to any name to override the default behaviour. Set to "default" if you are not using namespaces within StorageOS. Namespaces that do not pre-exist within StorageOS will be created.')
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
Suspend
The Suspend template allows the user to pause a workflow for a specified length of time.
The workflow can pause based on the given by duration
or indefinitely (i.e. until manually resumed).
The Suspend template also allows you to specify intermediate_parameters
which will replicate the given
parameters to the “inputs” and “outputs” of the template, resulting in a Suspend template that pauses and
waits for values from the user for the given list of parameters.
Source code in src/hera/workflows/suspend.py
automount_service_account_token
class-attribute
instance-attribute
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
TarArchiveStrategy
TarArchiveStrategy
indicates artifacts should be serialized using the tar
strategy.
Tar archiving is performed using the specified compression level.
Source code in src/hera/workflows/archive.py
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
Task
Task is used to run a given template within a DAG. Must be instantiated under a DAG context.
Source code in src/hera/workflows/task.py
45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 |
|
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
get_artifact
get_parameter
get_parameters_as
Returns a Parameter
that represents all the outputs of this subnode.
Parameters
name: str The name of the parameter to search for.
Returns:
Parameter
The parameter, named based on the given name
, along with a value that references all outputs.
Source code in src/hera/workflows/_mixins.py
get_result_as
Returns a Parameter
specification with the given name containing the results
of self
.
next
Set self as a dependency of other
.
Source code in src/hera/workflows/task.py
on_error
on_failure
on_other_result
Sets the current task to run when the given other
task results in the specified value
result.
Source code in src/hera/workflows/task.py
on_success
on_workflow_status
Sets the current task to run when the workflow finishes with the specified status.
Source code in src/hera/workflows/task.py
when_all_failed
Sets the current task to run when the given other
task has failed.
Source code in src/hera/workflows/task.py
when_any_succeeded
Sets the current task to run when the given other
task succeedds.
Source code in src/hera/workflows/task.py
TaskResult
The enumeration of Task Results.
See Also
Source code in src/hera/workflows/task.py
UserContainer
UserContainer
is a container type that is specifically used as a side container.
Source code in src/hera/workflows/user_container.py
40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 |
|
args
class-attribute
instance-attribute
args = Field(default=None, description='Arguments to the entrypoint. The container 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. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(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')
command
class-attribute
instance-attribute
command = Field(default=None, description='Entrypoint array. Not executed within a shell. The container 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. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(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')
image
class-attribute
instance-attribute
image = Field(default=None, description='Container 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.')
lifecycle
class-attribute
instance-attribute
lifecycle = Field(default=None, description='Actions that the management system should take in response to container lifecycle events. Cannot be updated.')
liveness_probe
class-attribute
instance-attribute
liveness_probe = Field(default=None, alias='livenessProbe', description='Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes')
mirror_volume_mounts
class-attribute
instance-attribute
mirror_volume_mounts = Field(default=None, alias='mirrorVolumeMounts', description='MirrorVolumeMounts will mount the same volumes specified in the main container to the container (including artifacts), at the same mountPaths. This enables dind daemon to partially see the same filesystem as the main container in order to use features such as docker volume binding')
name
class-attribute
instance-attribute
name = Field(..., description='Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated.')
ports
class-attribute
instance-attribute
ports = Field(default=None, description='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.')
readiness_probe
class-attribute
instance-attribute
readiness_probe = Field(default=None, alias='readinessProbe', description='Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes')
security_context
class-attribute
instance-attribute
security_context = Field(default=None, alias='securityContext', description='SecurityContext defines the security options the container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/')
startup_probe
class-attribute
instance-attribute
startup_probe = Field(default=None, alias='startupProbe', description="StartupProbe indicates that the Pod has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a Pod's lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes")
stdin
class-attribute
instance-attribute
stdin = Field(default=None, description='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.')
stdin_once
class-attribute
instance-attribute
stdin_once = Field(default=None, alias='stdinOnce', description='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')
termination_message_path
class-attribute
instance-attribute
termination_message_path = Field(default=None, alias='terminationMessagePath', description="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.")
termination_message_policy
class-attribute
instance-attribute
termination_message_policy = Field(default=None, alias='terminationMessagePolicy', description='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.')
tty
class-attribute
instance-attribute
tty = Field(default=None, description="Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false.")
volume_devices
class-attribute
instance-attribute
volume_devices = Field(default=None, alias='volumeDevices', description='volumeDevices is the list of block devices to be used by the container.')
volume_mounts
class-attribute
instance-attribute
volume_mounts = Field(default=None, alias='volumeMounts', description="Pod volumes to mount into the container's filesystem. Cannot be updated.")
working_dir
class-attribute
instance-attribute
working_dir = Field(default=None, alias='workingDir', description="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.")
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
build
Builds the Hera auto-generated model of the user container.
Source code in src/hera/workflows/user_container.py
Volume
Volume represents a basic, dynamic, volume representation.
This Volume
cannot only be instantiated to be used for mounting purposes but also for dynamically privisioning
volumes in K8s. When the volume is used a corresponding persistent volume claim is also created on workflow
submission.
Source code in src/hera/workflows/volume.py
503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 |
|
data_source
class-attribute
instance-attribute
data_source = Field(default=None, alias='dataSource', description='This field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. If the AnyVolumeDataSource feature gate is enabled, this field will always have the same contents as the DataSourceRef field.')
data_source_ref
class-attribute
instance-attribute
data_source_ref = Field(default=None, alias='dataSourceRef', description='Specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any local object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the DataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, both fields (DataSource and DataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. There are two important differences between DataSource and DataSourceRef: * While DataSource only allows two specific types of objects, DataSourceRef\n allows any non-core object, as well as PersistentVolumeClaim objects.\n* While DataSource ignores disallowed values (dropping them), DataSourceRef\n preserves all values, and generates an error if a disallowed value is\n specified.\n(Alpha) Using this field requires the AnyVolumeDataSource feature gate to be enabled.')
mount_propagation
class-attribute
instance-attribute
mount_propagation = Field(default=None, alias='mountPropagation', description='mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10.')
read_only
class-attribute
instance-attribute
read_only = Field(default=None, alias='readOnly', description='Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.')
selector
class-attribute
instance-attribute
sub_path
class-attribute
instance-attribute
sub_path = Field(default=None, alias='subPath', description='Path within the volume from which the container\'s volume should be mounted. Defaults to "" (volume\'s root).')
sub_path_expr
class-attribute
instance-attribute
sub_path_expr = Field(default=None, alias='subPathExpr', description='Expanded path within the volume from which the container\'s volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container\'s environment. Defaults to "" (volume\'s root). SubPathExpr and SubPath are mutually exclusive.')
volume_mode
class-attribute
instance-attribute
volume_mode = Field(default=None, alias='volumeMode', description='volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec.')
volume_name
class-attribute
instance-attribute
volume_name = Field(default=None, alias='volumeName', description='VolumeName is the binding reference to the PersistentVolume backing this claim.')
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
VsphereVirtualDiskVolume
VsphereVirtualDiskVolume
represents a vSphere virtual disk volume to mount.
Source code in src/hera/workflows/volume.py
fs_type
class-attribute
instance-attribute
fs_type = Field(default=None, alias='fsType', description='Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.')
mount_propagation
class-attribute
instance-attribute
mount_propagation = Field(default=None, alias='mountPropagation', description='mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10.')
read_only
class-attribute
instance-attribute
read_only = Field(default=None, alias='readOnly', description='Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.')
storage_policy_id
class-attribute
instance-attribute
storage_policy_id = Field(default=None, alias='storagePolicyID', description='Storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName.')
storage_policy_name
class-attribute
instance-attribute
storage_policy_name = Field(default=None, alias='storagePolicyName', description='Storage Policy Based Management (SPBM) profile name.')
sub_path
class-attribute
instance-attribute
sub_path = Field(default=None, alias='subPath', description='Path within the volume from which the container\'s volume should be mounted. Defaults to "" (volume\'s root).')
sub_path_expr
class-attribute
instance-attribute
sub_path_expr = Field(default=None, alias='subPathExpr', description='Expanded path within the volume from which the container\'s volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container\'s environment. Defaults to "" (volume\'s root). SubPathExpr and SubPath are mutually exclusive.')
volume_path
class-attribute
instance-attribute
volume_path = Field(..., alias='volumePath', description='Path that identifies vSphere volume vmdk')
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
Workflow
The base Workflow class for Hera.
Workflow implements the contextmanager interface so allows usage of with
, under which
any hera.workflows.protocol.Templatable
object instantiated under the context will be
added to the Workflow’s list of templates.
Workflows can be created directly on your Argo cluster via create
. They can also be dumped
to yaml via to_yaml
or built according to the Argo schema via build
to get an OpenAPI model
object.
Source code in src/hera/workflows/workflow.py
96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 |
|
automount_service_account_token
class-attribute
instance-attribute
deletion_grace_period_seconds
class-attribute
instance-attribute
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
ModelMapper
Source code in src/hera/workflows/_mixins.py
build_model
classmethod
Source code in src/hera/workflows/_mixins.py
build
Builds the Workflow and its components into an Argo schema Workflow object.
Source code in src/hera/workflows/workflow.py
create
Creates the Workflow on the Argo cluster.
Parameters
wait: bool = False If false then the workflow is created asynchronously and the function returns immediately. If true then the workflow is created and the function blocks until the workflow is done executing. poll_interval: int = 5 The interval in seconds to poll the workflow status if wait is true. Ignored when wait is true.
Source code in src/hera/workflows/workflow.py
from_dict
classmethod
Create a Workflow from a Workflow contained in a dict.
Examples:
>>> my_workflow = Workflow(name="my-workflow")
>>> my_workflow == Workflow.from_dict(my_workflow.to_dict())
True
Source code in src/hera/workflows/workflow.py
from_file
classmethod
Create a Workflow from a Workflow contained in a YAML file.
Examples:
Source code in src/hera/workflows/workflow.py
from_yaml
classmethod
Create a Workflow from a Workflow contained in a YAML string.
Examples:
Source code in src/hera/workflows/workflow.py
get_parameter
Attempts to find and return a Parameter
of the specified name.
Source code in src/hera/workflows/workflow.py
get_workflow_link
Returns the workflow link for the workflow.
Source code in src/hera/workflows/workflow.py
lint
Lints the Workflow using the Argo cluster.
Source code in src/hera/workflows/workflow.py
to_dict
Builds the Workflow as an Argo schema Workflow object and returns it as a dictionary.
to_file
Writes the Workflow as an Argo schema Workflow object to a YAML file and returns the path to the file.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
output_directory |
Union[Path, str]
|
The directory to write the file to. Defaults to the current working directory. |
'.'
|
name |
str
|
The name of the file to write without the file extension. Defaults to the Workflow’s name or a generated name. |
''
|
*args |
Additional arguments to pass to |
()
|
|
**kwargs |
Additional keyword arguments to pass to |
{}
|
Source code in src/hera/workflows/workflow.py
to_yaml
Builds the Workflow as an Argo schema Workflow object and returns it as yaml string.
Source code in src/hera/workflows/workflow.py
wait
Waits for the Workflow to complete execution.
Parameters
poll_interval: int = 5 The interval in seconds to poll the workflow status.
Source code in src/hera/workflows/workflow.py
WorkflowStatus
Placeholder for workflow statuses.
Source code in src/hera/workflows/workflow_status.py
from_argo_status
classmethod
Turns an Argo status into a Hera workflow status representation.
Source code in src/hera/workflows/workflow_status.py
WorkflowTemplate
WorkflowTemplates are definitions of Workflows that live in your namespace in your cluster.
This allows you to create a library of frequently-used templates and reuse them by referencing them from your Workflows.
Source code in src/hera/workflows/workflow_template.py
38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 |
|
automount_service_account_token
class-attribute
instance-attribute
deletion_grace_period_seconds
class-attribute
instance-attribute
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
ModelMapper
Source code in src/hera/workflows/_mixins.py
build_model
classmethod
Source code in src/hera/workflows/_mixins.py
build
Builds the WorkflowTemplate and its components into an Argo schema WorkflowTemplate object.
Source code in src/hera/workflows/workflow_template.py
create
Creates the WorkflowTemplate on the Argo cluster.
Source code in src/hera/workflows/workflow_template.py
create_as_workflow
Run this WorkflowTemplate instantly as a Workflow.
If generate_name is given, the workflow created uses generate_name as a prefix, as per the usual for hera.workflows.Workflow.generate_name. If not given, the WorkflowTemplate’s name will be used, truncated to 57 chars and appended with a hyphen.
Note: this function does not require the WorkflowTemplate to already exist on the cluster
Source code in src/hera/workflows/workflow_template.py
from_dict
classmethod
Create a WorkflowTemplate from a WorkflowTemplate contained in a dict.
Examples:
>>> my_workflow_template = WorkflowTemplate(name="my-wft")
>>> my_workflow_template == WorkflowTemplate.from_dict(my_workflow_template.to_dict())
True
Source code in src/hera/workflows/workflow_template.py
from_file
classmethod
Create a WorkflowTemplate from a WorkflowTemplate contained in a YAML file.
Examples:
Source code in src/hera/workflows/workflow_template.py
from_yaml
classmethod
Create a WorkflowTemplate from a WorkflowTemplate contained in a YAML string.
Examples:
Source code in src/hera/workflows/workflow_template.py
get
Attempts to get a workflow template based on the parameters of this template e.g. name + namespace.
Source code in src/hera/workflows/workflow_template.py
get_parameter
Attempts to find and return a Parameter
of the specified name.
Source code in src/hera/workflows/workflow.py
get_workflow_link
Returns the workflow link for the workflow.
Source code in src/hera/workflows/workflow.py
lint
Lints the WorkflowTemplate using the Argo cluster.
Source code in src/hera/workflows/workflow_template.py
to_dict
Builds the Workflow as an Argo schema Workflow object and returns it as a dictionary.
to_file
Writes the Workflow as an Argo schema Workflow object to a YAML file and returns the path to the file.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
output_directory |
Union[Path, str]
|
The directory to write the file to. Defaults to the current working directory. |
'.'
|
name |
str
|
The name of the file to write without the file extension. Defaults to the Workflow’s name or a generated name. |
''
|
*args |
Additional arguments to pass to |
()
|
|
**kwargs |
Additional keyword arguments to pass to |
{}
|
Source code in src/hera/workflows/workflow.py
to_yaml
Builds the Workflow as an Argo schema Workflow object and returns it as yaml string.
Source code in src/hera/workflows/workflow.py
update
Attempts to perform a template update based on the parameters of this template.
This creates the template if it does not exist. In addition, this performs
a get prior to updating to get the resource version to update in the first place. If you know the template
does not exist ahead of time, it is more efficient to use create()
directly to avoid one round trip.
Source code in src/hera/workflows/workflow_template.py
wait
Waits for the Workflow to complete execution.
Parameters
poll_interval: int = 5 The interval in seconds to poll the workflow status.
Source code in src/hera/workflows/workflow.py
WorkflowsService
The core workflows service for interacting with the Argo server.
Source code in src/hera/workflows/service.py
62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 |
|
verify_ssl
instance-attribute
create_cluster_workflow_template
API documentation.
Source code in src/hera/workflows/service.py
create_cron_workflow
API documentation.
Source code in src/hera/workflows/service.py
create_workflow
API documentation.
Source code in src/hera/workflows/service.py
create_workflow_template
API documentation.
Source code in src/hera/workflows/service.py
delete_archived_workflow
API documentation.
Source code in src/hera/workflows/service.py
delete_cluster_workflow_template
delete_cluster_workflow_template(name, grace_period_seconds=None, uid=None, resource_version=None, orphan_dependents=None, propagation_policy=None, dry_run=None)
API documentation.
Source code in src/hera/workflows/service.py
delete_cron_workflow
delete_cron_workflow(name, namespace=None, grace_period_seconds=None, uid=None, resource_version=None, orphan_dependents=None, propagation_policy=None, dry_run=None)
API documentation.
Source code in src/hera/workflows/service.py
delete_workflow
delete_workflow(name, namespace=None, grace_period_seconds=None, uid=None, resource_version=None, orphan_dependents=None, propagation_policy=None, dry_run=None, force=None)
API documentation.
Source code in src/hera/workflows/service.py
delete_workflow_template
delete_workflow_template(name, namespace=None, grace_period_seconds=None, uid=None, resource_version=None, orphan_dependents=None, propagation_policy=None, dry_run=None)
API documentation.
Source code in src/hera/workflows/service.py
get_archived_workflow
API documentation.
Source code in src/hera/workflows/service.py
get_artifact_file
get_artifact_file(id_discriminator, id_, node_id, artifact_name, artifact_discriminator, namespace=None)
Get an artifact.
Source code in src/hera/workflows/service.py
get_cluster_workflow_template
API documentation.
Source code in src/hera/workflows/service.py
get_cron_workflow
API documentation.
Source code in src/hera/workflows/service.py
get_cron_workflow_link
get_info
API documentation.
Source code in src/hera/workflows/service.py
get_input_artifact
Get an input artifact.
Source code in src/hera/workflows/service.py
get_input_artifact_by_uid
Get an input artifact by UID.
Source code in src/hera/workflows/service.py
get_output_artifact
Get an output artifact.
Source code in src/hera/workflows/service.py
get_output_artifact_by_uid
Get an output artifact by UID.
Source code in src/hera/workflows/service.py
get_user_info
API documentation.
Source code in src/hera/workflows/service.py
get_version
API documentation.
Source code in src/hera/workflows/service.py
get_workflow
API documentation.
Source code in src/hera/workflows/service.py
get_workflow_link
Returns the workflow link for the given workflow name.
get_workflow_template
API documentation.
Source code in src/hera/workflows/service.py
lint_cluster_workflow_template
API documentation.
Source code in src/hera/workflows/service.py
lint_cron_workflow
API documentation.
Source code in src/hera/workflows/service.py
lint_workflow
API documentation.
Source code in src/hera/workflows/service.py
lint_workflow_template
API documentation.
Source code in src/hera/workflows/service.py
list_archived_workflow_label_keys
API documentation.
Source code in src/hera/workflows/service.py
list_archived_workflow_label_values
list_archived_workflow_label_values(label_selector=None, field_selector=None, watch=None, allow_watch_bookmarks=None, resource_version=None, resource_version_match=None, timeout_seconds=None, limit=None, continue_=None)
API documentation.
Source code in src/hera/workflows/service.py
list_archived_workflows
list_archived_workflows(label_selector=None, field_selector=None, watch=None, allow_watch_bookmarks=None, resource_version=None, resource_version_match=None, timeout_seconds=None, limit=None, continue_=None, name_prefix=None)
API documentation.
Source code in src/hera/workflows/service.py
list_cluster_workflow_templates
list_cluster_workflow_templates(label_selector=None, field_selector=None, watch=None, allow_watch_bookmarks=None, resource_version=None, resource_version_match=None, timeout_seconds=None, limit=None, continue_=None)
API documentation.
Source code in src/hera/workflows/service.py
list_cron_workflows
list_cron_workflows(namespace=None, label_selector=None, field_selector=None, watch=None, allow_watch_bookmarks=None, resource_version=None, resource_version_match=None, timeout_seconds=None, limit=None, continue_=None)
API documentation.
Source code in src/hera/workflows/service.py
list_workflow_templates
list_workflow_templates(namespace=None, label_selector=None, field_selector=None, watch=None, allow_watch_bookmarks=None, resource_version=None, resource_version_match=None, timeout_seconds=None, limit=None, continue_=None)
API documentation.
Source code in src/hera/workflows/service.py
list_workflows
list_workflows(namespace=None, label_selector=None, field_selector=None, watch=None, allow_watch_bookmarks=None, resource_version=None, resource_version_match=None, timeout_seconds=None, limit=None, continue_=None, fields=None)
API documentation.
Source code in src/hera/workflows/service.py
pod_logs
pod_logs(name, pod_name, namespace=None, container=None, follow=None, previous=None, since_seconds=None, seconds=None, nanos=None, timestamps=None, tail_lines=None, limit_bytes=None, insecure_skip_tls_verify_backend=None, grep=None, selector=None)
DEPRECATED: Cannot work via HTTP if podName is an empty string. Use WorkflowLogs.
Source code in src/hera/workflows/service.py
resubmit_archived_workflow
API documentation.
Source code in src/hera/workflows/service.py
resubmit_workflow
API documentation.
Source code in src/hera/workflows/service.py
resume_cron_workflow
API documentation.
Source code in src/hera/workflows/service.py
resume_workflow
API documentation.
Source code in src/hera/workflows/service.py
retry_archived_workflow
API documentation.
Source code in src/hera/workflows/service.py
retry_workflow
API documentation.
Source code in src/hera/workflows/service.py
set_workflow
API documentation.
Source code in src/hera/workflows/service.py
stop_workflow
API documentation.
Source code in src/hera/workflows/service.py
submit_workflow
API documentation.
Source code in src/hera/workflows/service.py
suspend_cron_workflow
API documentation.
Source code in src/hera/workflows/service.py
suspend_workflow
API documentation.
Source code in src/hera/workflows/service.py
terminate_workflow
API documentation.
Source code in src/hera/workflows/service.py
update_cluster_workflow_template
API documentation.
Source code in src/hera/workflows/service.py
update_cron_workflow
API documentation.
Source code in src/hera/workflows/service.py
update_workflow_template
API documentation.
Source code in src/hera/workflows/service.py
workflow_logs
workflow_logs(name, namespace=None, pod_name=None, container=None, follow=None, previous=None, since_seconds=None, seconds=None, nanos=None, timestamps=None, tail_lines=None, limit_bytes=None, insecure_skip_tls_verify_backend=None, grep=None, selector=None)
API documentation.
Source code in src/hera/workflows/service.py
ZipArchiveStrategy
ZipArchiveStrategy
indicates artifacts should be serialized using the zip
strategy.
Source code in src/hera/workflows/archive.py
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.