Open Hour 2022-FEB-3

February 3, 2022 - Alyssa Rock

Agenda

  • General updates and announcements
  • Community forum updates
  • Salt docs updates
  • The Salty 5
  • Help wanted
  • 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 February 16.
  • The Security Working Group is meeting at a new time: the second Wednesday of every month from 9a.m. to 10a.m. Pacific.
  • We want you for the Salty 5!

Events

Community forum updates

  • This week’s featured issue: checking if a module is loaded in Jinja before trying to use it.
  • The problem is that you might need to install the dependencies before or while the state runs.
  • The best practices is to instead include a step that checks if the module is loaded in the dictionary. If it is not installed, it should skip over everything else except the dependency installation. On the next highstate run, it will find it and load all that information. This method is also a good way to gatekeep your highstate and prevent the introduction of errors.
  • A related issue is that file.directory has a clean parameter. To run effectively, this parameter requires the file state to know which things it should not delete. This parameter had a bug that is now fixed. Going forward, if you are using file.directory, then you have to use a file state in the requisite, meaning it should be required by the file directly or it should use require in.

Salt docs updates

  • We are increasing the Salt Docs working group meeting frequency to once a week. Starting next week, our working group meeting will be co-working sessions, which means that we will all work on Salt docs projects on the same Zoom call. We’ll provide support to each other while we work. Come join us!
  • The next Salt Docs working group meeting of the year: Tuesday, February 8 at 3p MST / 2p PST / 22:00 UTC.
  • Alyssa’s current Salt Docs initiative project is creating a set of quality standards for the module documentation. See Create and implement quality standards for module documentation for more information. Alyssa met with internal subject matter experts and gathered their feedback and insights about what should go into the module documentation. Next, she plans to work on creating drafts of three deliverables:
    • A template with the preferred organization and content that can be easily pasted into new module documentation.
    • An example of a module that uses this preferred standard.
    • A slightly more in-depth guide that explains how to use the template and what considerations to keep in mind when writing module documentation.
  • When these rough drafts are complete, we’ll provide these documents for community review and validation before finalizing these standards.
  • Down the road we’ll work on aligning the existing modules to these standards based on module importance and priority. As you can imagine, getting the existing docs up to speed is a major project. This alignment task could get done much faster with community support, so please let us know if you’d like to help! Also let us know if you would be interested in making this a community event, such as a docs jam.
  • Join our working group or talk with us on the #documentation channel to weigh in.

The Salty 5

  • This is a new segment of the Open Hour! In this segment, Salt Project community members can share interesting projects they’re working on with Salt.
  • Today: Thomas Phipps will demonstrate how he uses Salt with his home assistant. Check out the Open Hour video on the Salt Project channel to see the demo (link at the top of this post).

Help wanted

  • The core team is adding “help wanted” labels to issues that would be great for community members to tackle. These issues are ones that the team would love to get merged or work on, but that they don’t have the bandwidth for. It’s a great way to help the project and get started working with Salt. Look through the issues with that label and see if something piques your interest: https://github.com/saltstack/salt/labels/help-wanted
  • Here’s a highlighted issue:

Q&A plus discussion

  • Q: Did the flaky pr-centos-8-x86_64-py3-pytest test get fixed?
    • A: Yes, in the best possible way: centos-8 got removed. Rebase any pull requests where it was failing and everything should work.
  • Q: Our organization is having an issue with Salt and the detection of IP addresses. There is an issue we’re trying to resolve: https://github.com/saltstack/salt/issues/61370 We have a related pull request that needs attention, especially since we’re not sure if the assumptions made in the fix were correct.
    • A: This pull request likely slipped through the cracks. We can take a look and review that.
  • Q: Is Tiamat the way forward for making the Python version more flexible in our Salt system?
    • A: Yes, Tiamat is the way forward. For a deeper discussion of the nuances of packaging and best practices for managing Python dependencies, check out the Open Hour video on the Salt Project channel (link at the top of this post).