Skip to content

New Container Decorator

This example shows the use of the container decorator and special Input/Output classes.

 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
from typing_extensions import Annotated

from hera.shared import global_config
from hera.workflows import Input, Output, Parameter, Workflow

global_config.experimental_features["decorator_syntax"] = True


# We start by defining our Workflow
w = Workflow(generate_name="container-workflow-")


# This defines the template's inputs
class MyInput(Input):
    user: str = "Hera"


# This defines the template's outputs
class MyOutput(Output):
    container_greeting: Annotated[
        str,
        Parameter(
            name="container-greeting",
            value_from={"path": "/tmp/hello_world.txt"},
        ),
    ]


# We then use the decorators of the `Workflow` object
# to set the entrypoint and create a Container template
@w.set_entrypoint
@w.container(
    image="busybox",
    command=["sh", "-c"],
    args=["echo Hello {{inputs.parameters.user}} | tee /tmp/hello_world.txt"],
)
def basic_hello_world(my_input: MyInput) -> MyOutput: ...

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
apiVersion: argoproj.io/v1alpha1
kind: Workflow
metadata:
  generateName: container-workflow-
spec:
  entrypoint: basic-hello-world
  templates:
  - name: basic-hello-world
    container:
      image: busybox
      args:
      - echo Hello {{inputs.parameters.user}} | tee /tmp/hello_world.txt
      command:
      - sh
      - -c
    inputs:
      parameters:
      - name: user
        default: Hera
    outputs:
      parameters:
      - name: container-greeting
        valueFrom:
          path: /tmp/hello_world.txt

Comments