Skip to content

Script Annotations Artifact Custom Volume

This example will reuse the outputs volume across script steps.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
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
from typing import Annotated

from hera.workflows import (
    Artifact,
    EmptyDirVolume,
    Parameter,
    RunnerScriptConstructor,
    Steps,
    Workflow,
    models as m,
    script,
)
from hera.workflows.artifact import ArtifactLoader
from hera.workflows.volume import Volume


@script(
    constructor=RunnerScriptConstructor(
        outputs_directory="/mnt/empty/dir",
        volume_for_outputs=EmptyDirVolume(name="my-empty-dir"),
    ),
)
def output_artifact_empty_dir(
    a_number: Annotated[int, Parameter(name="a_number")],
) -> Annotated[int, Artifact(name="successor_out")]:
    return a_number + 1


@script(
    constructor=RunnerScriptConstructor(),  # Has no outputs
)
def use_artifact(
    successor_in: Annotated[
        int,
        Artifact(name="successor_in", loader=ArtifactLoader.json),
    ],
):
    print(successor_in)


@script(
    constructor=RunnerScriptConstructor(outputs_directory="/mnt/here"),
    volume_mounts=[
        m.VolumeMount(name="my-vol", mount_path="/mnt/here")
    ],  # Mounting volume created outside of this script
)
def output_artifact_existing_vol(
    a_number: Annotated[int, Parameter(name="a_number")],
) -> Annotated[int, Artifact(name="successor_out")]:
    return a_number + 1


@script(
    constructor=RunnerScriptConstructor(),  # no outputs
    volume_mounts=[
        m.VolumeMount(name="my-vol", mount_path="/mnt/here")
    ],  # Mounting volume created outside of this script
)
def use_artifact_existing_vol(
    successor_in: Annotated[
        int, Artifact(name="successor_in", path="/mnt/here/artifacts/successor_out", loader=ArtifactLoader.json)
    ],
):
    print(successor_in)


with Workflow(
    generate_name="test-output-annotations-",
    entrypoint="my-steps",
    volumes=[Volume(name="my-vol", size="1Gi")],
) as w:
    with Steps(name="my-steps") as s:
        out_to_empty_dir = output_artifact_empty_dir(arguments={"a_number": 3})
        use_artifact(arguments=[out_to_empty_dir.get_artifact("successor_out").with_name("successor_in")])

        out_to_my_vol = output_artifact_existing_vol(arguments={"a_number": 3})
        use_artifact_existing_vol()

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 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
120
121
122
apiVersion: argoproj.io/v1alpha1
kind: Workflow
metadata:
  generateName: test-output-annotations-
spec:
  entrypoint: my-steps
  templates:
  - name: my-steps
    steps:
    - - name: output-artifact-empty-dir
        template: output-artifact-empty-dir
        arguments:
          parameters:
          - name: a_number
            value: '3'
    - - name: use-artifact
        template: use-artifact
        arguments:
          artifacts:
          - name: successor_in
            from: '{{steps.output-artifact-empty-dir.outputs.artifacts.successor_out}}'
    - - name: output-artifact-existing-vol
        template: output-artifact-existing-vol
        arguments:
          parameters:
          - name: a_number
            value: '3'
    - - name: use-artifact-existing-vol
        template: use-artifact-existing-vol
  - name: output-artifact-empty-dir
    volumes:
    - name: my-empty-dir
      emptyDir: {}
    inputs:
      parameters:
      - name: a_number
    outputs:
      artifacts:
      - name: successor_out
        path: /mnt/empty/dir/artifacts/successor_out
    script:
      image: python:3.9
      source: '{{inputs.parameters}}'
      args:
      - -m
      - hera.workflows.runner
      - -e
      - examples.workflows.scripts.script_annotations_artifact_custom_volume:output_artifact_empty_dir
      command:
      - python
      env:
      - name: hera__outputs_directory
        value: /mnt/empty/dir
      volumeMounts:
      - name: my-empty-dir
        mountPath: /mnt/empty/dir
  - name: use-artifact
    inputs:
      artifacts:
      - name: successor_in
        path: /tmp/hera-inputs/artifacts/successor_in
    script:
      image: python:3.9
      source: '{{inputs.parameters}}'
      args:
      - -m
      - hera.workflows.runner
      - -e
      - examples.workflows.scripts.script_annotations_artifact_custom_volume:use_artifact
      command:
      - python
  - name: output-artifact-existing-vol
    inputs:
      parameters:
      - name: a_number
    outputs:
      artifacts:
      - name: successor_out
        path: /mnt/here/artifacts/successor_out
    script:
      image: python:3.9
      source: '{{inputs.parameters}}'
      args:
      - -m
      - hera.workflows.runner
      - -e
      - examples.workflows.scripts.script_annotations_artifact_custom_volume:output_artifact_existing_vol
      command:
      - python
      env:
      - name: hera__outputs_directory
        value: /mnt/here
      volumeMounts:
      - name: my-vol
        mountPath: /mnt/here
  - name: use-artifact-existing-vol
    inputs:
      artifacts:
      - name: successor_in
        path: /mnt/here/artifacts/successor_out
    script:
      image: python:3.9
      source: '{{inputs.parameters}}'
      args:
      - -m
      - hera.workflows.runner
      - -e
      - examples.workflows.scripts.script_annotations_artifact_custom_volume:use_artifact_existing_vol
      command:
      - python
      volumeMounts:
      - name: my-vol
        mountPath: /mnt/here
  volumeClaimTemplates:
  - metadata:
      name: my-vol
    spec:
      accessModes:
      - ReadWriteOnce
      resources:
        requests:
          storage: 1Gi

Comments