fix

Fixes: #114

.changelogs/1.0.2/40_add_option_to_run_only_on_cluster_master_node.yml

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

.changelogs/1.0.2/41_add_option_run_migration_parallel_or_sequential.yml

@@ -0,0 +1,2 @@
+added:
+  - Add option to run migrations in parallel or sequentially. [#41]

.changelogs/1.0.2/45_fix_daemon_timer.yml

@@ -0,0 +1,2 @@
+changed:
+  - Fix daemon timer to use hours instead of minutes. [#45]

.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

.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

.gitignore

@@ -1,2 +1,2 @@
-packaging/changelog-fragments-creator/
-dev/
+__pycache__
+proxlb_dev.yaml

CHANGELOG.md

@@ -1,40 +0,0 @@
-# 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.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 dry-run support to see what kind of rebalancing would be done. [#6]
-- Add LXC/Container integration. [#27]
-- Add include grouping feature to rebalance VMs bundled to new nodes. [#3]
-
-### 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.

CONTRIBUTING.md

@@ -1,121 +0,0 @@
-# Contributing to ProxLB (PLB)
-
-Thank you for considering contributing to ProxLB! We appreciate your help in improving the efficiency and performance of Proxmox clusters. Below are guidelines for contributing to the project.
-
-## Table of Contents
-
-- [Contributing to ProxLB (PLB)](#contributing-to-proxlb-plb)
-  - [Table of Contents](#table-of-contents)
-  - [Creating an Issue](#creating-an-issue)
-  - [Running Linting](#running-linting)
-  - [Running Tests](#running-tests)
-  - [Add Changelogs](#add-changelogs)
-  - [Submitting a Pull Request](#submitting-a-pull-request)
-  - [Code of Conduct](#code-of-conduct)
-  - [Getting Help](#getting-help)
-
-## Creating an Issue
-
-If you encounter a bug, have a feature request, or have any suggestions, please create an issue in our GitHub repository. To create an issue:
-
-1. **Go to the [Issues](https://github.com/gyptazy/proxlb/issues) section of the repository.**
-2. **Click on the "New issue" button.**
-3. **Select the appropriate issue template (Bug Report, Feature Request, or Custom Issue).**
-4. **Provide a clear and descriptive title.**
-5. **Fill out the necessary details in the issue template.** Provide as much detail as possible to help us understand and reproduce the issue or evaluate the feature request.
-
-## Running Linting
-Before submitting a pull request, ensure that your changes sucessfully perform the lintin. ProxLB uses [flake8] for running tests. Follow these steps to run tests locally:
-
-1. **Install pytest if you haven't already:**
-   ```sh
-   pip install fake8
-   ```
-
-2. **Run the lintin:**
-   ```sh
-   python3 -m flake8 proxlb
-   ```
-
-Linting will also be performed for each PR. Therefore, it might make sense to test this before pushing locally.
-
-## Running Tests
-
-Before submitting a pull request, ensure that your changes do not break existing functionality. ProxLB uses [pytest](https://docs.pytest.org/en/stable/) for running tests. Follow these steps to run tests locally:
-
-1. **Install pytest if you haven't already:**
-   ```sh
-   pip install pytest
-   ```
-
-2. **Run the tests:**
-   ```sh
-   pytest
-   ```
-
-Ensure all tests pass before submitting your changes.
-
-## Add Changelogs
-ProxLB uses the [Changelog Fragments Creator](https://github.com/gyptazy/changelog-fragments-creator) for creating the overall `CHANGELOG.md` file. This changelog file is being generated from the files placed in the https://github.com/gyptazy/ProxLB/tree/main/.changelogs/ directory. Each release is represented by its version number where additional yaml files are being placed and parsed by the CFC tool. Such files look like:
-
-```
-added:
-  - Add option to rebalance by assigned VM resources to avoid overprovisioning. [#16]
-```
-
-Every PR should contain such a file describing the change to ensure this is also stated in the changelog file.
-
-## Submitting a Pull Request
-
-We welcome your contributions! Follow these steps to submit a pull request:
-
-1. **Fork the repository to your GitHub account.**
-2. **Clone your forked repository to your local machine:**
-   ```sh
-   git clone https://github.com/gyptazy/proxlb.git
-   cd proxlb
-   ```
-
-Please prefix your PR regarding its type. It might be:
-* doc
-* feature
-* fix
-
-It should also provide the issue id to which it is related.
-
-1. **Create a new branch for your changes:**
-   ```sh
-   git checkout -b feature/10-add-new-cool-stuff
-   ```
-
-2. **Make your changes and commit them with a descriptive commit message:**
-   ```sh
-   git add .
-   git commit -m "feature: Adding new cool stuff"
-   ```
-
-3. **Push your changes to your forked repository:**
-   ```sh
-   git push origin feature/10-add-new-cool-stuff
-   ```
-
-4. **Create a pull request from your forked repository:**
-   - Go to the original repository on GitHub.
-   - Click on the "New pull request" button.
-   - Select the branch you pushed your changes to and create the pull request.
-
-Please ensure that your pull request:
-
-- Follows the project's coding style and guidelines.
-- Includes tests for any new functionality.
-- Updates the documentation as necessary.
-
-## Code of Conduct
-
-By participating in this project, you agree to abide by our [Code of Conduct](CODE_OF_CONDUCT.md). Please read it to understand the expected behavior and responsibilities when interacting with the community.
-
-## 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.
-
-Thank you for contributing to ProxLB! Together, we can enhance the efficiency and performance of Proxmox clusters.

Dockerfile

@@ -1,35 +0,0 @@
-# Use the official Debian 12 base image
-FROM debian:12
-
-# 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"
-
-# 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/*
-
-# Create a directory for the app
-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
-
-# Set the entry point to use the virtual environment's python
-ENTRYPOINT ["/app/venv/bin/python3", "/app/proxlb"]

LICENSE

@@ -1,674 +0,0 @@
-                    GNU GENERAL PUBLIC LICENSE
-                       Version 3, 29 June 2007
-
- Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
- Everyone is permitted to copy and distribute verbatim copies
- of this license document, but changing it is not allowed.
-
-                            Preamble
-
-  The GNU General Public License is a free, copyleft license for
-software and other kinds of works.
-
-  The licenses for most software and other practical works are designed
-to take away your freedom to share and change the works.  By contrast,
-the GNU General Public License is intended to guarantee your freedom to
-share and change all versions of a program--to make sure it remains free
-software for all its users.  We, the Free Software Foundation, use the
-GNU General Public License for most of our software; it applies also to
-any other work released this way by its authors.  You can apply it to
-your programs, too.
-
-  When we speak of free software, we are referring to freedom, not
-price.  Our General Public Licenses are designed to make sure that you
-have the freedom to distribute copies of free software (and charge for
-them if you wish), that you receive source code or can get it if you
-want it, that you can change the software or use pieces of it in new
-free programs, and that you know you can do these things.
-
-  To protect your rights, we need to prevent others from denying you
-these rights or asking you to surrender the rights.  Therefore, you have
-certain responsibilities if you distribute copies of the software, or if
-you modify it: responsibilities to respect the freedom of others.
-
-  For example, if you distribute copies of such a program, whether
-gratis or for a fee, you must pass on to the recipients the same
-freedoms that you received.  You must make sure that they, too, receive
-or can get the source code.  And you must show them these terms so they
-know their rights.
-
-  Developers that use the GNU GPL protect your rights with two steps:
-(1) assert copyright on the software, and (2) offer you this License
-giving you legal permission to copy, distribute and/or modify it.
-
-  For the developers' and authors' protection, the GPL clearly explains
-that there is no warranty for this free software.  For both users' and
-authors' sake, the GPL requires that modified versions be marked as
-changed, so that their problems will not be attributed erroneously to
-authors of previous versions.
-
-  Some devices are designed to deny users access to install or run
-modified versions of the software inside them, although the manufacturer
-can do so.  This is fundamentally incompatible with the aim of
-protecting users' freedom to change the software.  The systematic
-pattern of such abuse occurs in the area of products for individuals to
-use, which is precisely where it is most unacceptable.  Therefore, we
-have designed this version of the GPL to prohibit the practice for those
-products.  If such problems arise substantially in other domains, we
-stand ready to extend this provision to those domains in future versions
-of the GPL, as needed to protect the freedom of users.
-
-  Finally, every program is threatened constantly by software patents.
-States should not allow patents to restrict development and use of
-software on general-purpose computers, but in those that do, we wish to
-avoid the special danger that patents applied to a free program could
-make it effectively proprietary.  To prevent this, the GPL assures that
-patents cannot be used to render the program non-free.
-
-  The precise terms and conditions for copying, distribution and
-modification follow.
-
-                       TERMS AND CONDITIONS
-
-  0. Definitions.
-
-  "This License" refers to version 3 of the GNU General Public License.
-
-  "Copyright" also means copyright-like laws that apply to other kinds of
-works, such as semiconductor masks.
-
-  "The Program" refers to any copyrightable work licensed under this
-License.  Each licensee is addressed as "you".  "Licensees" and
-"recipients" may be individuals or organizations.
-
-  To "modify" a work means to copy from or adapt all or part of the work
-in a fashion requiring copyright permission, other than the making of an
-exact copy.  The resulting work is called a "modified version" of the
-earlier work or a work "based on" the earlier work.
-
-  A "covered work" means either the unmodified Program or a work based
-on the Program.
-
-  To "propagate" a work means to do anything with it that, without
-permission, would make you directly or secondarily liable for
-infringement under applicable copyright law, except executing it on a
-computer or modifying a private copy.  Propagation includes copying,
-distribution (with or without modification), making available to the
-public, and in some countries other activities as well.
-
-  To "convey" a work means any kind of propagation that enables other
-parties to make or receive copies.  Mere interaction with a user through
-a computer network, with no transfer of a copy, is not conveying.
-
-  An interactive user interface displays "Appropriate Legal Notices"
-to the extent that it includes a convenient and prominently visible
-feature that (1) displays an appropriate copyright notice, and (2)
-tells the user that there is no warranty for the work (except to the
-extent that warranties are provided), that licensees may convey the
-work under this License, and how to view a copy of this License.  If
-the interface presents a list of user commands or options, such as a
-menu, a prominent item in the list meets this criterion.
-
-  1. Source Code.
-
-  The "source code" for a work means the preferred form of the work
-for making modifications to it.  "Object code" means any non-source
-form of a work.
-
-  A "Standard Interface" means an interface that either is an official
-standard defined by a recognized standards body, or, in the case of
-interfaces specified for a particular programming language, one that
-is widely used among developers working in that language.
-
-  The "System Libraries" of an executable work include anything, other
-than the work as a whole, that (a) is included in the normal form of
-packaging a Major Component, but which is not part of that Major
-Component, and (b) serves only to enable use of the work with that
-Major Component, or to implement a Standard Interface for which an
-implementation is available to the public in source code form.  A
-"Major Component", in this context, means a major essential component
-(kernel, window system, and so on) of the specific operating system
-(if any) on which the executable work runs, or a compiler used to
-produce the work, or an object code interpreter used to run it.
-
-  The "Corresponding Source" for a work in object code form means all
-the source code needed to generate, install, and (for an executable
-work) run the object code and to modify the work, including scripts to
-control those activities.  However, it does not include the work's
-System Libraries, or general-purpose tools or generally available free
-programs which are used unmodified in performing those activities but
-which are not part of the work.  For example, Corresponding Source
-includes interface definition files associated with source files for
-the work, and the source code for shared libraries and dynamically
-linked subprograms that the work is specifically designed to require,
-such as by intimate data communication or control flow between those
-subprograms and other parts of the work.
-
-  The Corresponding Source need not include anything that users
-can regenerate automatically from other parts of the Corresponding
-Source.
-
-  The Corresponding Source for a work in source code form is that
-same work.
-
-  2. Basic Permissions.
-
-  All rights granted under this License are granted for the term of
-copyright on the Program, and are irrevocable provided the stated
-conditions are met.  This License explicitly affirms your unlimited
-permission to run the unmodified Program.  The output from running a
-covered work is covered by this License only if the output, given its
-content, constitutes a covered work.  This License acknowledges your
-rights of fair use or other equivalent, as provided by copyright law.
-
-  You may make, run and propagate covered works that you do not
-convey, without conditions so long as your license otherwise remains
-in force.  You may convey covered works to others for the sole purpose
-of having them make modifications exclusively for you, or provide you
-with facilities for running those works, provided that you comply with
-the terms of this License in conveying all material for which you do
-not control copyright.  Those thus making or running the covered works
-for you must do so exclusively on your behalf, under your direction
-and control, on terms that prohibit them from making any copies of
-your copyrighted material outside their relationship with you.
-
-  Conveying under any other circumstances is permitted solely under
-the conditions stated below.  Sublicensing is not allowed; section 10
-makes it unnecessary.
-
-  3. Protecting Users' Legal Rights From Anti-Circumvention Law.
-
-  No covered work shall be deemed part of an effective technological
-measure under any applicable law fulfilling obligations under article
-11 of the WIPO copyright treaty adopted on 20 December 1996, or
-similar laws prohibiting or restricting circumvention of such
-measures.
-
-  When you convey a covered work, you waive any legal power to forbid
-circumvention of technological measures to the extent such circumvention
-is effected by exercising rights under this License with respect to
-the covered work, and you disclaim any intention to limit operation or
-modification of the work as a means of enforcing, against the work's
-users, your or third parties' legal rights to forbid circumvention of
-technological measures.
-
-  4. Conveying Verbatim Copies.
-
-  You may convey verbatim copies of the Program's source code as you
-receive it, in any medium, provided that you conspicuously and
-appropriately publish on each copy an appropriate copyright notice;
-keep intact all notices stating that this License and any
-non-permissive terms added in accord with section 7 apply to the code;
-keep intact all notices of the absence of any warranty; and give all
-recipients a copy of this License along with the Program.
-
-  You may charge any price or no price for each copy that you convey,
-and you may offer support or warranty protection for a fee.
-
-  5. Conveying Modified Source Versions.
-
-  You may convey a work based on the Program, or the modifications to
-produce it from the Program, in the form of source code under the
-terms of section 4, provided that you also meet all of these conditions:
-
-    a) The work must carry prominent notices stating that you modified
-    it, and giving a relevant date.
-
-    b) The work must carry prominent notices stating that it is
-    released under this License and any conditions added under section
-    7.  This requirement modifies the requirement in section 4 to
-    "keep intact all notices".
-
-    c) You must license the entire work, as a whole, under this
-    License to anyone who comes into possession of a copy.  This
-    License will therefore apply, along with any applicable section 7
-    additional terms, to the whole of the work, and all its parts,
-    regardless of how they are packaged.  This License gives no
-    permission to license the work in any other way, but it does not
-    invalidate such permission if you have separately received it.
-
-    d) If the work has interactive user interfaces, each must display
-    Appropriate Legal Notices; however, if the Program has interactive
-    interfaces that do not display Appropriate Legal Notices, your
-    work need not make them do so.
-
-  A compilation of a covered work with other separate and independent
-works, which are not by their nature extensions of the covered work,
-and which are not combined with it such as to form a larger program,
-in or on a volume of a storage or distribution medium, is called an
-"aggregate" if the compilation and its resulting copyright are not
-used to limit the access or legal rights of the compilation's users
-beyond what the individual works permit.  Inclusion of a covered work
-in an aggregate does not cause this License to apply to the other
-parts of the aggregate.
-
-  6. Conveying Non-Source Forms.
-
-  You may convey a covered work in object code form under the terms
-of sections 4 and 5, provided that you also convey the
-machine-readable Corresponding Source under the terms of this License,
-in one of these ways:
-
-    a) Convey the object code in, or embodied in, a physical product
-    (including a physical distribution medium), accompanied by the
-    Corresponding Source fixed on a durable physical medium
-    customarily used for software interchange.
-
-    b) Convey the object code in, or embodied in, a physical product
-    (including a physical distribution medium), accompanied by a
-    written offer, valid for at least three years and valid for as
-    long as you offer spare parts or customer support for that product
-    model, to give anyone who possesses the object code either (1) a
-    copy of the Corresponding Source for all the software in the
-    product that is covered by this License, on a durable physical
-    medium customarily used for software interchange, for a price no
-    more than your reasonable cost of physically performing this
-    conveying of source, or (2) access to copy the
-    Corresponding Source from a network server at no charge.
-
-    c) Convey individual copies of the object code with a copy of the
-    written offer to provide the Corresponding Source.  This
-    alternative is allowed only occasionally and noncommercially, and
-    only if you received the object code with such an offer, in accord
-    with subsection 6b.
-
-    d) Convey the object code by offering access from a designated
-    place (gratis or for a charge), and offer equivalent access to the
-    Corresponding Source in the same way through the same place at no
-    further charge.  You need not require recipients to copy the
-    Corresponding Source along with the object code.  If the place to
-    copy the object code is a network server, the Corresponding Source
-    may be on a different server (operated by you or a third party)
-    that supports equivalent copying facilities, provided you maintain
-    clear directions next to the object code saying where to find the
-    Corresponding Source.  Regardless of what server hosts the
-    Corresponding Source, you remain obligated to ensure that it is
-    available for as long as needed to satisfy these requirements.
-
-    e) Convey the object code using peer-to-peer transmission, provided
-    you inform other peers where the object code and Corresponding
-    Source of the work are being offered to the general public at no
-    charge under subsection 6d.
-
-  A separable portion of the object code, whose source code is excluded
-from the Corresponding Source as a System Library, need not be
-included in conveying the object code work.
-
-  A "User Product" is either (1) a "consumer product", which means any
-tangible personal property which is normally used for personal, family,
-or household purposes, or (2) anything designed or sold for incorporation
-into a dwelling.  In determining whether a product is a consumer product,
-doubtful cases shall be resolved in favor of coverage.  For a particular
-product received by a particular user, "normally used" refers to a
-typical or common use of that class of product, regardless of the status
-of the particular user or of the way in which the particular user
-actually uses, or expects or is expected to use, the product.  A product
-is a consumer product regardless of whether the product has substantial
-commercial, industrial or non-consumer uses, unless such uses represent
-the only significant mode of use of the product.
-
-  "Installation Information" for a User Product means any methods,
-procedures, authorization keys, or other information required to install
-and execute modified versions of a covered work in that User Product from
-a modified version of its Corresponding Source.  The information must
-suffice to ensure that the continued functioning of the modified object
-code is in no case prevented or interfered with solely because
-modification has been made.
-
-  If you convey an object code work under this section in, or with, or
-specifically for use in, a User Product, and the conveying occurs as
-part of a transaction in which the right of possession and use of the
-User Product is transferred to the recipient in perpetuity or for a
-fixed term (regardless of how the transaction is characterized), the
-Corresponding Source conveyed under this section must be accompanied
-by the Installation Information.  But this requirement does not apply
-if neither you nor any third party retains the ability to install
-modified object code on the User Product (for example, the work has
-been installed in ROM).
-
-  The requirement to provide Installation Information does not include a
-requirement to continue to provide support service, warranty, or updates
-for a work that has been modified or installed by the recipient, or for
-the User Product in which it has been modified or installed.  Access to a
-network may be denied when the modification itself materially and
-adversely affects the operation of the network or violates the rules and
-protocols for communication across the network.
-
-  Corresponding Source conveyed, and Installation Information provided,
-in accord with this section must be in a format that is publicly
-documented (and with an implementation available to the public in
-source code form), and must require no special password or key for
-unpacking, reading or copying.
-
-  7. Additional Terms.
-
-  "Additional permissions" are terms that supplement the terms of this
-License by making exceptions from one or more of its conditions.
-Additional permissions that are applicable to the entire Program shall
-be treated as though they were included in this License, to the extent
-that they are valid under applicable law.  If additional permissions
-apply only to part of the Program, that part may be used separately
-under those permissions, but the entire Program remains governed by
-this License without regard to the additional permissions.
-
-  When you convey a copy of a covered work, you may at your option
-remove any additional permissions from that copy, or from any part of
-it.  (Additional permissions may be written to require their own
-removal in certain cases when you modify the work.)  You may place
-additional permissions on material, added by you to a covered work,
-for which you have or can give appropriate copyright permission.
-
-  Notwithstanding any other provision of this License, for material you
-add to a covered work, you may (if authorized by the copyright holders of
-that material) supplement the terms of this License with terms:
-
-    a) Disclaiming warranty or limiting liability differently from the
-    terms of sections 15 and 16 of this License; or
-
-    b) Requiring preservation of specified reasonable legal notices or
-    author attributions in that material or in the Appropriate Legal
-    Notices displayed by works containing it; or
-
-    c) Prohibiting misrepresentation of the origin of that material, or
-    requiring that modified versions of such material be marked in
-    reasonable ways as different from the original version; or
-
-    d) Limiting the use for publicity purposes of names of licensors or
-    authors of the material; or
-
-    e) Declining to grant rights under trademark law for use of some
-    trade names, trademarks, or service marks; or
-
-    f) Requiring indemnification of licensors and authors of that
-    material by anyone who conveys the material (or modified versions of
-    it) with contractual assumptions of liability to the recipient, for
-    any liability that these contractual assumptions directly impose on
-    those licensors and authors.
-
-  All other non-permissive additional terms are considered "further
-restrictions" within the meaning of section 10.  If the Program as you
-received it, or any part of it, contains a notice stating that it is
-governed by this License along with a term that is a further
-restriction, you may remove that term.  If a license document contains
-a further restriction but permits relicensing or conveying under this
-License, you may add to a covered work material governed by the terms
-of that license document, provided that the further restriction does
-not survive such relicensing or conveying.
-
-  If you add terms to a covered work in accord with this section, you
-must place, in the relevant source files, a statement of the
-additional terms that apply to those files, or a notice indicating
-where to find the applicable terms.
-
-  Additional terms, permissive or non-permissive, may be stated in the
-form of a separately written license, or stated as exceptions;
-the above requirements apply either way.
-
-  8. Termination.
-
-  You may not propagate or modify a covered work except as expressly
-provided under this License.  Any attempt otherwise to propagate or
-modify it is void, and will automatically terminate your rights under
-this License (including any patent licenses granted under the third
-paragraph of section 11).
-
-  However, if you cease all violation of this License, then your
-license from a particular copyright holder is reinstated (a)
-provisionally, unless and until the copyright holder explicitly and
-finally terminates your license, and (b) permanently, if the copyright
-holder fails to notify you of the violation by some reasonable means
-prior to 60 days after the cessation.
-
-  Moreover, your license from a particular copyright holder is
-reinstated permanently if the copyright holder notifies you of the
-violation by some reasonable means, this is the first time you have
-received notice of violation of this License (for any work) from that
-copyright holder, and you cure the violation prior to 30 days after
-your receipt of the notice.
-
-  Termination of your rights under this section does not terminate the
-licenses of parties who have received copies or rights from you under
-this License.  If your rights have been terminated and not permanently
-reinstated, you do not qualify to receive new licenses for the same
-material under section 10.
-
-  9. Acceptance Not Required for Having Copies.
-
-  You are not required to accept this License in order to receive or
-run a copy of the Program.  Ancillary propagation of a covered work
-occurring solely as a consequence of using peer-to-peer transmission
-to receive a copy likewise does not require acceptance.  However,
-nothing other than this License grants you permission to propagate or
-modify any covered work.  These actions infringe copyright if you do
-not accept this License.  Therefore, by modifying or propagating a
-covered work, you indicate your acceptance of this License to do so.
-
-  10. Automatic Licensing of Downstream Recipients.
-
-  Each time you convey a covered work, the recipient automatically
-receives a license from the original licensors, to run, modify and
-propagate that work, subject to this License.  You are not responsible
-for enforcing compliance by third parties with this License.
-
-  An "entity transaction" is a transaction transferring control of an
-organization, or substantially all assets of one, or subdividing an
-organization, or merging organizations.  If propagation of a covered
-work results from an entity transaction, each party to that
-transaction who receives a copy of the work also receives whatever
-licenses to the work the party's predecessor in interest had or could
-give under the previous paragraph, plus a right to possession of the
-Corresponding Source of the work from the predecessor in interest, if
-the predecessor has it or can get it with reasonable efforts.
-
-  You may not impose any further restrictions on the exercise of the
-rights granted or affirmed under this License.  For example, you may
-not impose a license fee, royalty, or other charge for exercise of
-rights granted under this License, and you may not initiate litigation
-(including a cross-claim or counterclaim in a lawsuit) alleging that
-any patent claim is infringed by making, using, selling, offering for
-sale, or importing the Program or any portion of it.
-
-  11. Patents.
-
-  A "contributor" is a copyright holder who authorizes use under this
-License of the Program or a work on which the Program is based.  The
-work thus licensed is called the contributor's "contributor version".
-
-  A contributor's "essential patent claims" are all patent claims
-owned or controlled by the contributor, whether already acquired or
-hereafter acquired, that would be infringed by some manner, permitted
-by this License, of making, using, or selling its contributor version,
-but do not include claims that would be infringed only as a
-consequence of further modification of the contributor version.  For
-purposes of this definition, "control" includes the right to grant
-patent sublicenses in a manner consistent with the requirements of
-this License.
-
-  Each contributor grants you a non-exclusive, worldwide, royalty-free
-patent license under the contributor's essential patent claims, to
-make, use, sell, offer for sale, import and otherwise run, modify and
-propagate the contents of its contributor version.
-
-  In the following three paragraphs, a "patent license" is any express
-agreement or commitment, however denominated, not to enforce a patent
-(such as an express permission to practice a patent or covenant not to
-sue for patent infringement).  To "grant" such a patent license to a
-party means to make such an agreement or commitment not to enforce a
-patent against the party.
-
-  If you convey a covered work, knowingly relying on a patent license,
-and the Corresponding Source of the work is not available for anyone
-to copy, free of charge and under the terms of this License, through a
-publicly available network server or other readily accessible means,
-then you must either (1) cause the Corresponding Source to be so
-available, or (2) arrange to deprive yourself of the benefit of the
-patent license for this particular work, or (3) arrange, in a manner
-consistent with the requirements of this License, to extend the patent
-license to downstream recipients.  "Knowingly relying" means you have
-actual knowledge that, but for the patent license, your conveying the
-covered work in a country, or your recipient's use of the covered work
-in a country, would infringe one or more identifiable patents in that
-country that you have reason to believe are valid.
-
-  If, pursuant to or in connection with a single transaction or
-arrangement, you convey, or propagate by procuring conveyance of, a
-covered work, and grant a patent license to some of the parties
-receiving the covered work authorizing them to use, propagate, modify
-or convey a specific copy of the covered work, then the patent license
-you grant is automatically extended to all recipients of the covered
-work and works based on it.
-
-  A patent license is "discriminatory" if it does not include within
-the scope of its coverage, prohibits the exercise of, or is
-conditioned on the non-exercise of one or more of the rights that are
-specifically granted under this License.  You may not convey a covered
-work if you are a party to an arrangement with a third party that is
-in the business of distributing software, under which you make payment
-to the third party based on the extent of your activity of conveying
-the work, and under which the third party grants, to any of the
-parties who would receive the covered work from you, a discriminatory
-patent license (a) in connection with copies of the covered work
-conveyed by you (or copies made from those copies), or (b) primarily
-for and in connection with specific products or compilations that
-contain the covered work, unless you entered into that arrangement,
-or that patent license was granted, prior to 28 March 2007.
-
-  Nothing in this License shall be construed as excluding or limiting
-any implied license or other defenses to infringement that may
-otherwise be available to you under applicable patent law.
-
-  12. No Surrender of Others' Freedom.
-
-  If conditions are imposed on you (whether by court order, agreement or
-otherwise) that contradict the conditions of this License, they do not
-excuse you from the conditions of this License.  If you cannot convey a
-covered work so as to satisfy simultaneously your obligations under this
-License and any other pertinent obligations, then as a consequence you may
-not convey it at all.  For example, if you agree to terms that obligate you
-to collect a royalty for further conveying from those to whom you convey
-the Program, the only way you could satisfy both those terms and this
-License would be to refrain entirely from conveying the Program.
-
-  13. Use with the GNU Affero General Public License.
-
-  Notwithstanding any other provision of this License, you have
-permission to link or combine any covered work with a work licensed
-under version 3 of the GNU Affero General Public License into a single
-combined work, and to convey the resulting work.  The terms of this
-License will continue to apply to the part which is the covered work,
-but the special requirements of the GNU Affero General Public License,
-section 13, concerning interaction through a network will apply to the
-combination as such.
-
-  14. Revised Versions of this License.
-
-  The Free Software Foundation may publish revised and/or new versions of
-the GNU General Public License from time to time.  Such new versions will
-be similar in spirit to the present version, but may differ in detail to
-address new problems or concerns.
-
-  Each version is given a distinguishing version number.  If the
-Program specifies that a certain numbered version of the GNU General
-Public License "or any later version" applies to it, you have the
-option of following the terms and conditions either of that numbered
-version or of any later version published by the Free Software
-Foundation.  If the Program does not specify a version number of the
-GNU General Public License, you may choose any version ever published
-by the Free Software Foundation.
-
-  If the Program specifies that a proxy can decide which future
-versions of the GNU General Public License can be used, that proxy's
-public statement of acceptance of a version permanently authorizes you
-to choose that version for the Program.
-
-  Later license versions may give you additional or different
-permissions.  However, no additional obligations are imposed on any
-author or copyright holder as a result of your choosing to follow a
-later version.
-
-  15. Disclaimer of Warranty.
-
-  THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
-APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
-HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
-OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
-THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
-PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
-IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
-ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
-
-  16. Limitation of Liability.
-
-  IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
-WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
-THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
-GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
-USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
-DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
-PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
-EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
-SUCH DAMAGES.
-
-  17. Interpretation of Sections 15 and 16.
-
-  If the disclaimer of warranty and limitation of liability provided
-above cannot be given local legal effect according to their terms,
-reviewing courts shall apply local law that most closely approximates
-an absolute waiver of all civil liability in connection with the
-Program, unless a warranty or assumption of liability accompanies a
-copy of the Program in return for a fee.
-
-                     END OF TERMS AND CONDITIONS
-
-            How to Apply These Terms to Your New Programs
-
-  If you develop a new program, and you want it to be of the greatest
-possible use to the public, the best way to achieve this is to make it
-free software which everyone can redistribute and change under these terms.
-
-  To do so, attach the following notices to the program.  It is safest
-to attach them to the start of each source file to most effectively
-state the exclusion of warranty; and each file should have at least
-the "copyright" line and a pointer to where the full notice is found.
-
-    <one line to give the program's name and a brief idea of what it does.>
-    Copyright (C) <year>  <name of author>
-
-    This program is free software: you can redistribute it and/or modify
-    it under the terms of the GNU General Public License as published by
-    the Free Software Foundation, either version 3 of the License, or
-    (at your option) any later version.
-
-    This program is distributed in the hope that it will be useful,
-    but WITHOUT ANY WARRANTY; without even the implied warranty of
-    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-    GNU General Public License for more details.
-
-    You should have received a copy of the GNU General Public License
-    along with this program.  If not, see <https://www.gnu.org/licenses/>.
-
-Also add information on how to contact you by electronic and paper mail.
-
-  If the program does terminal interaction, make it output a short
-notice like this when it starts in an interactive mode:
-
-    <program>  Copyright (C) <year>  <name of author>
-    This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
-    This is free software, and you are welcome to redistribute it
-    under certain conditions; type `show c' for details.
-
-The hypothetical commands `show w' and `show c' should show the appropriate
-parts of the General Public License.  Of course, your program's commands
-might be different; for a GUI interface, you would use an "about box".
-
-  You should also get your employer (if you work as a programmer) or school,
-if any, to sign a "copyright disclaimer" for the program, if necessary.
-For more information on this, and how to apply and follow the GNU GPL, see
-<https://www.gnu.org/licenses/>.
-
-  The GNU General Public License does not permit incorporating your program
-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>.

README.md

@@ -1,317 +1,52 @@
 # 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)
+
+
 
 ## 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:
+* 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)
+* Get best nodes for further automation
+* Supported Guest Types
+  * VMs
+  * CTs
+  * Both
+* Maintenance Mode
+  * Set node(s) into maintenance
+  * Move all workloads to different nodes
 * 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)
+* Affinity / Anti-Affinity Rules
 * Dry-run support
   * Human readable output in CLI
   * JSON output for further parsing
-* Migrate VM workloads away (e.g. maintenance preparation)
 * 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)
-
-## 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.
-
-### Dependencies
-* Python3
-* proxmoxer (Python module)
-
-### 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) |
-| 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) |
-| 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:
-```
-[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
-ignore_nodes: dummynode01,dummynode02
-ignore_vms: testvm01,testvm02
-[service]
-daemon: 1
-```
-
-### Parameters
-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) |
-| -d | --dry-run | Perform a dry-run without doing any actions. | Unset |
-| -j | --json | Return a JSON of the VM movement. | Unset |
-
-### 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.
-
-#### 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
-```
-
-Afterwards, restart the service (if running in daemon mode) to activate this rebalancing mode.
-
-#### 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
-```
-
-Afterwards, restart the service (if running in daemon mode) to activate this rebalancing mode.
-
-### 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.
-
-#### 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.
-
-#### 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.
-
-### 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`.
-
-| Unit Name | Options |
-|------|:------:|
-| proxlb | start, stop, status, restart |
-
-### 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)
-
-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
-```
-
-### 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.
-
-```bash
-git clone https://github.com/gyptazy/ProxLB.git
-cd ProxLB
-docker 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
-```
-
-### 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.
-
-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. |
-
-## 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.
-
-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.
-
-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.
-
-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.
-
-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.
-
-## References
-Here you can find some overviews of references for and about the ProxLB (PLB):
-
-| 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/ |
-
-## 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/
-
-
-### Repository
-Debian based systems can also use the repository by adding the following line to their apt sources:
-
-```
-deb https://repo.gyptazy.ch/ /
-```
-
-The Repository's GPG key can be found at: `https://repo.gyptazy.ch/repo/KEY.gpg`
-
-You can also simply import it by running:
-
-```
-# KeyID:  DEB76ADF7A0BAADB51792782FD6A7A70C11226AA
-# SHA256: 5e44fffa09c747886ee37cc6e9e7eaf37c6734443cc648eaf0a9241a89084383  KEY.gpg
-
-wget -O /etc/apt/trusted.gpg.d/proxlb.asc https://repo.gyptazy.ch/repo/KEY.gpg
-```
-
-*Note: The defined repositories `repo.gyptazy.ch` and `repo.proxlb.de` are the same!*
-
-### 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 |
-
-## 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/main/CONTRIBUTING.md) file.
-
-### 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.
-
-| 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/)  |
-| GitHub | [ProxLB GitHub](https://github.com/gyptazy/ProxLB/issues) |
-
-### Author(s)
- * Florian Paul Azim Hoberg @gyptazy (https://gyptazy.ch)
+  * One-Time
+  * Daemon
+  * Proxmox Web GUI Integration

config/proxlb.yaml

@@ -0,0 +1,27 @@
+proxmox_api:
+  hosts: ['virt01.example.com', '10.10.10.10', 'fe01::bad:code::cafe']
+  user: root@pam
+  pass: crazyPassw0rd!
+  ssl_verification: False
+  timeout: 10
+
+proxmox_cluster:
+  maintenance_nodes: ['virt66.example.com']
+  ignore_nodes: []
+  overprovisioning: True
+
+balancing:
+  enable: True
+  force: False
+  parallel: False
+  live: True
+  with_local_disks: True
+  balance_types: ['vm', 'ct']
+  max_job_validation: 1800
+  balanciness: 5
+  method: memory
+  mode: assigned
+
+service:
+  daemon: False
+  log_level: DEBUG

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
-```

docs/02_Configuration.md

@@ -1,26 +0,0 @@
-# Configuration
-
-## Balancing
-### By Used Memmory of VMs
-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
-```
-Afterwards, restart the service (if running in daemon mode) to activate this rebalancing mode.
-
-### By Assigned Memory of VMs
-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
-```
-Afterwards, restart the service (if running in daemon mode) to activate this rebalancing mode.
-
-## 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.
-
-### 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.
-
-### 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.

docs/03_FAQ.md

@@ -1,77 +0,0 @@
-## FAQ
-
-### Could not import all dependencies
-ProxLB requires the Python library `proxmoxer`. This can simply be installed by the most
-system repositories. If you encounter this error message you simply need to install it.
-
-
-```
-# systemctl status proxlb
-x proxlb.service - Proxmox Rebalancing Service
-     Loaded: loaded (/etc/systemd/system/proxlb.service; static)
-     Active: failed (Result: exit-code) since Sat 2024-07-06 10:25:16 UTC; 1s ago
-   Duration: 239ms
-    Process: 7285 ExecStart=/usr/bin/proxlb -c /etc/proxlb/proxlb.conf (code=exited, status=2)
-   Main PID: 7285 (code=exited, status=2)
-        CPU: 129ms
-
-Jul 06 10:25:16 build01 systemd[1]: Started proxlb.service - ProxLB.
-Jul 06 10:25:16 build01 proxlb[7285]:  proxlb: Error: [python-imports]: Could not import all dependencies. Please install "proxmoxer".
-```
-
-Debian/Ubuntu: apt-get install python3-proxmoxer
-If the package is not provided by your systems repository, you can also install it by running `pip3 install proxmoxer`.
-
-### 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.
-
-### 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.
-
-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. |
-
-### 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.
-
-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.
-
-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.
-
-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.
-
-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.
-
-### Packages / Container Images
-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/
-
-Container Images for Podman, Docker etc., can be found at:
-| Version | Image |
-|------|:------:|
-| latest | cr.gyptazy.ch/proxlb/proxlb:latest |
-
-### 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/main/CONTRIBUTING.md) file.
-
-### 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.
-
-| 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/)  |
-| GitHub | [ProxLB GitHub](https://github.com/gyptazy/ProxLB/issues) |

packaging/01_package.sh

@@ -1,16 +0,0 @@
-#!/bin/bash
-sudo apt-get install rpm cmake git make python3-yaml
-
-git clone https://github.com/gyptazy/changelog-fragments-creator.git
-./changelog-fragments-creator/changelog-creator -f ../.changelogs/ -o ../CHANGELOG.md
-mkdir packages
-mkdir build
-cd build
-cmake ..
-cpack -G DEB .
-cpack -G RPM .
-cp *.deb ../packages
-cp *.rpm ../packages
-cd ..
-rm -rf build
-echo "Packages created. Packages can be found in directory: packages"

packaging/02_changelog_only.sh

@@ -1,4 +0,0 @@
-#!/bin/bash
-git clone https://github.com/gyptazy/changelog-fragments-creator.git
-./changelog-fragments-creator/changelog-creator -f ../.changelogs/ -o ../CHANGELOG.md
-echo "Created changelog file"

packaging/CMakeLists.txt

@@ -1,41 +0,0 @@
-cmake_minimum_required(VERSION 3.16)
-project(proxmox-rebalancing-service VERSION 1.0.0)
-
-install(PROGRAMS ../proxlb DESTINATION /bin)
-install(FILES ../proxlb.conf DESTINATION /etc/proxlb)
-install(FILES proxlb.service DESTINATION /etc/systemd/system)
-
-# General
-set(CPACK_PACKAGE_NAME "proxlb")
-set(CPACK_RESOURCE_FILE_LICENSE "${CMAKE_CURRENT_SOURCE_DIR}/../LICENSE")
-set(CPACK_RESOURCE_FILE_README "${CMAKE_CURRENT_SOURCE_DIR}/../README.md")
-set(CPACK_DEBIAN_PACKAGE_MAINTAINER "Florian Paul Azim <gyptazy> Hoberg <gyptazy@gyptazy.ch>")
-set(CPACK_PACKAGE_CONTACT "Florian Paul Azim Hoberg <gyptazy@gyptazy.ch>")
-set(CPACK_PACKAGE_VENDOR "gyptazy")
-
-# RPM packaging
-set(CPACK_PACKAGE_VERSION ${CMAKE_PROJECT_VERSION})
-set(CPACK_GENERATOR "RPM")
-set(CPACK_RPM_PACKAGE_ARCHITECTURE "amd64")
-set(CPACK_RPM_PACKAGE_SUMMARY "ProxLB - Rebalance VM workloads across nodes in Proxmox clusters.")
-set(CPACK_RPM_PACKAGE_DESCRIPTION "ProxLB - Rebalance VM workloads across nodes in Proxmox clusters.")
-set(CPACK_RPM_CHANGELOG_FILE "${CMAKE_CURRENT_SOURCE_DIR}/changelog_redhat")
-set(CPACK_PACKAGE_RELEASE 1)
-set(CPACK_RPM_PACKAGE_LICENSE "GPL 3.0")
-set(CPACK_RPM_PACKAGE_REQUIRES "python >= 3.2.0")
-
-# DEB packaging
-set(CPACK_DEBIAN_FILE_NAME DEB-DEFAULT)
-set(CPACK_DEBIAN_PACKAGE_ARCHITECTURE "amd64")
-set(CPACK_DEBIAN_PACKAGE_SUMMARY "ProxLB - Rebalance VM workloads across nodes in Proxmox clusters.")
-set(CPACK_DEBIAN_PACKAGE_DESCRIPTION "ProxLB - Rebalance VM workloads across nodes in Proxmox clusters.")
-set(CPACK_DEBIAN_PACKAGE_CONTROL_EXTRA "${CMAKE_CURRENT_SOURCE_DIR}/changelog_debian")
-set(CPACK_DEBIAN_PACKAGE_DEPENDS "python3")
-set(CPACK_DEBIAN_PACKAGE_LICENSE "GPL 3.0")
-
-
-# Install
-set(CPACK_PACKAGING_INSTALL_PREFIX ${CMAKE_INSTALL_PREFIX})
-set(CPACK_DEBIAN_PACKAGE_CONTROL_EXTRA "${CMAKE_CURRENT_SOURCE_DIR}/postinst")
-set(CPACK_RPM_POST_INSTALL_SCRIPT_FILE "${CMAKE_CURRENT_SOURCE_DIR}/postinst")
-include(CPack)

packaging/README.md

@@ -1,14 +0,0 @@
-## Build packages
-Building the packages requires cmake, deb and rpm.
-For building packages, simly run the following commands:
-
-```
-mkdir build
-cd build
-cmake ..
-cpack -G RPM .
-cpack -G DEB .
-```
-
-When running on Debian/Ubuntu you can directly call `01_package.sh`
-to create your own packages.

packaging/changelog_debian

@@ -1,11 +0,0 @@
-proxlb (1.0.0) unstable; urgency=low
-
-  * Initial release of ProxLB.
-
- -- Florian Paul Azim Hoberg <gyptazy@gyptazy.ch>  Thu, 01 Aug 2024 17:04:12 +0200
-
-proxlb (0.9.0) unstable; urgency=low
-
-  * Initial development release of ProxLB as a tech preview.
-
- -- Florian Paul Azim Hoberg <gyptazy@gyptazy.ch>  Sun, 07 Jul 2024 05:38:41 +0200

packaging/changelog_redhat

@@ -1,5 +0,0 @@
-* Thu Aug 01 2024 Florian Paul Azim Hoberg <gyptazy@gyptazy.ch>
-- Initial release of ProxLB.
-
-* Sun Jul 07 2024 Florian Paul Azim Hoberg <gyptazy@gyptazy.ch>
-- Initial development release of ProxLB as a tech preview.

packaging/postinst

@@ -1,5 +0,0 @@
-#!/bin/bash
-useradd -m plb 
-chown plb:plb /etc/proxlb/proxlb.conf
-chmod 600 /etc/proxlb/proxlb.conf
-systemctl daemon-reload

packaging/proxlb.service

@@ -1,6 +0,0 @@
-[Unit]
-Description=ProxLB - Rebalance VM workloads
-
-[Service]
-ExecStart=/usr/bin/proxlb -c /etc/proxlb/proxlb.conf
-User=plb

proxlb

@@ -1,833 +0,0 @@
-#!/usr/bin/env python3
-
-# ProxLB
-# ProxLB (re)balances VM workloads across nodes in Proxmox clusters.
-# ProxLB obtains current metrics from all nodes within the cluster for
-# further auto balancing by memory, disk or cpu and rebalances the VMs
-# over all available nodes in a cluster by having an equal resource usage.
-# Copyright (C) 2024 Florian Paul Azim Hoberg @gyptazy <gyptazy@gyptazy.ch>
-#
-# This program is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with this program.  If not, see <https://www.gnu.org/licenses/>.
-
-import argparse
-import configparser
-import json
-import logging
-import os
-try:
-    import proxmoxer
-    _imports = True
-except ImportError:
-    _imports = False
-import random
-import re
-import requests
-import sys
-import time
-import urllib3
-
-
-# Constants
-__appname__ = "ProxLB"
-__version__ = "1.0.0"
-__author__  = "Florian Paul Azim Hoberg <gyptazy@gyptazy.ch> @gyptazy"
-__errors__ = False
-
-
-# Classes
-## Logging class
-class SystemdHandler(logging.Handler):
-    """ Class to handle logging options. """
-    PREFIX = {
-        logging.CRITICAL: "<2> " + __appname__ + ": ",
-        logging.ERROR: "<3> " + __appname__ + ": ",
-        logging.WARNING: "<4> " + __appname__ + ": ",
-        logging.INFO: "<6> " + __appname__ + ": ",
-        logging.DEBUG: "<7> " + __appname__ + ": ",
-        logging.NOTSET: "<7 " + __appname__ + ": ",
-    }
-
-    def __init__(self, stream=sys.stdout):
-        self.stream = stream
-        logging.Handler.__init__(self)
-
-    def emit(self, record):
-        try:
-            msg = self.PREFIX[record.levelno] + self.format(record) + "\n"
-            self.stream.write(msg)
-            self.stream.flush()
-        except Exception:
-            self.handleError(record)
-
-
-# Functions
-def initialize_logger(log_level, update_log_verbosity=False):
-    """ Initialize ProxLB logging handler. """
-    info_prefix = 'Info: [logger]:'
-
-    root_logger = logging.getLogger()
-    root_logger.setLevel(log_level)
-
-    if not update_log_verbosity:
-        root_logger.addHandler(SystemdHandler())
-        logging.info(f'{info_prefix} Logger got initialized.')
-    else:
-        logging.info(f'{info_prefix} Logger verbosity got updated to: {log_level}.')
-
-
-def pre_validations(config_path):
-    """ Run pre-validations as sanity checks. """
-    info_prefix = 'Info: [pre-validations]:'
-
-    __validate_imports()
-    __validate_config_file(config_path)
-    logging.info(f'{info_prefix} All pre-validations done.')
-
-
-def post_validations():
-    """ Run post-validations as sanity checks. """
-    error_prefix = 'Error: [post-validations]:'
-    info_prefix  = 'Info: [post-validations]:'
-
-    if __errors__:
-        logging.critical(f'{error_prefix} Not all post-validations succeeded. Please validate!')
-    else:
-        logging.info(f'{info_prefix} All post-validations succeeded.')
-
-
-def validate_daemon(daemon, schedule):
-    """ Validate if ProxLB runs as a daemon. """
-    info_prefix  = 'Info: [daemon]:'
-
-    if bool(int(daemon)):
-        logging.info(f'{info_prefix} Running in daemon mode. Next run in {schedule} hours.')
-        time.sleep(int(schedule) * 60)
-    else:
-        logging.info(f'{info_prefix} Not running in daemon mode. Quitting.')
-        sys.exit(0)
-
-
-def __validate_imports():
-    """ Validate if all Python imports succeeded. """
-    error_prefix = 'Error: [python-imports]:'
-    info_prefix  = 'Info: [python-imports]:'
-
-    if not _imports:
-        logging.critical(f'{error_prefix} Could not import all dependencies. Please install "proxmoxer".')
-        sys.exit(2)
-    else:
-        logging.info(f'{info_prefix} All required dependencies were imported.')
-
-
-def __validate_config_file(config_path):
-    """ Validate if all Python imports succeeded. """
-    error_prefix = 'Error: [config]:'
-    info_prefix  = 'Info: [config]:'
-
-    if not os.path.isfile(config_path):
-        logging.critical(f'{error_prefix} Could not find config file in: {config_path}.')
-        sys.exit(2)
-    else:
-        logging.info(f'{info_prefix} Configuration file loaded from: {config_path}.')
-
-
-def initialize_args():
-    """ Initialize given arguments for ProxLB. """
-    argparser = argparse.ArgumentParser(description='ProxLB')
-    argparser.add_argument('-c', '--config',  type=str, help='Path to config file.', required=True)
-    argparser.add_argument('-d', '--dry-run', help='Perform a dry-run without doing any actions.', action='store_true', required=False)
-    argparser.add_argument('-j', '--json',    help='Return a JSON of the VM movement.', action='store_true', required=False)
-    return argparser.parse_args()
-
-
-def initialize_config_path(app_args):
-    """ Initialize path to ProxLB config file. """
-    info_prefix  = 'Info: [config]:'
-
-    config_path = app_args.config
-    if app_args.config is None:
-        config_path = '/etc/proxlb/proxlb.conf'
-        logging.info(f'{info_prefix} No config file provided. Falling back to: {config_path}.')
-    else:
-        logging.info(f'{info_prefix} Using config file: {config_path}.')
-    return config_path
-
-
-def initialize_config_options(config_path):
-    """ Read configuration from given config file for ProxLB. """
-    error_prefix = 'Error: [config]:'
-    info_prefix  = 'Info: [config]:'
-
-    try:
-        config = configparser.ConfigParser()
-        config.read(config_path)
-        # Proxmox config
-        proxmox_api_host      = config['proxmox']['api_host']
-        proxmox_api_user      = config['proxmox']['api_user']
-        proxmox_api_pass      = config['proxmox']['api_pass']
-        proxmox_api_ssl_v     = config['proxmox']['verify_ssl']
-        # Balancing
-        balancing_method      = config['balancing'].get('method', 'memory')
-        balancing_mode        = config['balancing'].get('mode', 'used')
-        balancing_mode_option = config['balancing'].get('mode_option', 'bytes')
-        balancing_type        = config['balancing'].get('type', 'vm')
-        balanciness           = config['balancing'].get('balanciness', 10)
-        ignore_nodes          = config['balancing'].get('ignore_nodes', None)
-        ignore_vms            = config['balancing'].get('ignore_vms', None)
-        # Service
-        daemon                = config['service'].get('daemon', 1)
-        schedule              = config['service'].get('schedule', 24)
-        log_verbosity         = config['service'].get('log_verbosity', 'CRITICAL')
-    except configparser.NoSectionError:
-        logging.critical(f'{error_prefix} Could not find the required section.')
-        sys.exit(2)
-    except configparser.ParsingError:
-        logging.critical(f'{error_prefix} Unable to parse the config file.')
-        sys.exit(2)
-    except KeyError:
-        logging.critical(f'{error_prefix} Could not find the required options in config file.')
-        sys.exit(2)
-
-    logging.info(f'{info_prefix} Configuration file loaded.')
-    return proxmox_api_host, proxmox_api_user, proxmox_api_pass, proxmox_api_ssl_v, balancing_method, balancing_mode, \
-         balancing_mode_option, balancing_type, balanciness, ignore_nodes, ignore_vms, daemon, schedule, log_verbosity
-
-
-def api_connect(proxmox_api_host, proxmox_api_user, proxmox_api_pass, proxmox_api_ssl_v):
-    """ Connect and authenticate to the Proxmox remote API. """
-    error_prefix = 'Error: [api-connection]:'
-    warn_prefix  = 'Warning: [api-connection]:'
-    info_prefix  = 'Info: [api-connection]:'
-    proxmox_api_ssl_v = bool(int(proxmox_api_ssl_v))
-
-    if not proxmox_api_ssl_v:
-        requests.packages.urllib3.disable_warnings()
-        logging.warning(f'{warn_prefix} API connection does not verify SSL certificate.')
-
-    try:
-        api_object = proxmoxer.ProxmoxAPI(proxmox_api_host, user=proxmox_api_user, password=proxmox_api_pass, verify_ssl=proxmox_api_ssl_v)
-    except urllib3.exceptions.NameResolutionError:
-        logging.critical(f'{error_prefix} Could not resolve the given host: {proxmox_api_host}.')
-        sys.exit(2)
-    except requests.exceptions.ConnectTimeout:
-        logging.critical(f'{error_prefix} Connection time out to host: {proxmox_api_host}.')
-        sys.exit(2)
-    except requests.exceptions.SSLError:
-        logging.critical(f'{error_prefix} SSL certificate verification failed for host: {proxmox_api_host}.')
-        sys.exit(2)
-
-    logging.info(f'{info_prefix} API connection succeeded to host: {proxmox_api_host}.')
-    return api_object
-
-
-def get_node_statistics(api_object, ignore_nodes):
-    """ Get statistics of cpu, memory and disk for each node in the cluster. """
-    info_prefix       = 'Info: [node-statistics]:'
-    node_statistics   = {}
-    ignore_nodes_list =  ignore_nodes.split(',')
-
-    for node in api_object.nodes.get():
-        if node['status'] == 'online' and node['node'] not in ignore_nodes_list:
-            node_statistics[node['node']] = {}
-            node_statistics[node['node']]['cpu_total']                        = node['maxcpu']
-            node_statistics[node['node']]['cpu_assigned']                     = node['cpu']
-            node_statistics[node['node']]['cpu_assigned_percent']             = int((node_statistics[node['node']]['cpu_assigned']) / int(node_statistics[node['node']]['cpu_total']) * 100)
-            node_statistics[node['node']]['cpu_assigned_percent_last_run']    = 0
-            node_statistics[node['node']]['cpu_used']                         = 0
-            node_statistics[node['node']]['cpu_free']                         = int(node['maxcpu']) - int(node['cpu'])
-            node_statistics[node['node']]['cpu_free_percent']                 = int((node_statistics[node['node']]['cpu_free']) / int(node['maxcpu']) * 100)
-            node_statistics[node['node']]['cpu_free_percent_last_run']        = 0
-            node_statistics[node['node']]['memory_total']                     = node['maxmem']
-            node_statistics[node['node']]['memory_assigned']                  = 0
-            node_statistics[node['node']]['memory_assigned_percent']          = int((node_statistics[node['node']]['memory_assigned']) / int(node_statistics[node['node']]['memory_total']) * 100)
-            node_statistics[node['node']]['memory_assigned_percent_last_run'] = 0
-            node_statistics[node['node']]['memory_used']                      = node['mem']
-            node_statistics[node['node']]['memory_free']                      = int(node['maxmem']) - int(node['mem'])
-            node_statistics[node['node']]['memory_free_percent']              = int((node_statistics[node['node']]['memory_free']) / int(node['maxmem']) * 100)
-            node_statistics[node['node']]['memory_free_percent_last_run']     = 0
-            node_statistics[node['node']]['disk_total']                       = node['maxdisk']
-            node_statistics[node['node']]['disk_assigned']                    = 0
-            node_statistics[node['node']]['disk_assigned_percent']            = int((node_statistics[node['node']]['disk_assigned']) / int(node_statistics[node['node']]['disk_total']) * 100)
-            node_statistics[node['node']]['disk_assigned_percent_last_run']   = 0
-            node_statistics[node['node']]['disk_used']                        = node['disk']
-            node_statistics[node['node']]['disk_free']                        = int(node['maxdisk']) - int(node['disk'])
-            node_statistics[node['node']]['disk_free_percent']                = int((node_statistics[node['node']]['disk_free']) / int(node['maxdisk']) * 100)
-            node_statistics[node['node']]['disk_free_percent_last_run']       = 0
-            logging.info(f'{info_prefix} Added node {node["node"]}.')
-
-    logging.info(f'{info_prefix} Created node statistics.')
-    return node_statistics
-
-
-def get_vm_statistics(api_object, ignore_vms, balancing_type):
-    """ Get statistics of cpu, memory and disk for each vm in the cluster. """
-    info_prefix        = 'Info: [vm-statistics]:'
-    warn_prefix        = 'Warn: [vm-statistics]:'
-    vm_statistics      = {}
-    ignore_vms_list    =  ignore_vms.split(',')
-    group_include      = None
-    group_exclude      = None
-    vm_ignore          = None
-    vm_ignore_wildcard = False
-
-    # Wildcard support: Initially validate if we need to honour
-    # any wildcards within the vm_ignore list.
-    vm_ignore_wildcard = __validate_ignore_vm_wildcard(ignore_vms)
-
-    for node in api_object.nodes.get():
-
-        # Add all virtual machines if type is vm or all.
-        if balancing_type == 'vm' or balancing_type == 'all':
-            for vm in api_object.nodes(node['node']).qemu.get():
-
-                # Get the VM tags from API.
-                vm_tags       = __get_vm_tags(api_object, node, vm['vmid'], 'vm')
-                if vm_tags is not None:
-                    group_include, group_exclude, vm_ignore = __get_proxlb_groups(vm_tags)
-
-                # Get wildcard match for VMs to ignore if a wildcard pattern was
-                # previously found. Wildcards may slow down the task when using
-                # many patterns in the ignore list. Therefore, run this only if
-                # a wildcard pattern was found. We also do not need to validate
-                # this if the VM is already being ignored by a defined tag.
-                if vm_ignore_wildcard and not vm_ignore:
-                    vm_ignore = __check_vm_name_wildcard_pattern(vm['name'], ignore_vms_list)
-
-                if vm['status'] == 'running' and vm['name'] not in ignore_vms_list and not vm_ignore:
-                    vm_statistics[vm['name']] = {}
-                    vm_statistics[vm['name']]['group_include']  = group_include
-                    vm_statistics[vm['name']]['group_exclude']  = group_exclude
-                    vm_statistics[vm['name']]['cpu_total']      = vm['cpus']
-                    vm_statistics[vm['name']]['cpu_used']       = vm['cpu']
-                    vm_statistics[vm['name']]['memory_total']   = vm['maxmem']
-                    vm_statistics[vm['name']]['memory_used']    = vm['mem']
-                    vm_statistics[vm['name']]['disk_total']     = vm['maxdisk']
-                    vm_statistics[vm['name']]['disk_used']      = vm['disk']
-                    vm_statistics[vm['name']]['vmid']           = vm['vmid']
-                    vm_statistics[vm['name']]['node_parent']    = node['node']
-                    vm_statistics[vm['name']]['type']           = 'vm'
-                    # Rebalancing node will be overwritten after calculations.
-                    # If the vm stays on the node, it will be removed at a
-                    # later time.
-                    vm_statistics[vm['name']]['node_rebalance'] = node['node']
-                    logging.info(f'{info_prefix} Added vm {vm["name"]}.')
-
-        # Add all containers if type is ct or all.
-        if balancing_type == 'ct' or balancing_type == 'all':
-            for vm in api_object.nodes(node['node']).lxc.get():
-
-                logging.warning(f'{warn_prefix} Rebalancing on LXC containers (CT) always requires them to shut down.')
-                logging.warning(f'{warn_prefix} {vm["name"]} is from type CT and cannot be live migrated!')
-                # Get the VM tags from API.
-                vm_tags       = __get_vm_tags(api_object, node, vm['vmid'], 'ct')
-                if vm_tags is not None:
-                    group_include, group_exclude, vm_ignore = __get_proxlb_groups(vm_tags)
-
-                # Get wildcard match for VMs to ignore if a wildcard pattern was
-                # previously found. Wildcards may slow down the task when using
-                # many patterns in the ignore list. Therefore, run this only if
-                # a wildcard pattern was found. We also do not need to validate
-                # this if the VM is already being ignored by a defined tag.
-                if vm_ignore_wildcard and not vm_ignore:
-                    vm_ignore = __check_vm_name_wildcard_pattern(vm['name'], ignore_vms_list)
-
-                if vm['status'] == 'running' and vm['name'] not in ignore_vms_list and not vm_ignore:
-                    vm_statistics[vm['name']] = {}
-                    vm_statistics[vm['name']]['group_include']  = group_include
-                    vm_statistics[vm['name']]['group_exclude']  = group_exclude
-                    vm_statistics[vm['name']]['cpu_total']      = vm['cpus']
-                    vm_statistics[vm['name']]['cpu_used']       = vm['cpu']
-                    vm_statistics[vm['name']]['memory_total']   = vm['maxmem']
-                    vm_statistics[vm['name']]['memory_used']    = vm['mem']
-                    vm_statistics[vm['name']]['disk_total']     = vm['maxdisk']
-                    vm_statistics[vm['name']]['disk_used']      = vm['disk']
-                    vm_statistics[vm['name']]['vmid']           = vm['vmid']
-                    vm_statistics[vm['name']]['node_parent']    = node['node']
-                    vm_statistics[vm['name']]['type']           = 'ct'
-                    # Rebalancing node will be overwritten after calculations.
-                    # If the vm stays on the node, it will be removed at a
-                    # later time.
-                    vm_statistics[vm['name']]['node_rebalance'] = node['node']
-                    logging.info(f'{info_prefix} Added vm {vm["name"]}.')
-
-    logging.info(f'{info_prefix} Created VM statistics.')
-    return vm_statistics
-
-
-def update_node_statistics(node_statistics, vm_statistics):
-    """ Update node statistics by VMs statistics. """
-    info_prefix = 'Info: [node-update-statistics]:'
-    warn_prefix = 'Warning: [node-update-statistics]:'
-
-    for vm, vm_value in vm_statistics.items():
-        node_statistics[vm_value['node_parent']]['cpu_assigned']            = node_statistics[vm_value['node_parent']]['cpu_assigned'] + int(vm_value['cpu_total'])
-        node_statistics[vm_value['node_parent']]['cpu_assigned_percent']    = (node_statistics[vm_value['node_parent']]['cpu_assigned'] / node_statistics[vm_value['node_parent']]['cpu_total']) * 100
-        node_statistics[vm_value['node_parent']]['memory_assigned']         = node_statistics[vm_value['node_parent']]['memory_assigned'] + int(vm_value['memory_total'])
-        node_statistics[vm_value['node_parent']]['memory_assigned_percent'] = (node_statistics[vm_value['node_parent']]['memory_assigned'] / node_statistics[vm_value['node_parent']]['memory_total']) * 100
-        node_statistics[vm_value['node_parent']]['disk_assigned']           = node_statistics[vm_value['node_parent']]['disk_assigned'] + int(vm_value['disk_total'])
-        node_statistics[vm_value['node_parent']]['disk_assigned_percent']   = (node_statistics[vm_value['node_parent']]['disk_assigned'] / node_statistics[vm_value['node_parent']]['disk_total']) * 100
-
-        if node_statistics[vm_value['node_parent']]['cpu_assigned_percent'] > 99:
-            logging.warning(f'{warn_prefix} Node {vm_value["node_parent"]} is overprovisioned for CPU by {int(node_statistics[vm_value["node_parent"]]["cpu_assigned_percent"])}%.')
-
-        if node_statistics[vm_value['node_parent']]['memory_assigned_percent'] > 99:
-            logging.warning(f'{warn_prefix} Node {vm_value["node_parent"]} is overprovisioned for memory by {int(node_statistics[vm_value["node_parent"]]["memory_assigned_percent"])}%.')
-
-        if node_statistics[vm_value['node_parent']]['disk_assigned_percent'] > 99:
-            logging.warning(f'{warn_prefix} Node {vm_value["node_parent"]} is overprovisioned for disk by {int(node_statistics[vm_value["node_parent"]]["disk_assigned_percent"])}%.')
-
-    logging.info(f'{info_prefix} Updated node resource assignments by all VMs.')
-    logging.debug('node_statistics')
-    return node_statistics
-
-
-def __validate_ignore_vm_wildcard(ignore_vms):
-    """ Validate if a wildcard is used for ignored VMs. """
-    if '*' in ignore_vms:
-        return True
-
-
-def __check_vm_name_wildcard_pattern(vm_name, ignore_vms_list):
-    """ Validate if the VM name is in the ignore list pattern included. """
-    for ignore_vm in ignore_vms_list:
-        if '*' in ignore_vm:
-            if ignore_vm[:-1] in vm_name:
-                return True
-
-
-def __get_vm_tags(api_object, node, vmid, balancing_type):
-    """ Get tags for a VM/CT for a given VMID. """
-    info_prefix = 'Info: [api-get-vm-tags]:'
-
-    if balancing_type == 'vm':
-        vm_config = api_object.nodes(node['node']).qemu(vmid).config.get()
-
-    if balancing_type == 'ct':
-        vm_config = api_object.nodes(node['node']).lxc(vmid).config.get()
-
-    logging.info(f'{info_prefix} Got VM/CT tag from API.')
-    return vm_config.get('tags', None)
-
-
-def __get_proxlb_groups(vm_tags):
-    """ Get ProxLB related include and exclude groups. """
-    info_prefix   = 'Info: [api-get-vm-include-exclude-tags]:'
-    group_include = None
-    group_exclude = None
-    vm_ignore     = None
-
-    group_list = re.split(";", vm_tags)
-    for group in group_list:
-
-        if group.startswith('plb_include_'):
-            logging.info(f'{info_prefix} Got PLB include group.')
-            group_include = group
-
-        if group.startswith('plb_exclude_'):
-            logging.info(f'{info_prefix} Got PLB include group.')
-            group_exclude = group
-
-        if group.startswith('plb_ignore_vm'):
-            logging.info(f'{info_prefix} Got PLB ignore group.')
-            vm_ignore = True
-
-    return group_include, group_exclude, vm_ignore
-
-
-def balancing_calculations(balancing_method, balancing_mode, balancing_mode_option, node_statistics, vm_statistics, balanciness, rebalance, processed_vms):
-    """ Calculate re-balancing of VMs on present nodes across the cluster. """
-    info_prefix  = 'Info: [rebalancing-calculator]:'
-
-    # Validate for a supported balancing method, mode and if rebalancing is required.
-    __validate_balancing_method(balancing_method)
-    __validate_balancing_mode(balancing_mode)
-    __validate_vm_statistics(vm_statistics)
-    rebalance = __validate_balanciness(balanciness, balancing_method, balancing_mode, node_statistics)
-
-    if rebalance:
-        # Get most used/assigned resources of the VM and the most free or less allocated node.
-        resources_vm_most_used, processed_vms  = __get_most_used_resources_vm(balancing_method, balancing_mode, vm_statistics, processed_vms)
-        resources_node_most_free               = __get_most_free_resources_node(balancing_method, balancing_mode, balancing_mode_option, node_statistics)
-
-        # Update resource statistics for VMs and nodes.
-        node_statistics, vm_statistics         = __update_resource_statistics(resources_vm_most_used, resources_node_most_free,
-                                                                             vm_statistics, node_statistics, balancing_method, balancing_mode)
-
-        # Start recursion until we do not have any needs to rebalance anymore.
-        balancing_calculations(balancing_method, balancing_mode, balancing_mode_option, node_statistics, vm_statistics, balanciness, rebalance, processed_vms)
-
-    # Honour groupings for include and exclude groups for rebalancing VMs.
-    node_statistics, vm_statistics = __get_vm_tags_include_groups(vm_statistics, node_statistics, balancing_method, balancing_mode)
-    node_statistics, vm_statistics = __get_vm_tags_exclude_groups(vm_statistics, node_statistics, balancing_method, balancing_mode)
-
-    # Remove VMs that are not being relocated.
-    vms_to_remove = [vm_name for vm_name, vm_info in vm_statistics.items() if 'node_rebalance' in vm_info and vm_info['node_rebalance'] == vm_info.get('node_parent')]
-    for vm_name in vms_to_remove:
-        del vm_statistics[vm_name]
-
-    logging.info(f'{info_prefix} Balancing calculations done.')
-    return node_statistics, vm_statistics
-
-
-def __validate_balancing_method(balancing_method):
-    """ Validate for valid and supported balancing method. """
-    error_prefix = 'Error: [balancing-method-validation]:'
-    info_prefix  = 'Info: [balancing-method-validation]]:'
-
-    if balancing_method not in ['memory', 'disk', 'cpu']:
-        logging.error(f'{error_prefix} Invalid balancing method: {balancing_method}')
-        sys.exit(2)
-    else:
-        logging.info(f'{info_prefix} Valid balancing method: {balancing_method}')
-
-
-def __validate_balancing_mode(balancing_mode):
-    """ Validate for valid and supported balancing mode. """
-    error_prefix = 'Error: [balancing-mode-validation]:'
-    info_prefix  = 'Info: [balancing-mode-validation]]:'
-
-    if balancing_mode not in ['used', 'assigned']:
-        logging.error(f'{error_prefix} Invalid balancing method: {balancing_mode}')
-        sys.exit(2)
-    else:
-        logging.info(f'{info_prefix} Valid balancing method: {balancing_mode}')
-
-
-def __validate_vm_statistics(vm_statistics):
-    """ Validate for at least a single object of type CT/VM to rebalance. """
-    error_prefix = 'Error: [balancing-vm-stats-validation]:'
-
-    if len(vm_statistics) == 0:
-        logging.error(f'{error_prefix} Not a single CT/VM found in cluster.')
-        sys.exit(1)
-
-
-def __validate_balanciness(balanciness, balancing_method, balancing_mode, node_statistics):
-    """ Validate for balanciness to ensure further rebalancing is needed. """
-    info_prefix                   = 'Info: [balanciness-validation]:'
-    node_resource_percent_list    = []
-    node_assigned_percent_match = []
-
-    # Remap balancing mode to get the related values from nodes dict.
-    if balancing_mode == 'used':
-        node_resource_selector = 'free'
-    if balancing_mode == 'assigned':
-        node_resource_selector = 'assigned'
-
-    for node_name, node_info in node_statistics.items():
-
-        # Save information of nodes from current run to compare them in the next recursion.
-        if node_statistics[node_name][f'{balancing_method}_{node_resource_selector}_percent_last_run'] == node_statistics[node_name][f'{balancing_method}_{node_resource_selector}_percent']:
-            node_statistics[node_name][f'{balancing_method}_{node_resource_selector}_percent_match'] = True
-        else:
-            node_statistics[node_name][f'{balancing_method}_{node_resource_selector}_percent_match'] = False
-        # Update value to the current value of the recursion run.
-        node_statistics[node_name][f'{balancing_method}_{node_resource_selector}_percent_last_run'] = node_statistics[node_name][f'{balancing_method}_{node_resource_selector}_percent']
-
-        # If all node resources are unchanged, the recursion can be left.
-        for key, value in node_statistics.items():
-            node_assigned_percent_match.append(value.get(f'{balancing_method}_{node_resource_selector}_percent_match', False))
-
-        if False not in node_assigned_percent_match:
-            return False
-
-        # Add node information to resource list.
-        node_resource_percent_list.append(int(node_info[f'{balancing_method}_{node_resource_selector}_percent']))
-        logging.debug(f'{info_prefix} Node: {node_name} with values: {node_info}')
-
-    # Create a sorted list of the delta + balanciness between the node resources.
-    node_resource_percent_list_sorted    = sorted(node_resource_percent_list)
-    node_lowest_percent                  = node_resource_percent_list_sorted[0]
-    node_highest_percent                 = node_resource_percent_list_sorted[-1]
-
-    # Validate if the recursion should  be proceeded for further rebalancing.
-    if (int(node_lowest_percent) + int(balanciness)) < int(node_highest_percent):
-        logging.info(f'{info_prefix} Rebalancing for {balancing_method} is needed. Highest usage: {int(node_highest_percent)}% | Lowest usage: {int(node_lowest_percent)}%.')
-        return True
-    else:
-        logging.info(f'{info_prefix} Rebalancing for {balancing_method} is not needed. Highest usage: {int(node_highest_percent)}% | Lowest usage: {int(node_lowest_percent)}%.')
-        return False
-
-
-def __get_most_used_resources_vm(balancing_method, balancing_mode, vm_statistics, processed_vms):
-    """ Get and return the most used resources of a VM by the defined balancing method. """
-    info_prefix = 'Info: [get-most-used-resources-vm]:'
-
-    # Remap balancing mode to get the related values from nodes dict.
-    if balancing_mode == 'used':
-        vm_resource_selector = 'used'
-    if balancing_mode == 'assigned':
-        vm_resource_selector = 'total'
-
-    vm = max(vm_statistics.items(), key=lambda item: item[1][f'{balancing_method}_{vm_resource_selector}'] if item[0] not in processed_vms else -float('inf'))
-    processed_vms.append(vm[0])
-
-    logging.info(f'{info_prefix} {vm}')
-    return vm, processed_vms
-
-
-def __get_most_free_resources_node(balancing_method, balancing_mode, balancing_mode_option, node_statistics):
-    """ Get and return the most free resources of a node by the defined balancing method. """
-    info_prefix = 'Info: [get-most-free-resources-nodes]:'
-
-    # Return the node information based on the balancing mode.
-    if balancing_mode == 'used' and balancing_mode_option == 'bytes':
-        node = max(node_statistics.items(), key=lambda item: item[1][f'{balancing_method}_free'])
-    if balancing_mode == 'used' and balancing_mode_option == 'percent':
-        node = max(node_statistics.items(), key=lambda item: item[1][f'{balancing_method}_free_percent'])
-    if balancing_mode == 'assigned':
-        node = min(node_statistics.items(), key=lambda item: item[1][f'{balancing_method}_assigned'] if item[1][f'{balancing_method}_assigned_percent'] > 0 or item[1][f'{balancing_method}_assigned_percent'] < 100 else -float('inf'))
-
-    logging.info(f'{info_prefix} {node}')
-    return node
-
-
-def __update_resource_statistics(resource_highest_used_resources_vm, resource_highest_free_resources_node, vm_statistics, node_statistics, balancing_method, balancing_mode):
-    """ Update VM and node resource statistics. """
-    info_prefix = 'Info: [rebalancing-resource-statistics-update]:'
-
-    if resource_highest_used_resources_vm[1]['node_parent'] != resource_highest_free_resources_node[0]:
-        vm_name            = resource_highest_used_resources_vm[0]
-        vm_node_parent     = resource_highest_used_resources_vm[1]['node_parent']
-        vm_node_rebalance  = resource_highest_free_resources_node[0]
-        vm_resource_used   = vm_statistics[resource_highest_used_resources_vm[0]][f'{balancing_method}_used']
-        vm_resource_total  = vm_statistics[resource_highest_used_resources_vm[0]][f'{balancing_method}_total']
-
-        # Update dictionaries for new values
-        # Assign new rebalance node to vm
-        vm_statistics[vm_name]['node_rebalance'] = vm_node_rebalance
-
-        logging.info(f'Moving {vm_name} from {vm_node_parent} to {vm_node_rebalance}')
-
-        # Recalculate values for nodes
-        ## Add freed resources to old parent node
-        node_statistics[vm_node_parent][f'{balancing_method}_used']                = int(node_statistics[vm_node_parent][f'{balancing_method}_used']) - int(vm_resource_used)
-        node_statistics[vm_node_parent][f'{balancing_method}_free']                = int(node_statistics[vm_node_parent][f'{balancing_method}_free']) + int(vm_resource_used)
-        node_statistics[vm_node_parent][f'{balancing_method}_free_percent']        = int(int(node_statistics[vm_node_parent][f'{balancing_method}_free']) / int(node_statistics[vm_node_parent][f'{balancing_method}_total']) * 100)
-        node_statistics[vm_node_parent][f'{balancing_method}_assigned']            = int(node_statistics[vm_node_parent][f'{balancing_method}_assigned']) - int(vm_resource_total)
-        node_statistics[vm_node_parent][f'{balancing_method}_assigned_percent']    = int(int(node_statistics[vm_node_parent][f'{balancing_method}_assigned']) / int(node_statistics[vm_node_parent][f'{balancing_method}_total']) * 100)
-
-        ## Removed newly allocated resources to new rebalanced node
-        node_statistics[vm_node_rebalance][f'{balancing_method}_used']             = int(node_statistics[vm_node_rebalance][f'{balancing_method}_used']) + int(vm_resource_used)
-        node_statistics[vm_node_rebalance][f'{balancing_method}_free']             = int(node_statistics[vm_node_rebalance][f'{balancing_method}_free']) - int(vm_resource_used)
-        node_statistics[vm_node_rebalance][f'{balancing_method}_free_percent']     = int(int(node_statistics[vm_node_rebalance][f'{balancing_method}_free']) / int(node_statistics[vm_node_rebalance][f'{balancing_method}_total']) * 100)
-        node_statistics[vm_node_rebalance][f'{balancing_method}_assigned']         = int(node_statistics[vm_node_rebalance][f'{balancing_method}_assigned']) + int(vm_resource_total)
-        node_statistics[vm_node_rebalance][f'{balancing_method}_assigned_percent'] = int(int(node_statistics[vm_node_rebalance][f'{balancing_method}_assigned']) / int(node_statistics[vm_node_rebalance][f'{balancing_method}_total']) * 100)
-
-    logging.info(f'{info_prefix} Updated VM and node statistics.')
-    return node_statistics, vm_statistics
-
-
-def __get_vm_tags_include_groups(vm_statistics, node_statistics, balancing_method, balancing_mode):
-    """ Get VMs tags for include groups. """
-    info_prefix = 'Info: [rebalancing-tags-group-include]:'
-    tags_include_vms = {}
-    processed_vm = []
-
-    # Create groups of tags with belongings hosts.
-    for vm_name, vm_values in vm_statistics.items():
-        if vm_values.get('group_include', None):
-            if not tags_include_vms.get(vm_values['group_include'], None):
-                tags_include_vms[vm_values['group_include']] = [vm_name]
-            else:
-                tags_include_vms[vm_values['group_include']] = tags_include_vms[vm_values['group_include']] + [vm_name]
-
-    # Update the VMs to the corresponding node to their group assignments.
-    for group, vm_names in tags_include_vms.items():
-        # Do not take care of tags that have only a single host included.
-        if len(vm_names) < 2:
-            logging.info(f'{info_prefix} Only one host in group assignment.')
-            return node_statistics, vm_statistics
-
-        vm_node_rebalance = False
-        logging.info(f'{info_prefix} Create include groups of VM hosts.')
-        for vm_name in vm_names:
-            if vm_name not in processed_vm:
-                if not vm_node_rebalance:
-                    vm_node_rebalance = vm_statistics[vm_name]['node_rebalance']
-                else:
-                    _mocked_vm_object = (vm_name, vm_statistics[vm_name])
-                    node_statistics, vm_statistics = __update_resource_statistics(_mocked_vm_object, [vm_node_rebalance], vm_statistics, node_statistics, balancing_method, balancing_mode)
-            processed_vm.append(vm_name)
-
-    return node_statistics, vm_statistics
-
-
-def __get_vm_tags_exclude_groups(vm_statistics, node_statistics, balancing_method, balancing_mode):
-    """ Get VMs tags for exclude groups. """
-    info_prefix = 'Info: [rebalancing-tags-group-exclude]:'
-    tags_exclude_vms = {}
-    processed_vm = []
-
-    # Create groups of tags with belongings hosts.
-    for vm_name, vm_values in vm_statistics.items():
-        if vm_values.get('group_include', None):
-            if not tags_exclude_vms.get(vm_values['group_include'], None):
-                tags_exclude_vms[vm_values['group_include']] = [vm_name]
-            else:
-                tags_exclude_vms[vm_values['group_include']] = tags_exclude_vms[vm_values['group_include']] + [vm_name]
-
-    # Update the VMs to the corresponding node to their group assignments.
-    for group, vm_names in tags_exclude_vms.items():
-        # Do not take care of tags that have only a single host included.
-        if len(vm_names) < 2:
-            logging.info(f'{info_prefix} Only one host in group assignment.')
-            return node_statistics, vm_statistics
-
-        vm_node_rebalance = False
-        logging.info(f'{info_prefix} Create exclude groups of VM hosts.')
-        for vm_name in vm_names:
-            if vm_name not in processed_vm:
-                if not vm_node_rebalance:
-                    random_node = vm_statistics[vm_name]['node_parent']
-                    # Get a random node and make sure that it is not by accident the
-                    # currently assigned one.
-                    while random_node == vm_statistics[vm_name]['node_parent']:
-                        random_node = random.choice(list(node_statistics.keys()))
-                else:
-                    _mocked_vm_object = (vm_name, vm_statistics[vm_name])
-                    node_statistics, vm_statistics = __update_resource_statistics(_mocked_vm_object, [random_node], vm_statistics, node_statistics, balancing_method, balancing_mode)
-            processed_vm.append(vm_name)
-
-    return node_statistics, vm_statistics
-
-
-def __run_vm_rebalancing(api_object, vm_statistics_rebalanced, app_args):
-    """ Run & execute the VM rebalancing via API. """
-    error_prefix = 'Error: [rebalancing-executor]:'
-    info_prefix  = 'Info: [rebalancing-executor]:'
-
-    if len(vm_statistics_rebalanced) > 0 and not app_args.dry_run:
-        for vm, value in vm_statistics_rebalanced.items():
-
-            try:
-                # Migrate type VM (live migration).
-                if value['type'] == 'vm':
-                    logging.info(f'{info_prefix} Rebalancing VM {vm} from node {value["node_parent"]} to node {value["node_rebalance"]}.')
-                    api_object.nodes(value['node_parent']).qemu(value['vmid']).migrate().post(target=value['node_rebalance'],online=1)
-
-                # Migrate type CT (requires restart of container).
-                if value['type'] == 'ct':
-                    logging.info(f'{info_prefix} Rebalancing CT {vm} from node {value["node_parent"]} to node {value["node_rebalance"]}.')
-                    api_object.nodes(value['node_parent']).lxc(value['vmid']).migrate().post(target=value['node_rebalance'],restart=1)
-
-            except proxmoxer.core.ResourceException as error_resource:
-                logging.critical(f'{error_prefix} {error_resource}')
-    else:
-        logging.info(f'{info_prefix} No rebalancing needed.')
-
-
-def __create_json_output(vm_statistics_rebalanced, app_args):
-    """ Create a machine parsable json output of VM rebalance statitics. """
-    info_prefix  = 'Info: [json-output-generator]:'
-
-    if app_args.json:
-        logging.info(f'{info_prefix} Printing json output of VM statistics.')
-        print(json.dumps(vm_statistics_rebalanced))
-
-
-def __create_cli_output(vm_statistics_rebalanced, app_args):
-    """ Create output for CLI when running in dry-run mode. """
-    info_prefix_dry_run  = 'Info: [cli-output-generator-dry-run]:'
-    info_prefix_run      = 'Info: [cli-output-generator]:'
-    vm_to_node_list      = []
-
-    if app_args.dry_run:
-        info_prefix = info_prefix_dry_run
-        logging.info(f'{info_prefix} Starting dry-run to rebalance vms to their new nodes.')
-    else:
-        info_prefix = info_prefix_run
-        logging.info(f'{info_prefix} Start rebalancing vms to their new nodes.')
-
-    vm_to_node_list.append(['VM', 'Current Node', 'Rebalanced Node', 'VM Type'])
-    for vm_name, vm_values in vm_statistics_rebalanced.items():
-        vm_to_node_list.append([vm_name, vm_values['node_parent'], vm_values['node_rebalance'], vm_values['type']])
-
-    if len(vm_statistics_rebalanced) > 0:
-        logging.info(f'{info_prefix} Printing cli output of VM rebalancing.')
-        __print_table_cli(vm_to_node_list, app_args.dry_run)
-    else:
-        logging.info(f'{info_prefix} No rebalancing needed.')
-
-
-def __print_table_cli(table, dry_run=False):
-    """ Pretty print a given table to the cli. """
-    info_prefix_dry_run  = 'Info: [cli-output-generator-table-dryn-run]:'
-    info_prefix_run      = 'Info: [cli-output-generator-table]:'
-    info_prefix          = info_prefix_run
-
-    longest_cols = [
-        (max([len(str(row[i])) for row in table]) + 3)
-        for i in range(len(table[0]))
-    ]
-
-    row_format = "".join(["{:>" + str(longest_col) + "}" for longest_col in longest_cols])
-
-    for row in table:
-        # Print CLI output when running in dry-run mode to make the user's life easier.
-        if dry_run:
-            info_prefix = info_prefix_dry_run
-            print(row_format.format(*row))
-
-        # Log all items in info mode.
-        logging.info(f'{info_prefix} {row_format.format(*row)}')
-
-
-def run_vm_rebalancing(api_object, vm_statistics_rebalanced, app_args):
-    """ Run rebalancing of vms to new nodes in cluster. """
-    __run_vm_rebalancing(api_object, vm_statistics_rebalanced, app_args)
-    __create_json_output(vm_statistics_rebalanced, app_args)
-    __create_cli_output(vm_statistics_rebalanced, app_args)
-
-
-def main():
-    """ Run ProxLB for balancing VM workloads across a Proxmox cluster. """
-    # Initialize PAS.
-    initialize_logger('CRITICAL')
-    app_args = initialize_args()
-    config_path = initialize_config_path(app_args)
-    pre_validations(config_path)
-
-    # Parse global config.
-    proxmox_api_host, proxmox_api_user, proxmox_api_pass, proxmox_api_ssl_v, balancing_method, balancing_mode, balancing_mode_option, balancing_type, \
-        balanciness, ignore_nodes, ignore_vms, daemon, schedule, log_verbosity = initialize_config_options(config_path)
-
-    # Overwrite logging handler with user defined log verbosity.
-    initialize_logger(log_verbosity, update_log_verbosity=True)
-
-    while True:
-        # API Authentication.
-        api_object = api_connect(proxmox_api_host, proxmox_api_user, proxmox_api_pass, proxmox_api_ssl_v)
-
-        # Get metric & statistics for vms and nodes.
-        node_statistics = get_node_statistics(api_object, ignore_nodes)
-        vm_statistics   = get_vm_statistics(api_object, ignore_vms, balancing_type)
-        node_statistics = update_node_statistics(node_statistics, vm_statistics)
-
-        # Calculate rebalancing of vms.
-        node_statistics_rebalanced, vm_statistics_rebalanced = balancing_calculations(balancing_method, balancing_mode, balancing_mode_option,
-                                                                                      node_statistics, vm_statistics, balanciness, rebalance=False, processed_vms=[])
-
-        # Rebalance vms to new nodes within the cluster.
-        run_vm_rebalancing(api_object, vm_statistics_rebalanced, app_args)
-
-        # Validate for any errors.
-        post_validations()
-
-        # Validate daemon service.
-        validate_daemon(daemon, schedule)
-
-
-if __name__ == '__main__':
-    main()

proxlb.conf

@@ -1,14 +0,0 @@
-[proxmox]
-api_host: hypervisor01.gyptazy.ch
-api_user: root@pam
-api_pass: FooBar
-verify_ssl: 1
-[balancing]
-method: memory
-mode: used
-ignore_nodes: dummynode01,dummynode02
-ignore_vms: testvm01,testvm02
-[service]
-daemon: 1
-schedule: 24
-log_verbosity: CRITICAL

proxlb/main.py

@@ -0,0 +1,68 @@
+"""
+Module providing a function printing python version.
+"""
+
+import logging
+from utils.logger import SystemdLogger
+from utils.cli_parser import CliParser
+from utils.config_parser import ConfigParser
+from utils.proxmox_api import ProxmoxApi
+from models.nodes import Nodes
+from models.guests import Guests
+from models.groups import Groups
+from models.calculations import Calculations
+from models.balancing import Balancing
+from utils.helper import Helper
+
+
+def main():
+    """
+    ProxLB main function
+    """
+    # Initialize logging handler
+    logger = SystemdLogger(level=logging.INFO)
+
+    # Parses arguments passed from the CLI
+    cli_parser = CliParser()
+    cli_args = cli_parser.parse_args()
+
+    # Parse ProxLB config file
+    config_parser = ConfigParser(cli_args.config)
+    proxlb_config = config_parser.get_config()
+
+    # Update log level from config and fallback to INFO if not defined
+    logger.set_log_level(proxlb_config.get('service', {}).get('log_level', 'INFO'))
+
+    # Connect to Proxmox API & create API object
+    proxmox_api = ProxmoxApi(proxlb_config)
+
+    # Overwrite password after creating the API object
+    proxlb_config["proxmox_api"]["pass"] = "********"
+
+    # 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)
+    groups = Groups.get_groups(guests, nodes)
+
+    # Merge obtained objects from the Proxmox cluster for further usage
+    proxlb_data = {**meta, **nodes, **guests, **groups}
+    Helper.log_node_metrics(proxlb_data)
+
+    # Update the initial node resource assignments
+    # by the previously created groups.
+    Calculations.set_node_assignments(proxlb_data)
+    Calculations.get_most_free_node(proxlb_data)
+    Calculations.relocate_guests_on_maintenance_nodes(proxlb_data)
+    Calculations.get_balanciness(proxlb_data)
+    Calculations.relocate_guests(proxlb_data)
+    Helper.log_node_metrics(proxlb_data, init=False)
+
+    # Perform balancing actions via Proxmox API
+    Balancing(proxmox_api, proxlb_data)
+
+    logger.debug(f"Finished: __main__")
+
+
+if __name__ == "__main__":
+    main()

proxlb/models/balancing.py

@@ -0,0 +1,171 @@
+"""
+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.
+"""
+
+import proxmoxer
+import time
+from utils.logger import SystemdLogger
+from typing import Dict, Any
+
+logger = SystemdLogger()
+
+
+class Balancing:
+    """
+    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.
+    """
+
+    def __init__(self, proxmox_api: any, proxlb_data: Dict[str, Any]):
+        """
+        Initializes the Balancing class with the provided ProxLB data.
+
+        Args:
+            proxlb_data (dict): The data required for balancing VMs and CTs.
+        """
+        for guest_name, guest_meta in proxlb_data["guests"].items():
+
+            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"]
+
+                # 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)
+
+                # Hopefully never reaching, but should be catched
+                else:
+                    logger.critical(f"Balancing: Got unexpected guest type: {guest_meta["type"]}. Cannot proceed guest: {guest_meta["name"]}.")
+
+    def 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.
+        This function initiates the migration of a specified VM to a target node as part of the
+        load balancing process. It logs the migration process and handles any exceptions that
+        may occur during the migration.
+        Args:
+            proxmox_api (object): The Proxmox API client instance used to interact with the Proxmox cluster.
+            proxlb_data (dict): A dictionary containing data related to the ProxLB load balancing configuration.
+            guest_name (str): The name of the guest VM to be migrated.
+        Raises:
+            proxmox_api.core.ResourceException: If an error occurs during the migration process.
+        Returns:
+            None
+        """
+        logger.debug("Starting: exec_rebalancing_vm.")
+        guest_id = proxlb_data["guests"][guest_name]["id"]
+        guest_node_current = proxlb_data["guests"][guest_name]["node_current"]
+        guest_node_target = proxlb_data["guests"][guest_name]["node_target"]
+
+        if proxlb_data["meta"]["balancing"].get("live", True):
+            online_migration = 1
+        else:
+            online_migration = 0
+
+        if proxlb_data["meta"]["balancing"].get("with_local_disks", True):
+            with_local_disks = 1
+        else:
+            with_local_disks = 0
+
+        migration_options = {
+            'target': {guest_node_target},
+            'online': online_migration,
+            'with-local-disks': with_local_disks
+        }
+
+        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)
+        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("Finished: exec_rebalancing_vm.")
+
+    def 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.
+        This function initiates the migration of a specified CT to a target node as part of the
+        load balancing process. It logs the migration process and handles any exceptions that
+        may occur during the migration.
+        Args:
+            proxmox_api (object): The Proxmox API client instance used to interact with the Proxmox cluster.
+            proxlb_data (dict): A dictionary containing data related to the ProxLB load balancing configuration.
+            guest_name (str): The name of the guest CT to be migrated.
+        Raises:
+            proxmox_api.core.ResourceException: If an error occurs during the migration process.
+        Returns:
+            None
+        """
+        logger.debug("Starting: exec_rebalancing_ct.")
+        guest_id = proxlb_data["guests"][guest_name]["id"]
+        guest_node_current = proxlb_data["guests"][guest_name]["node_current"]
+        guest_node_target = proxlb_data["guests"][guest_name]["node_target"]
+
+        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)
+        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("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:
+        """
+        Monitors the status of a rebalancing job on a Proxmox node until it completes or a timeout is reached.
+
+        Args:
+            proxmox_api (object): The Proxmox API client instance.
+            proxlb_data (dict): The ProxLB configuration data.
+            guest_name (str): The name of the guest (virtual machine) being rebalanced.
+            guest_current_node (str): The current node where the guest is running.
+            job_id (str): The ID of the rebalancing job to monitor.
+            retry_counter (int, optional): The current retry count. Defaults to 1.
+
+        Returns:
+            bool: True if the job completed successfully, False otherwise.
+        """
+        logger.debug("Starting: get_rebalancing_job_status.")
+        # Parallel migrations can take a huge time and create a higher load, if not defined by an
+        # operator we will use a sequential mode by default
+        if not proxlb_data["meta"]["balancing"].get("parallel", False):
+            job = proxmox_api.nodes(guest_current_node).tasks(job_id).status().get()
+
+            # Watch job id until it finalizes
+            if job["status"] == "running":
+                # Do not hammer the API while
+                # watching the job status
+                time.sleep(10)
+                retry_counter += 1
+
+                # Run recursion until we hit the soft-limit of maximum migration time for a guest
+                if retry_counter < proxlb_data["meta"]["balancing"].get("max_job_validation", 1800):
+                    logger.debug(f"Balancing: Job ID {job_id} (guest: {guest_name}) for migration is still running... (Run: {retry_counter})")
+                    self.get_rebalancing_job_status(proxmox_api, proxlb_data, guest_name, guest_current_node, job_id, retry_counter)
+                else:
+                    logger.warning(f"Balancing: Job ID {job_id} (guest: {guest_name}) for migration took too long. Please check manually.")
+                    logger.debug("Finished: get_rebalancing_job_status.")
+                    return False
+
+            # Validate job output for errors when finished
+            if job["status"] == "stopped":
+
+                if job["exitstatus"] == "OK":
+                    logger.debug(f"Balancing: Job ID {job_id} (guest: {guest_name}) was sucessfully.")
+                    logger.debug("Finished: get_rebalancing_job_status.")
+                    return True
+                else:
+                    logger.critical(f"Balancing: Job ID {job_id} (guest: {guest_name}) went into an error! Please check manually.")
+                    logger.debug("Finished: get_rebalancing_job_status.")
+                    return False

proxlb/models/calculations.py

@@ -0,0 +1,299 @@
+"""
+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.
+"""
+
+from typing import Dict, Any
+from utils.logger import SystemdLogger
+
+logger = SystemdLogger()
+
+
+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.
+    """
+
+    def __init__(self, proxlb_data: Dict[str, Any]):
+        """
+        Initializes the Calculation class with the provided ProxLB data.
+
+        Args:
+            proxlb_data (Dict[str, Any]): The data required for balancing VMs and CTs.
+        """
+
+    @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
+        guest resources by their created groups as an initial base.
+
+        Args:
+            proxlb_data (Dict[str, Any]): The data holding all current statistics.
+
+        Returns:
+            Dict[str, Any]: Updated ProxLB data of nodes section with updated node assigned values.
+        """
+        logger.debug("Starting: set_node_assignments.")
+        for group_name, group_meta in proxlb_data["groups"]["affinity"].items():
+
+            for guest_name in group_meta["guests"]:
+                guest_node_current = proxlb_data["guests"][guest_name]["node_current"]
+                # Update Hardware assignments
+                # Update assigned values for the current node
+                proxlb_data["nodes"][guest_node_current]["cpu_assigned"] += proxlb_data["guests"][guest_name]["cpu_total"]
+                proxlb_data["nodes"][guest_node_current]["memory_assigned"] += proxlb_data["guests"][guest_name]["memory_total"]
+                proxlb_data["nodes"][guest_node_current]["disk_assigned"] += proxlb_data["guests"][guest_name]["disk_total"]
+                # Update assigned percentage values for the current node
+                proxlb_data["nodes"][guest_node_current]["cpu_assigned_percent"] = proxlb_data["nodes"][guest_node_current]["cpu_assigned"] / proxlb_data["nodes"][guest_node_current]["cpu_total"] * 100
+                proxlb_data["nodes"][guest_node_current]["memory_assigned_percent"] = proxlb_data["nodes"][guest_node_current]["memory_assigned"] / proxlb_data["nodes"][guest_node_current]["memory_total"] * 100
+                proxlb_data["nodes"][guest_node_current]["disk_assigned_percent"] = proxlb_data["nodes"][guest_node_current]["disk_assigned"] / proxlb_data["nodes"][guest_node_current]["disk_total"] * 100
+
+        logger.debug("Finished: set_node_assignments.")
+
+    @staticmethod
+    def get_balanciness(proxlb_data: Dict[str, Any]) -> Dict[str, Any]:
+        """
+        Get the blanaciness for further actions where the highest and lowest
+        usage or assignments of Proxmox nodes are compared. Based on the users
+        provided balanciness delta the balancing will be performed.
+
+        Args:
+            proxlb_data (Dict[str, Any]): The data holding all content of all objects.
+        Returns:
+            Dict[str, Any]: Updated meta data section of the balanciness action defined
+                  as a bool.
+        """
+        logger.debug("Starting: get_balanciness.")
+        proxlb_data["meta"]["balancing"]["balance"] = False
+
+        if len(proxlb_data["groups"]) > 0:
+            method = proxlb_data["meta"]["balancing"].get("method", "memory")
+            mode = proxlb_data["meta"]["balancing"].get("mode", "used")
+            balanciness = proxlb_data["meta"]["balancing"].get("balanciness", 10)
+            method_value = [node_meta[f"{method}_{mode}_percent"] for node_meta in proxlb_data["nodes"].values()]
+            method_value_highest = max(method_value)
+            method_value_lowest = min(method_value)
+
+            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.")
+
+        logger.debug("Finished: get_balanciness.")
+
+    @staticmethod
+    def get_most_free_node(proxlb_data: Dict[str, Any]) -> Dict[str, Any]:
+        """
+        Get 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).
+
+        Args:
+            proxlb_data (Dict[str, Any]): The data holding all content of all objects.
+
+        Returns:
+            Dict[str, Any]: Updated meta data section of the node with the most free resources that should
+                  be used for the next balancing action.
+        """
+        logger.debug("Starting: get_most_free_node.")
+        proxlb_data["meta"]["balancing"]["balance_next_node"] = ""
+
+        # 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"])
+        proxlb_data["meta"]["balancing"]["balance_reason"] = 'resources'
+        proxlb_data["meta"]["balancing"]["balance_next_node"] = lowest_usage_node["name"]
+
+        logger.debug("Finished: get_most_free_node.")
+
+    @staticmethod
+    def 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.
+
+        This function iterates over all guests on maintenance nodes and attempts
+        to relocate them to nodes with the most free resources that are not in
+        maintenance mode. It updates the node resources accordingly and logs
+        warnings if the balancing may not be perfect due to the maintenance
+        status of the original node.
+
+        Args:
+            proxlb_data (Dict[str, Any]): The data holding all content of all objects.
+        Returns:
+        None
+        """
+        logger.debug("Starting: get_most_free_node.")
+        proxlb_data["meta"]["balancing"]["balance_next_guest"] = ""
+
+        for guest_name in proxlb_data["groups"]["maintenance"]:
+            # Update the node with the most free nodes which is
+            # not in a maintenance
+            proxlb_data["meta"]["balancing"]["balance_next_guest"] = guest_name
+            Calculations.get_most_free_node(proxlb_data)
+            Calculations.update_node_resources(proxlb_data)
+            logger.warning(f"Warning: Balancing may not be perfect because guest {guest_name} was located on a node which is in maintenance mode.")
+
+        logger.debug("Finished: get_most_free_node.")
+
+    @staticmethod
+    def 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.
+
+        This function iterates over each affinity group in the provided data, identifies
+        the node with the most free resources, and migrates all guests within the group
+        to that node. It updates the node resources accordingly.
+
+        Args:
+            proxlb_data (Dict[str, Any]): The data holding all content of all objects.
+        Returns:
+        None
+        """
+        logger.debug("Starting: relocate_guests.")
+        if proxlb_data["meta"]["balancing"]["balance"] or proxlb_data["meta"]["balancing"]["force"]:
+
+            if proxlb_data["meta"]["balancing"].get("balance", False):
+                logger.debug("Balancing of guests will be performt. Reason: balanciness")
+
+            if proxlb_data["meta"]["balancing"].get("force", False):
+                logger.debug("Balancing of guests will be performt. Reason: force balancing")
+
+            for group_name in proxlb_data["groups"]["affinity"]:
+
+                # We get initially the node with the most free resources and then
+                # migrate all guests within the group to that node to ensure the
+                # affinity.
+                Calculations.get_most_free_node(proxlb_data)
+
+                for guest_name in proxlb_data["groups"]["affinity"][group_name]["guests"]:
+                    proxlb_data["meta"]["balancing"]["balance_next_guest"] = guest_name
+                    Calculations.val_anti_affinity(proxlb_data, guest_name)
+                    Calculations.update_node_resources(proxlb_data)
+
+        logger.debug("Finished: relocate_guests.")
+
+    @staticmethod
+    def val_anti_affinity(proxlb_data: Dict[str, Any], guest_name: str):
+        """
+        Validates and assigns nodes to guests based on anti-affinity rules.
+
+        This function iterates over all defined anti-affinity groups in the provided
+        `proxlb_data` and checks if the specified `guest_name` is included in any of
+        these groups. If the guest is included and has not been processed yet, it
+        attempts to assign an unused and non-maintenance node to the guest, ensuring
+        that the anti-affinity rules are respected.
+
+        Parameters:
+        proxlb_data (Dict[str, Any]): The data holding all content of all objects.
+        guest_name (str): The name of the guest to be validated and assigned a node.
+
+        Returns:
+        None
+        """
+        logger.debug("Starting: val_anti_affinity.")
+        # Start by interating 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
+            if guest_name in proxlb_data["groups"]["anti_affinity"][group_name]['guests'] and not proxlb_data["guests"][guest_name]["processed"]:
+                logger.critical(f"Anti-Affinity: Guest: {guest_name} is included in anti-affinity group: {group_name}.")
+
+                # Iterate over all available nodes
+                for node_name in proxlb_data["nodes"].keys():
+
+                    # Only select node if it was not used before and is not in a
+                    # maintenance mode. Afterwards, add it to the list of already
+                    # used nodes for the current anti-affinity group
+                    if node_name not in proxlb_data["groups"]["anti_affinity"][group_name]["used_nodes"]:
+
+                        if not proxlb_data["nodes"][node_name]["maintenance"]:
+                            # If the node has not been used yet, we assign this node to the guest
+                            proxlb_data["meta"]["balancing"]["balance_next_node"] = node_name
+                            proxlb_data["groups"]["anti_affinity"][group_name]["used_nodes"].append(node_name)
+                            logger.critical(f"Node: {node_name} marked as used for anti-affinity group: {group_name} with guest {guest_name}")
+                            break
+
+                    else:
+                        logger.critical(f"Node: {node_name} already got used for anti-affinity group:: {group_name}. (Tried for guest: {guest_name})")
+
+            else:
+                logger.debug(f"Guest: {guest_name} is not included in anti-affinity group: {group_name}. Skipping.")
+
+        logger.debug("Finished: val_anti_affinity.")
+
+    @staticmethod
+    def update_node_resources(proxlb_data):
+        """
+        Updates the resource allocation and usage statistics for nodes when a guest
+        is moved from one node to another.
+
+        Parameters:
+        proxlb_data (dict): A dictionary containing information about the nodes and
+        guests, including their resource allocations and usage.
+
+        The function performs the following steps:
+        1. Retrieves the guest name, current node, and target node from the provided data.
+        2. Updates the resource allocations and usage statistics for the target node by
+           adding the resources of the moved guest.
+        3. Updates the resource allocations and usage statistics for the current node by
+           subtracting the resources of the moved guest.
+        4. Logs the start and end of the resource update process, as well as the movement
+           of the guest from the current node to the target node.
+        """
+        logger.debug("Starting: update_node_resources.")
+        guest_name = proxlb_data["meta"]["balancing"]["balance_next_guest"]
+        node_current = proxlb_data["guests"][guest_name]["node_current"]
+        node_target = proxlb_data["meta"]["balancing"]["balance_next_node"]
+
+        # Update resources for the target node by the moved guest resources
+        # Add assigned resources to the target node
+        proxlb_data["nodes"][node_target]["cpu_assigned"] += proxlb_data["guests"][guest_name]["cpu_total"]
+        proxlb_data["nodes"][node_target]["memory_assigned"] += proxlb_data["guests"][guest_name]["memory_total"]
+        proxlb_data["nodes"][node_target]["disk_assigned"] += proxlb_data["guests"][guest_name]["disk_total"]
+        # Update the assigned percentages of assigned resources for the target node
+        proxlb_data["nodes"][node_target]["cpu_assigned_percent"] = proxlb_data["nodes"][node_target]["cpu_assigned"] / proxlb_data["nodes"][node_target]["cpu_total"] * 100
+        proxlb_data["nodes"][node_target]["memory_assigned_percent"] = proxlb_data["nodes"][node_target]["memory_assigned"] / proxlb_data["nodes"][node_target]["memory_total"] * 100
+        proxlb_data["nodes"][node_target]["disk_assigned_percent"] = proxlb_data["nodes"][node_target]["disk_assigned"] / proxlb_data["nodes"][node_target]["disk_total"] * 100
+        # Add used resources to the target node
+        proxlb_data["nodes"][node_target]["cpu_used"] += proxlb_data["guests"][guest_name]["cpu_used"]
+        proxlb_data["nodes"][node_target]["memory_used"] += proxlb_data["guests"][guest_name]["memory_used"]
+        proxlb_data["nodes"][node_target]["disk_used"] += proxlb_data["guests"][guest_name]["disk_used"]
+        # Update the used percentages of usage resources for the target node
+        proxlb_data["nodes"][node_target]["cpu_used_percent"] = proxlb_data["nodes"][node_target]["cpu_used"] / proxlb_data["nodes"][node_target]["cpu_total"] * 100
+        proxlb_data["nodes"][node_target]["memory_used_percent"] = proxlb_data["nodes"][node_target]["memory_used"] / proxlb_data["nodes"][node_target]["memory_total"] * 100
+        proxlb_data["nodes"][node_target]["disk_used_percent"] = proxlb_data["nodes"][node_target]["disk_used"] / proxlb_data["nodes"][node_target]["disk_total"] * 100
+
+        # Update resources for the current node by the moved guest resources
+        # Add assigned resources to the target node
+        proxlb_data["nodes"][node_current]["cpu_assigned"] -= proxlb_data["guests"][guest_name]["cpu_total"]
+        proxlb_data["nodes"][node_current]["memory_assigned"] -= proxlb_data["guests"][guest_name]["memory_total"]
+        proxlb_data["nodes"][node_current]["disk_assigned"] -= proxlb_data["guests"][guest_name]["disk_total"]
+        # Update the assigned percentages of assigned resources for the target node
+        proxlb_data["nodes"][node_current]["cpu_assigned_percent"] = proxlb_data["nodes"][node_current]["cpu_assigned"] / proxlb_data["nodes"][node_current]["cpu_total"] * 100
+        proxlb_data["nodes"][node_current]["memory_assigned_percent"] = proxlb_data["nodes"][node_current]["memory_assigned"] / proxlb_data["nodes"][node_current]["memory_total"] * 100
+        proxlb_data["nodes"][node_current]["disk_assigned_percent"] = proxlb_data["nodes"][node_current]["disk_assigned"] / proxlb_data["nodes"][node_current]["disk_total"] * 100
+        # Add used resources to the target node
+        proxlb_data["nodes"][node_current]["cpu_used"] -= proxlb_data["guests"][guest_name]["cpu_used"]
+        proxlb_data["nodes"][node_current]["memory_used"] -= proxlb_data["guests"][guest_name]["memory_used"]
+        proxlb_data["nodes"][node_current]["disk_used"] -= proxlb_data["guests"][guest_name]["disk_used"]
+        # Update the used percentages of usage resources for the target node
+        proxlb_data["nodes"][node_current]["cpu_used_percent"] = proxlb_data["nodes"][node_current]["cpu_used"] / proxlb_data["nodes"][node_current]["cpu_total"] * 100
+        proxlb_data["nodes"][node_current]["memory_used_percent"] = proxlb_data["nodes"][node_current]["memory_used"] / proxlb_data["nodes"][node_current]["memory_total"] * 100
+        proxlb_data["nodes"][node_current]["disk_used_percent"] = proxlb_data["nodes"][node_current]["disk_used"] / proxlb_data["nodes"][node_current]["disk_total"] * 100
+
+        # Assign guest to the new target node
+        proxlb_data["guests"][guest_name]["node_target"] = node_target
+        logger.debug(f"Set guest {guest_name} from node {node_current} to node {node_target}.")
+
+        logger.debug("Finished: update_node_resources.")

proxlb/models/groups.py

@@ -0,0 +1,110 @@
+"""
+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.
+"""
+
+from typing import Dict, Any
+from utils.logger import SystemdLogger
+from utils.helper import Helper
+
+logger = SystemdLogger()
+
+
+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.
+    """
+
+    def __init__(self, proxlb_data: Dict[str, Any]):
+        """
+        Initializes the Groups class with the provided ProxLB data.
+
+        Args:
+            proxlb_data (Dict[str, Any]): The data required for balancing VMs and CTs.
+        """
+
+    @staticmethod
+    def 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.
+
+        Args:
+            guests (Dict[str, Any]): A dictionary containing the guest data.
+            nodes  (Dict[str, Any]): A dictionary containing the nodes data.
+
+        Returns:
+            Dict[str, Any]: A dictionary containing the created groups that includes:
+                            * Affinity groups (or a randon and uniq group)
+                            * Anti-affinity groups
+                            * A list of guests that are currently placed on a node which
+                              is defined to be in maintenance.
+        """
+        logger.debug("Starting: get_groups.")
+        groups = {'groups': {'affinity': {}, 'anti_affinity': {}, 'maintenance': []}}
+
+        for guest_name, guest_meta in guests["guests"].items():
+            # Create affinity grouping
+            # Use an affinity group if available for the guest
+            if len(guest_meta["affinity_groups"]) > 0:
+                for affinity_group in guest_meta["affinity_groups"]:
+                    group_name = affinity_group
+                    logger.debug(f'Affinity group {affinity_group} for {guest_name} will be used.')
+            else:
+                # Generate a random uniq group name for the guest if
+                # the guest does not belong to any affinity group
+                random_group = Helper.get_uuid_string()
+                group_name = random_group
+                logger.debug(f'Random uniq group {random_group} for {guest_name} will be used.')
+
+            if not groups["groups"]["affinity"].get(group_name, False):
+                # Create group template with initial guest meta information
+                groups["groups"]["affinity"][group_name] = {}
+                groups["groups"]["affinity"][group_name]["guests"] = []
+                groups["groups"]["affinity"][group_name]["guests"].append(guest_name)
+                groups["groups"]["affinity"][group_name]["counter"] = 1
+                # Create groups resource template by the guests resources
+                groups["groups"]["affinity"][group_name]["cpu_total"] = guest_meta["cpu_total"]
+                groups["groups"]["affinity"][group_name]["cpu_used"] = guest_meta["cpu_used"]
+                groups["groups"]["affinity"][group_name]["memory_total"] = guest_meta["memory_total"]
+                groups["groups"]["affinity"][group_name]["memory_used"] = guest_meta["cpu_used"]
+                groups["groups"]["affinity"][group_name]["disk_total"] = guest_meta["disk_total"]
+                groups["groups"]["affinity"][group_name]["disk_used"] = guest_meta["cpu_used"]
+            else:
+                # Update group templates by guest meta information
+                groups["groups"]["affinity"][group_name]["guests"].append(guest_name)
+                groups["groups"]["affinity"][group_name]["counter"] += 1
+                # Update group resources by guest resources
+                groups["groups"]["affinity"][group_name]["cpu_total"] += guest_meta["cpu_total"]
+                groups["groups"]["affinity"][group_name]["cpu_used"] += guest_meta["cpu_used"]
+                groups["groups"]["affinity"][group_name]["memory_total"] += guest_meta["memory_total"]
+                groups["groups"]["affinity"][group_name]["memory_used"] += guest_meta["cpu_used"]
+                groups["groups"]["affinity"][group_name]["disk_total"] += guest_meta["disk_total"]
+                groups["groups"]["affinity"][group_name]["disk_used"] += guest_meta["cpu_used"]
+
+            # Create anti-affinity grouping
+            if len(guest_meta["anti_affinity_groups"]) > 0:
+                for anti_affinity_group in guest_meta["anti_affinity_groups"]:
+                    anti_affinity_group_name = anti_affinity_group
+                    logger.debug(f'Anti-affinity group {anti_affinity_group_name} for {guest_name} will be used.')
+
+                    if not groups["groups"]["anti_affinity"].get(anti_affinity_group_name, False):
+                        groups["groups"]["anti_affinity"][anti_affinity_group_name] = {}
+                        groups["groups"]["anti_affinity"][anti_affinity_group_name]["guests"] = []
+                        groups["groups"]["anti_affinity"][anti_affinity_group_name]["guests"].append(guest_name)
+                        groups["groups"]["anti_affinity"][anti_affinity_group_name]["counter"] = 1
+                        groups["groups"]["anti_affinity"][anti_affinity_group_name]["used_nodes"] = []
+                    else:
+                        groups["groups"]["anti_affinity"][anti_affinity_group_name]["guests"].append(guest_name)
+                        groups["groups"]["anti_affinity"][anti_affinity_group_name]["counter"] += 1
+
+            # Create grouping of guests that are currently located on nodes that are
+            # marked as in maintenance and must be migrated
+            if nodes["nodes"][guest_meta["node_current"]]["maintenance"]:
+                logger.debug(f'{guest_name} will be migrated to another node because the underlying node {guest_meta["node_current"]} is defined to be in maintenance.')
+                groups["groups"]["maintenance"].append(guest_name)
+
+        logger.debug("Finished: get_groups.")
+        return groups

proxlb/models/guests.py

@@ -0,0 +1,97 @@
+"""
+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.
+"""
+
+from typing import Dict, Any
+from utils.logger import SystemdLogger
+from models.tags import Tags
+
+logger = SystemdLogger()
+
+
+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.
+    """
+    def __init__(self):
+        """
+        Initializes the Guests class with the provided ProxLB data.
+        """
+
+    @staticmethod
+    def get_guests(proxmox_api: any, nodes: Dict[str, Any]) -> Dict[str, Any]:
+        """
+        Get metrics of all guests in a Proxmox cluster.
+
+        This method retrieves metrics for all running guests (both VMs and CTs) across all nodes in the Proxmox cluster.
+        It iterates over each node and collects resource metrics for each running guest, including CPU, memory, and disk usage.
+        Additionally, it retrieves tags and affinity/anti-affinity groups for each guest.
+
+        Args:
+            proxmox_api (any): The Proxmox API client instance.
+            nodes (Dict[str, Any]): A dictionary containing information about the nodes in the Proxmox cluster.
+
+        Returns:
+            Dict[str, Any]: A dictionary containing metrics and information for all running guests.
+        """
+        logger.debug("Starting: get_guests.")
+        guests = {"guests": {}}
+
+        # Guest objects are always only in the scope of a node.
+        # Therefore, we need to iterate over all nodes to get all guests.
+        for node in nodes['nodes'].keys():
+
+            # VM objects: Iterate over all VMs on the current node by the qemu API object.
+            # Unlike the nodes we need to keep them even when being ignored to create proper
+            # 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':
+                    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']]['memory_total'] = guest['maxmem']
+                    guests['guests'][guest['name']]['memory_used'] = guest['mem']
+                    guests['guests'][guest['name']]['disk_total'] = guest['maxdisk']
+                    guests['guests'][guest['name']]['disk_used'] = guest['disk']
+                    guests['guests'][guest['name']]['id'] = guest['vmid']
+                    guests['guests'][guest['name']]['node_current'] = node
+                    guests['guests'][guest['name']]['node_target'] = node
+                    guests['guests'][guest['name']]['processed'] = False
+                    guests['guests'][guest['name']]['tags'] = Tags.get_tags_from_guests(proxmox_api, node, guest['vmid'], 'vm')
+                    guests['guests'][guest['name']]['affinity_groups'] = Tags.get_affinity_groups(guests['guests'][guest['name']]['tags'])
+                    guests['guests'][guest['name']]['anti_affinity_groups'] = Tags.get_anti_affinity_groups(guests['guests'][guest['name']]['tags'])
+                    guests['guests'][guest['name']]['ignore'] = Tags.get_ignore(guests['guests'][guest['name']]['tags'])
+                    guests['guests'][guest['name']]['type'] = 'vm'
+                else:
+                    logger.debug(f'Metric for VM {guest["name"]} ignored because VM is not running.')
+
+            # CT objects: Iterate over all VMs on the current node by the lxc API object.
+            # Unlike the nodes we need to keep them even when being ignored to create proper
+            # resource metrics for rebalancing to ensure that we do not overprovisiong the node.
+            for guest in proxmox_api.nodes(node).lxc.get():
+                if guest['status'] == 'running':
+                    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']]['memory_total'] = guest['maxmem']
+                    guests['guests'][guest['name']]['memory_used'] = guest['mem']
+                    guests['guests'][guest['name']]['disk_total'] = guest['maxdisk']
+                    guests['guests'][guest['name']]['disk_used'] = guest['disk']
+                    guests['guests'][guest['name']]['id'] = guest['vmid']
+                    guests['guests'][guest['name']]['node_current'] = node
+                    guests['guests'][guest['name']]['node_target'] = node
+                    guests['guests'][guest['name']]['processed'] = False
+                    guests['guests'][guest['name']]['tags'] = Tags.get_tags_from_guests(proxmox_api, node, guest['vmid'], 'ct')
+                    guests['guests'][guest['name']]['affinity_groups'] = Tags.get_affinity_groups(guests['guests'][guest['name']]['tags'])
+                    guests['guests'][guest['name']]['anti_affinity_groups'] = Tags.get_anti_affinity_groups(guests['guests'][guest['name']]['tags'])
+                    guests['guests'][guest['name']]['ignore'] = Tags.get_ignore(guests['guests'][guest['name']]['tags'])
+                    guests['guests'][guest['name']]['type'] = 'ct'
+                else:
+                    logger.debug(f'Metric for CT {guest["name"]} ignored because CT is not running.')
+
+        logger.debug("Finished: get_guests.")
+        return guests

proxlb/models/nodes.py

@@ -0,0 +1,123 @@
+"""
+The Nodes class retrieves all running nodes in a Proxmox cluster
+and collects their resource metrics.
+"""
+
+from typing import Dict, Any
+from utils.logger import SystemdLogger
+
+logger = SystemdLogger()
+
+
+class Nodes:
+    """
+    The Nodes class retrieves all running nodes in a Proxmox cluster
+    and collects their resource metrics.
+    """
+    def __init__(self):
+        """
+        Initializes the Nodes class with the provided ProxLB data.
+        """
+
+    @staticmethod
+    def get_nodes(proxmox_api: any, proxlb_config: Dict[str, Any]) -> Dict[str, Any]:
+        """
+        Get metrics of all nodes in a Proxmox cluster.
+
+        This method retrieves metrics for all available nodes in the Proxmox cluster.
+        It iterates over each node and collects resource metrics including CPU, memory, and disk usage.
+
+        Args:
+            proxmox_api (any): The Proxmox API client instance.
+            nodes (Dict[str, Any]): A dictionary containing information about the nodes in the Proxmox cluster.
+
+        Returns:
+            Dict[str, Any]: A dictionary containing metrics and information for all running nodes.
+        """
+        logger.debug("Starting: get_nodes.")
+        nodes = {"nodes": {}}
+
+        for node in proxmox_api.nodes.get():
+            # Ignoring a node results into ignoring all placed guests on the ignored node!
+            if node["status"] == "online" and not Nodes.set_node_ignore(proxlb_config, node["node"]):
+                nodes["nodes"][node["node"]] = {}
+                nodes["nodes"][node["node"]]["name"] = node["node"]
+                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_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
+                nodes["nodes"][node["node"]]["cpu_used_percent"] = nodes["nodes"][node["node"]]["cpu_used"] / node["maxcpu"] * 100
+                nodes["nodes"][node["node"]]["memory_total"] = node["maxmem"]
+                nodes["nodes"][node["node"]]["memory_assigned"] = 0
+                nodes["nodes"][node["node"]]["memory_used"] = node["mem"]
+                nodes["nodes"][node["node"]]["memory_free"] = node["maxmem"] - node["mem"]
+                nodes["nodes"][node["node"]]["memory_assigned_percent"] = nodes["nodes"][node["node"]]["memory_assigned"] / nodes["nodes"][node["node"]]["memory_total"] * 100
+                nodes["nodes"][node["node"]]["memory_free_percent"] = nodes["nodes"][node["node"]]["memory_free"] / node["maxmem"] * 100
+                nodes["nodes"][node["node"]]["memory_used_percent"] = nodes["nodes"][node["node"]]["memory_used"] / node["maxmem"] * 100
+                nodes["nodes"][node["node"]]["disk_total"] = node["maxdisk"]
+                nodes["nodes"][node["node"]]["disk_assigned"] = 0
+                nodes["nodes"][node["node"]]["disk_used"] = node["disk"]
+                nodes["nodes"][node["node"]]["disk_free"] = node["maxdisk"] - node["disk"]
+                nodes["nodes"][node["node"]]["disk_assigned_percent"] = nodes["nodes"][node["node"]]["disk_assigned"] / nodes["nodes"][node["node"]]["disk_total"] * 100
+                nodes["nodes"][node["node"]]["disk_free_percent"] = nodes["nodes"][node["node"]]["disk_free"] / node["maxdisk"] * 100
+                nodes["nodes"][node["node"]]["disk_used_percent"] = nodes["nodes"][node["node"]]["disk_used"] / node["maxdisk"] * 100
+
+                # Evaluate if node should be set to maintenance mode
+                if Nodes.set_node_maintenance(proxlb_config, node["node"]):
+                    nodes["nodes"][node["node"]]["maintenance"] = True
+
+        logger.debug("Finished: get_nodes.")
+        return nodes
+
+    @staticmethod
+    def set_node_maintenance(proxlb_config: Dict[str, Any], node_name: str) -> Dict[str, Any]:
+        """
+        Set nodes to maintenance mode based on the provided configuration.
+
+        This method updates the nodes dictionary to mark certain nodes as being in maintenance mode
+        based on the configuration provided in proxlb_config.
+
+        Args:
+            proxlb_config (Dict[str, Any]): A dictionary containing the ProxLB configuration, including maintenance nodes.
+            node_name: (str): The current node name within the outer iteration.
+
+        Returns:
+            Bool: Returns a bool if the provided node name is present in the maintenance section of the config file.
+        """
+        logger.debug("Starting: set_node_maintenance.")
+
+        if proxlb_config.get("proxmox_cluster", None).get("maintenance_nodes", None) is not None:
+            if len(proxlb_config.get("proxmox_cluster", {}).get("maintenance_nodes", [])) > 0:
+                if node_name in proxlb_config.get("proxmox_cluster", {}).get("maintenance_nodes", []):
+                    logger.warning(f"Node: {node_name} has been set to maintenance mode.")
+                    return True
+
+        logger.debug("Finished: set_node_maintenance.")
+
+    @staticmethod
+    def set_node_ignore(proxlb_config: Dict[str, Any], node_name: str) -> Dict[str, Any]:
+        """
+        Set nodes to be ignored based on the provided configuration.
+
+        This method updates the nodes dictionary to mark certain nodes as being ignored
+        based on the configuration provided in proxlb_config.
+
+        Args:
+            proxlb_config (Dict[str, Any]): A dictionary containing the ProxLB configuration, including maintenance nodes.
+            node_name: (str): The current node name within the outer iteration.
+
+        Returns:
+            Bool: Returns a bool if the provided node name is present in the ignore section of the config file.
+        """
+        logger.debug("Starting: set_node_ignore.")
+
+        if proxlb_config.get("proxmox_cluster", None).get("ignore_nodes", None) is not None:
+            if len(proxlb_config.get("proxmox_cluster", {}).get("ignore_nodes", [])) > 0:
+                if node_name in proxlb_config.get("proxmox_cluster", {}).get("ignore_nodes", []):
+                    logger.warning(f"Node: {node_name} has been set to be ignored. Not adding node!")
+                    return True
+
+        logger.debug("Finished: set_node_ignore.")

proxlb/models/tags.py

@@ -0,0 +1,130 @@
+"""
+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.
+"""
+
+import time
+from typing import List
+from utils.logger import SystemdLogger
+
+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.
+    """
+    def __init__(self):
+        """
+        Initializes the Tags class.
+        """
+
+    @staticmethod
+    def get_tags_from_guests(proxmox_api: any, node: str, guest_id: int, guest_type: str) -> List[str]:
+        """
+        Get tags for a guest from the Proxmox cluster by the API.
+
+        This method retrieves all tags for a given guest from the Proxmox API which
+        is held in the guest_config.
+
+        Args:
+            proxmox_api (any): The Proxmox API client instance.
+            node (str): The node name where the given guest is located.
+            guest_id (int): The internal Proxmox ID of the guest.
+            guest_type (str): The type (vm or ct) of the guest.
+
+        Returns:
+            List: A list of all tags assoiciated with the given guest.
+        """
+        logger.debug("Starting: get_tags_from_guests.")
+        time.sleep(0.1)
+        if guest_type == 'vm':
+            guest_config = proxmox_api.nodes(node).qemu(guest_id).config.get()
+            tags = guest_config.get("tags", [])
+        if guest_type == 'ct':
+            guest_config = proxmox_api.nodes(node).lxc(guest_id).config.get()
+            tags = guest_config.get("tags", [])
+
+        if isinstance(tags, str):
+            tags = tags.split(";")
+
+        logger.debug("Finished: get_tags_from_guests.")
+        return tags
+
+    @staticmethod
+    def get_affinity_groups(tags: List[str]) -> List[str]:
+        """
+        Get affinity tags for a guest from the Proxmox cluster by the API.
+
+        This method retrieves all tags for a given guest and evaluates the
+        affinity tags which are required during the balancing calculations.
+
+        Args:
+            tags (List): A list holding all defined tags for a given guest.
+
+        Returns:
+            List: A list including all affinity tags for the given guest.
+        """
+        logger.debug("Starting: get_affinity_groups.")
+        affinity_tags = []
+
+        if len(tags) > 0:
+            for tag in tags:
+                if tag.startswith("plb_affinity"):
+                    affinity_tags.append(tag)
+
+        logger.debug("Finished: get_affinity_groups.")
+        return affinity_tags
+
+    @staticmethod
+    def get_anti_affinity_groups(tags: List[str]) -> List[str]:
+        """
+        Get anti-affinity tags for a guest from the Proxmox cluster by the API.
+
+        This method retrieves all tags for a given guest and evaluates the
+        anti-affinity tags which are required during the balancing calculations.
+
+        Args:
+            tags (List): A list holding all defined tags for a given guest.
+
+        Returns:
+            List: A list including all anti-affinity tags for the given guest..
+        """
+        logger.debug("Starting: get_anti_affinity_groups.")
+        anti_affinity_tags = []
+
+        if len(tags) > 0:
+            for tag in tags:
+                if tag.startswith("plb_anti_affinity"):
+                    anti_affinity_tags.append(tag)
+
+        logger.debug("Finished: get_anti_affinity_groups.")
+        return anti_affinity_tags
+
+    @staticmethod
+    def get_ignore(tags: List[str]) -> bool:
+        """
+        Validate for ignore tags of a guest from the Proxmox cluster by the API.
+
+        This method retrieves all tags for a given guest and evaluates the
+        ignore tag which are required during the balancing calculations.
+
+        Args:
+            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.
+        """
+        logger.debug("Starting: get_ignore.")
+        ignore_tag = False
+
+        if len(tags) > 0:
+            for tag in tags:
+                if tag.startswith("plb_ignore"):
+                    ignore_tag = True
+
+        logger.debug("Finished: get_ignore.")
+        return ignore_tag

proxlb/utils/cli_parser.py

@@ -0,0 +1,68 @@
+"""
+The CliParser class handles the parsing of command-line interface (CLI) arguments.
+"""
+
+import argparse
+from utils.logger import SystemdLogger
+
+logger = SystemdLogger()
+
+
+class CliParser:
+    """
+    The CliParser class handles the parsing of command-line interface (CLI) arguments.
+    """
+    def __init__(self):
+        """
+        Initializes the argument parser and defines available CLI options.
+        """
+        logger.debug("Starting: CliParser.")
+        self.parser = argparse.ArgumentParser(description="ProxLB - Proxmox Load Balancer")
+
+        self.parser.add_argument(
+            "-c", "--config",
+            help="Path to the configuration file",
+            type=str,
+            required=False
+        )
+        self.parser.add_argument(
+            "-d", "--dry-run",
+            help="Perform a dry-run without executing any actions",
+            action="store_true",
+            required=False
+        )
+        self.parser.add_argument(
+            "-j", "--json",
+            help="Return a JSON of the VM movement",
+            action="store_true",
+            required=False
+        )
+        self.parser.add_argument(
+            "-b", "--best-node",
+            help="Returns the best next node",
+            action="store_true",
+            required=False
+        )
+        self.parser.add_argument(
+            "-m", "--maintenance",
+            help="Sets node to maintenance mode & moves workloads away",
+            type=str,
+            required=False
+        )
+        self.parser.add_argument(
+            "-v", "--version",
+            help="Returns the current ProxLB version",
+            action="store_true",
+            required=False
+        )
+        logger.debug("Finished: CliParser.")
+
+    def parse_args(self) -> argparse.Namespace:
+        """
+        Parses and returns CLI arguments.
+        """
+        logger.debug("Starting: parse_args.")
+        logger.debug(self.parser.parse_args())
+
+        logger.debug("Finished: parse_args.")
+        return self.parser.parse_args()

proxlb/utils/config_parser.py

@@ -0,0 +1,89 @@
+"""
+The ConfigParser class handles the parsing of configuration file
+from a given YAML file from any location.
+"""
+
+import os
+import sys
+try:
+    import yaml
+    PYYAML_PRESENT = True
+except ImportError:
+    PYYAML_PRESENT = False
+from typing import Dict, Any
+from utils.logger import SystemdLogger
+
+logger = SystemdLogger()
+
+
+class ConfigParser:
+    """
+    The ConfigParser class handles the parsing of configuration file
+    from a given YAML file from any location.
+    """
+    def __init__(self, config_path: str):
+        """
+        Initializes the configuration file parser and validates the config file.
+        """
+        logger.debug("Starting: ConfigParser.")
+        self.test_module_dependencies = self.test_dependencies()
+        self.config_path = self.test_config_path(config_path)
+        logger.debug("Finished: ConfigParser.")
+
+    def test_dependencies(self) -> None:
+        """
+        Checks if the required dependencies are installed.
+        """
+        logger.debug("Starting: test_dependencies.")
+        if not PYYAML_PRESENT:
+            logger.critical("The required library 'pyyaml' is not installed.")
+            sys.exit(1)
+
+        logger.debug("Finished: test_dependencies.")
+
+    def test_config_path(self, config_path: str) -> None:
+        """
+        Checks if configuration file is present at given config path.
+        """
+        logger.debug("Starting: test_config_path.")
+        # Test for config file at given location
+        if config_path is not None:
+
+            if os.path.exists(config_path):
+                logger.debug(f"The file {config_path} exists.")
+            else:
+                logger.error(f"The file {config_path} does not exist.")
+                sys.exit(1)
+
+        # Test for config file at default location as a fallback
+        if config_path is None:
+            default_config_path = "/etc/proxlb/proxlb.yaml"
+
+            if os.path.exists(default_config_path):
+                logger.debug(f"The file {default_config_path} exists.")
+                config_path = default_config_path
+            else:
+                print(f"The config file {default_config_path} does not exist.")
+                logger.critical(f"The config file {default_config_path} does not exist.")
+                sys.exit(1)
+
+        logger.debug("Finished: test_config_path.")
+        return config_path
+
+    def get_config(self) -> Dict[str, Any]:
+        """
+        Parses and returns CLI arguments.
+        """
+        logger.debug("Starting: get_config.")
+        logger.info(f"Using config path: {self.config_path}")
+
+        try:
+            with open(self.config_path, "r", encoding="utf-8") as config_file:
+                config_data = yaml.load(config_file, Loader=yaml.FullLoader)
+            return config_data
+        except yaml.YAMLError as exception_error:
+            print(f"Error loading YAML file: {exception_error}")
+            logger.critical(f"Error loading YAML file: {exception_error}")
+            sys.exit(1)
+
+        logger.debug("Finished: get_config.")

proxlb/utils/helper.py

@@ -0,0 +1,65 @@
+"""
+The Helper class provides some basic helper functions to not mess up the code in other
+classes.
+"""
+
+import uuid
+from utils.logger import SystemdLogger
+from typing import Dict, Any
+
+logger = SystemdLogger()
+
+
+class Helper:
+    """
+    The Helper class provides some basic helper functions to not mess up the code in other
+    classes.
+    """
+    def __init__(self):
+        """
+        Initializes the general Helper clas.
+        """
+
+    @staticmethod
+    def get_uuid_string() -> str:
+        """
+        Generates a random uuid and returns it as a string.
+
+        Args:
+            None
+
+        Returns:
+            Str: Returns a random uuid as a string.
+        """
+        logger.debug("Starting: get_uuid_string.")
+        generated_uuid = uuid.uuid4()
+        logger.debug("Finished: get_uuid_string.")
+        return str(generated_uuid)
+
+    @staticmethod
+    def 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.
+
+        This method processes the usage metrics of nodes and logs them. It also updates the
+        'statistics' field in the 'meta' section of the proxlb_data dictionary with the
+        memory, CPU, and disk usage metrics before and after a certain operation.
+
+            proxlb_data (Dict[str, Any]): A dictionary containing node metrics and metadata.
+            init (bool): A flag indicating whether to initialize the 'before' statistics
+                        (True) or update the 'after' statistics (False). Default is True.
+        """
+        logger.debug("Starting: log_node_metrics.")
+        nodes_usage_memory = " | ".join([f"{key}: {value['memory_used_percent']:.2f}%" for key, value in proxlb_data["nodes"].items()])
+        nodes_usage_cpu = "  | ".join([f"{key}: {value['cpu_used_percent']:.2f}%" for key, value in proxlb_data["nodes"].items()])
+        nodes_usage_disk = " | ".join([f"{key}: {value['disk_used_percent']:.2f}%" for key, value in proxlb_data["nodes"].items()])
+
+        if init:
+            proxlb_data["meta"]["statistics"] = {"before": {"memory": nodes_usage_memory, "cpu": nodes_usage_cpu, "disk": nodes_usage_disk}, "after": {"memory": "", "cpu": "", "disk": ""}}
+        else:
+            proxlb_data["meta"]["statistics"]["after"] = {"memory": nodes_usage_memory, "cpu": nodes_usage_cpu, "disk": nodes_usage_disk}
+
+        logger.debug(f"Nodes usage memory: {nodes_usage_memory}")
+        logger.debug(f"Nodes usage cpu:    {nodes_usage_cpu}")
+        logger.debug(f"Nodes usage disk:   {nodes_usage_disk}")
+        logger.debug("Finished: log_node_metrics.")

proxlb/utils/logger.py

@@ -0,0 +1,109 @@
+"""
+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
+"""
+
+import logging
+try:
+    from systemd.journal import JournalHandler
+    SYSTEMD_PRESENT = True
+except ImportError:
+    SYSTEMD_PRESENT = False
+
+
+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.
+    """
+    # Create a singleton instance variable
+    instance = None
+
+    def __new__(cls, name: str = "ProxLB", level: str = logging.INFO) -> 'SystemdLogger':
+        """
+        Creating a new systemd logger class based on a given logging name
+        and its logging level/verbosity.
+
+        Args:
+            name (str): The application name that is being used for the logger.
+            level (str): The log level defined as a string (e.g.: INFO).
+
+        Returns:
+            SystemdLogger: The systemd logger object.
+        """
+        # Check if instance already exists, otherwise create a new one
+        if cls.instance is None:
+            cls.instance = super(SystemdLogger, cls).__new__(cls)
+            cls.instance.initialize_logger(name, level)
+        return cls.instance
+
+    def initialize_logger(self, name: str, level: str) -> None:
+        """
+        Initializing the systemd logger class based on a given logging name
+        and its logging level/verbosity.
+
+        Args:
+            name (str): The application name that is being used for the logger.
+            level (str): The log level defined as a string (e.g.: INFO).
+        """
+        self.logger = logging.getLogger(name)
+        self.logger.setLevel(level)
+
+        # Create a JournalHandler for systemd integration if this
+        # is supported on the underlying OS.
+        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)
+
+    def set_log_level(self, level: str) -> None:
+        """
+        Modifies and sets the log level on the given log level.
+
+        Args:
+            level (str): The log level defined as a string (e.g.: INFO).
+        """
+        self.logger.setLevel(level)
+
+        for handler in self.logger.handlers:
+            handler.setLevel(level)
+
+        self.logger.debug("Set to debug level")
+
+    # Handle systemd log levels
+    def debug(self, msg: str) -> str:
+        """
+        Logger out for messages of type: DEBUG
+        """
+        self.logger.debug(msg)
+
+    def info(self, msg: str) -> str:
+        """
+        Logger out for messages of type: INFO
+        """
+        self.logger.info(msg)
+
+    def warning(self, msg: str) -> str:
+        """
+        Logger out for messages of type: WARNING
+        """
+        self.logger.warning(msg)
+
+    def error(self, msg: str) -> str:
+        """
+        Logger out for messages of type: ERROR
+        """
+        self.logger.error(msg)
+
+    def critical(self, msg: str) -> str:
+        """
+        Logger out for messages of type: CRITICAL
+        """
+        self.logger.critical(msg)

proxlb/utils/proxmox_api.py

@@ -0,0 +1,309 @@
+"""
+Module providing a function printing python version.
+"""
+
+try:
+    import proxmoxer
+    PROXMOXER_PRESENT = True
+except ImportError:
+    PROXMOXER_PRESENT = False
+import random
+import socket
+import sys
+try:
+    import requests
+    REQUESTS_PRESENT = True
+except ImportError:
+    REQUESTS_PRESENT = False
+try:
+    import urllib3
+    URLLIB3_PRESENT = True
+except ImportError:
+    URLLIB3_PRESENT = False
+
+from typing import Dict, Any
+from utils.logger import SystemdLogger
+
+logger = SystemdLogger()
+
+
+class ProxmoxApi:
+    """
+    Handles command-line argument parsing for ProxLB.
+    """
+    def __init__(self, proxlb_config: Dict[str, Any]) -> None:
+        """
+        Initialize the ProxmoxApi instance.
+
+        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.
+
+        Args:
+            proxlb_config (Dict[str, Any]): Configuration dictionary containing Proxmox API connection details.
+
+        Returns:
+            None
+        """
+        logger.debug("Starting: ProxmoxApi initialization.")
+        self.test_module_dependencies = self.test_dependencies()
+        self.proxmox_api = self.api_connect(proxlb_config)
+        logger.debug("Finished: ProxmoxApi initialization.")
+
+    def __getattr__(self, name):
+        """
+        Delegate attribute access to proxmox_api.
+        """
+        return getattr(self.proxmox_api, name)
+
+    def test_dependencies(self) -> None:
+        """
+        Test for the presence of required libraries.
+
+        This method checks if the necessary libraries 'proxmoxer', 'urllib3', and 'requests'
+        are installed. If any of these libraries are missing, it logs a critical error message
+        and terminates the program.
+
+        Returns:
+            None
+
+        Raises:
+            SystemExit: If the provided imports are not available.
+        """
+        logger.debug("Starting: test_dependencies.")
+        if not PROXMOXER_PRESENT:
+            logger.critical("The required library 'proxmoxer' is not installed.")
+            sys.exit(1)
+
+        if not URLLIB3_PRESENT:
+            logger.critical("The required library 'urllib3' is not installed.")
+            sys.exit(1)
+
+        if not REQUESTS_PRESENT:
+            logger.critical("The required library 'requests' is not installed.")
+            sys.exit(1)
+
+        logger.debug("Finished: test_dependencies.")
+
+    def api_connect_get_hosts(self, proxmox_api_endpoints: list) -> str:
+        """
+        Perform a connectivity test to determine a working host for the Proxmox API.
+
+        This method takes a list of Proxmox API endpoints and validates their connectivity.
+        It returns a working host from the list. If only one endpoint is provided, it is
+        returned immediately. If multiple endpoints are provided, each one is tested for
+        connectivity. If a valid host is found, it is returned. If multiple valid hosts
+        are found, one is chosen at random to distribute the load across the cluster.
+
+        Args:
+            proxmox_api_endpoints (list): A list of Proxmox API endpoints to test.
+
+        Returns:
+            str: A working Proxmox API host.
+
+        Raises:
+            SystemExit: If the provided endpoints are not a list, if the list is empty,
+                        or if no valid hosts are found.
+        """
+        logger.debug("Starting: api_connect_get_hosts.")
+        # Pre-validate the given API endpoints
+        if not isinstance(proxmox_api_endpoints, list):
+            logger.critical(f"The proxmox_api hosts are not defined as a list type.")
+            sys.exit(1)
+
+        if not proxmox_api_endpoints:
+            logger.critical(f"No proxmox_api hosts are defined.")
+            sys.exit(1)
+
+        if len(proxmox_api_endpoints) == 0:
+            logger.critical(f"No proxmox_api hosts are defined.")
+            sys.exit(1)
+
+        # Get a suitable Proxmox API endpoint. Therefore, we check if we only have
+        # a single Proxmox API endpoint or multiple ones. If only one, we can return
+        # this one immediately. If this one does not work, the urllib will raise an
+        # exception during the connection attempt.
+        if len(proxmox_api_endpoints) == 1:
+            return proxmox_api_endpoints[0]
+
+        # If we have multiple Proxmox API endpoints, we need to check each one by
+        # doing a connection attempt for IPv4 and IPv6. If we find a working one,
+        # we return that one. This allows us to define multiple endpoints in a cluster.
+        validated_api_hosts = []
+        for host in proxmox_api_endpoints:
+            validated = self.test_api_proxmox_host(host)
+            if validated:
+                validated_api_hosts.append(validated)
+
+        if len(validated_api_hosts) > 0:
+            # Choose a random host to distribute the load across the cluster
+            # as a simple load balancing mechanism.
+            return random.choice(validated_api_hosts)
+
+        logger.critical("No valid Proxmox API hosts found.")
+        print("No valid Proxmox API hosts found.")
+
+        logger.debug("Finished: api_connect_get_hosts.")
+        sys.exit(1)
+
+    def test_api_proxmox_host(self, host: str) -> str:
+        """
+        Tests the connectivity to a Proxmox host by resolving its IP address and
+        checking both IPv4 and IPv6 addresses.
+
+        This function attempts to resolve the given hostname to its IP addresses
+        (both IPv4 and IPv6). It then tests the connectivity to the Proxmox API
+        using the resolved IP addresses. If the host is reachable via either
+        IPv4 or IPv6, the function returns the hostname. If the host is not
+        reachable, the function returns False.
+
+        Args:
+            host (str): The hostname of the Proxmox server to test.
+
+        Returns:
+            str: The hostname if the Proxmox server is reachable.
+            bool: False if the Proxmox server is not reachable.
+        """
+        logger.debug("Starting: test_api_proxmox_host.")
+        ip = socket.getaddrinfo(host, None, socket.AF_UNSPEC)
+        for address_type in ip:
+            if address_type[0] == socket.AF_INET:
+                logger.debug(f"{host} is type ipv4.")
+                if self.test_api_proxmox_host_ipv4(host):
+                    return host
+            elif address_type[0] == socket.AF_INET6:
+                logger.debug(f"{host} is type ipv6.")
+                if self.test_api_proxmox_host_ipv6(host):
+                    return host
+            else:
+                return False
+
+        logger.debug("Finished: test_api_proxmox_host.")
+
+    def test_api_proxmox_host_ipv4(self, host: str, port: int = 8006, timeout: int = 1) -> bool:
+        """
+        Test the reachability of a Proxmox host on its IPv4 management address.
+
+        This method attempts to establish a TCP connection to the specified host and port
+        within a given timeout period. It logs the process and results, indicating whether
+        the host is reachable or not.
+
+        Args:
+            host (str): The IPv4 address or hostname of the Proxmox host to test.
+            port (int, optional): The TCP port to connect to on the host. Defaults to 8006.
+            timeout (int, optional): The timeout duration in seconds for the connection attempt. Defaults to 1.
+
+        Returns:
+            bool: True if the host is reachable on the specified port, False otherwise.
+        """
+        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}.")
+        result = sock.connect_ex((host, port))
+
+        if result == 0:
+            sock.close()
+            logger.debug(f"Host {host} is reachable on IPv4 for tcp/{port}.")
+            return True
+
+        sock.close()
+        logger.warning(f"Host {host} is unreachable on IPv4 for tcp/{port}.")
+
+        logger.debug("Finished: test_api_proxmox_host_ipv4.")
+        return False
+
+    def test_api_proxmox_host_ipv6(self, host: str, port: int = 8006, timeout: int = 1) -> bool:
+        """
+        Test the reachability of a Proxmox host on its IPv6 management address.
+
+        This method attempts to establish a TCP connection to the specified host and port
+        within a given timeout period. It logs the process and results, indicating whether
+        the host is reachable or not.
+
+        Args:
+            host (str): The IPv6 address or hostname of the Proxmox host to test.
+            port (int, optional): The TCP port to connect to on the host. Defaults to 8006.
+            timeout (int, optional): The timeout duration in seconds for the connection attempt. Defaults to 1.
+
+        Returns:
+            bool: True if the host is reachable on the specified port, False otherwise.
+        """
+        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}.")
+        result = sock.connect_ex((host, port))
+
+        if result == 0:
+            sock.close()
+            logger.debug(f"Host {host} is reachable on IPv6 for tcp/{port}.")
+            return True
+
+        sock.close()
+        logger.warning(f"Host {host} is unreachable on IPv6 for tcp/{port}.")
+
+        logger.debug("Finished: test_api_proxmox_host_ipv4.")
+        return False
+
+    def api_connect(self, proxlb_config: Dict[str, Any]) -> proxmoxer.ProxmoxAPI:
+        """
+        Establishes a connection to the Proxmox API using the provided configuration.
+
+        This function retrieves the Proxmox API endpoint from the configuration, optionally disables SSL certificate
+        validation warnings, and attempts to authenticate and create a ProxmoxAPI object. It handles various exceptions
+        related to authentication, connection timeouts, SSL errors, and connection refusals, logging appropriate error
+        messages and exiting the program if necessary.
+
+        Args:
+            proxlb_config (Dict[str, Any]): A dictionary containing the Proxmox API configuration. Expected keys include:
+                - "proxmox_api": A dictionary with the following keys:
+                    - "hosts" (List[str]): A list of Proxmox API host addresses.
+                    - "user" (str): The username for Proxmox API authentication.
+                    - "pass" (str): The password for Proxmox API authentication.
+                    - "ssl_verification" (bool): Whether to verify SSL certificates (default is True).
+                    - "timeout" (int): The timeout duration for API requests.
+
+        Returns:
+            proxmoxer.ProxmoxAPI: An authenticated ProxmoxAPI object.
+
+        Raises:
+            proxmoxer.backends.https.AuthenticationError: If authentication fails.
+            requests.exceptions.ConnectTimeout: If the connection to the Proxmox API times out.
+            requests.exceptions.SSLError: If SSL certificate validation fails.
+            requests.exceptions.ConnectionError: If the connection to the Proxmox API is refused.
+        """
+        logger.debug("Starting: api_connect.")
+        # Get a valid Proxmox API endpoint
+        proxmox_api_endpoint = self.api_connect_get_hosts(proxlb_config.get("proxmox_api", {}).get("hosts", []))
+
+        # Disable warnings for SSL certificate validation
+        if not proxlb_config.get("proxmox_api").get("ssl_verification", True):
+            logger.warning(f"SSL certificate validation to host {proxmox_api_endpoint} is deactivated.")
+            urllib3.disable_warnings(category=urllib3.exceptions.InsecureRequestWarning)
+            requests.packages.urllib3.disable_warnings()
+
+        # 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))
+        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)
+        except requests.exceptions.ConnectTimeout:
+            logger.critical(f"Connection timeout to host {proxmox_api_endpoint}")
+            sys.exit(2)
+        except requests.exceptions.SSLError as proxmox_api_error:
+            logger.critical(f"SSL certificate validation failed: {proxmox_api_error}")
+            sys.exit(2)
+        except requests.exceptions.ConnectionError:
+            logger.critical(f"Connection refused by host {proxmox_api_endpoint}")
+            sys.exit(2)
+
+        logger.info(f"API connection to host {proxmox_api_endpoint} succeeded.")
+
+        logger.debug("Finished: api_connect.")
+        return proxmox_api

pyproject.toml

@@ -0,0 +1,2 @@
+[build-system]
+requires = ["setuptools>=42", "stdeb"]

requirements.txt

@@ -1,5 +1,4 @@
-argparse
-configparser
 proxmoxer
 requests
-urllib3
+urllib3
+PyYAML

setup.cfg

@@ -0,0 +1,2 @@
+[pycodestyle]
+ignore = E501, W503

setup.py

@@ -0,0 +1,23 @@
+from setuptools import setup, find_packages
+
+setup(
+    name='proxlb',
+    version='1.1.0',
+    description='A DRS alike loadbalancer for Proxmox clusters.',
+    author='Florian Paul Azim Hoberg',
+    author_email='gyptazy@gyptazy.com',
+    url='https://github.com/gyptazy/ProxLB',
+    packages=find_packages(),
+    install_requires=[
+        'python3-proxmoxer',
+        'python3-urllib3',
+        'python3-requests',
+        'python3-yaml',
+    ],
+    classifiers=[
+        'Programming Language :: Python :: 3',
+        'License :: OSI Approved :: GPL v3',
+        'Operating System :: OS Independent',
+    ],
+    python_requires='>=3.6',
+)

tests/README.md

@@ -1 +0,0 @@
-## Unit Tests

tests/tests.py

@@ -1,175 +0,0 @@
-import unittest
-from unittest.mock import patch, MagicMock
-import logging
-import sys
-import os
-import configparser
-
-from proxlb import (
-    initialize_logger,
-    pre_validations,
-    post_validations,
-    validate_daemon,
-    __validate_imports,
-    __validate_config_file,
-    initialize_args,
-    initialize_config_path,
-    initialize_config_options,
-    api_connect,
-    get_node_statistics,
-    get_vm_statistics,
-    balancing_calculations,
-    __get_node_most_free_values,
-    run_vm_rebalancing,
-    SystemdHandler,
-    __errors__
-)
-
-class TestProxLB(unittest.TestCase):
-
-    def test_initialize_logger(self):
-        with patch('logging.getLogger') as mock_get_logger, patch('logging.Handler'):
-            mock_logger = MagicMock()
-            mock_get_logger.return_value = mock_logger
-            initialize_logger(logging.DEBUG, SystemdHandler())
-            mock_logger.setLevel.assert_called_with(logging.DEBUG)
-            self.assertTrue(mock_logger.addHandler.called)
-
-    def test_pre_validations(self):
-        with patch('proxlb.__validate_imports') as mock_validate_imports, patch('proxlb.__validate_config_file') as mock_validate_config_file:
-            pre_validations('/path/to/config')
-            self.assertTrue(mock_validate_imports.called)
-            mock_validate_config_file.assert_called_with('/path/to/config')
-
-    def test_post_validations(self):
-        global __errors__
-        __errors__ = False
-        with patch('logging.critical') as mock_critical, patch('logging.info') as mock_info:
-            post_validations()
-            self.assertTrue(mock_info.called)
-            self.assertFalse(mock_critical.called)
-
-        __errors__ = True
-        with patch('logging.critical') as mock_critical, patch('logging.info'):
-            post_validations()
-            self.assertTrue(mock_critical.called)
-
-    def test_validate_daemon(self):
-        with patch('logging.info') as mock_info, patch('time.sleep') as mock_sleep, patch('sys.exit') as mock_exit:
-            validate_daemon(1, 1)
-            self.assertTrue(mock_info.called)
-            self.assertTrue(mock_sleep.called)
-
-            validate_daemon(0, 1)
-            self.assertTrue(mock_exit.called)
-
-    def test_validate_imports(self):
-        global _imports
-        _imports = True
-        with patch('logging.critical') as mock_critical, patch('logging.info') as mock_info, patch('sys.exit') as mock_exit:
-            __validate_imports()
-            self.assertTrue(mock_info.called)
-            self.assertFalse(mock_exit.called)
-            self.assertFalse(mock_critical.called)
-
-        _imports = False
-        with patch('logging.critical') as mock_critical, patch('logging.info'), patch('sys.exit') as mock_exit:
-            __validate_imports()
-            self.assertTrue(mock_critical.called)
-            self.assertTrue(mock_exit.called)
-
-    def test_validate_config_file(self):
-        with patch('os.path.isfile', return_value=True), patch('logging.critical') as mock_critical, patch('logging.info') as mock_info, patch('sys.exit') as mock_exit:
-            __validate_config_file('/path/to/config')
-            self.assertTrue(mock_info.called)
-            self.assertFalse(mock_exit.called)
-            self.assertFalse(mock_critical.called)
-
-        with patch('os.path.isfile', return_value=False), patch('logging.critical') as mock_critical, patch('logging.info'), patch('sys.exit') as mock_exit:
-            __validate_config_file('/path/to/config')
-            self.assertTrue(mock_critical.called)
-            self.assertTrue(mock_exit.called)
-
-    @patch('argparse.ArgumentParser.parse_args', return_value=argparse.Namespace(config='/path/to/config'))
-    def test_initialize_args(self, mock_parse_args):
-        args = initialize_args()
-        self.assertEqual(args.config, '/path/to/config')
-
-    def test_initialize_config_path(self):
-        app_args = MagicMock(config='/path/to/config')
-        with patch('logging.info') as mock_info:
-            config_path = initialize_config_path(app_args)
-            self.assertEqual(config_path, '/path/to/config')
-            self.assertTrue(mock_info.called)
-
-        app_args.config = None
-        with patch('logging.info') as mock_info:
-            config_path = initialize_config_path(app_args)
-            self.assertEqual(config_path, '/etc/proxlb/proxlb.conf')
-            self.assertTrue(mock_info.called)
-
-    @patch('configparser.ConfigParser.read', side_effect=lambda x: setattr(configparser.ConfigParser(), 'proxmox', {'api_host': 'host', 'api_user': 'user', 'api_pass': 'pass', 'verify_ssl': '0'}))
-    def test_initialize_config_options(self, mock_read):
-        with patch('logging.info') as mock_info, patch('sys.exit') as mock_exit:
-            config_path = '/path/to/config'
-            proxmox_api_host, proxmox_api_user, proxmox_api_pass, proxmox_api_ssl_v, balancing_method, ignore_nodes, ignore_vms, daemon, schedule = initialize_config_options(config_path)
-            self.assertEqual(proxmox_api_host, 'host')
-            self.assertEqual(proxmox_api_user, 'user')
-            self.assertEqual(proxmox_api_pass, 'pass')
-            self.assertEqual(proxmox_api_ssl_v, '0')
-            self.assertTrue(mock_info.called)
-            self.assertFalse(mock_exit.called)
-
-    @patch('proxmoxer.ProxmoxAPI')
-    def test_api_connect(self, mock_proxmox_api):
-        with patch('requests.packages.urllib3.disable_warnings') as mock_disable_warnings, patch('logging.warning') as mock_warning, patch('logging.info') as mock_info:
-            proxmox_api_ssl_v = 0
-            api_object = api_connect('host', 'user', 'pass', proxmox_api_ssl_v)
-            self.assertTrue(mock_disable_warnings.called)
-            self.assertTrue(mock_warning.called)
-            self.assertTrue(mock_info.called)
-            self.assertTrue(mock_proxmox_api.called)
-
-    def test_get_node_statistics(self):
-        mock_api_object = MagicMock()
-        mock_api_object.nodes.get.return_value = [{'node': 'node1', 'status': 'online', 'maxcpu': 100, 'cpu': 50, 'maxmem': 1000, 'mem': 500, 'maxdisk': 10000, 'disk': 5000}]
-        node_statistics = get_node_statistics(mock_api_object, '')
-        self.assertIn('node1', node_statistics)
-        self.assertEqual(node_statistics['node1']['cpu_total'], 100)
-        self.assertEqual(node_statistics['node1']['cpu_used'], 50)
-        self.assertEqual(node_statistics['node1']['memory_total'], 1000)
-        self.assertEqual(node_statistics['node1']['memory_used'], 500)
-        self.assertEqual(node_statistics['node1']['disk_total'], 10000)
-        self.assertEqual(node_statistics['node1']['disk_used'], 5000)
-
-    def test_get_vm_statistics(self):
-        mock_api_object = MagicMock()
-        mock_api_object.nodes.get.return_value = [{'node': 'node1', 'status': 'online'}]
-        mock_api_object.nodes().qemu.get.return_value = [{'name': 'vm1', 'status': 'running', 'cpus': 4, 'cpu': 2, 'maxmem': 8000, 'mem': 4000, 'maxdisk': 20000, 'disk': 10000, 'vmid': 101}]
-        vm_statistics = get_vm_statistics(mock_api_object, '')
-        self.assertIn('vm1', vm_statistics)
-        self.assertEqual(vm_statistics['vm1']['cpu_total'], 4)
-        self.assertEqual(vm_statistics['vm1']['cpu_used'], 2)
-        self.assertEqual(vm_statistics['vm1']['memory_total'], 8000)
-        self.assertEqual(vm_statistics['vm1']['memory_used'], 4000)
-        self.assertEqual(vm_statistics['vm1']['disk_total'], 20000)
-        self.assertEqual(vm_statistics['vm1']['disk_used'], 10000)
-        self.assertEqual(vm_statistics['vm1']['vmid'], 101)
-        self.assertEqual(vm_statistics['vm1']['node_parent'], 'node1')
-
-    def test_balancing_calculations(self):
-        node_statistics = {
-            'node1': {'cpu_free': 80, 'memory_free': 8000, 'disk_free': 80000},
-            'node2': {'cpu_free': 70, 'memory_free': 7000, 'disk_free': 70000}
-        }
-        vm_statistics = {
-            'vm1': {'cpu_used': 20, 'memory_used': 2000, 'disk_used': 20000, 'node_parent': 'node1'},
-            'vm2': {'cpu_used': 30, 'memory_used': 3000, 'disk_used': 30000, 'node_parent': 'node1'}
-        }
-        with patch('logging.info') as mock_info, patch('logging.error') as mock_error:
-            node_statistics_rebalanced, vm_statistics_rebalanced = balancing_calculations('memory', node_statistics, vm_statistics)
-            self.assertTrue(mock_info.called)
-            self.assertFalse(mock_error.called)
-            self.assertEqual(vm_statistics_rebalanced['vm1']['node_rebalance'], 'node2')
-            self.assertEqual(vm_statistics_rebalanced['vm2']['node
-