Skip to content

[DOCS] Document how to install optional dependencies for Salt #64291

@dehnert

Description

@dehnert

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationRelates to Salt documentationsalt install guideRepo for these docs: https://gitlab.com/saltstack/open/docs/salt-install-guideseverity-high2nd top severity, seen by most users, causes major problemstime-estimate-sprint

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions