Message Busses Unclear; more docs needed
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 15.7k
- Forks
- 5.6k
- Avg merge
- 2d 44m
- Merged PRs (30d)
- 80
Description
As a Salt user getting into deeper module writing, I've found the various message busses to be very confusing.
When an event is published, it can go (as far as I know):
- A minion bus (each minion has one local to it)
- The master bus (picked up by salt-api, the
state.eventrunner, and other places?) - The "publisher" (what's actually sent to minions?)
I have little idea about how these busses interact, or how they interact with more complex configurations (syndics? Round-robin masters?)
It was also entirely unclear when I got started on these deeper topics that these various busses even existed.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the event paths named in the issue—the minion bus, master bus, publisher, salt-api, and state.event—and trace how syndics and round-robin masters affect them. Document their relationships and configuration-specific behavior so module writers can understand where events are sent and how the busses interact.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100