tecdebt: Adjust code style.

fix: Requery a guest if that running guest reports 0 cpu usage

.changelogs/1.1.0/114_refactor_code_base.yml

@@ -1,6 +1,5 @@
 fixed:
   - Refactored code base for ProxLB [#114]
-  - Renamed package from `proxlb` to `python3-proxlb` to align with Debian packaging guidelines [#114]
   - Switched to `pycodestyle` for linting [#114]
   - Package building will be done within GitHub actions pipeline [#114]
   - ProxLB now only returns a warning when no guests for further balancing are not present (instead of quitting) [132#]
@@ -9,4 +8,4 @@ fixed:
   - Stop balancing when movement would get worste (new force param to enfoce for affinity rules) [#128]
   - Added requested documentation regarding Proxmox HA groups [#127]
   - Rewrite of the whole affinity/anti-affinity rules evaluation and placement [#123]
-  - Fixed the `ignore` parameter for nodes where the node and guests on the node will be untouched [#102]
+  - Fixed the `ignore` parameter for nodes where the node and guests on the node will be untouched [#102]

.changelogs/1.1.0/125-add-proxmox-api-authentication-support.yml

@@ -0,0 +1,2 @@
+feature:
+  - Add Proxmox API authentication support. [#125]

.changelogs/1.1.0/137_fix_systemd_unit_file.yml

@@ -0,0 +1,2 @@
+fixed:
+  - Fix the systemd unit file to start ProxLB after pveproxy (by @robertdahlem). [#137]

.changelogs/1.1.0/release_meta.yml

@@ -1 +1 @@
-date: TBD
+date: 2025-04-01

.changelogs/1.1.1/163_fix_ignore_vm_tag.yml

@@ -0,0 +1,2 @@
+fixed:
+  - Fix tag evluation for VMs for being ignored for further balancing [#163]

.changelogs/1.1.1/165_improve_logging_servity.yml

@@ -0,0 +1,2 @@
+fixed:
+  - Improve logging verbosity of messages that had a wrong servity [#165]

.changelogs/1.1.1/168_add_more_flexible_schedules.yml

@@ -0,0 +1,2 @@
+feature:
+  - Add a more flexible way to define schedules in minutes or hours (by @gyptazy) [#168]

.changelogs/1.1.1/171_set_correct_python_path_docker_image.yml

@@ -0,0 +1,2 @@
+fixed:
+  - Fix Python path for Docker entrypoint (by @crandler) [#170]

.changelogs/1.1.1/174_honor_balancing_activation_value.yml

@@ -0,0 +1,2 @@
+fixed:
+  - Honor the value when balancing should not be performed and stop balancing [#174]

.changelogs/1.1.1/176_change_turn_daemon_mode_on_default.yml

@@ -0,0 +1,2 @@
+changed:
+  - Change the default behaviour of the daemon mode to active [#176]

.changelogs/1.1.1/180_change_default_balancing_to_used_instead_assigned.yml

@@ -0,0 +1,2 @@
+changed:
+  - Change the default banalcing mode to used instead of assigned [#180]

.changelogs/1.1.1/184_validate_for_sufficient_user_permissions.yml

@@ -0,0 +1,2 @@
+feature:
+  - Add validation for the minimum required permissions of a user in Proxmox [#184]

.changelogs/1.1.1/185-logging-handler-for-no-systemd-integration.yml

@@ -0,0 +1,2 @@
+fix:
+  - add handler to log messages with severity less than info to the screen when there is no systemd integration, for instance, inside a docker container (by @glitchvern) [#185]

.changelogs/1.1.1/187_allow_use_of_minutes_instead_of_hours.yml

@@ -0,0 +1,2 @@
+fixed:
+  - allow the use of minutes instead of hours and only accept hours or minutes in the format (by @glitchvern) [#187]

.changelogs/1.1.1/195_set_cpu_used_to_cpu_usage_times_core_count.yml

@@ -0,0 +1,2 @@
+fixed:
+  - Set cpu_used to the cpu usage, which is a percent, times the total number of cores to get a number where guest cpu_used can be added to nodes cpu_used and be meaningful (by @glitchvern) [#195]

.changelogs/1.1.1/197_remove_hard_coded_memory_usage_from_lowest_usage_node.yml

@@ -0,0 +1,2 @@
+fixed:
+  - Remove hard coded memory usage from lowest usage node and use method and mode specified in configuration instead (by @glitchvern) [#197]

.changelogs/1.1.1/200_requery_zero_guest_cpu_used.yml

@@ -0,0 +1,2 @@
+fixed:
+  - Requery a guest if that running guest reports 0 cpu usage (by @glitchvern) [#200]

.changelogs/1.1.1/204_fix_migration_log_relationship_of_guest_type.yml

@@ -0,0 +1,2 @@
+fixed:
+  - Fix the guest type relationship in the logs when a migration job failed (by @gyptazy) [#204]

.changelogs/1.1.1/205_add_api_upstream_error_message_on_migration_failure.yml

@@ -0,0 +1,2 @@
+added:
+  - Providing the API upstream error message when migration fails in debug mode (by @gyptazy) [#205]

.changelogs/1.1.1/release_meta.yml

@@ -0,0 +1 @@
+date: TBD

.github/workflows/20-pipeline-build-deb-package.yml

@@ -28,7 +28,7 @@ jobs:
       - name: Check out repository
         uses: actions/checkout@v3
         with:
-          ref: 'development'
+          ref: ${{ github.ref }}
 
       - name: Set up Docker with Debian image
         run: |
@@ -39,9 +39,13 @@ jobs:
           docker run --rm -v $(pwd):/workspace -w /workspace debian:latest bash -c "
             # Install dependencies
             apt-get update && \
-            apt-get install -y python3 python3-setuptools debhelper dh-python python3-pip python3-stdeb python3-proxmoxer python3-requests python3-urllib3 && \
-            # Build package
-            python3 setup.py --command-packages=stdeb.command bdist_deb && \
+            apt-get install -y python3 python3-setuptools debhelper dh-python python3-pip python3-stdeb python3-proxmoxer python3-requests python3-urllib3 devscripts python3-all && \
+            # Build package using stdeb / setuptools
+            # python3 setup.py --command-packages=stdeb.command bdist_deb && \
+            # Build native package
+            dpkg-buildpackage -us -uc && \
+            mkdir package && \
+            mv ../*.deb package/ && \
             echo 'OK: Debian package successfully created.'
           "
 
@@ -49,7 +53,7 @@ jobs:
         uses: actions/upload-artifact@v4
         with:
           name: debian-package
-          path: deb_dist/*.deb
+          path: package/*.deb
 
   integration-test-debian:
     needs: build-package-debian
@@ -59,15 +63,16 @@ jobs:
         uses: actions/download-artifact@v4
         with:
           name: debian-package
-          path: deb_dist/
+          path: package/
 
       - name: Set up Docker with Debian image
         run: docker pull debian:latest
 
       - name: Install and test Debian package in Docker container
         run: |
-          docker run --rm -v $(pwd)/deb_dist:/deb_dist -w /deb_dist debian:latest bash -c "
+          docker run --rm -v $(pwd)/package:/package -w /package debian:latest bash -c "
             apt-get update && \
-            apt-get install -y ./python3-proxlb*.deb && \
+            apt-get install -y systemd && \
+            apt-get install -y ./proxlb*.deb && \
             python3 -c 'import proxlb; print(\"OK: Debian package successfully installed.\")'
           "

CHANGELOG.md

@@ -0,0 +1,140 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+
+## [1.1.0] - 2025-04-01
+
+### Fixed
+
+- Refactored code base for ProxLB [#114]
+- Switched to `pycodestyle` for linting [#114]
+- Package building will be done within GitHub actions pipeline [#114]
+- ProxLB now only returns a warning when no guests for further balancing are not present (instead of quitting) [132#]
+- All nodes (according to the free resources) will be used now [#130]
+- Fixed logging outputs where highest/lowest were mixed-up [#129]
+- Stop balancing when movement would get worste (new force param to enfoce for affinity rules) [#128]
+- Added requested documentation regarding Proxmox HA groups [#127]
+- Rewrite of the whole affinity/anti-affinity rules evaluation and placement [#123]
+- Fixed the `ignore` parameter for nodes where the node and guests on the node will be untouched [#102]
+
+
+## [1.0.6] - 2024-12-24
+
+### Fixed
+
+- Fix maintenance mode when using cli arg and config mode by using the merged list (by @CartCaved). [#119]
+- Fix that a scheduler time definition of 1 (int) gets wrongly interpreted as a bool (by @gyptazy). [#115]
+
+
+## [1.0.5] - 2024-10-30
+
+### Changed
+
+- Change docs to make bool usage in configs more clear (by @gyptazy). [#104]
+
+### Fixed
+
+- Fix node (and its objects) evaluation when not reachable, e.g., maintenance (by @gyptazy). [#107]
+- Fix migration from local disks (by @greenlogles). [#113]
+- Fix evaluation of maintenance mode where comparing list & string resulted in a crash (by @glitchvern). [#106]
+- Fix allowed values (add DEBUG, WARNING) for log verbosity (by @gyptazy). [#98]
+
+
+## [1.0.4] - 2024-10-11
+
+### Added
+
+- Add maintenance mode to evacuate a node and move workloads for other nodes in the cluster. [#58]
+- Add feature to make API timeout configureable. [#91]
+- Add version output cli arg. [#89]
+
+### Changed
+
+- Run storage balancing only on supported shared storages. [#79]
+- Run storage balancing only when needed to save time. [#79]
+
+### Fixed
+
+- Fix CPU balancing where calculations are done in float instead of int. (by @glitchvern) [#75]
+- Fix documentation for the underlying infrastructure. [#81]
+
+
+## [1.0.3] - 2024-09-12
+
+### Added
+
+- Add cli arg `-b` to return the next best node for next VM/CT placement. [#8]
+- Add a convert function to cast all bool alike options from configparser to bools. [#53]
+- Add a config parser options for future features. [#53]
+- Add a config versio schema that must be supported by ProxLB. [#53]
+- Add feature to allow the API hosts being provided as a comma separated list. [#60]
+- Add doc how to add dedicated user for authentication. (by @Dulux-Oz)
+- Add storage balancing function. [#51]
+
+### Changed
+
+- Provide a more reasonable output when HA services are not active in a Proxmox cluster. [#68]
+- Improve the underlying code base for future implementations. [#53]
+
+### Fixed
+
+- Fix anti-affinity rules not evaluating a new and different node. [#67]
+- Fixed `master_only` function by inverting the condition.
+- Fix documentation for the master_only parameter placed in the wrong config section. [#74]
+- Fix bug in the `proxlb.conf` in the vm_balancing section.
+- Fix handling of unset `ignore_nodes` and `ignore_vms` resulted in an attribute error. [#71]
+- Improved the overall validation and error handling. [#64]
+
+
+## [1.0.2] - 2024-08-13
+
+### Added
+
+- Add option to run ProxLB only on the Proxmox's master node in the cluster (reg. HA feature). [#40]
+- Add option to run migrations in parallel or sequentially. [#41]
+
+### Changed
+
+- Fix daemon timer to use hours instead of minutes. [#45]
+
+### Fixed
+
+- Fix CMake packaging for Debian package to avoid overwriting the config file. [#49]
+
+
+## [1.0.0] - 2024-08-01
+
+### Added
+
+- Add feature to prevent VMs from being relocated by defining the 'plb_ignore_vm' tag. [#7]
+- Add feature to prevent VMs from being relocated by defining a wildcard pattern. [#7]
+- Add Docker/Podman support. [#10 by @daanbosch]
+- Add option to rebalance by assigned VM resources to avoid overprovisioning. [#16]
+- Add feature to make log verbosity configurable [#17].
+- Add dry-run support to see what kind of rebalancing would be done. [#6]
+- Add LXC/Container integration. [#27]
+- Add exclude grouping feature to rebalance VMs from being located together to new nodes. [#4]
+- Add include grouping feature to rebalance VMs bundled to new nodes. [#3]
+- Add option_mode to rebalance by node's free resources in percent (instead of bytes). [#29]
+
+### Changed
+
+- Adjusted general logging and log more details.
+
+
+## [0.9.9] - 2024-07-06
+
+### Added
+
+- Initial public development release of ProxLB.
+
+
+## [0.9.0] - 2024-02-01
+
+### Added
+
+- Development release of ProxLB.

Dockerfile

@@ -0,0 +1,28 @@
+# Use the latest Alpine image
+FROM alpine:latest
+
+# Labels
+LABEL maintainer="gyptazy@gyptazy.com"
+LABEL org.label-schema.name="ProxLB"
+LABEL org.label-schema.description="ProxLB - An advanced load balancer for Proxmox clusters."
+LABEL org.label-schema.vendor="gyptazy"
+LABEL org.label-schema.url="https://proxlb.de"
+LABEL org.label-schema.vcs-url="https://github.com/gyptazy/ProxLB"
+
+# Install Python3
+RUN apk add --no-cache python3 py3-pip
+
+# Create a directory for the app
+WORKDIR /app
+
+# Copy the python program from the current directory to /app
+COPY proxlb /app/proxlb
+
+# Copy requirements to the container
+COPY requirements.txt /app/requirements.txt
+
+# Install dependencies in the virtual environment
+RUN pip install --break-system-packages -r /app/requirements.txt
+
+# Set the entry point to use the virtual environment's python
+ENTRYPOINT ["/usr/bin/python3", "/app/proxlb/main.py"]

README.md

@@ -4,10 +4,6 @@
 
 <p float="center"><img src="https://img.shields.io/github/license/gyptazy/ProxLB"/><img src="https://img.shields.io/github/contributors/gyptazy/ProxLB"/><img src="https://img.shields.io/github/last-commit/gyptazy/ProxLB/main"/><img src="https://img.shields.io/github/issues-raw/gyptazy/ProxLB"/><img src="https://img.shields.io/github/issues-pr/gyptazy/ProxLB"/></p>
 
-
-# :warning: Important: ProxLB 1.1.x is coming
-This repository is currently under heavy work and changes. During that time it might come to issues, non working pipelines or wrong documentation. Please select a stable release tag for a suitable version during this time!
-
 ## Table of Contents
 1. [Introduction](#introduction)
 2. [Features](#features)
@@ -15,26 +11,23 @@ This repository is currently under heavy work and changes. During that time it m
 4. [Installation](#installation)
    1. [Requirements / Dependencies](#requirements--dependencies)
    2. [Debian Package](#debian-package)
-   3. [RedHat Package](#redhat-package)
    4. [Container / Docker](#container--docker)
    5. [Source](#source)
-5. [Upgrading](#upgrading)
-   1. [Upgrading from < 1.1.0](#upgrading-from--110)
-   2. [Upgrading from >= 1.1.0](#upgrading-from--110)
-6. [Usage / Configuration](#usage--configuration)
+5. [Usage / Configuration](#usage--configuration)
    1. [GUI Integration](#gui-integration)
    2. [Proxmox HA Integration](#proxmox-ha-integration)
    3. [Options](#options)
-7. [Affinity & Anti-Affinity Rules](#affinity--anti-affinity-rules)
+6. [Affinity & Anti-Affinity Rules](#affinity--anti-affinity-rules)
    1. [Affinity Rules](#affinity-rules)
    2. [Anti-Affinity Rules](#anti-affinity-rules)
-8. [Maintenance](#maintenance)
-9. [Misc](#misc)
+   3. [Ignore VMs](#ignore-vms)
+7. [Maintenance](#maintenance)
+8. [Misc](#misc)
    1. [Bugs](#bugs)
    2. [Contributing](#contributing)
    3. [Documentation](#documentation)
    4. [Support](#support)
-10. [Author(s)](#authors)
+9. [Author(s)](#authors)
 
 
 ## Introduction
@@ -94,23 +87,126 @@ The dependencies can simply be installed with `pip` by running the following com
 pip install -r requirements.txt
 ```
 
-Distribution packages, such like the provided `.deb` package will automatically resolve and install all required dependencies by using already packaged version from the distribution's repository.
+*Note: Distribution packages, such like the provided `.deb` package will automatically resolve and install all required dependencies by using already packaged version from the distribution's repository. By using the Docker (container) image or Debian packages, you do not need to take any care of the requirements listed here.*
 
 ### Debian Package
+ProxLB is a powerful and flexible load balancer designed to work across various architectures, including `amd64`, `arm64`, `rv64` and many other ones that support Python. It runs independently of the underlying hardware, making it a versatile choice for different environments. This chapter covers the step-by-step process to install ProxLB on Debian-based systems, including Debian clones like Ubuntu.
 
-### RedHat Package
+#### Quick-Start
+You can simply use this snippet to install the repository and to install ProxLB on your system.
 
-### Container / Docker
+```bash
+echo "deb https://repo.gyptazy.com/stable /" > /etc/apt/sources.list.d/proxlb.list
+wget -O /etc/apt/trusted.gpg.d/proxlb.asc https://repo.gyptazy.com/repository.gpg
+apt-get update && apt-get -y install proxlb
+cp /etc/proxlb/proxlb_example.yaml /etc/proxlb/proxlb.yaml
+# Adjust the config to your needs
+vi /etc/proxlb/proxlb.yaml
+systemctl start proxlb
+```
+
+Afterwards, ProxLB is running in the background and balances your cluster by your defined balancing method (default: memory).
+
+#### Details
+ProxLB provides two different repositories:
+* https://repo.gyptazy.com/stable (only stable release)
+* https://repo.gyptazy.com/testing (bleeding edge - not recommended)
+
+The repository is signed and the GPG key can be found at:
+* https://repo.gyptazy.com/repository.gpg
+
+You can also simply import it by running:
+
+```
+# KeyID:  17169F23F9F71A14AD49EDADDB51D3EB01824F4C
+# UID:    gyptazy Solutions Repository <contact@gyptazy.com>
+# SHA256: 52c267e6f4ec799d40cdbdb29fa518533ac7942dab557fa4c217a76f90d6b0f3  repository.gpg
+
+wget -O /etc/apt/trusted.gpg.d/proxlb.asc https://repo.gyptazy.com/repository.gpg
+```
+
+*Note: The defined repositories `repo.gyptazy.com` and `repo.proxlb.de` are the same!*
+
+#### Debian Packages (.deb files)
+If you do not want to use the repository you can also find the debian packages as a .deb file on gyptazy's CDN at:
+* https://cdn.gyptazy.com/files/os/debian/proxlb/
+
+Afterwards, you can simply install the package by running:
+```bash
+dpkg -i proxlb_*.deb
+cp /etc/proxlb/proxlb_example.yaml /etc/proxlb/proxlb.yaml
+# Adjust the config to your needs
+vi /etc/proxlb/proxlb.yaml
+systemctl start proxlb
+```
+
+### Container Images / Docker
+Using the ProxLB container images is straight forward and only requires you to mount the config file.
+
+```bash
+# Pull the image
+docker pull cr.gyptazy.com/proxlb/proxlb:latest
+# Download the config
+wget -O proxlb.yaml https://raw.githubusercontent.com/gyptazy/ProxLB/refs/heads/main/config/proxlb_example.yaml
+# Adjust the config to your needs
+vi proxlb.yaml
+# Start the ProxLB container image with the ProxLB config
+docker run -it --rm -v $(pwd)/proxlb.yaml:/etc/proxlb/proxlb.yaml proxlb
+```
+
+*Note: ProxLB container images are officially only available at cr.proxlb.de and cr.gyptazy.com.*
+
+#### Overview of Images
+| Version | Image |
+|------|:------:|
+| latest | cr.gyptazy.com/proxlb/proxlb:latest |
+| v1.1.0 | cr.gyptazy.com/proxlb/proxlb:v1.1.0 |
+| v1.0.6 | cr.gyptazy.com/proxlb/proxlb:v1.0.6 |
+| v1.0.5 | cr.gyptazy.com/proxlb/proxlb:v1.0.5 |
+| v1.0.4 | cr.gyptazy.com/proxlb/proxlb:v1.0.4 |
+| v1.0.3 | cr.gyptazy.com/proxlb/proxlb:v1.0.3 |
+| v1.0.2 | cr.gyptazy.com/proxlb/proxlb:v1.0.2 |
+| v1.0.0 | cr.gyptazy.com/proxlb/proxlb:v1.0.0 |
+| v0.9.9 | cr.gyptazy.com/proxlb/proxlb:v0.9.9 |
 
 ### Source
+ProxLB can also easily be used from the provided sources - for traditional systems but also as a Docker/Podman container image.
 
-## Upgrading
+#### Traditional System
+Setting up and running ProxLB from the sources is simple and requires just a few commands. Ensure Python 3 and the Python dependencies are installed on your system, then run ProxLB using the following command:
+```bash
+git clone https://github.com/gyptazy/ProxLB.git
+cd ProxLB
+```
 
-### Upgrading from < 1.1.0
-Upgrading ProxLB is not supported due to a fundamental redesign introduced in version 1.1.x. With this update, ProxLB transitioned from a monolithic application to a pure Python-style project, embracing a more modular and flexible architecture. This shift aimed to improve maintainability and extensibility while keeping up with modern development practices. Additionally, ProxLB moved away from traditional ini-style configuration files and adopted YAML for configuration management. This change simplifies configuration handling, reduces the need for extensive validation, and ensures better type casting, ultimately providing a more streamlined and user-friendly experience.
+Afterwards simply adjust the config file to your needs:
+```bash
+vi config/proxlb.yaml
+```
 
-### Upgrading from >= 1.1.0
-Uprading within the current stable versions, starting from 1.1.0, will be possible in all supported ways.
+Start ProxLB by Python3 on the system:
+```bash
+python3 proxlb/main.py -c config/proxlb.yaml
+```
+
+#### Container Image
+Creating a container image of ProxLB is straightforward using the provided Dockerfile. The Dockerfile simplifies the process by automating the setup and configuration required to get ProxLB running in an Alpine container. Simply follow the steps in the Dockerfile to build the image, ensuring all dependencies and configurations are correctly applied. For those looking for an even quicker setup, a ready-to-use ProxLB container image is also available, eliminating the need for manual building and allowing for immediate deployment.
+
+```bash
+git clone https://github.com/gyptazy/ProxLB.git
+cd ProxLB
+docker build -t proxlb .
+```
+
+Afterwards simply adjust the config file to your needs:
+```bash
+vi config/proxlb.yaml
+```
+
+Finally, start the created container.
+```bash
+docker run -it --rm -v $(pwd)/proxlb.yaml:/etc/proxlb/proxlb.yaml proxlb
+```
 
 ## Usage / Configuration
 Running ProxLB is straightforward and versatile, as it only requires `Python3` and the `proxmoxer` library. This means ProxLB can be executed directly on a Proxmox node or on dedicated systems such as Debian, RedHat, or even FreeBSD, provided that the Proxmox API is accessible from the client running ProxLB. ProxLB can also run inside a Container - Docker or LXC - and is simply up to you.
@@ -136,41 +232,48 @@ See also: [#65: Host groups: Honour HA groups](https://github.com/gyptazy/ProxLB
 ### Options
 The following options can be set in the configuration file `proxlb.yaml`:
 
-| Section | Option | Example | Type | Description |
-|------|:------:|:------:|:------:|:------:|
-| `proxmox_api` |  |  | |  |
-| | hosts | ['virt01.example.com', '10.10.10.10', 'fe01::bad:code::cafe'] | `List` | List of Proxmox nodes. Can be IPv4, IPv6 or mixed. |
-| | user | root@pam | `Str` | Username for the API. |
-| | pass | FooBar | `Str` | Password for the API. |
-| | ssl_verification | True | `Bool` | Validate SSL certificates (1) or ignore (0). (default: 1, type: bool) |
-| | timeout | 10 | `Int` | Timeout for the Proxmox API in sec. (default: 10) |
-| `proxmox_cluster` |  | | |  |
-| | maintenance_nodes | ['virt66.example.com'] | `List` | A list of Proxmox nodes that are defined to be in a maintenance. (default: []) |
-| | ignore_nodes | [] | `List` | A list of Proxmox nodes that are defined to be ignored.  (default: []) |
-| | overprovisioning | False | `Bool` | Avoids balancing when nodes would become overprovisioned. |
-| `balancing` |  | | |  |
-| | enable | True | `Bool` | Enables the guest balancing.  (default: True)|
-| | force | True | `Bool` | Enforcing affinity/anti-affinity rules but balancing might become worse.  (default: False) |
-| | parallel | False | `Bool` | If guests should be moved in parallel or sequentially. (default: False)|
-| | live | True | `Bool` | If guests should be moved live or shutdown.  (default: True)|
-| | with_local_disks | True | `Bool` | If balancing of guests should include local disks  (default: True)|
-| | balance_types | ['vm', 'ct'] | `List` | Defined the types of guests that should be honored.  (default: ['vm', 'ct']) |
-| | max_job_validation | 1800 | `Int` | How long a job validation may take in seconds. (default: 1800) |
-| | balanciness | 10 | `Int` | The maximum delta of resource usage between node with highest and lowest usage. (default: 10) |
-| | method | memory | `Str` | The balancing method that should be used.  (default: memory | choices: memory, cpu, disk)|
-| | mode | used | `Str` | The balancing mode that should be used.  (default: used | choices: used, assigned)|
-| `service` |  | | |  |
-| | daemon | False | `Bool` | If daemon mode should be activated  (default: False)|
-| | schedule | 12 | `Int` | How often rebalancing should occur in hours in daemon mode (default: 12)|
-| | log_level | INFO | `Str` | Defines the default log level that should be logged.  (default: INFO) |
+| Section | Option | Sub Option | Example | Type | Description |
+|---------|:------:|:----------:|:-------:|:----:|:-----------:|
+| `proxmox_api` |  |  |  |  |  |
+|  | hosts |  | ['virt01.example.com', '10.10.10.10', 'fe01::bad:code::cafe'] | `List` | List of Proxmox nodes. Can be IPv4, IPv6 or mixed. |
+|  | user |  | root@pam | `Str` | Username for the API. |
+|  | pass |  | FooBar | `Str` | Password for the API. (Recommended: Use API token authorization!) |
+|  | token_id |  | proxlb | `Str` | Token ID of the user for the API. |
+|  | token_secret |  | 430e308f-1337-1337-beef-1337beefcafe | `Str` | Secret of the token ID for the API. |
+|  | ssl_verification |  | True | `Bool` | Validate SSL certificates (1) or ignore (0). (default: 1, type: bool) |
+|  | timeout |  | 10 | `Int` | Timeout for the Proxmox API in sec. (default: 10) |
+| `proxmox_cluster` |  |  |  |  |  |
+|  | maintenance_nodes |  | ['virt66.example.com'] | `List` | A list of Proxmox nodes that are defined to be in a maintenance. (default: []) |
+|  | ignore_nodes |  | [] | `List` | A list of Proxmox nodes that are defined to be ignored.  (default: []) |
+|  | overprovisioning |  | False | `Bool` | Avoids balancing when nodes would become overprovisioned. |
+| `balancing` |  |  |  |  |  |
+|  | enable |  | True | `Bool` | Enables the guest balancing.  (default: True)|
+|  | enforce_affinity |  | True | `Bool` | Enforcing affinity/anti-affinity rules but balancing might become worse.  (default: False) |
+|  | parallel |  | False | `Bool` | If guests should be moved in parallel or sequentially. (default: False)|
+|  | live |  | True | `Bool` | If guests should be moved live or shutdown.  (default: True)|
+|  | with_local_disks |  | True | `Bool` | If balancing of guests should include local disks  (default: True)|
+|  | balance_types |  | ['vm', 'ct'] | `List` | Defined the types of guests that should be honored.  (default: ['vm', 'ct']) |
+|  | max_job_validation |  | 1800 | `Int` | How long a job validation may take in seconds. (default: 1800) |
+|  | balanciness |  | 10 | `Int` | The maximum delta of resource usage between node with highest and lowest usage. (default: 10) |
+|  | method |  | memory | `Str` | The balancing method that should be used.  (default: memory | choices: memory, cpu, disk)|
+|  | mode |  | used | `Str` | The balancing mode that should be used.  (default: used | choices: used, assigned)|
+| `service` |  |  |  |  |  |
+|  | daemon |  | True | `Bool` | If daemon mode should be activated  (default: True)|
+|  | `schedule` |  |  | `Dict` | Schedule config block for rebalancing. |
+|  |  | interval | 12 | `Int` | How often rebalancing should occur in daemon mode (default: 12)|
+|  |  | format | hours | `Str` | Sets the time format. (Allowed: `minutes`, `hours` | default: `hours`)|
+|  | log_level |  | INFO | `Str` | Defines the default log level that should be logged.  (default: INFO) |
+
 
 An example of the configuration file looks like:
 ```
 proxmox_api:
   hosts: ['virt01.example.com', '10.10.10.10', 'fe01::bad:code::cafe']
   user: root@pam
-  pass: crazyPassw0rd!
-  ssl_verification: False
+  #pass: crazyPassw0rd!
+  token_id: proxlb
+  token_secret: 430e308f-1337-1337-beef-1337beefcafe
+  ssl_verification: True
   timeout: 10
 
 proxmox_cluster:
@@ -180,7 +283,7 @@ proxmox_cluster:
 
 balancing:
   enable: True
-  force: False
+  enforce_affinity: False
   parallel: False
   live: True
   with_local_disks: True
@@ -188,12 +291,14 @@ balancing:
   max_job_validation: 1800
   balanciness: 5
   method: memory
-  mode: assigned
+  mode: used
 
 service:
-  daemon: False
-  schedule: 12
-  log_level: DEBUG
+  daemon: True
+  schedule:
+    interval: 12
+    format: hours
+  log_level: INFO
 ```
 
 ### Parameters
@@ -201,7 +306,7 @@ The following options and parameters are currently supported:
 
 | Option | Long Option | Description | Default |
 |------|:------:|------:|------:|
-| -c | --config | Path to a config file. | /etc/proxlb/proxlb.conf (default) |
+| -c | --config | Path to a config file. | /etc/proxlb/proxlb.yaml (default) |
 | -d | --dry-run | Performs a dry-run without doing any actions. | False |
 | -j | --json | Returns a JSON of the VM movement. | False |
 | -b | --best-node | Returns the best next node for a VM/CT placement (useful for further usage with Terraform/Ansible). | False |
@@ -238,20 +343,42 @@ As a result, ProxLB will try to place the VMs with the `plb_anti_affinity_ntp` t
 
 **Note:** While this ensures that ProxLB tries distribute these VMs across different physical hosts within the Proxmox cluster this may not always work. If you have more guests attached to the group than nodes in the cluster, we still need to run them anywhere. If this case occurs, the next one with the most free resources will be selected.
 
+### Ignore VMs / CTs
+<img align="left" src="https://cdn.gyptazy.com/images/proxlb-ignore-vm-movement.jpg"/> Guests, such as VMs or CTs, can also be completely ignored. This means, they won't be affected by any migration (even when (anti-)affinity rules are enforced). To ensure a proper resource evaluation, these guests are still collected and evaluated but simply skipped for balancing actions. Another thing is the implementation. While ProxLB might have a very restricted configuration file including the file permissions, this file is only read- and writeable by the Proxmox administrators. However, we might have user and groups who want to define on their own that their systems shouldn't be moved. Therefore, these users can simpy set a specific tag to the guest object - just like the (anti)affinity rules.
+
+To define a guest to be ignored from the balancing, users assign a tag with the prefix `plb_ignore_$TAG`:
+
+#### Example for Screenshot
+```
+plb_ignore_dev
+```
+
+As a result, ProxLB will not migrate this guest with the `plb_ignore_dev` tag to any other node.
+
+**Note:** Ignored guests are really ignored. Even by enforcing affinity rules this guest will be ignored.
+
 ## Maintenance
 <img src="https://cdn.gyptazy.com/images/proxlb-rebalancing-demo.gif"/>
 
 The `maintenance_nodes` option allows operators to designate one or more Proxmox nodes for maintenance mode. When a node is set to maintenance, no new guest workloads will be assigned to it, and all existing workloads will be migrated to other available nodes within the cluster. This process ensures that (anti)-affinity rules and resource availability are respected, preventing disruptions while maintaining optimal performance across the infrastructure.
 
+### Adding / Removing Nodes from Maintenance
+Within the section `proxmox_cluster` you can define the key `maintenance_nodes` as a list object. Simply add/remove one or more nodes with their equal name in the cluster and restart the daemon.
+```
+proxmox_cluster:
+  maintenance_nodes: ['virt66.example.com']
+```
+Afterwards, all guest objects will be moved to other nodes in the cluster by ensuring the best balancing.
+
 ## Misc
 ### Bugs
 Bugs can be reported via the GitHub issue tracker [here](https://github.com/gyptazy/ProxLB/issues). You may also report bugs via email or deliver PRs to fix them on your own. Therefore, you might also see the contributing chapter.
 
 ### Contributing
-Feel free to add further documentation, to adjust already existing one or to contribute with code. Please take care about the style guide and naming conventions. You can find more in our [CONTRIBUTING.md](https://github.com/gyptazy/ProxLB/blob/development/CONTRIBUTING.md) file.
+Feel free to add further documentation, to adjust already existing one or to contribute with code. Please take care about the style guide and naming conventions. You can find more in our [CONTRIBUTING.md](https://github.com/gyptazy/ProxLB/blob/main/CONTRIBUTING.md) file.
 
 ### Documentation
-You can also find additional and more detailed documentation within the [docs/](https://github.com/gyptazy/ProxLB/tree/development/docs) directory.
+You can also find additional and more detailed documentation within the [docs/](https://github.com/gyptazy/ProxLB/tree/main/docs) directory.
 
 ### Support
 If you need assistance or have any questions, we offer support through our dedicated [chat room](https://matrix.to/#/#proxlb:gyptazy.com) in Matrix or [Discord](https://discord.gg/JemGu7WbfQ). Join our community for real-time help, advice, and discussions. The Matrix and Discord room are bridged to ensure that the communication is not splitted - so simply feel free to join which fits most to you!
@@ -268,4 +395,4 @@ Connect with us in our dedicated chat room for immediate support and live intera
 **Note:** Please always keep in mind that this is a one-man show project without any further help. This includes coding, testing, packaging and all the infrastructure around it to keep this project up and running.
 
 ### Author(s)
- * Florian Paul Azim Hoberg @gyptazy (https://gyptazy.com)
+ * Florian Paul Azim Hoberg @gyptazy (https://gyptazy.com)

config/proxlb_example.yaml

@@ -2,7 +2,10 @@ proxmox_api:
   hosts: ['virt01.example.com', '10.10.10.10', 'fe01::bad:code::cafe']
   user: root@pam
   pass: crazyPassw0rd!
-  ssl_verification: False
+  # API Token method
+  # token_id: proxlb
+  # token_secret: 430e308f-1337-1337-beef-1337beefcafe
+  ssl_verification: True
   timeout: 10
 
 proxmox_cluster:
@@ -12,7 +15,7 @@ proxmox_cluster:
 
 balancing:
   enable: True
-  force: False
+  enforce_affinity: False
   parallel: False
   live: True
   with_local_disks: True
@@ -20,9 +23,11 @@ balancing:
   max_job_validation: 1800
   balanciness: 5
   method: memory
-  mode: assigned
+  mode: used
 
 service:
-  daemon: False
-  schedule: 12
-  log_level: DEBUG
+  daemon: True
+  schedule:
+    interval: 12
+    format: hours
+  log_level: INFO

debian/changelog

@@ -0,0 +1,12 @@
+proxlb (1.1.1) stable; urgency=medium
+
+  * Fix tag evluation for VMs for being ignored for further balancing. (Closes: #163)
+  * Improve logging verbosity of messages that had a wrong servity. (Closes: #165)
+
+ -- Florian Paul Azim Hoberg <gyptazy@gyptazy.com>  Tue, 1 Apr 2025 18:55:02 +0000
+
+proxlb (1.1.0) stable; urgency=medium
+
+  * Refactored code base of ProxLB. (Closes: #114)
+
+ -- Florian Paul Azim Hoberg <gyptazy@gyptazy.com>  Mon, 17 Mar 2025 18:55:02 +0000

debian/control

@@ -0,0 +1,12 @@
+Source: proxlb
+Maintainer: Florian Paul Azim Hoberg <gyptazy@gyptazy.com>
+Section: admin
+Priority: optional
+Standards-Version: 4.5.0
+Build-Depends: debhelper-compat (= 13), dh-python, python3-all, python3-setuptools
+
+Package: proxlb
+Architecture: all
+Depends: ${python3:Depends}, ${misc:Depends}, python3-requests, python3-urllib3, python3-proxmoxer, python3-yaml 
+Description: A DRS alike Load Balancer for Proxmox Clusters
+ An advanced DRS alike loadbalancer for Proxmox clusters that also supports maintenance modes and affinity/anti-affinity rules.

debian/install

@@ -0,0 +1,2 @@
+proxlb /usr/lib/python3/dist-packages/
+service/proxlb.service /lib/systemd/system/

debian/postinst

@@ -0,0 +1,16 @@
+#!/bin/bash
+set -e
+
+#DEBHELPER#
+if [ "$1" = "configure" ]; then
+    systemctl enable proxlb.service
+    systemctl restart proxlb.service || true
+
+    # Create the 'plb' user if it does not exist
+    if ! id "plb" &>/dev/null; then
+        useradd --system --home /var/lib/proxlb --create-home --shell /usr/sbin/nologin --group nogroup plb
+        echo "User 'plb' created."
+    else
+        echo "User 'plb' already exists, skipping creation."
+    fi
+fi

debian/prerm

@@ -0,0 +1,16 @@
+#!/bin/bash
+set -e
+
+#DEBHELPER#
+if [ "$1" = "remove" ]; then
+    systemctl stop proxlb.service || true
+    systemctl disable proxlb.service || true
+
+    # Remove the 'plb' user if it exists
+    if id "plb" &>/dev/null; then
+        userdel --remove plb
+        echo "User 'plb' removed."
+    else
+        echo "User 'plb' does not exist, skipping removal."
+    fi
+fi

debian/rules

@@ -0,0 +1,4 @@
+#!/usr/bin/make -f
+%:
+	dh $@ --with python3 --buildsystem=pybuild
+

debian/source/format

@@ -0,0 +1 @@
+3.0 (native)

docs/01_requirements.md

@@ -0,0 +1,65 @@
+# Table of Contents
+
+- [Requirements](#requirements)
+- [Where To Run?](#where-to-run)
+
+## Requirements
+ProxLB is a sophisticated load balancer designed to enhance the management and distribution of workloads within a Proxmox cluster. By fully utilizing the Proxmox API, ProxLB eliminates the need for additional SSH access, streamlining cluster management while maintaining robust security. This chapter outlines the general requirements necessary to deploy and operate ProxLB effectively.
+
+### Proxmox Cluster Requirements
+To use ProxLB, you must have an existing Proxmox cluster consisting of at least two nodes. While traditional load balancers often struggle to manage minimal node configurations, ProxLB is optimized to provide efficient load distribution even in a two-node environment. The more nodes present in the cluster, the better ProxLB can optimize resource usage and manage workloads.
+
+### ProxLB Package Requirements
+Next to the previously mentioned requirements, ProxLB also requires you to fit the following ones:
+* Python3.x
+* proxmoxer
+* requests
+* urllib3
+* pyyaml
+
+### Seamless API Integration
+ProxLB relies exclusively on the Proxmox API for all management tasks. This eliminates the need for direct SSH access, ensuring a cleaner and more secure interaction with the cluster. The API integration allows ProxLB to:
+
+- Monitor cluster health and node resource utilization
+- Migrate virtual machines (VMs) and containers as needed
+- Manage storage utilization and distribution
+- Implement load balancing policies
+
+### Authentication and Security Standards
+ProxLB fully supports Proxmox’s integrated user management system, providing robust authentication and access control. Key features include:
+
+- **Multi-Factor Authentication (MFA):** Enhances security by requiring multiple verification methods.
+- **API Key Support:** ProxLB can utilize API keys for authentication instead of traditional username/password combinations, minimizing exposure to credentials.
+- **Role-Based Access Control (RBAC):** Ensures administrators have fine-grained control over user permissions.
+
+### Flexible Storage Support
+ProxLB offers versatile storage management options, supporting both local and shared storage types. It efficiently balances storage workloads across the cluster using the following storage systems:
+
+- **Local Storage:** Direct-attached storage on each node.
+- **Shared Storage:** Includes options like iSCSI, NVMeOF, and NFS for centralized storage solutions.
+- **Ceph:** Integrated support for Ceph distributed storage, providing high availability and fault tolerance.
+
+### Network Infrastructure Requirements
+For optimal performance, ProxLB requires a reliable and high-speed network connection between the nodes in the cluster. Ensure that the network infrastructure meets the following criteria:
+
+- **Low Latency:** Essential for real-time load balancing and VM migration.
+- **Sufficient Bandwidth:** Adequate to handle storage access, data replication, and migration traffic.
+- **Redundant Network Paths:** Recommended for increased fault tolerance and uptime.
+
+### System Resource Allocation
+ProxLB itself requires minimal system resources to operate. However, for managing larger clusters or high workloads, ensure the node running ProxLB has adequate resources available:
+
+- **CPU:** A modern multi-core processor.
+- **Memory:** At least 2 GB of RAM.
+- **Storage:** Minimal disk space for configuration files and logs.
+
+
+## Where To Run?
+ProxLB can run on pretty anthing and only requires you to have a network connectivity to any of the Proxmox host's API (usually on tcp/8006).
+
+Therefore, you can simply run ProxLB on:
+* Bare-metal Systems
+* VMs (even inside the Proxmox cluster)
+* Docker/Podman Container
+* LXC Container
+* On a Proxmox node

docs/02_installation.md

@@ -0,0 +1,164 @@
+# Table of Contents
+
+- [Installation](#installation)
+  - [Requirements / Dependencies](#requirements--dependencies)
+  - [Debian Package](#debian-package)
+    - [Quick-Start](#quick-start)
+    - [Details](#details)
+    - [Debian Packages (.deb files)](#debian-packages-deb-files)
+  - [RedHat Package](#redhat-package)
+  - [Container Images / Docker](#container-images--docker)
+    - [Overview of Images](#overview-of-images)
+  - [Source](#source)
+    - [Traditional System](#traditional-system)
+    - [Container Image](#container-image)
+- [Upgrading](#upgrading)
+  - [Upgrading from < 1.1.0](#upgrading-from--110)
+  - [Upgrading from >= 1.1.0](#upgrading-from--110)
+
+
+## Installation
+### Requirements / Dependencies
+* Python3.x
+* proxmoxer
+* requests
+* urllib3
+* pyyaml
+
+The dependencies can simply be installed with `pip` by running the following command:
+```
+pip install -r requirements.txt
+```
+
+*Note: Distribution packages, such like the provided `.deb` package will automatically resolve and install all required dependencies by using already packaged version from the distribution's repository. By using the Docker (container) image or Debian packages, you do not need to take any care of the requirements listed here.*
+
+### Debian Package
+ProxLB is a powerful and flexible load balancer designed to work across various architectures, including `amd64`, `arm64`, `rv64` and many other ones that support Python. It runs independently of the underlying hardware, making it a versatile choice for different environments. This chapter covers the step-by-step process to install ProxLB on Debian-based systems, including Debian clones like Ubuntu.
+
+#### Quick-Start
+You can simply use this snippet to install the repository and to install ProxLB on your system.
+
+```bash
+echo "deb https://repo.gyptazy.com/stable /" > /etc/apt/sources.list.d/proxlb.list
+wget -O /etc/apt/trusted.gpg.d/proxlb.asc https://repo.gyptazy.com/repository.gpg
+apt-get update && apt-get -y install proxlb
+cp /etc/proxlb/proxlb_example.yaml /etc/proxlb/proxlb.yaml
+# Adjust the config to your needs
+vi /etc/proxlb/proxlb.yaml
+systemctl start proxlb
+```
+
+Afterwards, ProxLB is running in the background and balances your cluster by your defined balancing method (default: memory).
+
+#### Details
+ProxLB provides two different repositories:
+* https://repo.gyptazy.com/stable (only stable release)
+* https://repo.gyptazy.com/testing (bleeding edge - not recommended)
+
+The repository is signed and the GPG key can be found at:
+* https://repo.gyptazy.com/repository.gpg
+
+You can also simply import it by running:
+
+```
+# KeyID:  17169F23F9F71A14AD49EDADDB51D3EB01824F4C
+# UID:    gyptazy Solutions Repository <contact@gyptazy.com>
+# SHA256: 52c267e6f4ec799d40cdbdb29fa518533ac7942dab557fa4c217a76f90d6b0f3  repository.gpg
+
+wget -O /etc/apt/trusted.gpg.d/proxlb.asc https://repo.gyptazy.com/repository.gpg
+```
+
+*Note: The defined repositories `repo.gyptazy.com` and `repo.proxlb.de` are the same!*
+
+#### Debian Packages (.deb files)
+If you do not want to use the repository you can also find the debian packages as a .deb file on gyptazy's CDN at:
+* https://cdn.gyptazy.com/files/os/debian/proxlb/
+
+Afterwards, you can simply install the package by running:
+```bash
+dpkg -i proxlb_*.deb
+cp /etc/proxlb/proxlb_example.yaml /etc/proxlb/proxlb.yaml
+# Adjust the config to your needs
+vi /etc/proxlb/proxlb.yaml
+systemctl start proxlb
+```
+
+### RedHat Package
+There's currently no official support for RedHat based systems. However, there's a dummy .rpm package for such systems in the pipeline which can be found here:
+* https://github.com/gyptazy/ProxLB/actions/workflows/20-pipeline-build-rpm-package.yml
+
+
+### Container Images / Docker
+Using the ProxLB container images is straight forward and only requires you to mount the config file.
+
+```bash
+# Pull the image
+docker pull cr.gyptazy.com/proxlb/proxlb:latest
+# Download the config
+wget -O proxlb.yaml https://raw.githubusercontent.com/gyptazy/ProxLB/refs/heads/main/config/proxlb_example.yaml
+# Adjust the config to your needs
+vi proxlb.yaml
+# Start the ProxLB container image with the ProxLB config
+docker run -it --rm -v $(pwd)/proxlb.yaml:/etc/proxlb/proxlb.yaml proxlb
+```
+
+*Note: ProxLB container images are officially only available at cr.proxlb.de and cr.gyptazy.com.* 
+
+#### Overview of Images
+| Version | Image |
+|------|:------:|
+| latest | cr.gyptazy.com/proxlb/proxlb:latest |
+| v1.1.0 | cr.gyptazy.com/proxlb/proxlb:v1.1.0 |
+| v1.0.6 | cr.gyptazy.com/proxlb/proxlb:v1.0.6 |
+| v1.0.5 | cr.gyptazy.com/proxlb/proxlb:v1.0.5 |
+| v1.0.4 | cr.gyptazy.com/proxlb/proxlb:v1.0.4 |
+| v1.0.3 | cr.gyptazy.com/proxlb/proxlb:v1.0.3 |
+| v1.0.2 | cr.gyptazy.com/proxlb/proxlb:v1.0.2 |
+| v1.0.0 | cr.gyptazy.com/proxlb/proxlb:v1.0.0 |
+| v0.9.9 | cr.gyptazy.com/proxlb/proxlb:v0.9.9 |
+
+### Source
+ProxLB can also easily be used from the provided sources - for traditional systems but also as a Docker/Podman container image.
+
+#### Traditional System
+Setting up and running ProxLB from the sources is simple and requires just a few commands. Ensure Python 3 and the Python dependencies are installed on your system, then run ProxLB using the following command:
+```bash
+git clone https://github.com/gyptazy/ProxLB.git
+cd ProxLB
+```
+
+Afterwards simply adjust the config file to your needs:
+```bash
+vi config/proxlb.yaml
+```
+
+Start ProxLB by Python3 on the system:
+```bash
+python3 proxlb/main.py -c config/proxlb.yaml
+```
+
+#### Container Image
+Creating a container image of ProxLB is straightforward using the provided Dockerfile. The Dockerfile simplifies the process by automating the setup and configuration required to get ProxLB running in an Alpine container. Simply follow the steps in the Dockerfile to build the image, ensuring all dependencies and configurations are correctly applied. For those looking for an even quicker setup, a ready-to-use ProxLB container image is also available, eliminating the need for manual building and allowing for immediate deployment.
+
+```bash
+git clone https://github.com/gyptazy/ProxLB.git
+cd ProxLB
+docker build -t proxlb .
+```
+
+Afterwards simply adjust the config file to your needs:
+```bash
+vi config/proxlb.yaml
+```
+
+Finally, start the created container.
+```bash
+docker run -it --rm -v $(pwd)/proxlb.yaml:/etc/proxlb/proxlb.yaml proxlb
+```
+
+## Upgrading
+### Upgrading from < 1.1.0
+Upgrading ProxLB is not supported due to a fundamental redesign introduced in version 1.1.x. With this update, ProxLB transitioned from a monolithic application to a pure Python-style project, embracing a more modular and flexible architecture. This shift aimed to improve maintainability and extensibility while keeping up with modern development practices. Additionally, ProxLB moved away from traditional ini-style configuration files and adopted YAML for configuration management. This change simplifies configuration handling, reduces the need for extensive validation, and ensures better type casting, ultimately providing a more streamlined and user-friendly experience.
+
+### Upgrading from >= 1.1.0
+Uprading within the current stable versions, starting from 1.1.0, will be possible in all supported ways.

docs/03_configuration.md

@@ -0,0 +1,196 @@
+# Table of Contents
+
+1. [Authentication / User Accounts / Permissions](#authentication--user-accounts--permissions)
+    1. [Authentication](#authentication)
+    2. [Creating a Dedicated User](#creating-a-dedicated-user)
+    3. [Creating an API Token for a User](#creating-an-api-token-for-a-user)
+    4. [Required Permissions for a User](#required-permissions-for-a-user)
+2. [Configuration](#configuration)
+    1. [Affinity & Anti-Affinity Rules](#affinity--anti-affinity-rules)
+        1. [Affinity Rules](#affinity-rules)
+        2. [Anti-Affinity Rules](#anti-affinity-rules)
+        3. [Affinity / Anti-Affinity Enforcing](#affinity--anti-affinity-enforcing)
+        4. [Ignore VMs](#ignore-vms)
+    2. [API Loadbalancing](#api-loadbalancing)
+    3. [Ignore Host-Nodes or Guests](#ignore-host-nodes-or-guests)
+    4. [IPv6 Support](#ipv6-support)
+    5. [Logging / Log-Level](#logging--log-level)
+    6. [Parallel Migrations](#parallel-migrations)
+    7. [Run as a Systemd-Service](#run-as-a-systemd-service)
+    8. [SSL Self-Signed Certificates](#ssl-self-signed-certificates)
+
+## Authentication / User Accounts / Permissions
+### Authentication
+ProxLB supports the traditional username and password authentication method, which is familiar to many users. This method requires users to provide their credentials (username and password) to gain access to the Proxmox system. While this method is straightforward and easy to implement, it has several security limitations. Username and password combinations can be vulnerable to brute force attacks, where an attacker systematically attempts various combinations until the correct one is found. If a user's credentials are compromised through phishing, malware, or other means, the attacker can gain unauthorized access to the system. Additionally, traditional authentication does not provide granular control over permissions and access levels, potentially exposing sensitive operations to unauthorized users.
+
+To enhance security, ProxLB supports API token authentication. API tokens are unique identifiers that are used to authenticate API requests. They offer several advantages over traditional username and password authentication. API tokens are more secure as they are typically long, random strings that are difficult to guess. They can be revoked and regenerated as needed, reducing the risk of unauthorized access. API tokens can be associated with specific user accounts that have only the required permissions, ensuring that users only have access to the resources and operations they need. Furthermore, API tokens can be used for automated scripts and applications, facilitating seamless integration with other systems and services.
+
+When Multi-Factor Authentication (MFA) or Two-Factor Authentication (2FA) is enabled in the Proxmox cluster, the system enforces the use of API tokens for authentication. This is because traditional username and password authentication is not considered secure enough in conjunction with MFA/2FA. To ensure the highest level of security when using API tokens, follow these best practices: Use dedicated user accounts for API tokens, each with only the necessary permissions. This limits the potential impact of a compromised token. Ensure that API tokens are long, random, and unique. Avoid using easily guessable patterns or sequences. Periodically regenerate and replace API tokens to minimize the risk of long-term exposure. Store API tokens securely, using environment variables or secure vaults. Avoid hardcoding tokens in source code or configuration files. Regularly monitor and audit the usage of API tokens to detect any suspicious activity or unauthorized access.
+
+### Creating a Dedicated User
+It is advisable to avoid using the default root@pam user for balancing tasks in ProxLB. Instead, creating a dedicated user account is recommended and can be done easily. You can create a new user through the GUI, API, or CLI. While the detailed roles required for balancing are outlined in the next chapter, you can also use the following CLI commands to create a user with the necessary roles to manage Virtual Machines (VMs) and Containers (CTs):
+
+```
+pveum role add proxlb --privs Datastore.Audit,Sys.Audit,VM.Audit,VM.Migrate
+pveum user add proxlb@pve --password <password>
+pveum acl modify / --roles proxlb --users proxlb@pve
+```
+
+*Note: The user management can also be done on the WebUI without invoking the CLI.*
+
+### Creating an API Token for a User
+
+```
+# Create an API token for user proxlb@pve with token ID proxlb
+pveum user token add proxlb@pve proxlb
+```
+
+Afterwards, you get the token secret returned. You can now add those entries to your ProxLB config. Make sure, that you also keep the `user` parameter, next to the new token parameters.
+
+> [!IMPORTANT]  
+> The parameter `pass` then needs to be **absent**! You should also take care about the privilege and authentication mechanism behind Proxmox. You might want or even might not want to use privilege separation and this is up to your personal needs and use case.
+
+| Proxmox API  | ProxLB Config  | Example  |
+|---|---|---|
+| User  | [user](https://github.com/gyptazy/ProxLB/blob/main/config/proxlb_example.yaml#L3) | proxlb@pve  |
+| Token ID  | [token_id](https://github.com/gyptazy/ProxLB/blob/main/config/proxlb_example.yaml#L6) | proxlb  |
+| Token Secret  | [token_secret](https://github.com/gyptazy/ProxLB/blob/main/config/proxlb_example.yaml#L7)  |  430e308f-1337-1337-beef-1337beefcafe |
+
+*Note: The API token configuration can also be done on the WebUI without invoking the CLI.*
+
+### Required Permissions for a User
+To ensure that ProxLB operates effectively and securely, it is essential to assign the appropriate permissions to the user accounts responsible for managing the load balancing tasks. The following permissions are the minimum required for a user to perform essential ProxLB operations:
+
+* `Datastore.Audit`: Grants the ability to audit and view datastore information.
+* `Sys.Audit`: Allows the user to audit and view system information.
+* `VM.Audit`: Enables the user to audit and view virtual machine details.
+* `VM.Migrate`: Provides the permission to migrate virtual machines.
+
+Assigning these permissions ensures that the user can access necessary information and perform critical operations related to load balancing without granting excessive privileges. This practice helps maintain a secure and efficient ProxLB environment.
+
+## Configuration
+
+### Affinity & Anti-Affinity Rules
+ProxLB provides an advanced mechanism to define affinity and anti-affinity rules, enabling precise control over virtual machine (VM) placement. These rules help manage resource distribution, improve high availability configurations, and optimize performance within a Proxmox Virtual Environment (PVE) cluster. By leveraging Proxmox’s integrated access management, ProxLB ensures that users can only define and manage rules for guests they have permission to access.
+
+ProxLB implements affinity and anti-affinity rules through a tag-based system within the Proxmox web interface. Each guest (virtual machine or container) can be assigned specific tags, which then dictate its placement behavior. This method maintains a streamlined and secure approach to managing VM relationships while preserving Proxmox’s inherent permission model.
+
+#### Affinity Rules
+<img align="left" src="https://cdn.gyptazy.com/images/proxlb-affinity-rules.jpg"/> Affinity rules are used to group certain VMs together, ensuring that they run on the same host whenever possible. This can be beneficial for workloads requiring low-latency communication, such as clustered databases or application servers that frequently exchange data.
+
+To define an affinity rule which keeps all guests assigned to this tag together on a node, users assign a tag with the prefix `plb_affinity_$TAG`:
+
+##### Example for Screenshot
+```
+plb_affinity_talos
+```
+
+As a result, ProxLB will attempt to place all VMs with the `plb_affinity_web` tag on the same host (see also the attached screenshot with the same node).
+
+#### Anti-Affinity Rules
+<img align="left" src="https://cdn.gyptazy.com/images/proxlb-anti-affinity-rules.jpg"/> Conversely, anti-affinity rules ensure that designated VMs do not run on the same physical host. This is particularly useful for high-availability setups, where redundancy is crucial. Ensuring that critical services are distributed across multiple hosts reduces the risk of a single point of failure.
+
+To define an anti-affinity rule that ensures to not move systems within this group to the same node, users assign a tag with the prefix:
+
+##### Example for Screenshot
+```
+plb_anti_affinity_ntp
+```
+
+As a result, ProxLB will try to place the VMs with the `plb_anti_affinity_ntp` tag on different hosts (see also the attached screenshot with the different nodes).
+
+**Note:** While this ensures that ProxLB tries distribute these VMs across different physical hosts within the Proxmox cluster this may not always work. If you have more guests attached to the group than nodes in the cluster, we still need to run them anywhere. If this case occurs, the next one with the most free resources will be selected.
+
+### Affinity / Anti-Affinity Enforcing
+When a cluster is already balanced and does not require further adjustments, enabling the enforce_affinity parameter ensures that affinity and anti-affinity rules are still respected. This parameter prioritizes the placement of guest objects according to these rules, even if it leads to slight resource imbalances or increased migration overhead. Regularly reviewing and updating these rules, along with monitoring cluster performance, helps maintain optimal performance and reliability. By carefully managing these aspects, you can create a cluster environment that meets your specific needs and maintains a good balance of resources.
+
+```
+balancing:
+  enforce_affinity: True
+```
+
+*Note: This may have impacts to the cluster. Depending on the created group matrix, the result may also be an unbalanced cluster.*
+
+### Ignore VMs / CTs
+<img align="left" src="https://cdn.gyptazy.com/images/proxlb-ignore-vm-movement.jpg"/> Guests, such as VMs or CTs, can also be completely ignored. This means, they won't be affected by any migration (even when (anti-)affinity rules are enforced). To ensure a proper resource evaluation, these guests are still collected and evaluated but simply skipped for balancing actions. Another thing is the implementation. While ProxLB might have a very restricted configuration file including the file permissions, this file is only read- and writeable by the Proxmox administrators. However, we might have user and groups who want to define on their own that their systems shouldn't be moved. Therefore, these users can simpy set a specific tag to the guest object - just like the (anti)affinity rules.
+
+To define a guest to be ignored from the balancing, users assign a tag with the prefix `plb_ignore_$TAG`:
+
+#### Example for Screenshot
+```
+plb_ignore_dev
+```
+
+As a result, ProxLB will not migrate this guest with the `plb_ignore_dev` tag to any other node.
+
+**Note:** Ignored guests are really ignored. Even by enforcing affinity rules this guest will be ignored.
+
+### API Loadbalancing
+ProxLB supports API loadbalancing, where one or more host objects can be defined as a list. This ensures, that you can even operator ProxLB without further changes when one or more nodes are offline or in a maintenance. When defining multiple hosts, the first reachable one will be picked.
+
+```
+proxmox_api:
+  hosts: ['virt01.example.com', '10.10.10.10', 'fe01::bad:code::cafe']
+```
+
+### Ignore Host-Nodes or Guests
+In managing a Proxmox environment, it's often necessary to exclude certain host nodes and guests from various operations. For host nodes, this exclusion can be achieved by specifying them in the ignore_nodes parameter within the proxmox_api chapter, effectively preventing any automated processes from interacting with these nodes. Guests, on the other hand, can be ignored by assigning them a specific tag that starts with or is equal to plb_ignore, ensuring they are omitted from any automated tasks or monitoring. By implementing these configurations, administrators can fine-tune their Proxmox management to focus only on relevant nodes and guests, optimizing operational efficiency and resource allocation.
+
+```
+proxmox_cluster:
+  ignore_nodes: ['node01', 'node02']
+```
+
+### IPv6 Support
+Yes, ProxLB fully supports IPv6.
+
+### Logging / Log-Level
+ProxLB supports systemd for seamless service management on Linux distributions. To enable this, create a proxLB.service file in /etc/systemd/system/ from `service/proxlb.service` within this repository.
+
+On systems without systemd, such as FreeBSD and macOS, ProxLB runs with similar configurations but logs to stdout and stderr. The logging level and verbosity can be set in the `service` section of the configuration file:
+
+```
+service:
+  log_level: DEBUG
+```
+
+ProxLB only support the following log levels:
+* INFO
+* WARNING
+* CRITICAL
+* DEBUG
+
+### Parallel Migrations
+By default, parallel migrations are deactivated. This means, that a guest object gets migrated and the migration job is being watched until the VM or CT got moved to a new node. However, this may take a lot of time and many environments are fast enough to handle the IO load for multiple guest objects. However, there are always corner cases and this depends on your setup. Parallel migrations can be enabled by setting `parallel` to `True` within the `balancing` chapter:
+
+```
+balancing:
+  parallel: False
+```
+
+### Run as a Systemd-Service
+The proxlb systemd unit orchestrates the ProxLB application. ProxLB can be used either as a one-shot solution or run periodically, depending on the configuration specified in the daemon chapter of its configuration file.
+
+```
+service:
+  daemon: False
+    schedule:
+      interval: 12
+      format: hours
+```
+
+In this configuration:
+* `daemon`: False indicates that the ProxLB application is not running as a daemon and will execute as a one-shot solution.
+* `schedule`: 12 defines the interval for the schedule, specifying how often rebalancing should be done if running as a daemon.
+* `format`: Defines the given format of schedule where you can choose between `hours` or `minutes`.
+
+### SSL Self-Signed Certificates
+If you are using SSL self-signed certificates or non-valid certificated in general and do not want to deal with additional trust levels, you may also disable the SSL validation. This may mostly be helpful for dev- & test labs.
+
+SSL certificate validation can be disabled in the `proxmox_api` section in the config file by setting:
+```
+proxmox_api:
+    ssl_verification: False
+```
+
+*Note: Disabling SSL certificate validation is not recommended.*

docs/99-faq.md

@@ -0,0 +1,24 @@
+## Table of Contents
+
+1. [GUI Integration](#gui-integration)
+    - [How to install pve-proxmoxlb-service-ui package](https://github.com/gyptazy/ProxLB/issues/44)
+2. [Proxmox HA Integration](#proxmox-ha-integration)
+    - [Host groups: Honour HA groups](https://github.com/gyptazy/ProxLB/issues/65)
+
+### GUI Integration
+<img align="left" src="https://cdn.gyptazy.com/images/proxlb-GUI-integration.jpg"/> ProxLB can also be accessed through the Proxmox Web UI by installing the optional `pve-proxmoxlb-service-ui` package, which depends on the proxlb package. For full Web UI integration, this package must be installed on all nodes within the cluster. Once installed, a new menu item - `Rebalancing`, appears in the cluster level under the HA section. Once installed, it offers two key functionalities:
+* Rebalancing VM workloads
+* Migrate VM workloads away from a defined node (e.g. maintenance preparation)
+
+**Note:** This package is currently discontinued and will be readded at a later time. See also: [#44: How to install pve-proxmoxlb-service-ui package](https://github.com/gyptazy/ProxLB/issues/44).
+
+### Proxmox HA Integration
+Proxmox HA (High Availability) groups are designed to ensure that virtual machines (VMs) remain running within a Proxmox cluster. HA groups define specific rules for where VMs should be started or migrated in case of node failures, ensuring minimal downtime and automatic recovery.
+
+However, when used in conjunction with ProxLB, the built-in load balancer for Proxmox, conflicts can arise. ProxLB operates with its own logic for workload distribution, taking into account affinity and anti-affinity rules. While it effectively balances guest workloads, it may re-shift and redistribute VMs in a way that does not align with HA group constraints, potentially leading to unsuitable placements.
+
+Due to these conflicts, it is currently not recommended to use both HA groups and ProxLB simultaneously. The interaction between the two mechanisms can lead to unexpected behavior, where VMs might not adhere to HA group rules after being moved by ProxLB.
+
+A solution to improve compatibility between HA groups and ProxLB is under evaluation, aiming to ensure that both features can work together without disrupting VM placement strategies.
+
+See also: [#65: Host groups: Honour HA groups](https://github.com/gyptazy/ProxLB/issues/65).

misc/01-replace-version.sh

@@ -1,6 +1,6 @@
 #!/usr/bin/env bash
-VERSION="1.1.0-alpha"
+VERSION="1.1.1"
 
 sed -i "s/^__version__ = .*/__version__ = \"$VERSION\"/" "proxlb/utils/version.py"
 sed -i "s/version=\"[0-9]*\.[0-9]*\.[0-9]*\"/version=\"$VERSION\"/" setup.py
-echo "OK: Versions have been sucessfully set to $VERSION"
+echo "OK: Versions have been sucessfully set to $VERSION"

proxlb/main.py

@@ -7,6 +7,11 @@ perform balancing actions based on the configuration provided. It also includes
 parser for handling command-line arguments and a custom logger for systemd integration.
 """
 
+__author__ = "Florian Paul Azim Hoberg <gyptazy>"
+__copyright__ = "Copyright (C) 2025 Florian Paul Azim Hoberg (@gyptazy)"
+__license__ = "GPL-3.0"
+
+
 import logging
 from utils.logger import SystemdLogger
 from utils.cli_parser import CliParser
@@ -49,7 +54,7 @@ def main():
         # Get all required objects from the Proxmox cluster
         meta = {"meta": proxlb_config}
         nodes = Nodes.get_nodes(proxmox_api, proxlb_config)
-        guests = Guests.get_guests(proxmox_api, nodes)
+        guests = Guests.get_guests(proxmox_api, nodes, meta)
         groups = Groups.get_groups(guests, nodes)
 
         # Merge obtained objects from the Proxmox cluster for further usage
@@ -66,9 +71,12 @@ def main():
         Helper.log_node_metrics(proxlb_data, init=False)
 
         # Perform balancing actions via Proxmox API
-        if not cli_args.dry_run:
+        if not cli_args.dry_run or not proxlb_data["meta"]["balancing"].get("enable", False):
             Balancing(proxmox_api, proxlb_data)
 
+        # Validate if the JSON output should be
+        # printed to stdout
+        Helper.print_json(proxlb_data, cli_args.json)
         # Validate daemon mode
         Helper.get_daemon_mode(proxlb_config)
 

proxlb/models/balancing.py

@@ -1,10 +1,15 @@
 """
-The balancing class is responsible for processing workloads on Proxmox clusters.
-The previously generated data (hold in proxlb_data) will processed and guests and
-other supported types will be moved across Proxmox clusters based on the defined
-values by an operator.
+The Balancing class is responsible for processing workloads on Proxmox clusters.
+It processes the previously generated data (held in proxlb_data) and moves guests
+and other supported types across Proxmox clusters based on the defined values by an operator.
 """
 
+
+__author__ = "Florian Paul Azim Hoberg <gyptazy>"
+__copyright__ = "Copyright (C) 2025 Florian Paul Azim Hoberg (@gyptazy)"
+__license__ = "GPL-3.0"
+
+
 import proxmoxer
 import time
 from utils.logger import SystemdLogger
@@ -19,6 +24,23 @@ class Balancing:
     The previously generated data (hold in proxlb_data) will processed and guests and
     other supported types will be moved across Proxmox clusters based on the defined
     values by an operator.
+
+    Methods:
+    __init__(self, proxmox_api: any, proxlb_data: Dict[str, Any]):
+        Initializes the Balancing class with the provided ProxLB data and initiates the rebalancing
+        process for guests.
+
+    exec_rebalancing_vm(self, proxmox_api: any, proxlb_data: Dict[str, Any], guest_name: str) -> None:
+        Executes the rebalancing of a virtual machine (VM) to a new node within the cluster. Logs the migration
+        process and handles exceptions.
+
+    exec_rebalancing_ct(self, proxmox_api: any, proxlb_data: Dict[str, Any], guest_name: str) -> None:
+        Executes the rebalancing of a container (CT) to a new node within the cluster. Logs the migration
+        process and handles exceptions.
+
+    get_rebalancing_job_status(self, proxmox_api: any, proxlb_data: Dict[str, Any], guest_name: str, guest_current_node: str, job_id: int, retry_counter: int = 1) -> bool:
+        Monitors the status of a rebalancing job on a Proxmox node until it completes or a timeout
+        is reached. Returns True if the job completed successfully, False otherwise.
     """
 
     def __init__(self, proxmox_api: any, proxlb_data: Dict[str, Any]):
@@ -30,22 +52,30 @@ class Balancing:
         """
         for guest_name, guest_meta in proxlb_data["guests"].items():
 
+            # Check if the guest's target is not the same as the current node
             if guest_meta["node_current"] != guest_meta["node_target"]:
-                guest_id = guest_meta["id"]
-                guest_node_current = guest_meta["node_current"]
-                guest_node_target = guest_meta["node_target"]
+                # Check if the guest is not ignored and perform the balancing
+                # operation based on the guest type
+                if not guest_meta["ignore"]:
+                    guest_id = guest_meta["id"]
+                    guest_node_current = guest_meta["node_current"]
+                    guest_node_target = guest_meta["node_target"]
 
-                # VM Balancing
-                if guest_meta["type"] == "vm":
-                    self.exec_rebalancing_vm(proxmox_api, proxlb_data, guest_name)
+                    # VM Balancing
+                    if guest_meta["type"] == "vm":
+                        self.exec_rebalancing_vm(proxmox_api, proxlb_data, guest_name)
 
-                # CT Balancing
-                elif guest_meta["type"] == "ct":
-                    self.exec_rebalancing_ct(proxmox_api, proxlb_data, guest_name)
+                    # CT Balancing
+                    elif guest_meta["type"] == "ct":
+                        self.exec_rebalancing_ct(proxmox_api, proxlb_data, guest_name)
 
-                # Hopefully never reaching, but should be catched
+                    # Just in case we get a new type of guest in the future
+                    else:
+                        logger.critical(f"Balancing: Got unexpected guest type: {guest_meta['type']}. Cannot proceed guest: {guest_meta['name']}.")
                 else:
-                    logger.critical(f"Balancing: Got unexpected guest type: {guest_meta['type']}. Cannot proceed guest: {guest_meta['name']}.")
+                    logger.debug(f"Balancing: Guest {guest_name} is ignored and will not be rebalanced.")
+            else:
+                logger.debug(f"Balancing: Guest {guest_name} is already on the target node {guest_meta['node_target']} and will not be rebalanced.")
 
     def exec_rebalancing_vm(self, proxmox_api: any, proxlb_data: Dict[str, Any], guest_name: str) -> None:
         """
@@ -86,10 +116,10 @@ class Balancing:
         try:
             logger.debug(f"Balancing: Starting to migrate guest {guest_name} of type VM.")
             job_id = proxmox_api.nodes(guest_node_current).qemu(guest_id).migrate().post(**migration_options)
-            job = self.get_rebalancing_job_status(proxmox_api, proxlb_data, guest_name, guest_node_current, job_id)
+            self.get_rebalancing_job_status(proxmox_api, proxlb_data, guest_name, guest_node_current, job_id)
         except proxmoxer.core.ResourceException as proxmox_api_error:
-            logger.critical(f"Balancing: Failed to migrate guest {guest_name} of type CT due to some Proxmox errors. Please check if resource is locked or similar.")
-
+            logger.critical(f"Balancing: Failed to migrate guest {guest_name} of type VM due to some Proxmox errors. Please check if resource is locked or similar.")
+            logger.debug(f"Balancing: Failed to migrate guest {guest_name} of type VM due to some Proxmox errors: {proxmox_api_error}")
         logger.debug("Finished: exec_rebalancing_vm.")
 
     def exec_rebalancing_ct(self, proxmox_api: any, proxlb_data: Dict[str, Any], guest_name: str) -> None:
@@ -115,10 +145,10 @@ class Balancing:
         try:
             logger.debug(f"Balancing: Starting to migrate guest {guest_name} of type CT.")
             job_id = proxmox_api.nodes(guest_node_current).lxc(guest_id).migrate().post(target=guest_node_target, restart=1)
-            job = self.get_rebalancing_job_status(proxmox_api, proxlb_data, guest_name, guest_node_current, job_id)
+            self.get_rebalancing_job_status(proxmox_api, proxlb_data, guest_name, guest_node_current, job_id)
         except proxmoxer.core.ResourceException as proxmox_api_error:
             logger.critical(f"Balancing: Failed to migrate guest {guest_name} of type CT due to some Proxmox errors. Please check if resource is locked or similar.")
-
+            logger.debug(f"Balancing: Failed to migrate guest {guest_name} of type CT due to some Proxmox errors: {proxmox_api_error}")
         logger.debug("Finished: exec_rebalancing_ct.")
 
     def get_rebalancing_job_status(self, proxmox_api: any, proxlb_data: Dict[str, Any], guest_name: str, guest_current_node: str, job_id: int, retry_counter: int = 1) -> bool:
@@ -162,7 +192,7 @@ class Balancing:
             if job["status"] == "stopped":
 
                 if job["exitstatus"] == "OK":
-                    logger.debug(f"Balancing: Job ID {job_id} (guest: {guest_name}) was sucessfully.")
+                    logger.debug(f"Balancing: Job ID {job_id} (guest: {guest_name}) was successfully.")
                     logger.debug("Finished: get_rebalancing_job_status.")
                     return True
                 else:

proxlb/models/calculations.py

@@ -1,9 +1,15 @@
 """
-The calculation class is responsible for handling the balancing of virtual machines (VMs)
+The Calculations class is responsible for handling the balancing of virtual machines (VMs)
 and containers (CTs) across all available nodes in a Proxmox cluster. It provides methods
 to calculate the optimal distribution of VMs and CTs based on the provided data.
 """
 
+
+__author__ = "Florian Paul Azim Hoberg <gyptazy>"
+__copyright__ = "Copyright (C) 2025 Florian Paul Azim Hoberg (@gyptazy)"
+__license__ = "GPL-3.0"
+
+
 import sys
 from typing import Dict, Any
 from utils.logger import SystemdLogger
@@ -16,6 +22,37 @@ class Calculations:
     The calculation class is responsible for handling the balancing of virtual machines (VMs)
     and containers (CTs) across all available nodes in a Proxmox cluster. It provides methods
     to calculate the optimal distribution of VMs and CTs based on the provided data.
+
+    Methods:
+    __init__(proxlb_data: Dict[str, Any]):
+        Initializes the Calculation class with the provided ProxLB data.
+
+    set_node_assignments(proxlb_data: Dict[str, Any]) -> Dict[str, Any]:
+        Sets the assigned resources of the nodes based on the current assigned
+        guest resources by their created groups as an initial base.
+
+    get_balanciness(proxlb_data: Dict[str, Any]) -> Dict[str, Any]:
+        Gets the balanciness for further actions where the highest and lowest
+        usage or assignments of Proxmox nodes are compared.
+
+    get_most_free_node(proxlb_data: Dict[str, Any], return_node: bool = False) -> Dict[str, Any]:
+        Gets the name of the Proxmox node in the cluster with the most free resources based on
+        the user-defined method (e.g., memory) and mode (e.g., used).
+
+    relocate_guests_on_maintenance_nodes(proxlb_data: Dict[str, Any]):
+        Relocates guests that are currently on nodes marked for maintenance to
+        nodes with the most available resources.
+
+    relocate_guests(proxlb_data: Dict[str, Any]):
+        Relocates guests within the provided data structure to ensure affinity groups are
+        placed on nodes with the most free resources.
+
+    val_anti_affinity(proxlb_data: Dict[str, Any], guest_name: str):
+        Validates and assigns nodes to guests based on anti-affinity rules.
+
+    update_node_resources(proxlb_data):
+        Updates the resource allocation and usage statistics for nodes when a guest
+        is moved from one node to another.
     """
 
     def __init__(self, proxlb_data: Dict[str, Any]):
@@ -29,7 +66,7 @@ class Calculations:
     @staticmethod
     def set_node_assignments(proxlb_data: Dict[str, Any]) -> Dict[str, Any]:
         """
-        Set the assigned ressources of the nodes based on the current assigned
+        Set the assigned resources of the nodes based on the current assigned
         guest resources by their created groups as an initial base.
 
         Args:
@@ -82,10 +119,8 @@ class Calculations:
             if method_value_highest - method_value_lowest > balanciness:
                 proxlb_data["meta"]["balancing"]["balance"] = True
                 logger.debug(f"Guest balancing is required. Highest value: {method_value_highest}, lowest value: {method_value_lowest} balanced by {method} and {mode}.")
-                logger.critical(f"Guest balancing is required. Highest value: {method_value_highest}, lowest value: {method_value_lowest} balanced by {method} and {mode}.")
             else:
                 logger.debug(f"Guest balancing is ok. Highest value: {method_value_highest}, lowest value: {method_value_lowest} balanced by {method} and {mode}.")
-                logger.critical(f"Guest balancing is ok. Highest value: {method_value_highest}, lowest value: {method_value_lowest} balanced by {method} and {mode}.")
 
         else:
             logger.warning("No guests for balancing found.")
@@ -112,7 +147,9 @@ class Calculations:
 
         # Do not include nodes that are marked in 'maintenance'
         filtered_nodes = [node for node in proxlb_data["nodes"].values() if not node["maintenance"]]
-        lowest_usage_node = min(filtered_nodes, key=lambda x: x["memory_used_percent"])
+        method = proxlb_data["meta"]["balancing"].get("method", "memory")
+        mode = proxlb_data["meta"]["balancing"].get("mode", "used")
+        lowest_usage_node = min(filtered_nodes, key=lambda x: x[f"{method}_{mode}_percent"])
         proxlb_data["meta"]["balancing"]["balance_reason"] = 'resources'
         proxlb_data["meta"]["balancing"]["balance_next_node"] = lowest_usage_node["name"]
 
@@ -170,13 +207,13 @@ class Calculations:
         None
         """
         logger.debug("Starting: relocate_guests.")
-        if proxlb_data["meta"]["balancing"]["balance"] or proxlb_data["meta"]["balancing"]["force"]:
+        if proxlb_data["meta"]["balancing"]["balance"] or proxlb_data["meta"]["balancing"].get("enforce_affinity", False):
 
             if proxlb_data["meta"]["balancing"].get("balance", False):
-                logger.debug("Balancing of guests will be performt. Reason: balanciness")
+                logger.debug("Balancing of guests will be performed. Reason: balanciness")
 
-            if proxlb_data["meta"]["balancing"].get("force", False):
-                logger.debug("Balancing of guests will be performt. Reason: force balancing")
+            if proxlb_data["meta"]["balancing"].get("enforce_affinity", False):
+                logger.debug("Balancing of guests will be performed. Reason: enforce affinity balancing")
 
             for group_name in proxlb_data["groups"]["affinity"]:
 
@@ -211,10 +248,10 @@ class Calculations:
         None
         """
         logger.debug("Starting: val_anti_affinity.")
-        # Start by interating over all defined anti-affinity groups
+        # Start by iterating over all defined anti-affinity groups
         for group_name in proxlb_data["groups"]["anti_affinity"].keys():
 
-            # Validate if the provided guest ist included in the anti-affinity group
+            # Validate if the provided guest is included in the anti-affinity group
             if guest_name in proxlb_data["groups"]["anti_affinity"][group_name]['guests'] and not proxlb_data["guests"][guest_name]["processed"]:
                 logger.debug(f"Anti-Affinity: Guest: {guest_name} is included in anti-affinity group: {group_name}.")
 

proxlb/models/groups.py

@@ -1,9 +1,15 @@
 """
-The groups class is responsible for handling the correlations between the guests
-and their groups like affinity and anti-affinity groups. To ensure a proper balancing
-guests will ge grouped and then evaluated for further balancing.
+The Groups class is responsible for handling the correlations between the guests
+and their groups, such as affinity and anti-affinity groups. It ensures proper balancing
+by grouping guests and evaluating them for further balancing. The class provides methods
+to initialize with ProxLB data and to generate groups based on guest and node data.
 """
 
+__author__ = "Florian Paul Azim Hoberg <gyptazy>"
+__copyright__ = "Copyright (C) 2025 Florian Paul Azim Hoberg (@gyptazy)"
+__license__ = "GPL-3.0"
+
+
 from typing import Dict, Any
 from utils.logger import SystemdLogger
 from utils.helper import Helper
@@ -16,6 +22,14 @@ class Groups:
     The groups class is responsible for handling the correlations between the guests
     and their groups like affinity and anti-affinity groups. To ensure a proper balancing
     guests will ge grouped and then evaluated for further balancing.
+
+    Methods:
+        __init__(proxlb_data: Dict[str, Any]):
+            Initializes the Groups class.
+
+        get_groups(guests: Dict[str, Any], nodes: Dict[str, Any]) -> Dict[str, Any]:
+            Generates and returns a dictionary of affinity and anti-affinity groups
+            based on the provided data.
     """
 
     def __init__(self, proxlb_data: Dict[str, Any]):

proxlb/models/guests.py

@@ -3,9 +3,15 @@ The Guests class retrieves all running guests on the Proxmox cluster across all
 It handles both VM and CT guest types, collecting their resource metrics.
 """
 
+__author__ = "Florian Paul Azim Hoberg <gyptazy>"
+__copyright__ = "Copyright (C) 2025 Florian Paul Azim Hoberg (@gyptazy)"
+__license__ = "GPL-3.0"
+
+
 from typing import Dict, Any
 from utils.logger import SystemdLogger
 from models.tags import Tags
+import time
 
 logger = SystemdLogger()
 
@@ -14,6 +20,14 @@ class Guests:
     """
     The Guests class retrieves all running guests on the Proxmox cluster across all available nodes.
     It handles both VM and CT guest types, collecting their resource metrics.
+
+    Methods:
+        __init__:
+            Initializes the Guests class.
+
+        get_guests(proxmox_api: any, nodes: Dict[str, Any]) -> Dict[str, Any]:
+            Retrieves metrics for all running guests (both VMs and CTs) across all nodes in the Proxmox cluster.
+            It collects resource metrics such as CPU, memory, and disk usage, as well as tags and affinity/anti-affinity groups.
     """
     def __init__(self):
         """
@@ -21,7 +35,7 @@ class Guests:
         """
 
     @staticmethod
-    def get_guests(proxmox_api: any, nodes: Dict[str, Any]) -> Dict[str, Any]:
+    def get_guests(proxmox_api: any, nodes: Dict[str, Any], meta: Dict[str, Any]) -> Dict[str, Any]:
         """
         Get metrics of all guests in a Proxmox cluster.
 
@@ -48,10 +62,22 @@ class Guests:
             # resource metrics for rebalancing to ensure that we do not overprovisiong the node.
             for guest in proxmox_api.nodes(node).qemu.get():
                 if guest['status'] == 'running':
+
+                    # If the balancing method is set to cpu, we need to wait for the guest to report
+                    # cpu usage. This is important for the balancing process to ensure that we do not
+                    # wait for a guest for an infinite time.
+                    if meta["meta"]["balancing"]["method"] == "cpu":
+                        retry_counter = 0
+                        while guest['cpu'] == 0 and retry_counter < 10:
+                            guest = proxmox_api.nodes(node).qemu(guest['vmid']).status.current.get()
+                            logger.debug(f"Guest {guest['name']} (type VM) is reporting {guest['cpu']} cpu usage on retry {retry_counter}.")
+                            retry_counter += 1
+                            time.sleep(1)
+
                     guests['guests'][guest['name']] = {}
                     guests['guests'][guest['name']]['name'] = guest['name']
                     guests['guests'][guest['name']]['cpu_total'] = guest['cpus']
-                    guests['guests'][guest['name']]['cpu_used'] = guest['cpu']
+                    guests['guests'][guest['name']]['cpu_used'] = guest['cpu'] * guest['cpus']
                     guests['guests'][guest['name']]['memory_total'] = guest['maxmem']
                     guests['guests'][guest['name']]['memory_used'] = guest['mem']
                     guests['guests'][guest['name']]['disk_total'] = guest['maxdisk']

proxlb/models/nodes.py

@@ -1,8 +1,26 @@
 """
 The Nodes class retrieves all running nodes in a Proxmox cluster
 and collects their resource metrics.
+
+Methods:
+    __init__:
+        Initializes the Nodes class.
+
+    get_nodes(proxmox_api: any, proxlb_config: Dict[str, Any]) -> Dict[str, Any]:
+        Gets metrics of all nodes in a Proxmox cluster.
+
+    set_node_maintenance(proxlb_config: Dict[str, Any], node_name: str) -> Dict[str, Any]:
+        Sets Proxmox nodes to a maintenance mode if required.
+
+    set_node_ignore(proxlb_config: Dict[str, Any], node_name: str) -> Dict[str, Any]:
+        Sets Proxmox nodes to be ignored if requested.
 """
 
+__author__ = "Florian Paul Azim Hoberg <gyptazy>"
+__copyright__ = "Copyright (C) 2025 Florian Paul Azim Hoberg (@gyptazy)"
+__license__ = "GPL-3.0"
+
+
 from typing import Dict, Any
 from utils.logger import SystemdLogger
 
@@ -45,7 +63,7 @@ class Nodes:
                 nodes["nodes"][node["node"]]["maintenance"] = False
                 nodes["nodes"][node["node"]]["cpu_total"] = node["maxcpu"]
                 nodes["nodes"][node["node"]]["cpu_assigned"] = 0
-                nodes["nodes"][node["node"]]["cpu_used"] = node["cpu"]
+                nodes["nodes"][node["node"]]["cpu_used"] = node["cpu"] * node["maxcpu"]
                 nodes["nodes"][node["node"]]["cpu_free"] = (node["maxcpu"]) - (node["cpu"] * node["maxcpu"])
                 nodes["nodes"][node["node"]]["cpu_assigned_percent"] = nodes["nodes"][node["node"]]["cpu_assigned"] / nodes["nodes"][node["node"]]["cpu_total"] * 100
                 nodes["nodes"][node["node"]]["cpu_free_percent"] = nodes["nodes"][node["node"]]["cpu_free"] / node["maxcpu"] * 100

proxlb/models/tags.py

@@ -1,9 +1,15 @@
 """
-The Tags class retrieves all tags from guests of the type VM or CT running
-in a Proxmox cluster and validates for affinity, anti-affinity and ignore
-tags set for the guest in the Proxmox API.
+The Tags class retrieves and processes tags from guests of type VM or CT running
+in a Proxmox cluster. It provides methods to fetch tags from the Proxmox API and
+evaluate them for affinity, anti-affinity, and ignore tags, which are used during
+balancing calculations.
 """
 
+__author__ = "Florian Paul Azim Hoberg <gyptazy>"
+__copyright__ = "Copyright (C) 2025 Florian Paul Azim Hoberg (@gyptazy)"
+__license__ = "GPL-3.0"
+
+
 import time
 from typing import List
 from utils.logger import SystemdLogger
@@ -13,13 +19,30 @@ logger = SystemdLogger()
 
 class Tags:
     """
-    The Tags class retrieves all tags from guests of the type VM or CT running
-    in a Proxmox cluster and validates for affinity, anti-affinity and ignore
-    tags set for the guest in the Proxmox API.
+    The Tags class retrieves and processes tags from guests of type VM or CT running
+    in a Proxmox cluster. It provides methods to fetch tags from the Proxmox API and
+    evaluate them for affinity, anti-affinity, and ignore tags, which are used during
+    balancing calculations.
+
+    Methods:
+        __init__:
+            Initializes the Tags class.
+
+        get_tags_from_guests(proxmox_api: any, node: str, guest_id: int, guest_type: str) -> List[str]:
+            Retrieves all tags for a given guest from the Proxmox API.
+
+        get_affinity_groups(tags: List[str]) -> List[str]:
+            Evaluates and returns all affinity tags from the provided list of tags.
+
+        get_anti_affinity_groups(tags: List[str]) -> List[str]:
+            Evaluates and returns all anti-affinity tags from the provided list of tags.
+
+        get_ignore(tags: List[str]) -> bool:
+            Evaluates and returns a boolean indicating whether the guest should be ignored based on the provided list of tags.
     """
     def __init__(self):
         """
-        Initializes the Tags class.
+        Initializes the tags class.
         """
 
     @staticmethod
@@ -116,7 +139,7 @@ class Tags:
             tags (List): A list holding all defined tags for a given guest.
 
         Returns:
-            Bool: Returns a bool that indicates wether to ignore a guest or not.
+            Bool: Returns a bool that indicates whether to ignore a guest or not.
         """
         logger.debug("Starting: get_ignore.")
         ignore_tag = False

proxlb/utils/cli_parser.py

@@ -2,6 +2,11 @@
 The CliParser class handles the parsing of command-line interface (CLI) arguments.
 """
 
+__author__ = "Florian Paul Azim Hoberg <gyptazy>"
+__copyright__ = "Copyright (C) 2025 Florian Paul Azim Hoberg (@gyptazy)"
+__license__ = "GPL-3.0"
+
+
 import argparse
 import utils.version
 from utils.logger import SystemdLogger

proxlb/utils/config_parser.py

@@ -3,6 +3,11 @@ The ConfigParser class handles the parsing of configuration file
 from a given YAML file from any location.
 """
 
+__author__ = "Florian Paul Azim Hoberg <gyptazy>"
+__copyright__ = "Copyright (C) 2025 Florian Paul Azim Hoberg (@gyptazy)"
+__license__ = "GPL-3.0"
+
+
 import os
 import sys
 try:
@@ -24,8 +29,16 @@ logger = SystemdLogger()
 
 class ConfigParser:
     """
-    The ConfigParser class handles the parsing of configuration file
-    from a given YAML file from any location.
+    The ConfigParser class handles the parsing of a configuration file.
+
+    Methods:
+    __init__(config_path: str)
+
+    test_config_path(config_path: str) -> None
+        Checks if the configuration file is present at the given config path.
+
+    get_config() -> Dict[str, Any]
+        Parses and returns the configuration data from the YAML file.
     """
     def __init__(self, config_path: str):
         """

proxlb/utils/helper.py

@@ -3,6 +3,12 @@ The Helper class provides some basic helper functions to not mess up the code in
 classes.
 """
 
+__author__ = "Florian Paul Azim Hoberg <gyptazy>"
+__copyright__ = "Copyright (C) 2025 Florian Paul Azim Hoberg (@gyptazy)"
+__license__ = "GPL-3.0"
+
+
+import json
 import uuid
 import sys
 import time
@@ -17,6 +23,22 @@ class Helper:
     """
     The Helper class provides some basic helper functions to not mess up the code in other
     classes.
+
+    Methods:
+        __init__():
+            Initializes the general Helper class.
+
+        get_uuid_string() -> str:
+            Generates a random uuid and returns it as a string.
+
+        log_node_metrics(proxlb_data: Dict[str, Any], init: bool = True) -> None:
+            Logs the memory, CPU, and disk usage metrics of nodes in the provided proxlb_data dictionary.
+
+        get_version(print_version: bool = False) -> None:
+            Returns the current version of ProxLB and optionally prints it to stdout.
+
+        get_daemon_mode(proxlb_config: Dict[str, Any]) -> None:
+            Checks if the daemon mode is active and handles the scheduling accordingly.
     """
     def __init__(self):
         """
@@ -94,12 +116,49 @@ class Helper:
             None
         """
         logger.debug("Starting: get_daemon_mode.")
-        if proxlb_config.get("service", {}).get("daemon", False):
-            sleep_seconds = proxlb_config.get("service", {}).get("schedule", 12) * 3600
-            logger.info(f"Daemon mode active: Next run in: {proxlb_config.get('service', {}).get('schedule', 12)} hours.")
+        if proxlb_config.get("service", {}).get("daemon", True):
+
+            # Validate schedule format which changed in v1.1.1
+            if type(proxlb_config["service"].get("schedule", None)) != dict:
+                logger.error("Invalid format for schedule. Please use 'hours' or 'minutes'.")
+                sys.exit(1)
+
+            # Convert hours to seconds
+            if proxlb_config["service"]["schedule"].get("format", "hours") == "hours":
+                sleep_seconds = proxlb_config.get("service", {}).get("schedule", {}).get("interval", 12) * 3600
+            # Convert minutes to seconds
+            elif proxlb_config["service"]["schedule"].get("format", "hours") == "minutes":
+                sleep_seconds = proxlb_config.get("service", {}).get("schedule", {}).get("interval", 720) * 60
+            else:
+                logger.error("Invalid format for schedule. Please use 'hours' or 'minutes'.")
+                sys.exit(1)
+
+            logger.info(f"Daemon mode active: Next run in: {proxlb_config.get('service', {}).get('schedule', {}).get('interval', 12)} {proxlb_config['service']['schedule'].get('format', 'hours')}.")
             time.sleep(sleep_seconds)
+
         else:
-            logger.debug("Daemon mode is not active.")
+            logger.debug("Successfully executed ProxLB. Daemon mode not active - stopping.")
+            print("Daemon mode not active - stopping.")
             sys.exit(0)
 
         logger.debug("Finished: get_daemon_mode.")
+
+    @staticmethod
+    def print_json(proxlb_config: Dict[str, Any], print_json: bool = False) -> None:
+        """
+        Prints the calculated balancing matrix as a JSON output to stdout.
+
+        Parameters:
+            proxlb_config (Dict[str, Any]): A dictionary containing the ProxLB configuration.
+
+        Returns:
+            None
+        """
+        logger.debug("Starting: print_json.")
+        if print_json:
+            # Create a filtered list by stripping the 'meta' key from the proxlb_config dictionary
+            # to make sure that no credentials are leaked.
+            filtered_data = {k: v for k, v in proxlb_config.items() if k != "meta"}
+            print(json.dumps(filtered_data, indent=4))
+
+        logger.debug("Finished: print_json.")

proxlb/utils/logger.py

@@ -1,10 +1,15 @@
 """
-The SystemdLogger class provides the root logger support. It dynamically
-evaluates the further usage and imports of journald and adjusts
-the logger to the systems functionality where it gets executed
+The SystemdLogger class provides a singleton logger that integrates with systemd's journal if available.
+It dynamically evaluates the environment and adjusts the logger accordingly.
 """
 
+__author__ = "Florian Paul Azim Hoberg <gyptazy>"
+__copyright__ = "Copyright (C) 2025 Florian Paul Azim Hoberg (@gyptazy)"
+__license__ = "GPL-3.0"
+
+
 import logging
+import sys
 try:
     from systemd.journal import JournalHandler
     SYSTEMD_PRESENT = True
@@ -14,9 +19,36 @@ except ImportError:
 
 class SystemdLogger:
     """
-    The SystemdLogger class provides the root logger support. It dynamically
-    evaluates the further usage and imports of journald and adjusts
-    the logger to the systems functionality where it gets executed.
+    The SystemdLogger class provides a singleton logger that integrates with systemd's journal if available.
+    It dynamically evaluates the environment and adjusts the logger accordingly.
+
+    Attributes:
+        instance (SystemdLogger): Singleton instance of the SystemdLogger class.
+
+    Methods:
+        __new__(cls, name: str = "ProxLB", level: str = logging.INFO) -> 'SystemdLogger':
+            Creates a new instance of the SystemdLogger class or returns the existing instance.
+
+        initialize_logger(self, name: str, level: str) -> None:
+            Initializes the logger with the given name and log level. Adds a JournalHandler if systemd is present.
+
+        set_log_level(self, level: str) -> None:
+            Sets the log level for the logger and all its handlers.
+
+        debug(self, msg: str) -> str:
+            Logs a message with level DEBUG.
+
+        info(self, msg: str) -> str:
+            Logs a message with level INFO.
+
+        warning(self, msg: str) -> str:
+            Logs a message with level WARNING.
+
+        error(self, msg: str) -> str:
+            Logs a message with level ERROR.
+
+        critical(self, msg: str) -> str:
+            Logs a message with level CRITICAL.
     """
     # Create a singleton instance variable
     instance = None
@@ -51,17 +83,22 @@ class SystemdLogger:
         self.logger = logging.getLogger(name)
         self.logger.setLevel(level)
 
-        # Create a JournalHandler for systemd integration if this
-        # is supported on the underlying OS.
+        # Create a logging handler depending on the
+        # capabilities of the underlying OS where systemd
+        # logging is preferred.
         if SYSTEMD_PRESENT:
             # Add a JournalHandler for systemd integration
-            journal_handler = JournalHandler()
-            journal_handler.setLevel(level)
-            # Set a formatter to include the logger's name and log message
-            formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
-            journal_handler.setFormatter(formatter)
-            # Add handler to logger
-            self.logger.addHandler(journal_handler)
+            handler = JournalHandler()
+        else:
+            # Add a stdout handler as a fallback
+            handler = logging.StreamHandler(sys.stdout)
+
+        handler.setLevel(level)
+        # Set a formatter to include the logger's name and log message
+        formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
+        handler.setFormatter(formatter)
+        # Add handler to logger
+        self.logger.addHandler(handler)
 
     def set_log_level(self, level: str) -> None:
         """

proxlb/utils/proxmox_api.py

@@ -1,7 +1,18 @@
 """
-Module providing a function printing python version.
+    The proxmox_api class manages connections to the Proxmox API by parsing the required objects
+    for the authentication which can be based on username/password or API tokens.
+
+    This class provides methods to initialize the Proxmox API connection, test connectivity to
+    Proxmox hosts, and handle authentication using either username/password or API tokens.
+    It also includes functionality to distribute load across multiple Proxmox API endpoints
+    and manage SSL certificate validation.
 """
 
+__author__ = "Florian Paul Azim Hoberg <gyptazy>"
+__copyright__ = "Copyright (C) 2025 Florian Paul Azim Hoberg (@gyptazy)"
+__license__ = "GPL-3.0"
+
+
 try:
     import proxmoxer
     PROXMOXER_PRESENT = True
@@ -42,31 +53,94 @@ logger = SystemdLogger()
 
 class ProxmoxApi:
     """
-    Handles command-line argument parsing for ProxLB.
+    The proxmox_api class manages connections to the Proxmox API by parsing the required objects
+    for the authentication which can be based on username/password or API tokens.
+
+    This class provides methods to initialize the Proxmox API connection, test connectivity to
+    Proxmox hosts, and handle authentication using either username/password or API tokens.
+    It also includes functionality to distribute load across multiple Proxmox API endpoints
+    and manage SSL certificate validation.
+
+    Attributes:
+        logger (SystemdLogger): Logger instance for logging messages.
+        proxmox_api (proxmoxer.ProxmoxAPI): Authenticated ProxmoxAPI object.
+
+    Methods:
+        __init__(proxlb_config: Dict[str, Any]) -> None:
+            Initializes the ProxmoxApi instance with the provided configuration.
+        __getattr__(name):
+            Delegates attribute access to the proxmox_api object.
+        api_connect_get_hosts(proxmox_api_endpoints: list) -> str:
+            Determines a working Proxmox API host from a list of endpoints.
+        test_api_proxmox_host(host: str) -> str:
+            Tests connectivity to a Proxmox host by resolving its IP address.
+        test_api_proxmox_host_ipv4(host: str, port: int = 8006, timeout: int = 1) -> bool:
+            Tests reachability of a Proxmox host on its IPv4 address.
+        test_api_proxmox_host_ipv6(host: str, port: int = 8006, timeout: int = 1) -> bool:
+            Tests reachability of a Proxmox host on its IPv6 address.
+        api_connect(proxlb_config: Dict[str, Any]) -> proxmoxer.ProxmoxAPI:
+            Establishes a connection to the Proxmox API using the provided configuration.
     """
     def __init__(self, proxlb_config: Dict[str, Any]) -> None:
         """
-        Initialize the ProxmoxApi instance.
+        Initializes the ProxmoxApi instance with the provided configuration.
 
-        This method sets up the ProxmoxApi instance by testing the required module dependencies
-        and establishing a connection to the Proxmox API using the provided configuration.
+        This constructor method sets up the Proxmox API connection by calling the
+        api_connect method with the given configuration dictionary. It logs the
+        initialization process for debugging purposes.
 
         Args:
-            proxlb_config (Dict[str, Any]): Configuration dictionary containing Proxmox API connection details.
-
-        Returns:
-            None
+            proxlb_config (Dict[str, Any]): A dictionary containing the Proxmox API configuration.
         """
         logger.debug("Starting: ProxmoxApi initialization.")
         self.proxmox_api = self.api_connect(proxlb_config)
+        self.test_api_user_permissions(self.proxmox_api)
         logger.debug("Finished: ProxmoxApi initialization.")
 
     def __getattr__(self, name):
         """
-        Delegate attribute access to proxmox_api.
+        Delegate attribute access to proxmox_api to the underlying proxmoxer module.
         """
         return getattr(self.proxmox_api, name)
 
+    def validate_config(self, proxlb_config: Dict[str, Any]) -> None:
+        """
+        Validates the provided ProxLB configuration dictionary to ensure that it contains
+        the necessary credentials for authentication and that the credentials are not
+        mutually exclusive.
+
+        Args:
+            proxlb_config (Dict[str, Any]): A dictionary containing the ProxLB configuration.
+                It must include a "proxmox_api" key with a nested dictionary that contains
+                either "user" and "password" keys for username/password authentication or
+                "token_id" and "token_secret" keys for API token authentication.
+
+        Raises:
+            SystemExit: If both pass/token_secret and API token authentication methods are
+                        provided, the function will log a critical error message and terminate
+                        the program.
+
+        Logs:
+            Logs the start and end of the validation process. Logs a critical error if both
+            authentication methods are provided.
+        """
+        logger.debug("Starting: validate_config.")
+        if not proxlb_config.get("proxmox_api", False):
+            logger.critical(f"Config error. Please check your proxmox_api chapter in your config file.")
+            print(f"Config error. Please check your proxmox_api chapter in your config file.")
+            sys.exit(1)
+
+        proxlb_credentials = proxlb_config["proxmox_api"]
+        present_auth_pass = "pass" in proxlb_credentials
+        present_auth_secret = "token_secret" in proxlb_credentials
+
+        if present_auth_pass and present_auth_secret:
+            logger.critical(f"Username/password and API token authentication are mutal exclusive. Please use only one!")
+            print(f"Username/password and API token authentication are mutal exclusive. Please use only one!")
+            sys.exit(1)
+
+        logger.debug("Finished: validate_config.")
+
     def api_connect_get_hosts(self, proxmox_api_endpoints: list) -> str:
         """
         Perform a connectivity test to determine a working host for the Proxmox API.
@@ -147,7 +221,15 @@ class ProxmoxApi:
             bool: False if the Proxmox server is not reachable.
         """
         logger.debug("Starting: test_api_proxmox_host.")
-        ip = socket.getaddrinfo(host, None, socket.AF_UNSPEC)
+
+        # Try resolving DNS to IP and log non-resolvable ones
+        try:
+            ip = socket.getaddrinfo(host, None, socket.AF_UNSPEC)
+        except socket.gaierror:
+            logger.warning(f"Could not resolve {host}.")
+            return False
+
+        # Validate if given object is IPv4 or IPv6
         for address_type in ip:
             if address_type[0] == socket.AF_INET:
                 logger.debug(f"{host} is type ipv4.")
@@ -181,7 +263,7 @@ class ProxmoxApi:
         logger.debug("Starting: test_api_proxmox_host_ipv4.")
         sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
         sock.settimeout(timeout)
-        logger.warning(f"Warning: Host {host} ran into a timout when connectoing on IPv4 for tcp/{port}.")
+        logger.warning(f"Warning: Host {host} ran into a timeout when connecting on IPv4 for tcp/{port}.")
         result = sock.connect_ex((host, port))
 
         if result == 0:
@@ -214,7 +296,7 @@ class ProxmoxApi:
         logger.debug("Starting: test_api_proxmox_host_ipv6.")
         sock = socket.socket(socket.AF_INET6, socket.SOCK_STREAM)
         sock.settimeout(timeout)
-        logger.warning(f"Host {host} ran into a timout when connectoing on IPv6 for tcp/{port}.")
+        logger.warning(f"Host {host} ran into a timeout when connecting via IPv6 for tcp/{port}.")
         result = sock.connect_ex((host, port))
 
         if result == 0:
@@ -228,6 +310,36 @@ class ProxmoxApi:
         logger.debug("Finished: test_api_proxmox_host_ipv4.")
         return False
 
+    def test_api_user_permissions(self, proxmox_api: any):
+        """
+        Test the permissions of the current user/token used for the Proxmox API.
+
+        This method gets all assigned permissions for all API paths for the current
+        used user/token and validates them against the minimum required permissions.
+
+        Args:
+            proxmox_api (any): The Proxmox API client instance.
+        """
+        logger.debug("Starting: test_api_user_permissions.")
+        permissions_required = ["Datastore.Audit", "Sys.Audit", "VM.Audit", "VM.Migrate"]
+        permissions_available = []
+
+        # Get the permissions for the current user/token from API
+        permissions = proxmox_api.access.permissions.get()
+
+        # Get all available permissions of the current user/token
+        for path, permission in permissions.items():
+            for permission in permissions[path]:
+                permissions_available.append(permission)
+
+        # Validate if all required permissions are included within the available permissions
+        for required_permission in permissions_required:
+            if required_permission not in permissions_available:
+                logger.critical(f"Permission '{required_permission}' is missing. Please adjust the permissions for your user/token. See also: https://github.com/gyptazy/ProxLB/blob/main/docs/03_configuration.md#required-permissions-for-a-user")
+                sys.exit(1)
+
+        logger.debug("Finished: test_api_user_permissions.")
+
     def api_connect(self, proxlb_config: Dict[str, Any]) -> proxmoxer.ProxmoxAPI:
         """
         Establishes a connection to the Proxmox API using the provided configuration.
@@ -256,6 +368,9 @@ class ProxmoxApi:
             requests.exceptions.ConnectionError: If the connection to the Proxmox API is refused.
         """
         logger.debug("Starting: api_connect.")
+        # Validate config
+        self.validate_config(proxlb_config)
+
         # Get a valid Proxmox API endpoint
         proxmox_api_endpoint = self.api_connect_get_hosts(proxlb_config.get("proxmox_api", {}).get("hosts", []))
 
@@ -267,12 +382,24 @@ class ProxmoxApi:
 
         # Login into Proxmox API and create API object
         try:
-            proxmox_api = proxmoxer.ProxmoxAPI(
-                proxmox_api_endpoint,
-                user=proxlb_config.get("proxmox_api").get("user", True),
-                password=proxlb_config.get("proxmox_api").get("pass", True),
-                verify_ssl=proxlb_config.get("proxmox_api").get("ssl_verification", True),
-                timeout=proxlb_config.get("proxmox_api").get("timeout", True))
+
+            if proxlb_config.get("proxmox_api").get("token_secret", False):
+                proxmox_api = proxmoxer.ProxmoxAPI(
+                    proxmox_api_endpoint,
+                    user=proxlb_config.get("proxmox_api").get("user", True),
+                    token_name=proxlb_config.get("proxmox_api").get("token_id", True),
+                    token_value=proxlb_config.get("proxmox_api").get("token_secret", True),
+                    verify_ssl=proxlb_config.get("proxmox_api").get("ssl_verification", True),
+                    timeout=proxlb_config.get("proxmox_api").get("timeout", True))
+                logger.debug("Using API token authentication.")
+            else:
+                proxmox_api = proxmoxer.ProxmoxAPI(
+                    proxmox_api_endpoint,
+                    user=proxlb_config.get("proxmox_api").get("user", True),
+                    password=proxlb_config.get("proxmox_api").get("pass", True),
+                    verify_ssl=proxlb_config.get("proxmox_api").get("ssl_verification", True),
+                    timeout=proxlb_config.get("proxmox_api").get("timeout", True))
+                logger.debug("Using username/password authentication.")
         except proxmoxer.backends.https.AuthenticationError as proxmox_api_error:
             logger.critical(f"Authentication failed. Please check the defined credentials: {proxmox_api_error}")
             sys.exit(2)

proxlb/utils/version.py

@@ -1,5 +1,7 @@
 __app_name__ = "ProxLB"
 __app_desc__ = "A DRS alike loadbalancer for Proxmox clusters."
 __author__ = "Florian Paul Azim Hoberg <gyptazy>"
-__version__ = "1.1.0-alpha"
+__copyright__ = "Copyright (C) 2025 Florian Paul Azim Hoberg (@gyptazy)"
+__license__ = "GPL-3.0"
+__version__ = "1.1.1"
 __url__ = "https://github.com/gyptazy/ProxLB"

service/proxlb.service

@@ -1,11 +1,11 @@
 [Unit]
 Description=ProxLB - A loadbalancer for Proxmox clusters
-After=network-online.target
-Wants=network-online.target
+After=pveproxy.service
+Wants=pveproxy.service
 
 [Service]
 ExecStart=python3 /usr/lib/python3/dist-packages/proxlb/main.py -c /etc/proxlb/proxlb.yaml
 User=plb
 
 [Install]
-WantedBy=multi-user.target
+WantedBy=multi-user.target

setup.py

@@ -2,7 +2,7 @@ from setuptools import setup
 
 setup(
     name="proxlb",
-    version="1.1.0-alpha",
+    version="1.1.1",
     description="A DRS alike loadbalancer for Proxmox clusters.",
     long_description="An advanced DRS alike loadbalancer for Proxmox clusters that also supports maintenance modes and affinity/anti-affinity rules.",
     author="Florian Paul Azim Hoberg",