saltstack / saltstack/salt

[DOCS] Document how to install optional dependencies for Salt

Open
#64,291 6 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation salt install guide severity-high time-estimate-sprint
Dominant language
Python
Stars
15.7k
Forks
5.6k
Avg merge
2d 44m
Merged PRs (30d)
80

Description

Description
I was previously running 3004.1 and had working states using the virt module. That requires the libvirt Python module, so I installed the python3-libvirt package, which worked. I then installed 3006.1 using the instructions, and the states complained that the virt module is missing. Given that I had the Python libvirt module installed, this was confusing. Judging by https://docs.saltproject.io/salt/install-guide/en/latest/topics/upgrade-to-onedir.html#upgrade-to-onedir, I think the recommended approach is to install with pip and that will install in Salt's Python install, not the global one, but I think it would be useful to be more explicit about that. I'm used to using Ubuntu packages to install Python libraries when available, and no longer supporting that feels like a big change.

Suggested Fix
Add improved documentation of how to install optional dependencies

Some places I could see this being helpful:

Type of documentation
This could be Salt documentation, Salt modules, the Salt Repo or the Getting Started guide.

Could impact all of these

Location or format of documentation
https://docs.saltproject.io/salt/install-guide/en/latest/topics/install-by-operating-system/ubuntu.html is what I was following

Additional context
Add any other context or screenshots about the feature request here.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the upgrade-to-onedir page and the Ubuntu install guide linked in the issue, then review the install overview page for where optional dependencies should be introduced. Update the relevant documentation so users can identify and install dependencies in Salt’s Python environment, with guidance covering the general install flow and per-OS instructions.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.