fix

* Native Python3 project
 * Oop style
 * Native Debian packaging
   - Renamed package: python3-proxlb

Fixes: #114

.changelogs/1.1.0/114_refactor_code_base.yml

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

.changelogs/1.1.0/release_meta.yml

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

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

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

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

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

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

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

.gitignore

@@ -1,2 +1,7 @@
 __pycache__
+*.pyc
+.DS_Store
+build/
+dist/
+*.egg-info/
 proxlb_dev.yaml

CONTRIBUTING.md

@@ -0,0 +1,121 @@
+# 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 flake8
+   ```
+
+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.com) in Matrix.
+
+Thank you for contributing to ProxLB! Together, we can enhance the efficiency and performance of Proxmox clusters.

LICENSE

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

@@ -5,8 +5,36 @@
 <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
+# :warning: Important: ProxLB 1.1.x is coming
+This repository is currently under heavy work and changes. During that time it might come to issues, non working pipelines or wrong documentation. Please select a stable release tag for a suitable version during this time!
 
+## Table of Contents
+1. [Introduction](#introduction)
+2. [Features](#features)
+3. [How does it work?](#how-does-it-work)
+4. [Installation](#installation)
+   1. [Requirements / Dependencies](#requirements--dependencies)
+   2. [Debian Package](#debian-package)
+   3. [RedHat Package](#redhat-package)
+   4. [Container / Docker](#container--docker)
+   5. [Source](#source)
+5. [Upgrading](#upgrading)
+   1. [Upgrading from < 1.1.0](#upgrading-from--110)
+   2. [Upgrading from >= 1.1.0](#upgrading-from--110)
+6. [Usage / Configuration](#usage--configuration)
+   1. [GUI Integration](#gui-integration)
+   2. [Proxmox HA Integration](#proxmox-ha-integration)
+   3. [Options](#options)
+7. [Affinity & Anti-Affinity Rules](#affinity--anti-affinity-rules)
+   1. [Affinity Rules](#affinity-rules)
+   2. [Anti-Affinity Rules](#anti-affinity-rules)
+8. [Maintenance](#maintenance)
+9. [Misc](#misc)
+   1. [Bugs](#bugs)
+   2. [Contributing](#contributing)
+   3. [Documentation](#documentation)
+   4. [Support](#support)
+10. [Author(s)](#authors)
 
 
 ## Introduction
@@ -24,6 +52,9 @@ Overall, ProxLB significantly enhances resource management by intelligently dist
 <img src="https://cdn.gyptazy.com/images/proxlb-rebalancing-demo.gif"/>
 
 ## Features
+ProxLB's key features are by enabling automatic rebalancing of VMs and CTs across a Proxmox cluster based on memory, CPU, and local disk usage while identifying optimal nodes for automation. It supports maintenance mode, affinity rules, and seamless Proxmox API integration with ACL support, offering flexible usage as a one-time operation, a daemon, or through the Proxmox Web GUI.
+
+**Features**
 * Rebalance VMs/CTs in the cluster by:
   * Memory
   * Disk (only local storage)
@@ -32,21 +63,209 @@ Overall, ProxLB significantly enhances resource management by intelligently dist
 * 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
 * Affinity / Anti-Affinity Rules
-* Dry-run support
-  * Human readable output in CLI
-  * JSON output for further parsing
 * Fully based on Proxmox API
   * Fully integrated into the Proxmox ACL
   * No SSH required
 * Usage
   * One-Time
   * Daemon
-  * Proxmox Web GUI Integration
+  * Proxmox Web GUI Integration
+
+## How does it work?
+ProxLB is a load-balancing system designed to optimize the distribution of virtual machines (VMs) and containers (CTs) across a cluster. It works by first gathering resource usage metrics from all nodes in the cluster through the Proxmox API. This includes detailed resource metrics for each VM and CT on every node. ProxLB then evaluates the difference between the maximum and minimum resource usage of the nodes, referred to as "Balanciness." If this difference exceeds a predefined threshold (which is configurable), the system initiates the rebalancing process.
+
+Before starting any migrations, ProxLB validates that rebalancing actions are necessary and beneficial. Depending on the selected balancing mode — such as CPU, memory, or disk — it creates a balancing matrix. This matrix sorts the VMs by their maximum used or assigned resources, identifying the VM with the highest usage. ProxLB then places this VM on the node with the most free resources in the selected balancing type. This process runs recursively until the operator-defined Balanciness is achieved. Balancing can be defined for the used or max. assigned resources of VMs/CTs.
+
+## Installation
+
+### Requirements / Dependencies
+* Python3.x
+* proxmoxer
+* requests
+* urllib3
+* pyyaml
+
+The dependencies can simply be installed with `pip` by running the following command:
+```
+pip install -r requirements.txt
+```
+
+Distribution packages, such like the provided `.deb` package will automatically resolve and install all required dependencies by using already packaged version from the distribution's repository.
+
+### Debian Package
+
+### RedHat Package
+
+### Container / Docker
+
+### Source
+
+## Upgrading
+
+### Upgrading from < 1.1.0
+Upgrading ProxLB is not supported due to a fundamental redesign introduced in version 1.1.x. With this update, ProxLB transitioned from a monolithic application to a pure Python-style project, embracing a more modular and flexible architecture. This shift aimed to improve maintainability and extensibility while keeping up with modern development practices. Additionally, ProxLB moved away from traditional ini-style configuration files and adopted YAML for configuration management. This change simplifies configuration handling, reduces the need for extensive validation, and ensures better type casting, ultimately providing a more streamlined and user-friendly experience.
+
+### Upgrading from >= 1.1.0
+Uprading within the current stable versions, starting from 1.1.0, will be possible in all supported ways.
+
+## Usage / Configuration
+Running ProxLB is straightforward and versatile, as it only requires `Python3` and the `proxmoxer` library. This means ProxLB can be executed directly on a Proxmox node or on dedicated systems such as Debian, RedHat, or even FreeBSD, provided that the Proxmox API is accessible from the client running ProxLB. ProxLB can also run inside a Container - Docker or LXC - and is simply up to you.
+
+### GUI Integration
+<img align="left" src="https://cdn.gyptazy.com/images/proxlb-GUI-integration.jpg"/> ProxLB can also be accessed through the Proxmox Web UI by installing the optional `pve-proxmoxlb-service-ui` package, which depends on the proxlb package. For full Web UI integration, this package must be installed on all nodes within the cluster. Once installed, a new menu item - `Rebalancing`, appears in the cluster level under the HA section. Once installed, it offers two key functionalities:
+* Rebalancing VM workloads
+* Migrate VM workloads away from a defined node (e.g. maintenance preparation)
+
+**Note:** This package is currently discontinued and will be readded at a later time. See also: [#44: How to install pve-proxmoxlb-service-ui package](https://github.com/gyptazy/ProxLB/issues/44).
+
+### Proxmox HA Integration
+Proxmox HA (High Availability) groups are designed to ensure that virtual machines (VMs) remain running within a Proxmox cluster. HA groups define specific rules for where VMs should be started or migrated in case of node failures, ensuring minimal downtime and automatic recovery.
+
+However, when used in conjunction with ProxLB, the built-in load balancer for Proxmox, conflicts can arise. ProxLB operates with its own logic for workload distribution, taking into account affinity and anti-affinity rules. While it effectively balances guest workloads, it may re-shift and redistribute VMs in a way that does not align with HA group constraints, potentially leading to unsuitable placements.
+
+Due to these conflicts, it is currently not recommended to use both HA groups and ProxLB simultaneously. The interaction between the two mechanisms can lead to unexpected behavior, where VMs might not adhere to HA group rules after being moved by ProxLB.
+
+A solution to improve compatibility between HA groups and ProxLB is under evaluation, aiming to ensure that both features can work together without disrupting VM placement strategies.
+
+See also: [#65: Host groups: Honour HA groups](https://github.com/gyptazy/ProxLB/issues/65).
+
+### Options
+The following options can be set in the configuration file `proxlb.yaml`:
+
+| Section | Option | Example | Type | Description |
+|------|:------:|:------:|:------:|:------:|
+| `proxmox_api` |  |  | |  |
+| | hosts | ['virt01.example.com', '10.10.10.10', 'fe01::bad:code::cafe'] | `List` | List of Proxmox nodes. Can be IPv4, IPv6 or mixed. |
+| | user | root@pam | `Str` | Username for the API. |
+| | pass | FooBar | `Str` | Password for the API. |
+| | ssl_verification | True | `Bool` | Validate SSL certificates (1) or ignore (0). (default: 1, type: bool) |
+| | timeout | 10 | `Int` | Timeout for the Proxmox API in sec. (default: 10) |
+| `proxmox_cluster` |  | | |  |
+| | maintenance_nodes | ['virt66.example.com'] | `List` | A list of Proxmox nodes that are defined to be in a maintenance. (default: []) |
+| | ignore_nodes | [] | `List` | A list of Proxmox nodes that are defined to be ignored.  (default: []) |
+| | overprovisioning | False | `Bool` | Avoids balancing when nodes would become overprovisioned. |
+| `balancing` |  | | |  |
+| | enable | True | `Bool` | Enables the guest balancing.  (default: True)|
+| | force | True | `Bool` | Enforcing affinity/anti-affinity rules but balancing might become worse.  (default: False) |
+| | parallel | False | `Bool` | If guests should be moved in parallel or sequentially. (default: False)|
+| | live | True | `Bool` | If guests should be moved live or shutdown.  (default: True)|
+| | with_local_disks | True | `Bool` | If balancing of guests should include local disks  (default: True)|
+| | balance_types | ['vm', 'ct'] | `List` | Defined the types of guests that should be honored.  (default: ['vm', 'ct']) |
+| | max_job_validation | 1800 | `Int` | How long a job validation may take in seconds. (default: 1800) |
+| | balanciness | 10 | `Int` | The maximum delta of resource usage between node with highest and lowest usage. (default: 10) |
+| | method | memory | `Str` | The balancing method that should be used.  (default: memory | choices: memory, cpu, disk)|
+| | mode | used | `Str` | The balancing mode that should be used.  (default: used | choices: used, assigned)|
+| `service` |  | | |  |
+| | daemon | False | `Bool` | If daemon mode should be activated  (default: False)|
+| | schedule | 12 | `Int` | How often rebalancing should occur in hours in daemon mode (default: 12)|
+| | log_level | INFO | `Str` | Defines the default log level that should be logged.  (default: INFO) |
+
+An example of the configuration file looks like:
+```
+proxmox_api:
+  hosts: ['virt01.example.com', '10.10.10.10', 'fe01::bad:code::cafe']
+  user: root@pam
+  pass: crazyPassw0rd!
+  ssl_verification: False
+  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
+  schedule: 12
+  log_level: DEBUG
+```
+
+### 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 | Performs a dry-run without doing any actions. | False |
+| -j | --json | Returns a JSON of the VM movement. | False |
+| -b | --best-node | Returns the best next node for a VM/CT placement (useful for further usage with Terraform/Ansible). | False |
+| -v | --version | Returns the ProxLB version on stdout. | False |
+
+## Affinity & Anti-Affinity Rules
+ProxLB provides an advanced mechanism to define affinity and anti-affinity rules, enabling precise control over virtual machine (VM) placement. These rules help manage resource distribution, improve high availability configurations, and optimize performance within a Proxmox Virtual Environment (PVE) cluster. By leveraging Proxmox’s integrated access management, ProxLB ensures that users can only define and manage rules for guests they have permission to access.
+
+ProxLB implements affinity and anti-affinity rules through a tag-based system within the Proxmox web interface. Each guest (virtual machine or container) can be assigned specific tags, which then dictate its placement behavior. This method maintains a streamlined and secure approach to managing VM relationships while preserving Proxmox’s inherent permission model.
+
+### Affinity Rules
+<img align="left" src="https://cdn.gyptazy.com/images/proxlb-affinity-rules.jpg"/> Affinity rules are used to group certain VMs together, ensuring that they run on the same host whenever possible. This can be beneficial for workloads requiring low-latency communication, such as clustered databases or application servers that frequently exchange data.
+
+To define an affinity rule which keeps all guests assigned to this tag together on a node, users assign a tag with the prefix `plb_affinity_$TAG`:
+
+#### Example for Screenshot
+```
+plb_affinity_talos
+```
+
+As a result, ProxLB will attempt to place all VMs with the `plb_affinity_web` tag on the same host (see also the attached screenshot with the same node).
+
+### Anti-Affinity Rules
+<img align="left" src="https://cdn.gyptazy.com/images/proxlb-anti-affinity-rules.jpg"/> Conversely, anti-affinity rules ensure that designated VMs do not run on the same physical host. This is particularly useful for high-availability setups, where redundancy is crucial. Ensuring that critical services are distributed across multiple hosts reduces the risk of a single point of failure.
+
+To define an anti-affinity rule that ensures to not move systems within this group to the same node, users assign a tag with the prefix:
+
+#### Example for Screenshot
+```
+plb_anti_affinity_ntp
+```
+
+As a result, ProxLB will try to place the VMs with the `plb_anti_affinity_ntp` tag on different hosts (see also the attached screenshot with the different nodes).
+
+**Note:** While this ensures that ProxLB tries distribute these VMs across different physical hosts within the Proxmox cluster this may not always work. If you have more guests attached to the group than nodes in the cluster, we still need to run them anywhere. If this case occurs, the next one with the most free resources will be selected.
+
+## Maintenance
+<img src="https://cdn.gyptazy.com/images/proxlb-rebalancing-demo.gif"/>
+
+The `maintenance_nodes` option allows operators to designate one or more Proxmox nodes for maintenance mode. When a node is set to maintenance, no new guest workloads will be assigned to it, and all existing workloads will be migrated to other available nodes within the cluster. This process ensures that (anti)-affinity rules and resource availability are respected, preventing disruptions while maintaining optimal performance across the infrastructure.
+
+## Misc
+### Bugs
+Bugs can be reported via the GitHub issue tracker [here](https://github.com/gyptazy/ProxLB/issues). You may also report bugs via email or deliver PRs to fix them on your own. Therefore, you might also see the contributing chapter.
+
+### Contributing
+Feel free to add further documentation, to adjust already existing one or to contribute with code. Please take care about the style guide and naming conventions. You can find more in our [CONTRIBUTING.md](https://github.com/gyptazy/ProxLB/blob/development/CONTRIBUTING.md) file.
+
+### Documentation
+You can also find additional and more detailed documentation within the [docs/](https://github.com/gyptazy/ProxLB/tree/development/docs) directory.
+
+### Support
+If you need assistance or have any questions, we offer support through our dedicated [chat room](https://matrix.to/#/#proxlb:gyptazy.com) in Matrix or [Discord](https://discord.gg/JemGu7WbfQ). Join our community for real-time help, advice, and discussions. The Matrix and Discord room are bridged to ensure that the communication is not splitted - so simply feel free to join which fits most to you!
+
+Connect with us in our dedicated chat room for immediate support and live interaction with other users and developers. You can also visit our [GitHub Community](https://github.com/gyptazy/ProxLB/discussions/) to post your queries, share your experiences, and get support from fellow community members and moderators. You may also just open directly an issue [here](https://github.com/gyptazy/ProxLB/issues) on GitHub.
+
+| Support Channel | Link |
+|------|:------:|
+| Matrix | [#proxlb:gyptazy.com](https://matrix.to/#/#proxlb:gyptazy.com) |
+| Discord | [Discord](https://discord.gg/JemGu7WbfQ) |
+| GitHub Community | [GitHub Community](https://github.com/gyptazy/ProxLB/discussions/)
+| GitHub | [ProxLB GitHub](https://github.com/gyptazy/ProxLB/issues) |
+
+**Note:** Please always keep in mind that this is a one-man show project without any further help. This includes coding, testing, packaging and all the infrastructure around it to keep this project up and running.
+
+### Author(s)
+ * Florian Paul Azim Hoberg @gyptazy (https://gyptazy.com)

config/proxlb_example.yaml

@@ -24,4 +24,5 @@ balancing:
 
 service:
   daemon: False
+  schedule: 12
   log_level: DEBUG

misc/01-replace-version.sh

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

misc/02-create-changelog.sh

@@ -0,0 +1,4 @@
+#!/usr/bin/env 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"

proxlb/main.py

@@ -0,0 +1,79 @@
+"""
+ProxLB is a load balancing tool for Proxmox Virtual Environment (PVE) clusters.
+It connects to the Proxmox API, retrieves information about nodes, guests, and groups,
+and performs calculations to determine the optimal distribution of resources across the
+cluster. The tool supports daemon mode for continuous operation and can log metrics and
+perform balancing actions based on the configuration provided. It also includes a CLI
+parser for handling command-line arguments and a custom logger for systemd integration.
+"""
+
+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()
+    Helper.get_version(cli_args.version)
+
+    # 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"] = "********"
+
+    while True:
+        # 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, cli_args.best_node)
+        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
+        if not cli_args.dry_run:
+            Balancing(proxmox_api, proxlb_data)
+
+        # Validate daemon mode
+        Helper.get_daemon_mode(proxlb_config)
+
+        logger.debug(f"Finished: __main__")
+
+
+if __name__ == "__main__":
+    main()

proxlb/models/balancing.py

@@ -45,7 +45,7 @@ class Balancing:
 
                 # 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"]}.")
+                    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:
         """

proxlb/models/calculations.py

@@ -4,6 +4,7 @@ and containers (CTs) across all available nodes in a Proxmox cluster. It provide
 to calculate the optimal distribution of VMs and CTs based on the provided data.
 """
 
+import sys
 from typing import Dict, Any
 from utils.logger import SystemdLogger
 
@@ -92,13 +93,15 @@ class Calculations:
         logger.debug("Finished: get_balanciness.")
 
     @staticmethod
-    def get_most_free_node(proxlb_data: Dict[str, Any]) -> Dict[str, Any]:
+    def get_most_free_node(proxlb_data: Dict[str, Any], return_node: bool = False) -> 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.
+            return_node (bool): The indicator to simply return the best node for further
+                                assignments.
 
         Returns:
             Dict[str, Any]: Updated meta data section of the node with the most free resources that should
@@ -113,6 +116,12 @@ class Calculations:
         proxlb_data["meta"]["balancing"]["balance_reason"] = 'resources'
         proxlb_data["meta"]["balancing"]["balance_next_node"] = lowest_usage_node["name"]
 
+        # If executed to simply get the best node for further usage, we return
+        # the best node on stdout and gracefully exit here
+        if return_node:
+            print(lowest_usage_node["name"])
+            sys.exit(0)
+
         logger.debug("Finished: get_most_free_node.")
 
     @staticmethod
@@ -207,7 +216,7 @@ class Calculations:
 
             # 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}.")
+                logger.debug(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():
@@ -221,7 +230,7 @@ class Calculations:
                             # 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}")
+                            logger.debug(f"Node: {node_name} marked as used for anti-affinity group: {group_name} with guest {guest_name}")
                             break
 
                     else:

proxlb/utils/cli_parser.py

@@ -3,6 +3,7 @@ The CliParser class handles the parsing of command-line interface (CLI) argument
 """
 
 import argparse
+import utils.version
 from utils.logger import SystemdLogger
 
 logger = SystemdLogger()
@@ -14,10 +15,25 @@ class CliParser:
     """
     def __init__(self):
         """
-        Initializes the argument parser and defines available CLI options.
+        Initializes the CliParser class.
+
+        This method sets up an argument parser for the command-line interface (CLI) with various options:
+        - `-c` or `--config`: Specifies the path to the configuration file.
+        - `-d` or `--dry-run`: Performs a dry-run without executing any actions.
+        - `-j` or `--json`: Returns a JSON of the VM movement.
+        - `-b` or `--best-node`: Returns the best next node.
+        - `-v` or `--version`: Returns the current ProxLB version.
+
+        Logs the start and end of the initialization process.
         """
         logger.debug("Starting: CliParser.")
-        self.parser = argparse.ArgumentParser(description="ProxLB - Proxmox Load Balancer")
+
+        self.parser = argparse.ArgumentParser(
+            description=(
+                f"{utils.version.__app_name__} ({utils.version.__version__}): "
+                f"{utils.version.__app_desc__}"
+            )
+        )
 
         self.parser.add_argument(
             "-c", "--config",
@@ -43,12 +59,6 @@ class CliParser:
             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",
@@ -59,7 +69,14 @@ class CliParser:
 
     def parse_args(self) -> argparse.Namespace:
         """
-        Parses and returns CLI arguments.
+        Parses and returns the parsed command-line interface (CLI) arguments.
+
+        This method uses the argparse library to parse the arguments provided
+        via the command line. It logs the start and end of the parsing process,
+        as well as the parsed arguments for debugging purposes.
+
+        Returns:
+            argparse.Namespace: An object containing the parsed CLI arguments.
         """
         logger.debug("Starting: parse_args.")
         logger.debug(self.parser.parse_args())

proxlb/utils/config_parser.py

@@ -13,6 +13,12 @@ except ImportError:
 from typing import Dict, Any
 from utils.logger import SystemdLogger
 
+
+if not PYYAML_PRESENT:
+    print("Error: The required library 'pyyaml' is not installed.")
+    sys.exit(1)
+
+
 logger = SystemdLogger()
 
 
@@ -26,21 +32,9 @@ class ConfigParser:
         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.

proxlb/utils/helper.py

@@ -4,6 +4,9 @@ classes.
 """
 
 import uuid
+import sys
+import time
+import utils.version
 from utils.logger import SystemdLogger
 from typing import Dict, Any
 
@@ -37,7 +40,7 @@ class Helper:
         return str(generated_uuid)
 
     @staticmethod
-    def log_node_metrics(proxlb_data: Dict [str, Any], init: bool=True) -> None:
+    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.
 
@@ -62,4 +65,41 @@ class Helper:
         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.")
+        logger.debug("Finished: log_node_metrics.")
+
+    @staticmethod
+    def get_version(print_version: bool = False) -> None:
+        """
+        Returns the current version of ProxLB and optionally prints it to stdout.
+
+        Parameters:
+            print_version (bool): If True, prints the version information to stdout and exits the program.
+
+        Returns:
+            None
+        """
+        if print_version:
+            print(f"{utils.version.__app_name__} version: {utils.version.__version__}\n(C) 2025 by {utils.version.__author__}\n{utils.version.__url__}")
+            sys.exit(0)
+
+    @staticmethod
+    def get_daemon_mode(proxlb_config: Dict[str, Any]) -> None:
+        """
+        Checks if the daemon mode is active and handles the scheduling accordingly.
+
+        Parameters:
+            proxlb_config (Dict[str, Any]): A dictionary containing the ProxLB configuration.
+
+        Returns:
+            None
+        """
+        logger.debug("Starting: get_daemon_mode.")
+        if proxlb_config.get("service", {}).get("daemon", False):
+            sleep_seconds = proxlb_config.get("service", {}).get("schedule", 12) * 3600
+            logger.info(f"Daemon mode active: Next run in: {proxlb_config.get('service', {}).get('schedule', 12)} hours.")
+            time.sleep(sleep_seconds)
+        else:
+            logger.debug("Daemon mode is not active.")
+            sys.exit(0)
+
+        logger.debug("Finished: get_daemon_mode.")

proxlb/utils/proxmox_api.py

@@ -20,10 +20,23 @@ try:
     URLLIB3_PRESENT = True
 except ImportError:
     URLLIB3_PRESENT = False
-
 from typing import Dict, Any
 from utils.logger import SystemdLogger
 
+
+if not PROXMOXER_PRESENT:
+    print("Error: The required library 'proxmoxer' is not installed.")
+    sys.exit(1)
+
+if not URLLIB3_PRESENT:
+    print("Error: The required library 'urllib3' is not installed.")
+    sys.exit(1)
+
+if not REQUESTS_PRESENT:
+    print("Error: The required library 'requests' is not installed.")
+    sys.exit(1)
+
+
 logger = SystemdLogger()
 
 
@@ -45,7 +58,6 @@ class ProxmoxApi:
             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.")
 
@@ -55,35 +67,6 @@ class ProxmoxApi:
         """
         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.

proxlb/utils/version.py

@@ -0,0 +1,5 @@
+__app_name__ = "ProxLB"
+__app_desc__ = "A DRS alike loadbalancer for Proxmox clusters."
+__author__ = "Florian Paul Azim Hoberg <gyptazy>"
+__version__ = "1.1.0-alpha"
+__url__ = "https://github.com/gyptazy/ProxLB"

requirements.txt

@@ -0,0 +1,4 @@
+proxmoxer
+requests
+urllib3
+PyYAML

service/proxlb.service

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

setup.py

@@ -0,0 +1,21 @@
+from setuptools import setup
+
+setup(
+    name="proxlb",
+    version="1.1.0-alpha",
+    description="A DRS alike loadbalancer for Proxmox clusters.",
+    long_description="An advanced DRS alike loadbalancer for Proxmox clusters that also supports maintenance modes and affinity/anti-affinity rules.",
+    author="Florian Paul Azim Hoberg",
+    author_email="gyptazy@gyptazy.com",
+    maintainer="Florian Paul Azim Hoberg",
+    maintainer_email="gyptazy@gyptazy.com",
+    url="https://github.com/gyptazy/ProxLB",
+    packages=["proxlb", "proxlb.utils", "proxlb.models"],
+    install_requires=[
+        "requests",
+        "urllib3",
+        "proxmoxer",
+        "pyyaml",
+    ],
+        data_files=[('/etc/systemd/system', ['service/proxlb.service']), ('/etc/proxlb/', ['config/proxlb_example.yaml'])],
+)

source/proxlb/main.py

@@ -1,68 +0,0 @@
-"""
-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()