StackStorm / StackStorm/st2

Add a timeout parameter to the Orquesta runner

Open
#5,116 1 comment 8 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

feature workflows: orquesta
Dominant language
Python
Stars
6.5k
Forks
787
PR merge metrics
No merged PRs in 30d

Description

Almost all action runners have a timeout parameter (see the fancy table here), but there is no timeout parameter for Orquesta.

This means that there is no way to set a time limit a subworkflow if something goes wrong.

It would be nice to allow users to specify this parameter as a fail safe in case the Orquesta engine hangs, for example. It would also be more consistent with our other action runners:

tasks:
  do_thing:
    action: mypack.myworkflow  # Orquesta workflow, may take awhile to finish, and/or hang
    input:
      timeout: 60  # seconds

This has been requested by multiple people in the StackStorm Forum.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The issue names the Orquesta runner and engine, and points to the action-runners quick-reference table for existing timeout behavior. Start by tracing how the YAML action input reaches the Orquesta runner and compare it with other runners' timeout handling. Done means users can set a timeout in the shown workflow input and a hung or over-limit subworkflow fails safely.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
backend, devops
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.