Skip to content

docs: Python plugin dependencies installation#2315

Merged
BareosBot merged 3 commits intobareos:masterfrom
sduehr:dev/sduehr/master/doc-python-dependency-install
Jul 10, 2025
Merged

docs: Python plugin dependencies installation#2315
BareosBot merged 3 commits intobareos:masterfrom
sduehr:dev/sduehr/master/doc-python-dependency-install

Conversation

@sduehr
Copy link
Member

@sduehr sduehr commented Jul 7, 2025 •
edited by bruno-at-bareos
Loading

Some Linux distributions have externally managed python environment, discouring using pip as root. This documentation enhancement describes how to install python modules only for Bareos plugins.

Also add a link to an article that explains how to check VSS writer errors and disable specfic VSS writers when using the VMware Plugin with Windows VMs.

Checklist for the reviewer of the PR (will be processed by the Bareos team)

Make sure you check/merge the PR using devtools/pr-tool to have some simple automated checks run and a proper changelog record added.

General
  • Is the PR title usable as CHANGELOG entry?
  • Purpose of the PR is understood
  • Commit descriptions are understandable and well formatted
  • Required backport PRs have been created
  • Correct milestone is set
Source code quality
  • Source code changes are understandable
  • Variable and function names are meaningful
  • Code comments are correct (logically and spelling)
  • Required documentation changes are present and part of the PR

@sduehr
docs: Python plugin dependencies installation
770958c 
Some Linux distributions have externally managed python environment,
discouring using pip as root. This documentation enhancement describes
how to install python modules only for Bareos plugins.

Also add a link to an article that explains how to check VSS writer
errors and disable specfic VSS writers when using the VMware Plugin
with Windows VMs.
@sduehr sduehr added documentation This PR changes only documentation requires backport to 24 labels Jul 7, 2025
bruno-at-bareos
bruno-at-bareos requested changes Jul 9, 2025
View reviewed changes
Copy link
Contributor

@bruno-at-bareos bruno-at-bareos left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice improvement.
See few glitches to be fixed.

Another question shouldn't we mention the support of vddk 9 ?

@bruno-at-bareos
Copy link
Contributor

bruno-at-bareos commented Jul 9, 2025 •
edited
Loading

Also I would maybe add some sentences about the fact that people will still see the warning about pip as root, but the modules will all be installed in bareos plugin dir.

 pip install -t $BPP --upgrade pyvmomi
Collecting pyvmomi
  Downloading pyvmomi-9.0.0.0-py3-none-any.whl (2.0 MB)
     |████████████████████████████████| 2.0 MB 2.7 MB/s
Installing collected packages: pyvmomi
Successfully installed pyvmomi-9.0.0.0
WARNING: Running pip as the 'root' user can result in broken permissions and conflicting
behaviour with the system package manager. It is recommended to use a virtual environment
instead: https://pip.pypa.io/warnings/venv


ls -lah $BPP
total 352K
drwxr-xr-x 1 root root  492 Jul  9 11:50 .
drwxr-xr-x 1 root root  598 Jul  9 09:19 ..
-rw-r--r-- 1 root root  20K Jul  8 18:08 BareosFdPluginBaseclass.py
-rw-r--r-- 1 root root  12K Jul  8 18:08 BareosFdPluginLocalFilesBaseclass.py
-rw-r--r-- 1 root root 3.5K Jul  8 18:08 BareosFdWrapper.py
drwxr-xr-x 1 root root  114 Jul  9 11:50 __pycache__
-rwxr-xr-x 1 root root  20K Jul  8 18:13 autoxflate-sd.so
-rw-r--r-- 1 root root 8.1K Jul  8 18:08 bareos-fd-local-fileset.py
-rw-r--r-- 1 root root 189K Jul  8 18:08 bareos-fd-vmware.py
-rwxr-xr-x 1 root root  29K Jul  8 18:13 bpipe-fd.so
drwxr-xr-x 1 root root   90 Jul  9 11:50 pyVim
drwxr-xr-x 1 root root  686 Jul  9 11:50 pyVmomi
-rwxr-xr-x 1 root root  37K Jul  8 18:13 python3-fd.so
drwxr-xr-x 1 root root  132 Jul  9 11:50 pyvmomi-9.0.0.0.dist-info
-rw-r--r-- 1 root root  13K Jul  9 11:50 vsanapiutils.py
-rw-r--r-- 1 root root  123 Jul  9 11:50 vsanmgmtObjects.py

@bruno-at-bareos bruno-at-bareos added this to the 25.0.0 milestone Jul 9, 2025
@sduehr sduehr requested a review from bruno-at-bareos July 9, 2025 21:38
bruno-at-bareos
bruno-at-bareos approved these changes Jul 10, 2025
View reviewed changes
Copy link
Contributor

@bruno-at-bareos bruno-at-bareos left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great improvement. Validated

@bruno-at-bareos bruno-at-bareos mentioned this pull request Jul 10, 2025
Merged
6 tasks
@BareosBot BareosBot merged commit 2e1172a into bareos:master Jul 10, 2025
1 check was pending
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@bruno-at-bareos bruno-at-bareos bruno-at-bareos approved these changes

Assignees

@sduehr sduehr

Labels

documentation This PR changes only documentation requires backport to 24

Projects

None yet

Milestone

25.0.0

Development

Successfully merging this pull request may close these issues.

3 participants

@sduehr @bruno-at-bareos @BareosBot