utils/schedule.py:handle_func() - Fix for accessing returner configur… #33912
Conversation
…ation attributes 'return_config' and 'return_kwargs'. They are specified as 'return_config' and 'return_kwargs' in the documentation, and those are the member names used elsewhere in the code base. However, this code previously referenced 'returner_kwargs' and 'returner_config', so returners from scheduled jobs were not appropriately called in situations in which configuration parameters to override default minion config needed to be provided to the schedule module. Resolves issue saltstack#33868 (saltstack#33868).
|
Thanks, @abalashov @garethgreenaway is this something that you'd like to take a look at? |
cachedout
added
the
Pending-Discussion
|
@cachedout @abalashov Fix looks right to me. Would be good to include that item in the documentation for the schedule execution module as well. |
|
The documentation is already correct on this point; the code just didn't line up with it. That said, the schedule execution module has literally no documentation for the parameters that can be passed into -- Alex Principal, Evariste Systems LLC (www.evaristesys.com) Sent from my Google Nexus. |
|
I would be happy to try to tackle this on my own, but don't know how the docs are generated or where to make the appropriate modifications. I get the impression it's all in YAML blocks at the top of the source files. Are there any guides for this? Sorry for the newbie question. |
|
Hi @abalashov . Function docs are pulled out of function doc strings but more in-depth documentation is all here: https://github.com/saltstack/salt/tree/develop/doc I'm going to merge this for now but a follow-up PR with additional docs would be very welcome! |
What does this PR do?
Fixes incorrect data member names accessed for returner configuration in the schedule module.
What issues does this PR fix or reference?
Issue #33868.
Previous Behavior
Remove this section if not relevant
New Behavior
See #33868.
Tests written?
No.
…ation attributes 'return_config' and 'return_kwargs'.
They are specified as 'return_config' and 'return_kwargs' in the documentation, and those are the member names used elsewhere in the code base. However, this code previously referenced 'returner_kwargs' and 'returner_config', so returners from scheduled jobs were not appropriately called in situations in which configuration parameters to override default minion config needed to be provided to the schedule module.
Resolves issue #33868 (#33868).