Open Hour 2022-MAR-17

March 17, 2022 - Alyssa Rock

Agenda

  • General updates and announcements
  • Documentation updates
  • Salty 5
  • Q&A plus discussion

Open Hour YouTube playlist | Contact us! saltproject@vmware.com

General updates and announcements

  • Open Hours are held every 1st and 3rd Thursday from 10a.m. to 11a.m. Pacific.
  • Our next Salt Community Open Hour will be April 7th.
  • We want you for the Salty 5!

Events

Documentation updates

  • If you follow the Salt Docs Product Roadmap, you’ll notice that Alyssa recently changed which documentation epic is her current focus. She was working on the module documentation standards project, but she needs to pivot and work on overhauling the Salt installation guide in order to support the upcoming Phosphorus (3005) release. She’ll also work on improving our supported platforms page as part of this project. She’ll resume work on the module documentation standards after the Phosphorus release.
  • The Salt Docs working group is making some great progress on the Salt User Guide:
    • We have some new content that is being added by Thomas Phipps that should help provide some more foundational knowledge about Salt.
    • We have two community members working on ensuring the Salt User Guide follows our style guide. One is working on cleaning up the existing content and another is focused on style guide enforcement through tooling and automation using Vale.
    • Come join us and use this time to work on docs improvements!
  • Alyssa has also been working on making improvements to our Code of Conduct. We’re working to make it more specific to Salt, a little more positive in its approach, and we’ll work on building out a more clear and detailed Code of Conduct response system.

Salty 5

  • Wayne Werner will demonstrate his troubleshooting techniques for working in Salt. For the best experience, watch the video of the Open Hour to see Wayne’s demo.
  • Of course, you can always start by Googling the error.
  • Wayne’s debugging method is to look at the message and start by trying to figure out if it’s one of three things:
    • Is it a Python error? If so, start looking for Python solutions.
    • Is it a Salt error? If so, go to a clone of Salt and search for the text of that error message, limiting it to the salt directory. That can help you know what conditions trigger that specific error message.
    • Is it a user error? One common user error occurs when mixing data types and feeding in a data structure that Salt doesn’t expect.
  • Then, you just gradually narrow it down from there. On average, you can expect debugging to take 10-30 minutes. Sometimes it’s a genuine Salt bug, in which case you should open an issue.

Q&A plus discussion

  • Q: What is the timeline on the 3005 (Phosphorus) release?
    • A: We’re targeting end of May, but that’s not yet finalized. As we get closer to that date, we’ll have more information.
  • Q: There has been some work on the Salt transport system. Can you give any status updates?
    • A: There has been a fairly substantial refactor of the transport system and that was merged in. Some work has been going on to make an option for RabbitMQ, but we’re not sure how far that work has come along. When that happens, it should make things more pluggable and usable. They were resolving a regression issue.
    • Will it land in 3005 (Phosphorus)? Probably not, but likely in a future release.
    • Comment from community member: Would be super-interesting to see some documentation or general information on making pluggable transport. Would love to see if it would fit on other platforms.
    • We recommend reviewing the latest Salt code, such as the TCP or the ZeroMQ transport layer and use that as a jumping off point. From there, if you want to document that, it would an amazing contribution. Tag Alyssa on your docs-only PR and she can make sure it gets fast-tracked for approval.
  • Q: I’m not seeing working group meetings posted on YouTube recently, has there been any change with regards to that?
    • A: Feel free to contact Chunga and he can help with posting working groups. In some cases, we don’t always record working group meetings.