Add state_events option for state module functions #63316
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
re-run pr-macosx-catalina-x86_64-py3-pytest |
nicholasmhughes
previously approved these changes
Dec 14, 2022
MacOS test failures are a known failure right now due to a licensing issue that we're in the process of resolving. |
barneysowood
force-pushed
the
state-events-option
branch
from
3f2a232
to
d930980
Compare
|
@nicholasmhughes and @whytewolf - I've added docs and a changelog entry for this - if you could review when you get a moment, that would be great. |
nicholasmhughes
suggested changes
Jan 31, 2023
tests/pytests/integration/modules/state/test_state_state_events.py
Outdated
Show resolved
Hide resolved
whytewolf
previously approved these changes
Jan 31, 2023
Adds a state_events option to state.highstate, state.apply, state.sls, state.sls_id to enable state events whilst applying states. Removes the need to set state_events globally in the master config, without requiring adding fire_event to every state.
Updates the state_events opts handling to be consistent with how other opts are processed in state.py
Adds additional documentation on the state_events option to the Salt Master Events doc
Adds documentation on the fire_events state option to the Salt Master Events doc for completeness.
barneysowood
force-pushed
the
state-events-option
branch
from
097cf10
to
018c216
Compare
nicholasmhughes
approved these changes
Feb 2, 2023
whytewolf
approved these changes
Feb 2, 2023
Ch3LL
approved these changes
Feb 2, 2023
garethgreenaway
approved these changes
Feb 3, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What does this PR do?
Adds a state_events option to state.highstate, state.apply, state.sls, state.sls_id to enable state events whilst applying states.
Removes the need to set state_events globally in the master config, without requiring adding fire_event to every state.
The ability to send state events is really useful but under-utilised. I suspect this is because you either have to enable it globally in the master config
This is a pre-requisite to some work I'm doing to improve feedback in the salt cli command
Previous Behavior
State events could only be enabled globally in the master config
New Behavior
State events can be enabled on a per highstate or state.apply basis.
Merge requirements satisfied?
Commits signed with GPG?
No