Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[3006.x][DOC] add note for reactor state id uniquness. #64181

Merged
merged 3 commits into from
Apr 27, 2023
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions changelog/63589.fixed.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
add documentation note about reactor state ids.
8 changes: 8 additions & 0 deletions doc/topics/reactor/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -212,6 +212,10 @@ in :ref:`local reactions <reactor-local>`, but as noted above this is not very
user-friendly. Therefore, the new config schema is recommended if the master
is running a supported release.

.. note::
State ids of reactors for runners and wheels should all be unique.Tthey can
twangboy marked this conversation as resolved.
Show resolved Hide resolved
overwrite each other when added to the async queue causing lost reactions
twangboy marked this conversation as resolved.
Show resolved Hide resolved

The below two examples are equivalent:

+-------------------------------------------------+-------------------------------------------------+
Expand Down Expand Up @@ -248,6 +252,10 @@ Like :ref:`runner reactions <reactor-runner>`, the old config schema called for
wheel reactions to have arguments passed directly under the name of the
:ref:`wheel function <all-salt.wheel>` (or in ``arg`` or ``kwarg`` parameters).

.. note::
State ids of reactors for runners and wheels should all be unique. They can
overwrite each other when added to the async queue causing lost reactions
twangboy marked this conversation as resolved.
Show resolved Hide resolved

The below two examples are equivalent:

+-----------------------------------+---------------------------------+
Expand Down