SaltStack Support

Using Timeouts in Orchestration and States

To demonstrate the timeout and retry functionality, the following examples can be applied:

The orchestration state file orch.longtest.sls will allow a Salt Minion ID to be passed in as Salt Pillar data to determine the target for the Salt State execution.  If the pillar data is not provided or is Null, then the default value of testing will be used as the targeting parameter. 

# orch.longtest.sls
#
# The orchestration will wait up to 15 minutes before timing out
deploy-temporary-bbcpu:
  salt.state:
    - tgt: {{ pillar.get('minion', 'testing') }}
    - sls: randomlongtest
    - timeout: 900
The following example state file randomlongtest.slswill demonstrate the timeout and retry options provided by the Salt State system. 
# randomlongtest.sls
#
# pycheck.py calls randint to sleep for a random amount of time 
# before returning True

copy_script:
  file.managed:
    - name: /root/pycheck.py
    - source: salt://general/files/pycheck.py
    
run_a_random_long_test:
  cmd.run:
    - name: "python /root/pycheck.py"
    - timeout: 10
    - retry:
        interval: 3
        attempts: 50
    - require: 
      - file: copy_script
With the combination of Salt Orchestration executing a Salt State as shown above, a random long test execution with the timeout options set directly will demonstrate the extra functionality provided by the Salt State system.  In the above example, the minion will re-attempt to execute the State up to 50 times with a 3 second pause in between attempts. Each call of the State will have 10 seconds before timing out. The Orchestration State will continue to check every 5 seconds (configurable in the Master configuration) on the status of the job using the saltutil.find_job function. As long as the Minion returns the status of the job as active, the orchestration should wait indefinitely.

Related articles