A quick introduction to Salt timeouts
Salt features two timeout parameters called
gather_job_timeout that are relevant during the execution of Salt commands and jobs--it does not matter whether they are triggered using CLI or API. These two parameters are explained in the following article.
This is a normal workflow when all minions are well reachable:
- A salt command or job is executed:
salt '*' test.ping
- Salt master publishes the job with the targeted minions into the Salt PUB channel.
- Minions take that job and start working on it.
- Salt master is looking at the Salt RET channel to gather responses from the minions.
- If Salt master gets all responses from targeted minions, then everything is completed and Salt master will return a response containing all the minion responses.
If some of the minions are down during this process, the workflow continues as follows:
timeoutis reached before getting all expected responses from the minions, then Salt master would trigger another job (a Salt
find_jobjob) targeting only pending minions to check whether the job is already running on the minion.
gather_job_timeoutis evaluated. A new counter is now triggered.
- If this new
find_jobjob responses that the original job is actually running on the minion, then Salt master will wait for that minion's response.
- In case of reaching
gather_job_timeoutwithout having any response from the minion (neither for the initial
test.pingnor for the
find_jobjob), Salt master will return with only the gathered responses from the responding minions.
By default, SUMA globally sets
gather_job_timeout to 120 seconds. So, in the worst case, a Salt call targeting unreachable minions will end up with 240 seconds of waiting until getting a response.
Synchronous calls with unreachable Salt minions: a presence ping mechanism
In order to prevent waiting until timeouts are reached when some minions are down, SUSE introduced a so-called "presence mechanism" for Salt minions.
On SUMA 3.0.5 and later, this presence mechanism checks for unreachable Salt minions when SUMA is performing synchronous calls to these minions, and it excludes unreachable minions from that call. Synchronous calls are going to be displaced in favor of asynchronous calls but currently still being used during some workflows.
The newly introduced presence mechanism triggers a Salt
test.ping with a custom and fixed short Salt timeout values. Default Salt values for the presence ping are:
timeout = 4 and
gather_job_timeout = 1. This way, we can quickly detect which targeted minions are unreachable, and then exclude them from the synchronous call.
Overriding Salt presence timeouts values (/etc/rhn/rhn.conf)
SUMA administrators are able to increase or decrease defaults presence ping timeouts values by uncommenting and setting the desire value for `salt_presence_ping_timeout` and `salt_presence_ping_gather_job_timeout` options in `/etc/rhn/rhn.conf`:
# SUSE Manager presence timeouts for Salt minions # salt_presence_ping_timeout = 4 # salt_presence_ping_gather_job_timeout = 1
Salt SSH Minions (SSH Push)
Salt SSH minions are slightly different that regular minions (zeromq). In this case, they don't use Salt PUB/RET channels but a wrapper salt command inside an ssh call. Salt
gather_job_timeout are not playing a role here.
SUMA defines a timeout for SSH connection in /etc/rhn/rhn.conf:
# salt_ssh_connect_timeout = 180
The presence ping mechanism is also working with SSH minions. In this case, SUMA will use
salt_presence_ping_timeout to override the default timeout value for SSH connections.