Open Hour 2022-OCT-20

October 20, 2022 - Alyssa Rock

Agenda

  • General updates and announcements
  • Salt docs working group updates
  • User group meetups
  • From the community forums
  • Q&A plus discussion

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

General updates and announcements

  • Open Hours are usually held every 1st and 3rd Thursday from 10a.m. to 11a.m. Pacific.
  • Our next Salt Community Open Hour will be November 3rd.
  • Join a Salt Project working group! https://saltproject.io/home/working-groups/

Events

Salt docs working group updates

  • The Salt Docs working group has two new aspiring technical writers who are working on some strategic documentation initiatives:
    • Improve the Salt docs landing page – Jennifer is going to do some user research to develop user personas for the Salt community. Once she’s developed those personas and validated them with the dev team and the community, she’s going to create user stories and user flows for how these different personas will interact with our docs landing page to quickly find the documentation they need in the Salt Docs.
    • Salt module documentation quality standards – Bennett is working on a project to develop a set of guidelines and templates to help get the Salt module documentation meet our quality standards. Then we’ll work on auditing the most important module docs and get them into compliance with our quality policies.
  • Since some of these projects will likely involve working with the community, we hope everyone in the community will be supportive and cooperative as these projects are underway.

User group meetups

  • Since we haven’t been able to have an in-person conference this year, Nicholas Hughes is working on a community-led effort to host some more in-person Salt events. These would be:
    • Single-day events.
    • Within a reasonable distance.
    • Speakers giving sessions that are possibly recorded so that people who can’t intend in person can still participate.
    • And of course: food and chances to do some social networking.
  • Go to spugm.com to join a mailing list for updates and let us know you are interested.

From the community forums

  • Today’s issue: salt-call vs. salt <minion>. Why one might work and the other doesn’t. HINT: environments matter.
  • The reason why you might get different outcomes when using salt-call is because it has nothing to do with the daemon. Salt-call creates its own connections and doesn’t communicate with the daemon on the minion at all.
  • It also means that any environment variables that might exist for your user will be there for salt-call but might not exist for the daemon that is running. So, any modules that might operate differently depending on environmental variables will be impacted. That’s especially important in systemd envivronments because it gives a stripped down root environment.
  • The Saltfile also matters because salt-call will read that file directly but the daemon might not have access to it because it starts in a different directory. Saltfile is like a runtime config file. It’s a little like an environmental variable, but it’s just a file. Salt will look for it and apply what info you have in there to the command, which is useful for testing different things.
  • By the way, running salt-call --local test.ping is completely pointless. All it does is tells you the Python works.

Q&A plus discussion

  • Q: I’ve noticed the Salt Docs working group has been offering a Git training workshop for the last few sessions. I had some technical writers who could benefit from that training. Is there any chance it will be offered again?
    • Contact Alyssa and we can arrange another time to run that workshop. FYI, the Git training workshop materials were developed by The Good Docs Project and so the materials are taken from there. The Good Docs Project is currently working on open-sourcing the curriculum so that other groups could run the workshop on their own, but it’s a work in progress.
  • Q: Is there any chance of getting a onedir tutorial in a future Open Hour?
    • Yes, it’s coming and we apologize for the delay. The difficulty has been getting schedules aligned.