Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOCS] state - virtualenv.managed - onedir documentation needed + possibly block this state #62687

Open
ITJamie opened this issue Sep 15, 2022 · 2 comments
Labels
docstring-update string edits Documentation Relates to Salt documentation module doc standards salt install guide Repo for these docs: https://gitlab.com/saltstack/open/docs/salt-install-guide severity-medium 3rd level, incorrect or bad functionality, confusing and lacks a work around time-estimate-sprint

Comments

@ITJamie
Copy link
Contributor

ITJamie commented Sep 15, 2022

Description
I just noticed another place where we should add warnings about the python onedir change.
when using the virtualenv.managed state with salt onedir. if you dont supply the python variable it will use onedir’s python to create the virtualenv https://docs.saltproject.io/en/latest/ref/states/all/salt.states.virtualenv_mod.html#salt.states.virtualenv_mod.managed
we called needing to update pip.installed uses for the onedir changeover, but we should also add virtualenv.managed to those warnings
https://docs.saltproject.io/salt/install-guide/en/latest/topics/upgrade-to-onedir.html#how-to-upgrade-to-onedir (step 4)

Suggested Fix
add docs on upgrade guide to supply python path to a system python package

Type of documentation
Salt modules + salt repo / salt install guide

Additional context
It might be a good idea to block use of virtualenv.managed on onedir builds if python var isnt supplied. aka making it a required field

@ITJamie ITJamie added Documentation Relates to Salt documentation needs-triage labels Sep 15, 2022
@OrangeDog
Copy link
Contributor

Supplying venv_bin should also be sufficient.

@barbaricyawps
Copy link
Contributor

Thanks again for opening this issue, @ITJamie . I'll assign myself to this issue and try to get some doc updates for you.

@barbaricyawps barbaricyawps self-assigned this Sep 19, 2022
@barbaricyawps barbaricyawps added docstring-update string edits salt install guide Repo for these docs: https://gitlab.com/saltstack/open/docs/salt-install-guide time-estimate-sprint severity-medium 3rd level, incorrect or bad functionality, confusing and lacks a work around and removed needs-triage labels Sep 19, 2022
@barbaricyawps barbaricyawps removed their assignment Dec 12, 2022
@dwoz dwoz added this to the Sulfur v3006.9 milestone May 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docstring-update string edits Documentation Relates to Salt documentation module doc standards salt install guide Repo for these docs: https://gitlab.com/saltstack/open/docs/salt-install-guide severity-medium 3rd level, incorrect or bad functionality, confusing and lacks a work around time-estimate-sprint
Projects
None yet
Development

No branches or pull requests

4 participants