fix: Fix authentication timeout in rare cases that could lead to a stacktrace

Fixes: #285

.changelogs/1.0.2/40_add_option_to_run_only_on_cluster_master_node.yml

@@ -1,2 +1,2 @@
 added:
-  - Add option to run ProxLB only on the Proxmox's master node in the cluster. [40]
+  - Add option to run ProxLB only on the Proxmox's master node in the cluster (reg. HA feature). [#40]

.changelogs/1.0.2/49_fix_cmake_debian_packaging.yml

@@ -0,0 +1,2 @@
+fixed:
+  - Fix CMake packaging for Debian package to avoid overwriting the config file. [#49]

.changelogs/1.0.2/release_meta.yml

@@ -0,0 +1 @@
+date: 2024-08-13

.changelogs/1.0.3/51_add_storage_balancing.yml

@@ -0,0 +1,2 @@
+added:
+  - Add storage balancing function. [#51]

.changelogs/1.0.3/53_code_improvements.yml

@@ -0,0 +1,6 @@
+added:
+  - 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]
+changed:
+  - Improve the underlying code base for future implementations. [#53]

.changelogs/1.0.3/60_allow_api_hosts_to_be_given_as_an_optional_list.yml

@@ -0,0 +1,2 @@
+added:
+  - Add feature to allow the API hosts being provided as a comma separated list. [#60]

.changelogs/1.0.3/64_improve_error_handling_and_validations.yml

@@ -0,0 +1,2 @@
+fixed:
+  - Improved the overall validation and error handling. [#64]

.changelogs/1.0.3/67_fix_anti_affinity_rules.yml

@@ -0,0 +1,2 @@
+fixed:
+  - Fix anti-affinity rules not evaluating a new and different node. [#67]

.changelogs/1.0.3/68_adjust_logging_ha_services.yml

@@ -0,0 +1,2 @@
+changed:
+  - Provide a more reasonable output when HA services are not active in a Proxmox cluster. [#68]

.changelogs/1.0.3/71_fix_ignore_vm_node_handling_if_unset.yml

@@ -0,0 +1,2 @@
+fixed:
+  - Fix handling of unset `ignore_nodes` and `ignore_vms` resulted in an attribute error. [#71]

.changelogs/1.0.3/74_fix_documentation_master_only.yml

@@ -0,0 +1,2 @@
+fixed:
+  - Fix documentation for the master_only parameter placed in the wrong config section. [#74]

.changelogs/1.0.3/8_add_best_next_node_for_placement.yml

@@ -0,0 +1,2 @@
+added:
+  - Add cli arg `-b` to return the next best node for next VM/CT placement. [#8]

.changelogs/1.0.3/bug_fix_cluster_master_only.yml

@@ -0,0 +1,2 @@
+fixed:
+  - Fixed `master_only` function by inverting the condition.

.changelogs/1.0.3/docs_fix_default_config_add_dedicated_user_howto.yml

@@ -0,0 +1,4 @@
+fixed:
+  - Fix bug in the `proxlb.conf` in the vm_balancing section.
+added:
+  - Add doc how to add dedicated user for authentication. (by @Dulux-Oz) 

.changelogs/1.0.3/release_meta.yml

@@ -0,0 +1 @@
+date: 2024-09-12

.changelogs/1.0.4/58_add_maintenance_mode.yml

@@ -0,0 +1,2 @@
+added:
+  - Add maintenance mode to evacuate a node and move workloads for other nodes in the cluster. [#58]

.changelogs/1.0.4/75_fix_cpu_balancing.yml

@@ -0,0 +1,2 @@
+fixed:
+  - Fix CPU balancing where calculations are done in float instead of int. (by @glitchvern) [#75]

.changelogs/1.0.4/79_storage_balancing_whitelist.yml

@@ -0,0 +1,3 @@
+changed:
+  - Run storage balancing only on supported shared storages. [#79]
+  - Run storage balancing only when needed to save time. [#79]

.changelogs/1.0.4/81_documentation_infrastrucutre.yml

@@ -0,0 +1,2 @@
+fixed:
+  - Fix documentation for the underlying infrastructure. [#81]

.changelogs/1.0.4/89_add_version_output.yml

@@ -0,0 +1,2 @@
+added:
+  - Add version output cli arg. [#89]

.changelogs/1.0.4/91_make_api_timeout_configureable.yml

@@ -0,0 +1,2 @@
+added:
+  - Add feature to make API timeout configureable. [#91]

.changelogs/1.0.4/release_meta.yml

@@ -0,0 +1 @@
+date: 2024-10-11

.changelogs/1.0.5/104_docs_bool_adjustment.yml

@@ -0,0 +1,2 @@
+changed:
+  - Change docs to make bool usage in configs more clear (by @gyptazy). [#104]

.changelogs/1.0.5/106_fix_maintenance_mode_compare_str_list.yml

@@ -0,0 +1,2 @@
+fixed:
+  - Fix evaluation of maintenance mode where comparing list & string resulted in a crash (by @glitchvern). [#106]

.changelogs/1.0.5/107_fix_offline_node_eval.yml

@@ -0,0 +1,2 @@
+fixed:
+  - Fix node (and its objects) evaluation when not reachable, e.g., maintenance (by @gyptazy). [#107]

.changelogs/1.0.5/113_fix_migration_from_local_disk.yml

@@ -0,0 +1,2 @@
+fixed:
+  - Fix migration from local disks (by @greenlogles). [#113]

.changelogs/1.0.5/98_fix_log_verbosity_opts.yml

@@ -0,0 +1,2 @@
+fixed:
+  - Fix allowed values (add DEBUG, WARNING) for log verbosity (by @gyptazy). [#98]

.changelogs/1.0.5/release_meta.yml

@@ -0,0 +1 @@
+date: 2024-10-30

.changelogs/1.0.6/115_fix_daemon_scheduler_bool_time_fix.yml

@@ -0,0 +1,2 @@
+fixed:
+  - Fix that a scheduler time definition of 1 (int) gets wrongly interpreted as a bool (by @gyptazy). [#115]

.changelogs/1.0.6/119_fix_maintenance_mode_cli_and_config.yml

@@ -0,0 +1,2 @@
+fixed:
+  - Fix maintenance mode when using cli arg and config mode by using the merged list (by @CartCaved). [#119]

.changelogs/1.0.6/release_meta.yml

@@ -0,0 +1 @@
+date: 2024-12-24

.changelogs/1.1.0/114_refactor_code_base.yml

@@ -0,0 +1,11 @@
+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]

.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: 2025-04-20

.changelogs/1.1.2/137_fix_systemd_unit_file.yml

@@ -0,0 +1,2 @@
+fixed:
+  - Fix systemd unit file to run after network on non PVE nodes (by @robertdahlem) [#137]

.changelogs/1.1.2/157_add_proxmox_api_retry_mechanism.yml

@@ -0,0 +1,2 @@
+added:
+  - Add a configurable retry mechanism when connecting to the Proxmox API (by @gyptazy) [#157]

.changelogs/1.1.2/218_add_1_to_one_relationship_guest_node_pinning.yml

@@ -0,0 +1,2 @@
+added:
+  - Add 1-to-1 relationships between guest and hypervisor node to ping a guest on a node (by @gyptazy) [#218]

.changelogs/1.1.2/222_fix_force_type_cast_cpu_metrics_to_int.yml

@@ -0,0 +1,2 @@
+fixed:
+  - Force type cast cpu count of guests to int for some corner cases where a str got returned (by @gyptazy). [#222]

.changelogs/1.1.2/release_meta.yml

@@ -0,0 +1 @@
+date: 2025-05-13

.changelogs/1.1.3/189_add_reload_function.yml

@@ -0,0 +1,2 @@
+added:
+  - Add relaod (SIGHUP) function to ProxLB to reload the configuration (by @gyptazy). [#189]

.changelogs/1.1.3/232_align_maintenance_mode_proxmox_ha.yml

@@ -0,0 +1,2 @@
+fixed:
+  - Align maintenance mode with Proxmox HA maintenance mode (by @gyptazy). [#232]

.changelogs/1.1.3/239_add_optional_delay_time_until_service_starts.yml

@@ -0,0 +1,2 @@
+added:
+  - Add optional wait time parameter to delay execution until the service takes action (by @gyptazy). #239

.changelogs/1.1.3/241_make_amount_of_parallel_migrations_configurable.yml

@@ -0,0 +1,2 @@
+added:
+  - Make the amount of parallel migrations configurable (by @gyptazy). [#241]

.changelogs/1.1.3/94_cpu_balancing_use_avg_instead_current_consumption.yml

@@ -0,0 +1,2 @@
+changed:
+  - Use the average CPU consumption of a guest within the last 60 minutes instead of the current CPU usage (by @philslab-ninja & @gyptazy). [#94]

.changelogs/1.1.3/release_meta.yml

@@ -0,0 +1 @@
+date: 2025-06-19

.changelogs/1.1.4/245_add_guest_pinning_to_groups_of_nodes.yml

@@ -0,0 +1,2 @@
+added:
+  - Allow pinning of guests to a group of nodes (@gyptazy). [#245]

.changelogs/1.1.4/248_fix_dry_run_combination_balancing_disabled.yml

@@ -0,0 +1,2 @@
+fixed:
+  - Fixed an issue where balancing was performed in combination of deactivated balancing and dry-run mode (@gyptazy). [#248]

.changelogs/1.1.4/255_fix_loglevels.yml

@@ -0,0 +1,2 @@
+fixed:
+  - Modified log levels to make output lighter at INFO level (@pmarasse) [#255]

.changelogs/1.1.4/release_meta.yml

@@ -0,0 +1 @@
+date: 2025-06-27

.changelogs/1.1.5/260_allow_custom_api_ports.yml

@@ -0,0 +1,2 @@
+added:
+  - Allow custom API ports instead of fixed tcp/8006 (@gyptazy). [#260]

.changelogs/1.1.5/release_meta.yml

@@ -0,0 +1 @@
+date: 2025-07-14

.changelogs/1.1.6/268_fix_balancing_type_eval.yml

@@ -0,0 +1,2 @@
+fixed:
+  - Fix balancing evaluation of guest types (e.g., VM or CT) (@gyptazy). [#268]

.changelogs/1.1.6/285_fix_authentication_timeout.yml

@@ -0,0 +1,2 @@
+fixed:
+  - Fix authentication timeout in rare cases that could lead to a stacktrace (@gyptazy). [#285]

.changelogs/1.1.6/290_validate_user_token_syntax.yml

@@ -0,0 +1,2 @@
+added:
+  - Add validation for provided API user token id to avoid confusions (@gyptazy). [#291]

.changelogs/1.1.6/291_fix_stack_trace_no_user_permissions_testing.yml

@@ -0,0 +1,2 @@
+fixed:
+  - Fix stacktrace output when validating permissions on non existing users in Proxmox (@gyptazy). [#291]

.changelogs/1.1.6/release_meta.yml

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

.flake8

@@ -1,3 +0,0 @@
-[flake8]
-per-file-ignores =
-    proxlb: E501,E221,E266,E231,E127,E222,E128

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,27 @@
+---
+name: Bug report
+about: Create a bug report
+title: "`Bug`:"
+labels: bug, needs-analysis
+assignees: ''
+
+---
+
+## General
+<-- Describe the bug from a high level perspective. -->
+
+## Weighting
+Score: <-- Define a scoring from 0-10 (10 highest, most urgent) -->
+
+## Config
+<-- Attach the ProxLB configuration for further analysis. Please take car to NOT publish your API credentials! -->
+
+## Log
+<-- Attach the ProxLB debug log for further analysis. Please take car to NOT publish your API credentials! -->
+
+## Meta
+Please provide some more information about your setup. This includes where you obtained ProxLB (e.g., as a `.deb` file, from the repository or container image) and also which version you're running in which mode. You can obtain the used version from you image version, your local repository information or by running `proxlb -v`.
+
+Version: <-- DEFINE_VERSION -->
+Installed from: <-- DEFINE_INSTALL_SOURCE -->
+Running as: <-- Container, local on Proxmox, local on all Proxmox, dedicated -->

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,14 @@
+---
+name: Feature request
+about: Create a new request for a missing feature
+title: "`Feature`: "
+labels: feature, needs-analysis
+assignees: ''
+
+---
+
+## General
+<-- Describe the feature idea from a high level perspective. -->
+
+## Details
+<-- Provide some more details about the new feature request and provide examples. -->

.github/workflows/02-create-package.yml

@@ -1,26 +0,0 @@
-name: Run basic pipeline on push
-on: [push]
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        python-version: ["3.8"]
-    steps:
-      - uses: actions/checkout@v3
-      - name: Set up Python for ProxLB
-        uses: actions/setup-python@v4
-        with:
-          python-version: ${{ matrix.python-version }}
-      - name: Install dependencies for ProxLB
-        run: |
-          python -m pip install --upgrade pip
-          pip install pytest proxmoxer flake8
-          if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
-      - name: Run Python linting
-        run: |
-          python3 -m flake8 proxlb
-      - name: Create distro packages
-        run: |
-          cd packaging
-          ./01_package.sh

.github/workflows/10-code-liniting.yml

@@ -0,0 +1,21 @@
+name: Code linting
+on: [push]
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.8"]
+    steps:
+      - uses: actions/checkout@v3
+      - name: Setup dependencies for code linting
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install additional dependencies for code linting
+        run: |
+          sudo apt-get update
+          sudo apt-get -y install python3-pycodestyle pycodestyle
+      - name: Run code linting on ProxLB Python code
+        run: |
+          pycodestyle proxlb/*

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

@@ -0,0 +1,78 @@
+name: "Build package: .deb"
+on: [push]
+jobs:
+  lint-code-proxlb:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.8"]
+    steps:
+      - uses: actions/checkout@v3
+      - name: Setup dependencies for code linting
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install additional dependencies for code linting
+        run: |
+          sudo apt-get update
+          sudo apt-get -y install python3-pycodestyle pycodestyle
+      - name: Run code linting on ProxLB Python code
+        run: |
+          pycodestyle proxlb/* && \
+          echo "OK: Code linting successfully performed on ProxLB code."
+
+  build-package-debian:
+    needs: lint-code-proxlb
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v3
+        with:
+          ref: ${{ github.ref }}
+
+      - name: Set up Docker with Debian image
+        run: |
+          docker pull debian:latest
+
+      - name: Build DEB package in Docker container
+        run: |
+          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 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.'
+          "
+
+      - name: Upload Debian package python3-proxlb as artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: debian-package
+          path: package/*.deb
+
+  integration-test-debian:
+    needs: build-package-debian
+    runs-on: ubuntu-latest
+    steps:
+      - name: Download Debian package artifact
+        uses: actions/download-artifact@v4
+        with:
+          name: debian-package
+          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)/package:/package -w /package debian:latest bash -c "
+            apt-get update && \
+            apt-get install -y systemd && \
+            apt-get install -y ./proxlb*.deb && \
+            python3 -c 'import proxlb; print(\"OK: Debian package successfully installed.\")'
+          "

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

@@ -0,0 +1,96 @@
+name: "Build package: .rpm"
+on: [push]
+jobs:
+  lint-code-proxlb:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.8"]
+    steps:
+      - uses: actions/checkout@v3
+      - name: Setup dependencies for code linting
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install additional dependencies for code linting
+        run: |
+          sudo apt-get update
+          sudo apt-get -y install python3-pycodestyle pycodestyle
+      - name: Run code linting on ProxLB Python code
+        run: |
+          pycodestyle proxlb/* && \
+          echo "OK: Code linting successfully performed on ProxLB code."
+
+  build-package-rpm:
+    needs: lint-code-proxlb
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v3
+        with:
+          ref: 'development'
+
+      - name: Set up Docker with Debian image
+        run: |
+          docker pull debian:latest
+
+      - name: Build DEB package in Docker container
+        run: |
+          docker run --rm -v $(pwd):/workspace -w /workspace debian:latest bash -c "
+            # Install dependencies
+            apt-get update && \
+            apt-get install -y python3 python3-setuptools rpm debhelper dh-python python3-pip python3-stdeb python3-proxmoxer python3-requests python3-urllib3 && \
+            # Build package
+            python3 setup.py --command-packages=stdeb.command bdist_rpm && \
+            echo 'OK: RPM package successfully created.'
+          "
+
+      - name: Upload RPM package python3-proxlb as artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: rpm-package
+          path: dist/*.rpm
+
+  # integration-test-rpm-rockylinux-9:
+  #   needs: build-package-rpm
+  #   runs-on: ubuntu-latest
+  #   steps:
+  #     - name: Download RPM package artifact
+  #       uses: actions/download-artifact@v4
+  #       with:
+  #         name: rpm-package
+  #         path: dist/
+
+  #     - name: Set up Docker with RockyLinux 9 image
+  #       run: docker pull rockylinux:9
+
+  #     - name: Install and test RPM package in Rocky Linux Docker container
+  #       run: |
+  #         docker run --rm -v $(pwd)/dist:/dist -w /dist rockylinux:9 bash -c "
+  #           # DNF does not handle wildcards well
+  #           rpm_file=\$(ls proxlb*.noarch.rpm) && \
+  #           dnf install -y \$rpm_file && \
+  #           python3 -c 'import proxlb; print(\"OK: RPM package successfully installed.\")'
+  #         "
+
+  # integration-test-rpm-rockylinux-8:
+  #   needs: build-package-rpm
+  #   runs-on: ubuntu-latest
+  #   steps:
+  #     - name: Download RPM package artifact
+  #       uses: actions/download-artifact@v4
+  #       with:
+  #         name: rpm-package
+  #         path: dist/
+
+  #     - name: Set up Docker with RockyLinux 8 image
+  #       run: docker pull rockylinux:8
+
+  #     - name: Install and test RPM package in Rocky Linux Docker container
+  #       run: |
+  #         docker run --rm -v $(pwd)/dist:/dist -w /dist rockylinux:8 bash -c "
+  #           # DNF does not handle wildcards well
+  #           rpm_file=\$(ls proxlb*.noarch.rpm) && \
+  #           dnf install -y \$rpm_file && \
+  #           python3 -c 'import proxlb; print(\"OK: RPM package successfully installed.\")'
+  #         "

.github/workflows/30-pipeline-build-container-amd64.yml

@@ -0,0 +1,26 @@
+name: "Build Container Image: AMD64"
+on: [push]
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v4
+    - name: Set up QEMU
+      uses: docker/setup-qemu-action@v3
+    - name: Set up Docker Buildx
+      uses: docker/setup-buildx-action@v3
+    - name: Build amd64 image and save as tar
+      run: |
+        docker buildx build \
+          --platform linux/amd64 \
+          --load \
+          -t proxlb-image:amd64 \
+          .
+
+        docker save proxlb-image:amd64 -o proxlb_image_amd64.tar
+    - name: Upload Docker image artifact
+      uses: actions/upload-artifact@v4
+      with:
+        name: proxlb-image-amd64
+        path: proxlb_image_amd64.tar

.github/workflows/30-pipeline-build-container-arm64.yml

@@ -0,0 +1,26 @@
+name: "Build Container Image: ARM64"
+on: [push]
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v4
+    - name: Set up QEMU
+      uses: docker/setup-qemu-action@v3
+    - name: Set up Docker Buildx
+      uses: docker/setup-buildx-action@v3
+    - name: Build arm64 image and save as tar
+      run: |
+        docker buildx build \
+          --platform linux/arm64 \
+          --load \
+          -t proxlb-image:arm64 \
+          .
+
+        docker save proxlb-image:arm64 -o proxlb_image_arm64.tar
+    - name: Upload Docker image artifact
+      uses: actions/upload-artifact@v4
+      with:
+        name: proxlb-image-arm64
+        path: proxlb_image_arm64.tar

.github/workflows/30-pipeline-build-container-multi-arch.yml

@@ -0,0 +1,23 @@
+name: "Build Container Image: Multiarch"
+on: [push]
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v4
+    - name: Set up QEMU
+      uses: docker/setup-qemu-action@v3
+    - name: Set up Docker Buildx
+      uses: docker/setup-buildx-action@v3
+    - name: Build multi-arch image and save as tar
+      run: |
+        docker buildx build \
+          --platform linux/amd64,linux/arm64 \
+          --output type=tar,dest=proxlb_image_multiarch.tar \
+          .
+    - name: Upload Docker image artifact
+      uses: actions/upload-artifact@v4
+      with:
+        name: proxlb-image-multiarch
+        path: proxlb_image_multiarch.tar

.gitignore

@@ -1,2 +1,7 @@
-packaging/changelog-fragments-creator/
-dev/
+__pycache__
+*.pyc
+.DS_Store
+build/
+dist/
+*.egg-info/
+proxlb_dev.yaml

CHANGELOG.md

@@ -6,20 +6,193 @@ 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.5] - 2025-07-14
+
+### Added
+
+- Allow custom API ports instead of fixed tcp/8006 (@gyptazy). [#260]
+
+
+## [1.1.4] - 2025-06-27
+
+### Added
+
+- Allow pinning of guests to a group of nodes (@gyptazy). [#245]
+
+### Fixed
+
+- Modified log levels to make output lighter at INFO level (@pmarasse) [#255]
+- Fixed an issue where balancing was performed in combination of deactivated balancing and dry-run mode (@gyptazy). [#248]
+
+
+## [1.1.3] - 2025-06-19
+
+### Added
+
+- Add relaod (SIGHUP) function to ProxLB to reload the configuration (by @gyptazy). [#189]
+- Add optional wait time parameter to delay execution until the service takes action (by @gyptazy). [#239]
+- Make the amount of parallel migrations configurable (by @gyptazy). [#241]
+
+### Changed
+
+- Use the average CPU consumption of a guest within the last 60 minutes instead of the current CPU usage (by @philslab-ninja & @gyptazy). [#94]
+
+### Fixed
+
+- Align maintenance mode with Proxmox HA maintenance mode (by @gyptazy). [#232]
+
+
+## [1.1.2] - 2025-05-13
+
+### Added
+
+- Add a configurable retry mechanism when connecting to the Proxmox API (by @gyptazy) [#157]
+- Add 1-to-1 relationships between guest and hypervisor node to ping a guest on a node (by @gyptazy) [#218]
+
+### Fixed
+
+- Force type cast cpu count of guests to int for some corner cases where a str got returned (by @gyptazy). [#222]
+- Fix systemd unit file to run after network on non PVE nodes (by @robertdahlem) [#137]
+
+
+## [1.1.1] - 2025-04-20
+
+### Added
+
+- Providing the API upstream error message when migration fails in debug mode (by @gyptazy) [#205]
+
+### Changed
+
+- Change the default behaviour of the daemon mode to active [#176]
+- Change the default banalcing mode to used instead of assigned [#180]
+
+### 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]
+- Fix tag evluation for VMs for being ignored for further balancing [#163]
+- Honor the value when balancing should not be performed and stop balancing [#174]
+- allow the use of minutes instead of hours and only accept hours or minutes in the format (by @glitchvern) [#187]
+- Remove hard coded memory usage from lowest usage node and use method and mode specified in configuration instead (by @glitchvern) [#197]
+- Fix the guest type relationship in the logs when a migration job failed (by @gyptazy) [#204]
+- Requery a guest if that running guest reports 0 cpu usage (by @glitchvern) [#200]
+- Fix Python path for Docker entrypoint (by @crandler) [#170]
+- Improve logging verbosity of messages that had a wrong servity [#165]
+
+
+## [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 a wildcard pattern. [#7]
-- Add feature to make log verbosity configurable [#17].
-- Add option_mode to rebalance by node's free resources in percent (instead of bytes). [#29]
-- Add option to rebalance by assigned VM resources to avoid over provisioning. [#16]
-- Add Docker/Podman support. [#10 by @daanbosch]
-- Add exclude grouping feature to rebalance VMs from being located together to new nodes. [#4]
 - 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
 
@@ -37,4 +210,4 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
-- Development release of ProxLB.
+- Development release of ProxLB.

CONTRIBUTING.md

@@ -29,7 +29,7 @@ Before submitting a pull request, ensure that your changes sucessfully perform t
 
 1. **Install pytest if you haven't already:**
    ```sh
-   pip install fake8
+   pip install flake8
    ```
 
 2. **Run the lintin:**
@@ -116,6 +116,6 @@ By participating in this project, you agree to abide by our [Code of Conduct](CO
 
 ## Getting Help
 
-If you need help or have any questions, feel free to reach out by creating an issue or by joining our [discussion forum](https://github.com/gyptazy/proxlb/discussions). You can also refer to our [documentation](https://github.com/gyptazy/ProxLB/tree/main/docs) for more information about the project or join our [chat room](https://matrix.to/#/#proxlb:gyptazy.ch) in Matrix.
+If you need help or have any questions, feel free to reach out by creating an issue or by joining our [discussion forum](https://github.com/gyptazy/proxlb/discussions). You can also refer to our [documentation](https://github.com/gyptazy/ProxLB/tree/main/docs) for more information about the project or join our [chat room](https://matrix.to/#/#proxlb:gyptazy.com) in Matrix.
 
 Thank you for contributing to ProxLB! Together, we can enhance the efficiency and performance of Proxmox clusters.

Dockerfile

@@ -1,20 +1,16 @@
-# Use the official Debian 12 base image
-FROM debian:12
+# Use the latest Alpine image
+FROM alpine:latest
 
 # Labels
-LABEL maintainer="gyptazy@gyptazy.ch"
-LABEL org.label-schema.schema-version="0.9"
-LABEL org.label-schema.description="ProxLB - Rebalance VM workloads across nodes in a Proxmox cluster."
-LABEL org.label-schema.url="https://github.com/gyptazy/ProxLB"
+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"
 
-# Set environment variables
-ENV DEBIAN_FRONTEND=noninteractive
-
-# Install python3 and python3-venv
-RUN apt-get update && \
-    apt-get install -y python3 python3-pip python3-venv && \
-    apt-get clean && \
-    rm -rf /var/lib/apt/lists/*
+# Install Python3
+RUN apk add --no-cache python3 py3-pip
 
 # Create a directory for the app
 WORKDIR /app
@@ -22,14 +18,11 @@ WORKDIR /app
 # Copy the python program from the current directory to /app
 COPY proxlb /app/proxlb
 
-# Create a virtual environment
-RUN python3 -m venv venv
-
 # Copy requirements to the container
 COPY requirements.txt /app/requirements.txt
 
 # Install dependencies in the virtual environment
-RUN . venv/bin/activate && pip install -r /app/requirements.txt
+RUN pip install --break-system-packages -r /app/requirements.txt
 
 # Set the entry point to use the virtual environment's python
-ENTRYPOINT ["/app/venv/bin/python3", "/app/proxlb"]
+ENTRYPOINT ["/usr/bin/python3", "/app/proxlb/main.py"]

LICENSE

@@ -671,4 +671,4 @@ into proprietary programs.  If your program is a subroutine library, you
 may consider it more useful to permit linking proprietary applications with
 the library.  If this is what you want to do, use the GNU Lesser General
 Public License instead of this License.  But first, please read
-<https://www.gnu.org/licenses/why-not-lgpl.html>.
+<https://www.gnu.org/licenses/why-not-lgpl.html>.

README.md

@@ -1,225 +1,206 @@
 # ProxLB - (Re)Balance VM Workloads in Proxmox Clusters
-<img align="left" src="https://cdn.gyptazy.ch/images/Prox-LB-logo.jpg"/>
+<img align="left" src="https://cdn.gyptazy.com/images/Prox-LB-logo.jpg"/>
 <br>
 
 <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>
 
-
 ## Table of Contents
-- [ProxLB - (Re)Balance VM Workloads in Proxmox Clusters](#proxlb---rebalance-vm-workloads-in-proxmox-clusters)
-  - [Table of Contents](#table-of-contents)
-  - [Introduction](#introduction)
-    - [Video of Migration](#video-of-migration)
-  - [Features](#features)
-  - [How does it work?](#how-does-it-work)
-  - [Usage](#usage)
-    - [Dependencies](#dependencies)
-    - [Options](#options)
-    - [Parameters](#parameters)
-    - [Balancing](#balancing)
-      - [General](#general)
-      - [By Used Memory of VMs/CTs](#by-used-memory-of-vmscts)
-      - [By Assigned Memory of VMs/CTs](#by-assigned-memory-of-vmscts)
-    - [Grouping](#grouping)
-      - [Include (Stay Together)](#include-stay-together)
-      - [Exclude (Stay Separate)](#exclude-stay-separate)
-      - [Ignore VMs (Tag Style)](#ignore-vms-tag-style)
-    - [Systemd](#systemd)
-    - [Manual](#manual)
-    - [Proxmox GUI Integration](#proxmox-gui-integration)
-    - [Quick Start](#quick-start)
-    - [Container Quick Start (Docker/Podman)](#container-quick-start-dockerpodman)
-    - [Logging](#logging)
-  - [Motivation](#motivation)
-  - [References](#references)
-  - [Downloads](#downloads)
-    - [Packages](#packages)
-    - [Repository](#repository)
-    - [Container Images (Docker/Podman)](#container-images-dockerpodman)
-  - [Misc](#misc)
-    - [Bugs](#bugs)
-    - [Contributing](#contributing)
-    - [Support](#support)
-    - [Author(s)](#authors)
+1. [Introduction](#introduction)
+2. [Features](#features)
+3. [How does it work?](#how-does-it-work)
+4. [Installation](#installation)
+   1. [Requirements / Dependencies](#requirements--dependencies)
+   2. [Debian Package](#debian-package)
+   4. [Container / Docker](#container--docker)
+   5. [Source](#source)
+5. [Usage / Configuration](#usage--configuration)
+   1. [GUI Integration](#gui-integration)
+   2. [Proxmox HA Integration](#proxmox-ha-integration)
+   3. [Options](#options)
+6. [Affinity & Anti-Affinity Rules](#affinity--anti-affinity-rules)
+   1. [Affinity Rules](#affinity-rules)
+   2. [Anti-Affinity Rules](#anti-affinity-rules)
+   3. [Ignore VMs](#ignore-vms)
+   4. [Pin VMs to Hypervisor Nodes](#pin-vms-to-hypervisor-nodes)
+7. [Maintenance](#maintenance)
+8. [Misc](#misc)
+   1. [Bugs](#bugs)
+   2. [Contributing](#contributing)
+   3. [Documentation](#documentation)
+   4. [Support](#support)
+9. [Author(s)](#authors)
+
 
 ## Introduction
-`ProxLB` (PLB) is an advanced tool designed to enhance the efficiency and performance of Proxmox clusters by optimizing the distribution of virtual machines (VMs) or Containers (CTs) across the cluster nodes by using the Proxmox API. ProxLB meticulously gathers and analyzes a comprehensive set of resource metrics from both the cluster nodes and the running VMs. These metrics include CPU usage, memory consumption, and disk utilization, specifically focusing on local disk resources.
+ProxLB is an advanced load balancing solution specifically designed for Proxmox clusters, addressing the absence of a Dynamic Resource Scheduler (DRS) that is familiar to VMware users. As a third-party solution, ProxLB enhances the management and efficiency of Proxmox clusters by intelligently distributing workloads across available nodes. Workloads can be balanced by different times like the guest's memory, CPU or disk usage or their assignment to avoid overprovisioning and ensuring resources.
 
-PLB collects resource usage data from each node in the Proxmox cluster, including CPU, (local) disk and memory utilization. Additionally, it gathers resource usage statistics from all running VMs, ensuring a granular understanding of the cluster's workload distribution.
+One of the key advantages of ProxLB is that it is fully open-source and free, making it accessible for anyone to use, modify, and contribute to. This ensures transparency and fosters community-driven improvements. ProxLB supports filtering and ignoring specific nodes and guests through configuration files and API calls, providing administrators with the flexibility to tailor the load balancing behavior to their specific needs.
 
-Intelligent rebalancing is a key feature of ProxLB where it re-balances VMs based on their memory, disk or CPU usage, ensuring that no node is overburdened while others remain underutilized. The rebalancing capabilities of PLB significantly enhance cluster performance and reliability. By ensuring that resources are evenly distributed, PLB helps prevent any single node from becoming a performance bottleneck, improving the reliability and stability of the cluster. Efficient rebalancing leads to better utilization of available resources, potentially reducing the need for additional hardware investments and lowering operational costs.
+A standout feature of ProxLB is its maintenance mode. When enabled, all guest workloads are automatically moved to other nodes within the cluster, ensuring that a node can be safely updated, rebooted, or undergo hardware maintenance without disrupting the overall cluster operation. Additionally, ProxLB supports both affinity and anti-affinity rules, allowing operators to group multiple guests to run together on the same node or ensure that certain guests do not run on the same node, depending on the cluster's node count. This feature is crucial for optimizing performance and maintaining high availability.
 
-Automated rebalancing reduces the need for manual actions, allowing operators to focus on other critical tasks, thereby increasing operational efficiency.
+ProxLB can also return the best next node for guest placement, which can be integrated into CI/CD pipelines using tools like Ansible or Terraform. This capability streamlines the deployment process and ensures efficient resource utilization. Furthermore, ProxLB leverages the Proxmox API, including the entire ACL (Access Control List) system, for secure and efficient operation. Unlike some solutions, it does not require SSH access, enhancing security and simplifying configuration.
+
+Overall, ProxLB significantly enhances resource management by intelligently distributing workloads, reducing downtime through its maintenance mode, and providing improved flexibility with affinity and anti-affinity rules. Its seamless integration with CI/CD tools and reliance on the Proxmox API make it a robust and secure solution for optimizing Proxmox cluster performance.
 
 ### Video of Migration
-<img src="https://cdn.gyptazy.ch/images/proxlb-rebalancing-demo.gif"/>
+<img src="https://cdn.gyptazy.com/images/proxlb-rebalancing-demo.gif"/>
 
 ## Features
-* Rebalance the cluster by:
+ProxLB's key features are by enabling automatic rebalancing of VMs and CTs across a Proxmox cluster based on memory, CPU, and local disk usage while identifying optimal nodes for automation. It supports maintenance mode, affinity rules, and seamless Proxmox API integration with ACL support, offering flexible usage as a one-time operation, a daemon, or through the Proxmox Web GUI.
+
+**Features**
+* Rebalance VMs/CTs in the cluster by:
   * Memory
   * Disk (only local storage)
   * CPU
-* Performing
-  * Periodically
-  * One-shot solution
-* Types
-  * Rebalance only VMs
-  * Rebalance only CTs
-  * Rebalance all (VMs and CTs)
-* Filter
-  * Exclude nodes
-  * Exclude virtual machines
-* Grouping
-  * Include groups (VMs that are rebalanced to nodes together)
-  * Exclude groups (VMs that must run on different nodes)
-  * Ignore groups (VMs that should be untouched)
-* Dry-run support
-  * Human readable output in CLI
-  * JSON output for further parsing
-* Migrate VM workloads away (e.g. maintenance preparation)
+* Get best nodes for further automation
+* Supported Guest Types
+  * VMs
+  * CTs
+* Maintenance Mode
+  * Set node(s) into maintenance
+  * Move all workloads to different nodes
+* Affinity / Anti-Affinity Rules
 * Fully based on Proxmox API
+  * Fully integrated into the Proxmox ACL
+  * No SSH required
 * Usage
-  * One-Shot (one-shot)
-  * Periodically (daemon)
-  * Proxmox Web GUI Integration (optional)
+  * One-Time
+  * Daemon
+  * Proxmox Web GUI Integration
 
 ## How does it work?
 ProxLB is a load-balancing system designed to optimize the distribution of virtual machines (VMs) and containers (CTs) across a cluster. It works by first gathering resource usage metrics from all nodes in the cluster through the Proxmox API. This includes detailed resource metrics for each VM and CT on every node. ProxLB then evaluates the difference between the maximum and minimum resource usage of the nodes, referred to as "Balanciness." If this difference exceeds a predefined threshold (which is configurable), the system initiates the rebalancing process.
 
 Before starting any migrations, ProxLB validates that rebalancing actions are necessary and beneficial. Depending on the selected balancing mode — such as CPU, memory, or disk — it creates a balancing matrix. This matrix sorts the VMs by their maximum used or assigned resources, identifying the VM with the highest usage. ProxLB then places this VM on the node with the most free resources in the selected balancing type. This process runs recursively until the operator-defined Balanciness is achieved. Balancing can be defined for the used or max. assigned resources of VMs/CTs.
 
-## Usage
-Running PLB is easy and it runs almost everywhere since it just depends on `Python3` and the `proxmoxer` library. Therefore, it can directly run on a Proxmox node, dedicated systems like Debian, RedHat, or even FreeBSD, as long as the API is reachable by the client running PLB.
+## Installation
 
-### Dependencies
-* Python3
-* proxmoxer (Python module)
+### Requirements / Dependencies
+* Proxmox
+    * Proxmox 7.x
+    * Proxmox 8.x
+    * Proxmox 9.x (Beta 1 tested)
+* Python3.x
+* proxmoxer
+* requests
+* urllib3
+* pyyaml
 
-### Options
-The following options can be set in the `proxlb.conf` file:
-
-| Option | Example | Description |
-|------|:------:|:------:|
-| api_host | hypervisor01.gyptazy.ch | Host or IP address of the remote Proxmox API. |
-| api_user | root@pam | Username for the API. |
-| api_pass | FooBar | Password for the API. |
-| verify_ssl | 1 | Validate SSL certificates (1) or ignore (0). (default: 1) |
-| method | memory | Defines the balancing method (default: memory) where you can use `memory`, `disk` or `cpu`. |
-| mode | used | Rebalance by `used` resources (efficiency) or `assigned` (avoid overprovisioning) resources. (default: used)|
-| mode_option | byte | Rebalance by node's resources in `bytes` or `percent`. (default: bytes) |
-| type | vm | Rebalance only `vm` (virtual machines), `ct` (containers) or `all` (virtual machines & containers). (default: vm)|
-| balanciness | 10 | Value of the percentage of lowest and highest resource consumption on nodes may differ before rebalancing. (default: 10) |
-| parallel_migrations | 1 | Defines if migrations should be done parallely or sequentially. (default: 1) |
-| ignore_nodes | dummynode01,dummynode02,test* | Defines a comma separated list of nodes to exclude. |
-| ignore_vms | testvm01,testvm02 | Defines a comma separated list of VMs to exclude. (`*` as suffix wildcard or tags are also supported) |
-| master_only | 0 | Defines is this should only be performed (1) on the cluster master node or not (0). (default: 0) |
-| daemon | 1 | Run as a daemon (1) or one-shot (0). (default: 1) |
-| schedule | 24 | Hours to rebalance in hours. (default: 24) |
-| log_verbosity | INFO | Defines the log level (default: CRITICAL) where you can use `INFO`, `WARN` or `CRITICAL` |
-
-An example of the configuration file looks like:
+The dependencies can simply be installed with `pip` by running the following command:
 ```
-[proxmox]
-api_host: hypervisor01.gyptazy.ch
-api_user: root@pam
-api_pass: FooBar
-verify_ssl: 1
-[balancing]
-method: memory
-mode: used
-type: vm
-# Balanciness defines how much difference may be
-# between the lowest & highest resource consumption
-# of nodes before rebalancing will be done.
-# Examples:
-# Rebalancing:     node01: 41% memory consumption :: node02: 52% consumption
-# No rebalancing:  node01: 43% memory consumption :: node02: 50% consumption
-balanciness: 10
-# Enable parallel migrations. If set to 0 it will wait for completed migrations
-# before starting next migration.
-parallel_migrations: 1
-ignore_nodes: dummynode01,dummynode02
-ignore_vms: testvm01,testvm02
-[service]
-# The master_only option might be usuful if running ProxLB on all nodes in a cluster
-# but only a single one should do the balancing. The master node is obtained from the Proxmox
-# HA status.
-master_only: 0
-daemon: 1
+pip install -r requirements.txt
 ```
 
-### Parameters
-The following options and parameters are currently supported:
+*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.*
 
-| Option | Long Option | Description | Default |
-|------|:------:|------:|------:|
-| -c | --config | Path to a config file. | /etc/proxlb/proxlb.conf (default) |
-| -d | --dry-run | Perform a dry-run without doing any actions. | Unset |
-| -j | --json | Return a JSON of the VM movement. | Unset |
+### 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.
 
-### Balancing
-#### General
-In general, virtual machines and containers can be rebalanced and moved around nodes in the cluster. Often, this also works without downtime without any further downtimes. However, this does **not** work with containers. LXC based containers will be shutdown, copied and started on the new node. Also to note, live migrations can work fluently without any issues but there are still several things to be considered. This is out of scope for ProxLB and applies in general to Proxmox and your cluster setup. You can find more details about this here: https://pve.proxmox.com/wiki/Migrate_to_Proxmox_VE.
+#### Quick-Start
+You can simply use this snippet to install the repository and to install ProxLB on your system.
 
-#### By Used Memory of VMs/CTs
-By continuously monitoring the current resource usage of VMs, ProxLB intelligently reallocates workloads to prevent any single node from becoming overloaded. This approach ensures that resources are balanced efficiently, providing consistent and optimal performance across the entire cluster at all times. To activate this balancing mode, simply activate the following option in your ProxLB configuration:
-```
-mode: used
+```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, restart the service (if running in daemon mode) to activate this rebalancing mode.
+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:
 
-#### By Assigned Memory of VMs/CTs
-By ensuring that resources are always available for each VM, ProxLB prevents over-provisioning and maintains a balanced load across all nodes. This guarantees that users have consistent access to the resources they need. However, if the total assigned resources exceed the combined capacity of the cluster, ProxLB will issue a warning, indicating potential over-provisioning despite its best efforts to balance the load.  To activate this balancing mode, simply activate the following option in your ProxLB configuration:
 ```
-mode: assigned
+# 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
 ```
 
-Afterwards, restart the service (if running in daemon mode) to activate this rebalancing mode.
+*Note: The defined repositories `repo.gyptazy.com` and `repo.proxlb.de` are the same!*
 
-### Grouping
-#### Include (Stay Together)
-<img align="left" src="https://cdn.gyptazy.ch/images/plb-rebalancing-include-balance-group.jpg"/> Access the Proxmox Web UI by opening your web browser and navigating to your Proxmox VE web interface, then log in with your credentials. Navigate to the VM you want to tag by selecting it from the left-hand navigation panel. Click on the "Options" tab to view the VM's options, then select "Edit" or "Add" (depending on whether you are editing an existing tag or adding a new one). In the tag field, enter plb_include_ followed by your unique identifier, for example, plb_include_group1. Save the changes to apply the tag to the VM. Repeat these steps for each VM that should be included in the group.
+#### 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/
 
-#### Exclude (Stay Separate)
-<img align="left" src="https://cdn.gyptazy.ch/images/plb-rebalancing-exclude-balance-group.jpg"/> Access the Proxmox Web UI by opening your web browser and navigating to your Proxmox VE web interface, then log in with your credentials. Navigate to the VM you want to tag by selecting it from the left-hand navigation panel. Click on the "Options" tab to view the VM's options, then select "Edit" or "Add" (depending on whether you are editing an existing tag or adding a new one). In the tag field, enter plb_exclude_ followed by your unique identifier, for example, plb_exclude_critical. Save the changes to apply the tag to the VM. Repeat these steps for each VM that should be excluded from being on the same node.
+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
+```
 
-#### Ignore VMs (Tag Style)
-<img align="left" src="https://cdn.gyptazy.ch/images/plb-rebalancing-ignore-vm.jpg"/>  In Proxmox, you can ensure that certain VMs are ignored during the rebalancing process by setting a specific tag within the Proxmox Web UI, rather than solely relying on configurations in the ProxLB config file. This can be achieved by adding the tag 'plb_ignore_vm' to the VM. Once this tag is applied, the VM will be excluded from any further rebalancing operations, simplifying the management process.
+### Container Images / Docker
+Using the ProxLB container images is straight forward and only requires you to mount the config file.
 
-### Systemd
-When installing a Linux distribution (such as .deb or .rpm) file, this will be shipped with a systemd unit file. The default configuration file will be sourced from `/etc/proxlb/proxlb.conf`.
+```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
+```
 
-| Unit Name | Options |
+*Note: ProxLB container images are officially only available at cr.proxlb.de and cr.gyptazy.com.*
+
+#### Overview of Images
+| Version | Image |
 |------|:------:|
-| proxlb | start, stop, status, restart |
+| latest | cr.gyptazy.com/proxlb/proxlb:latest |
+| v1.1.5 | cr.gyptazy.com/proxlb/proxlb:v1.1.5 |
+| v1.1.4 | cr.gyptazy.com/proxlb/proxlb:v1.1.4 |
+| v1.1.3 | cr.gyptazy.com/proxlb/proxlb:v1.1.3 |
+| v1.1.2 | cr.gyptazy.com/proxlb/proxlb:v1.1.2 |
+| v1.1.1 | cr.gyptazy.com/proxlb/proxlb:v1.1.1 |
+| 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 |
 
-### Manual
-A manual installation is possible and also supports BSD based systems. Proxmox Rebalancing Service relies on mainly two important files:
-* proxlb (Python Executable)
-* proxlb.conf (Config file)
+### Source
+ProxLB can also easily be used from the provided sources - for traditional systems but also as a Docker/Podman container image.
 
-The executable must be able to read the config file, if no dedicated config file is given by the `-c` argument, PLB tries to read it from `/etc/proxlb/proxlb.conf`.
-
-### Proxmox GUI Integration
-<img align="left" src="https://cdn.gyptazy.ch/images/proxlb-GUI-integration.jpg"/> PLB can also be directly be used from the Proxmox Web UI by installing the optional package `pve-proxmoxlb-service-ui` package which has a dependency on the `proxlb` package. For the Web UI integration, it requires to be installed (in addition) on the nodes on the cluster. Afterwards, a new menu item is present in the HA chapter called `Rebalancing`. This chapter provides two possibilities:
-* Rebalancing VM workloads
-* Migrate VM workloads away from a defined node (e.g. maintenance preparation)
-
-### Quick Start
-The easiest way to get started is by using the ready-to-use packages that I provide on my CDN and to run it on a Linux Debian based system. This can also be one of the Proxmox nodes itself.
-
-```
-wget https://cdn.gyptazy.ch/files/amd64/debian/proxlb/proxlb_1.0.0_amd64.deb
-dpkg -i proxlb_1.0.0_amd64.deb
-# Adjust your config
-vi /etc/proxlb/proxlb.conf
-systemctl restart proxlb
-systemctl status proxlb
+#### 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
 ```
 
-### Container Quick Start (Docker/Podman)
-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 a 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.
+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
@@ -228,83 +209,207 @@ docker build -t proxlb .
 ```
 
 Afterwards simply adjust the config file to your needs:
-```
-vi /etc/proxlb/proxlb.conf
+```bash
+vi config/proxlb.yaml
 ```
 
 Finally, start the created container.
 ```bash
-docker run -it --rm -v $(pwd)/proxlb.conf:/etc/proxlb/proxlb.conf proxlb
+docker run -it --rm -v $(pwd)/proxlb.yaml:/etc/proxlb/proxlb.yaml proxlb
 ```
 
-### Logging
-ProxLB uses the `SystemdHandler` for logging. You can find all your logs in your systemd unit log or in the `journalctl`. In default, ProxLB only logs critical events. However, for further understanding of the balancing it might be useful to change this to `INFO` or `DEBUG` which can simply be done in the [proxlb.conf](https://github.com/gyptazy/ProxLB/blob/main/proxlb.conf#L14) file by changing the `log_verbosity` parameter.
+## 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.
 
-Available logging values:
-| Verbosity | Description |
-|------|:------:|
-| DEBUG | This option logs everything and is needed for debugging the code. |
-| INFO | This option provides insides behind the scenes. What/why has been something done and with which values. |
-| WARNING | This option provides only warning messages, which might be a problem in general but not for the application itself. |
-| CRITICAL | This option logs all critical events that will avoid running ProxLB. |
+### 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)
 
-## Motivation
-As a developer managing a cluster of virtual machines for my projects, I often encountered the challenge of resource imbalance. Nodes within the cluster would become unevenly loaded, with some nodes being overburdened while others remained underutilized. This imbalance led to inefficiencies, performance bottlenecks, and increased operational costs. Frustrated by the lack of an adequate solution to address this issue, I decided to develop the ProxLB (PLB) to ensure better resource distribution across my clusters.
+**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).
 
-My primary motivation for creating PLB stemmed from my work on my BoxyBSD project, where I consistently faced the difficulty of maintaining balanced nodes while running various VM workloads but also on my personal clusters. The absence of an efficient rebalancing mechanism made it challenging to achieve optimal performance and stability. Recognizing the necessity for a tool that could gather and analyze resource metrics from both the cluster nodes and the running VMs, I embarked on developing ProxLB.
+### 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.
 
-PLB meticulously collects detailed resource usage data from each node in a Proxmox cluster, including CPU load, memory usage, and local disk space utilization. It also gathers comprehensive statistics from all running VMs, providing a granular understanding of the workload distribution. With this data, PLB intelligently redistributes VMs based on memory usage, local disk usage, and CPU usage. This ensures that no single node is overburdened, storage resources are evenly distributed, and the computational load is balanced, enhancing overall cluster performance.
+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.
 
-As an advocate of the open-source philosophy, I believe in the power of community and collaboration. By sharing solutions like PLB, I aim to contribute to the collective knowledge and tools available to developers facing similar challenges. Open source fosters innovation, transparency, and mutual support, enabling developers to build on each other's work and create better solutions together.
+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.
 
-Developing PLB was driven by a desire to solve a real problem I faced in my projects. However, the spirit behind this effort was to provide a valuable resource to the community. By open-sourcing PLB, I hope to help other developers manage their clusters more efficiently, optimize their resource usage, and reduce operational costs. Sharing this solution aligns with the core principles of open source, where the goal is not only to solve individual problems but also to contribute to the broader ecosystem.
+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.
 
-## References
-Here you can find some overviews of references for and about the ProxLB (PLB):
+See also: [#65: Host groups: Honour HA groups](https://github.com/gyptazy/ProxLB/issues/65).
 
-| Description | Link |
-|------|:------:|
-| General introduction into ProxLB | https://gyptazy.ch/blog/proxlb-rebalancing-vm-workloads-across-nodes-in-proxmox-clusters/ |
-| Howto install and use ProxLB on Debian to rebalance vm workloads in a Proxmox cluster | https://gyptazy.ch/howtos/howto-install-and-use-proxlb-to-rebalance-vm-workloads-across-nodes-in-proxmox-clusters/ |
+### Options
+The following options can be set in the configuration file `proxlb.yaml`:
 
-## Downloads
-ProxLB can be obtained in man different ways, depending on which use case you prefer. You can use simply copy the code from GitHub, use created packages for Debian or RedHat based systems, use a Repository to keep ProxLB always up to date or simply use a Container image for Docker/Podman.
-
-### Packages
-Ready to use packages can be found at:
-* https://cdn.gyptazy.ch/files/amd64/debian/proxlb/
-* https://cdn.gyptazy.ch/files/amd64/ubuntu/proxlb/
-* https://cdn.gyptazy.ch/files/amd64/redhat/proxlb/
-* https://cdn.gyptazy.ch/files/amd64/freebsd/proxlb/
+| Section | Option | Sub Option | Example | Type | Description |
+|---------|:------:|:----------:|:-------:|:----:|:-----------:|
+| `proxmox_api` |  |  |  |  |  |
+|  | hosts |  | ['virt01.example.com', '10.10.10.10', 'fe01:bad:code::cafe', 'virt01.example.com:443', '[fc00::1]', '[fc00::1]:443', 'fc00::1:8006'] | `List` | List of Proxmox nodes. Can be IPv4, IPv6 or mixed. You can specify custom ports. In case of IPv6 without brackets the port is considered after the last colon |
+|  | 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). [values: `1` (default), `0`] |
+|  | timeout |  | 10 | `Int` | Timeout for the Proxmox API in sec. |
+|  | retries |  | 1 | `Int` | How often a connection attempt to the defined API host should be performed. |
+|  | wait_time |  | 1 | `Int` | How many seconds should be waited before performing another connection attempt to the API host. |
+| `proxmox_cluster` |  |  |  |  |  |
+|  | maintenance_nodes |  | ['virt66.example.com'] | `List` | A list of Proxmox nodes that are defined to be in a maintenance. (must be the same node names as used within the cluster) |
+|  | ignore_nodes |  | [] | `List` | A list of Proxmox nodes that are defined to be ignored. |
+|  | overprovisioning |  | False | `Bool` | Avoids balancing when nodes would become overprovisioned. |
+| `balancing` |  |  |  |  |  |
+|  | enable |  | True | `Bool` | Enables the guest balancing.|
+|  | enforce_affinity |  | True | `Bool` | Enforcing affinity/anti-affinity rules but balancing might become worse. |
+|  | parallel |  | False | `Bool` | If guests should be moved in parallel or sequentially.|
+|  | parallel_jobs |  | 5 | `Int` | The amount if parallel jobs when migrating guests. (default: `5`)|
+|  | live |  | True | `Bool` | If guests should be moved live or shutdown.|
+|  | with_local_disks |  | True | `Bool` | If balancing of guests should include local disks.|
+|  | balance_types |  | ['vm', 'ct'] | `List` | Defined the types of guests that should be honored. [values: `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. |
+|  | method |  | memory | `Str` | The balancing method that should be used.  [values: `memory` (default), `cpu`, `disk`]|
+|  | mode |  | used | `Str` | The balancing mode that should be used. [values: `used` (default), `assigned`] |
+| `service` |  |  |  |  |  |
+|  | daemon |  | True | `Bool` | If daemon mode should be activated. |
+|  | `schedule` |  |  | `Dict` | Schedule config block for rebalancing. |
+|  |  | interval | 12 | `Int` | How often rebalancing should occur in daemon mode.|
+|  |  | format | hours | `Str` | Sets the time format. [values: `hours` (default), `minutes`]|
+|  | `delay` |  |  | `Dict` | Schedule config block for an optional delay until the service starts. |
+|  |  | enable | False | `Bool` | If a delay time should be validated.|
+|  |  | time | 1 | `Int` | Delay time until the service starts after the initial execution.|
+|  |  | format | hours | `Str` | Sets the time format. [values: `hours` (default), `minutes`]|
+|  | log_level |  | INFO | `Str` | Defines the default log level that should be logged. [values: `INFO` (default), `WARNING`, `CRITICAL`, `DEBUG`] |
 
 
-### Repository
-Debian based systems can also use the repository by adding the following line to their apt sources:
-
+An example of the configuration file looks like:
 ```
-deb https://repo.gyptazy.ch/ /
+proxmox_api:
+  hosts: ['virt01.example.com', '10.10.10.10', 'fe01:bad:code::cafe']
+  user: root@pam
+  pass: crazyPassw0rd!
+  # API Token method
+  # token_id: proxlb
+  # token_secret: 430e308f-1337-1337-beef-1337beefcafe
+  ssl_verification: True
+  timeout: 10
+  # API Connection retries
+  # retries: 1
+  # wait_time: 1
+
+proxmox_cluster:
+  maintenance_nodes: ['virt66.example.com']
+  ignore_nodes: []
+  overprovisioning: True
+
+balancing:
+  enable: True
+  enforce_affinity: False
+  parallel: False
+  live: True
+  with_local_disks: True
+  balance_types: ['vm', 'ct']
+  max_job_validation: 1800
+  balanciness: 5
+  method: memory
+  mode: used
+
+service:
+  daemon: True
+  schedule:
+    interval: 12
+    format: hours
+  delay:
+    enable: False
+    time: 1
+    format: hours
+  log_level: INFO
 ```
 
-The Repository's GPG key can be found at: `https://repo.gyptazy.ch/repo/KEY.gpg`
+### Parameters
+The following options and parameters are currently supported:
 
-You can also simply import it by running:
+| Option | Long Option | Description | 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 |
+| -v | --version | Returns the ProxLB version on stdout. | False |
 
+## 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
 ```
-# KeyID:  DEB76ADF7A0BAADB51792782FD6A7A70C11226AA
-# SHA256: 5e44fffa09c747886ee37cc6e9e7eaf37c6734443cc648eaf0a9241a89084383  KEY.gpg
-
-wget -O /etc/apt/trusted.gpg.d/proxlb.asc https://repo.gyptazy.ch/repo/KEY.gpg
+plb_affinity_talos
 ```
 
-*Note: The defined repositories `repo.gyptazy.ch` and `repo.proxlb.de` are the same!*
+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).
 
-### Container Images (Docker/Podman)
-Container Images for Podman, Docker etc., can be found at:
-| Version | Image |
-|------|:------:|
-| latest | cr.gyptazy.ch/proxlb/proxlb:latest |
-| v1.0.0 | cr.gyptazy.ch/proxlb/proxlb:v1.0.0 |
-| v0.9.9 | cr.gyptazy.ch/proxlb/proxlb:v0.9.9 |
+### 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.
+
+### Ignore VMs
+<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.
+
+### Pin VMs to Specific Hypervisor Nodes
+<img align="left" src="https://cdn.gyptazy.com/images/proxlb-tag-node-pinning.jpg"/> Guests, such as VMs or CTs, can also be pinned to specific (and multiple) nodes in the cluster. This might be usefull when running applications with some special licensing requirements that are only fulfilled on certain nodes. It might also be interesting, when some physical hardware is attached to a node, that is not available in general within the cluster.
+
+To pin a guest to a specific cluster node, users assign a tag with the prefix `plb_pin_$nodename` to the desired guest:
+
+#### Example for Screenshot
+```
+plb_pin_node03
+```
+
+As a result, ProxLB will pin the guest `dev-vm01` to the node `virt03`.
+
+You can also repeat this step multiple times for different node names to create a potential group of allowed hosts where a the guest may be served on. In this case, ProxLB takes the node with the lowest used resources according to the defined balancing values from this group.
+
+**Note:** The given node names from the tag are validated. This means, ProxLB validated if the given node name is really part of the cluster. In case of a wrongly defined or unavailable node name it continous to use the regular processes to make sure the guest keeps running.
+
+## 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
@@ -313,14 +418,22 @@ Bugs can be reported via the GitHub issue tracker [here](https://github.com/gypt
 ### 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/main/CONTRIBUTING.md) file.
 
+### Documentation
+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.ch) in Matrix and on Reddit. Join our community for real-time help, advice, and discussions. Connect with us in our dedicated chat room for immediate support and live interaction with other users and developers. You can also visit our [Reddit community](https://www.reddit.com/r/Proxmox/comments/1e78ap3/introducing_proxlb_rebalance_your_vm_workloads/) to post your queries, share your experiences, and get support from fellow community members and moderators. You may also just open directly an issue [here](https://github.com/gyptazy/ProxLB/issues) on GitHub. We are here to help and ensure you have the best experience possible.
+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!
+
+Connect with us in our dedicated chat room for immediate support and live interaction with other users and developers. You can also visit our [GitHub Community](https://github.com/gyptazy/ProxLB/discussions/) to post your queries, share your experiences, and get support from fellow community members and moderators. You may also just open directly an issue [here](https://github.com/gyptazy/ProxLB/issues) on GitHub.
 
 | Support Channel | Link |
 |------|:------:|
-| Matrix | [#proxlb:gyptazy.ch](https://matrix.to/#/#proxlb:gyptazy.ch) |
-| Reddit | [Reddit community](https://www.reddit.com/r/Proxmox/comments/1e78ap3/introducing_proxlb_rebalance_your_vm_workloads/)  |
+| Matrix | [#proxlb:gyptazy.com](https://matrix.to/#/#proxlb:gyptazy.com) |
+| Discord | [Discord](https://discord.gg/JemGu7WbfQ) |
+| GitHub Community | [GitHub Community](https://github.com/gyptazy/ProxLB/discussions/)
 | GitHub | [ProxLB GitHub](https://github.com/gyptazy/ProxLB/issues) |
 
+**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.ch)
+ * Florian Paul Azim Hoberg @gyptazy (https://gyptazy.com)

config/proxlb_example.yaml

@@ -0,0 +1,43 @@
+proxmox_api:
+  hosts: ['virt01.example.com', '10.10.10.10', 'fe01:bad:code::cafe']
+  user: root@pam
+  pass: crazyPassw0rd!
+  # API Token method
+  # token_id: proxlb
+  # token_secret: 430e308f-1337-1337-beef-1337beefcafe
+  ssl_verification: True
+  timeout: 10
+  # API Connection retries
+  # retries: 1
+  # wait_time: 1
+
+proxmox_cluster:
+  maintenance_nodes: ['virt66.example.com']
+  ignore_nodes: []
+  overprovisioning: True
+
+balancing:
+  enable: True
+  enforce_affinity: False
+  parallel: False
+  # If running parallel job, you can define
+  # the amount of prallel jobs (default: 5)
+  parallel_jobs: 1
+  live: True
+  with_local_disks: True
+  balance_types: ['vm', 'ct']
+  max_job_validation: 1800
+  balanciness: 5
+  method: memory
+  mode: used
+
+service:
+  daemon: True
+  schedule:
+    interval: 12
+    format: hours
+  delay:
+    enable: False
+    time: 1
+    format: hours
+  log_level: INFO

debian/changelog

@@ -0,0 +1,54 @@
+proxlb (1.1.5) stable; urgency=medium
+
+  * Allow custom API ports instead of fixed tcp/8006. (Closes: #260)
+
+ -- Florian Paul Azim Hoberg <gyptazy@gyptazy.com>  Mon, 14 Jul 2025 11:07:34 +0000
+
+proxlb (1.1.4) stable; urgency=medium
+
+  * Allow pinning of guests to a group of nodes. (Closes: #245)
+  * Modified log levels to make output lighter at INFO level. (Closes: #255)
+  * ixed an issue where balancing was performed in combination of deactivated balancing and dry-run mode. (Closes: #248)
+
+ -- Florian Paul Azim Hoberg <gyptazy@gyptazy.com>  Fri, 27 Jun 2025 16:22:58 +0000
+
+proxlb (1.1.3) stable; urgency=medium
+
+  * Add relaod (SIGHUP) function to ProxLB to reload the configuration. (Closes: #189)
+  * Add optional wait time parameter to delay execution until the service takes action. (Closes: #239)
+  * Make the amount of parallel migrations configurable. (Closes: #241)
+  * Use the average CPU consumption of a guest within the last 60 minutes instead of the current CPU usage. (Closes: #94)
+  * Align maintenance mode with Proxmox HA maintenance mode. (Closes: #232)
+
+ -- Florian Paul Azim Hoberg <gyptazy@gyptazy.com>  Thu, 19 Jun 2025 09:10:43 +0000
+
+proxlb (1.1.2) stable; urgency=medium
+
+  * Add a configurable retry mechanism when connecting to the Proxmox API. (Closed: #157)
+  * Add 1-to-1 relationships between guest and hypervisor node to ping a guest on a node. (Closes #218)
+  * Force type cast cpu count of guests to int for some corner cases where a str got returned. (Closed #222)
+  * Fix systemd unit file to run after network on non PVE nodes. (Closes #137)
+
+ -- Florian Paul Azim Hoberg <gyptazy@gyptazy.com>  Mon, 13 May 2025 18:12:04 +0000
+
+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)
+  * Providing the API upstream error message when migration fails in debug mode (Closes: #205)
+  * Change the default behaviour of the daemon mode to active. (Closes: #176)
+  * Change the default banalcing mode to used instead of assigned. (Closes: #180)
+  * 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. (Closes: #195)
+  * Honor the value when balancing should not be performed and stop balancing. (Closes: #174)
+  * Allow the use of minutes instead of hours and only accept hours or minutes in the format. (Closes: #187)
+  * Remove hard coded memory usage from lowest usage node and use method and mode specified in configuration instead. (Closes: #197)
+  * Fix the guest type relationship in the logs when a migration job failed. (Closes: #204)
+  * Requery a guest if that running guest reports 0 cpu usage. (Closes: #200)
+
+ -- Florian Paul Azim Hoberg <gyptazy@gyptazy.com>  Sat, 20 Apr 2025 20: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_Installation.md

@@ -1,32 +0,0 @@
-# Installation
-
-## Packages
-The easiest way to get started is by using the ready-to-use packages that I provide on my CDN and to run it on a Linux Debian based system. This can also be one of the Proxmox nodes itself.
-
-```
-wget https://cdn.gyptazy.ch/files/amd64/debian/proxlb/proxlb_0.9.9_amd64.deb
-dpkg -i proxlb_0.9.9_amd64.deb
-# Adjust your config
-vi /etc/proxlb/proxlb.conf
-systemctl restart proxlb
-systemctl status proxlb
-```
-
-## Container (Docker/Podman)
-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 a 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
-build -t proxlb .
-```
-
-Afterwards simply adjust the config file to your needs:
-```
-vi /etc/proxlb/proxlb.conf
-```
-
-Finally, start the created container.
-```bash
-docker run -it --rm -v $(pwd)/proxlb.conf:/etc/proxlb/proxlb.conf proxlb
-```