Skip to content

New Suspend Decorator

This example shows the use of the suspend 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
38
39
40
41
from typing_extensions import Annotated

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

global_config.experimental_features["decorator_syntax"] = True


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


# This defines the template's inputs
class MyInput(Input):
    approve: Annotated[
        str,
        Parameter(
            description="Choose YES to continue workflow and deploy to production",
            enum=["YES", "NO"],
        ),
    ] = "NO"


class MyOutput(Output):
    approve: Annotated[
        str,
        Parameter(
            name="approve",
            value_from=ValueFrom(
                supplied=SuppliedValueFrom(),
            ),
        ),
    ]


# We then use the decorators of the `Workflow` object
# to set the entrypoint and create a Suspend template
@w.set_entrypoint
@w.suspend_template()
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
apiVersion: argoproj.io/v1alpha1
kind: Workflow
metadata:
  generateName: suspend-workflow-
spec:
  entrypoint: basic-hello-world
  templates:
  - name: basic-hello-world
    inputs:
      parameters:
      - name: approve
        default: 'NO'
        description: Choose YES to continue workflow and deploy to production
        enum:
        - 'YES'
        - 'NO'
    outputs:
      parameters:
      - name: approve
        valueFrom:
          supplied: {}
    suspend: {}

Comments