proxlb 1.1.12.dev4__py3-none-any.whl

proxlb/models/features.py

@@ -0,0 +1,124 @@
+"""
+ProxLB Features module for validating and adjusting feature flags
+based on Proxmox VE node versions and cluster compatibility.
+"""
+
+__author__ = "Florian Paul Azim Hoberg <gyptazy>"
+__copyright__ = "Copyright (C) 2025 Florian Paul Azim Hoberg (@gyptazy)"
+__license__ = "GPL-3.0"
+
+
+from typing import List
+from typing import Dict, Any
+from utils.logger import SystemdLogger
+from packaging import version
+
+logger = SystemdLogger()
+
+
+class Features:
+    """
+    ProxLB Features module for validating and adjusting feature flags
+    based on Proxmox VE node versions and cluster compatibility.
+
+    Responsibilities:
+        - Validate and adjust feature flags based on Proxmox VE node versions.
+
+    Methods:
+        __init__():
+            No-op initializer.
+
+        validate_available_features(proxlb_data: dict) -> None:
+            Static method that inspects proxlb_data["nodes"] versions and disables
+            incompatible balancing features for Proxmox VE versions < 9.0.0.
+            This function mutates proxlb_data in place.
+
+    Notes:
+        - Expects proxlb_data to be a dict with "nodes" and "meta" keys.
+    """
+    def __init__(self):
+        """
+        Initializes the Features class.
+        """
+
+    @staticmethod
+    def validate_available_features(proxlb_data: any) -> None:
+        """
+        Validate and adjust feature flags in the provided proxlb_data according to Proxmox VE versions.
+
+        This function inspects the cluster node versions in proxlb_data and disables features
+        that are incompatible with Proxmox VE versions older than 9.0.0. Concretely, if any node
+        reports a 'pve_version' lower than "9.0.0":
+        - If meta.balancing.with_conntrack_state is truthy, it is set to False and a warning is logged.
+        - If meta.balancing.mode equals "psi", meta.balancing.enable is set to False and a warning is logged.
+
+            proxlb_data (dict): Cluster data structure that must contain:
+                - "nodes": a mapping (e.g., dict) whose values are mappings containing a 'pve_version' string.
+                - "meta": a mapping that may contain a "balancing" mapping with keys:
+                    - "with_conntrack_state" (bool, optional)
+                    - "mode" (str, optional)
+                    - "enable" (bool, optional)
+
+            None: The function mutates proxlb_data in place to disable incompatible features.
+
+        Side effects:
+            - Mutates proxlb_data["meta"]["balancing"] when incompatible features are detected.
+            - Emits debug and warning log messages.
+
+        Notes:
+            - Unexpected or missing keys/types in proxlb_data may raise KeyError or TypeError.
+            - Version comparison uses semantic version parsing; callers should provide versions as strings.
+
+        Returns:
+            None
+        """
+        logger.debug("Starting: validate_available_features.")
+
+        any_non_pve9_node = any(version.parse(n['pve_version']) < version.parse("9.0.0") for n in proxlb_data["nodes"].values())
+        if any_non_pve9_node:
+
+            with_conntrack_state = proxlb_data["meta"].get("balancing", {}).get("with_conntrack_state", False)
+            if with_conntrack_state:
+                logger.warning("Non Proxmox VE 9 systems detected: Deactivating migration option 'with-conntrack-state'!")
+                proxlb_data["meta"]["balancing"]["with_conntrack_state"] = False
+
+            psi_balancing = proxlb_data["meta"].get("balancing", {}).get("mode", None)
+            if psi_balancing == "psi":
+                logger.warning("Non Proxmox VE 9 systems detected: Deactivating balancing!")
+                proxlb_data["meta"]["balancing"]["enable"] = False
+
+        logger.debug("Finished: validate_available_features.")
+
+    @staticmethod
+    def validate_any_non_pve9_node(meta: any, nodes: any) -> dict:
+        """
+        Validate if any node in the cluster is running Proxmox VE < 9.0.0 and update meta accordingly.
+
+        This function inspects the cluster node versions and sets a flag in meta indicating whether
+        any node is running a Proxmox VE version older than 9.0.0.
+
+        Args:
+            meta (dict):    Metadata structure that will be updated with cluster version information.
+            nodes (dict):   Cluster nodes mapping whose values contain 'pve_version' strings.
+
+        Returns:
+            dict:           The updated meta dictionary with 'cluster_non_pve9' flag set to True or False.
+
+        Side effects:
+            - Mutates meta["meta"]["cluster_non_pve9"] based on node versions.
+            - Emits debug log messages.
+
+        Notes:
+            - Version comparison uses semantic version parsing; defaults to "0.0.0" if pve_version is missing.
+        """
+        logger.debug("Starting: validate_any_non_pve9_node.")
+        any_non_pve9_node = any(version.parse(node.get("pve_version", "0.0.0")) < version.parse("9.0.0") for node in nodes.get("nodes", {}).values())
+
+        if any_non_pve9_node:
+            meta["meta"]["cluster_non_pve9"] = True
+            logger.debug("Finished: validate_any_non_pve9_node. Result: True")
+        else:
+            meta["meta"]["cluster_non_pve9"] = False
+            logger.debug("Finished: validate_any_non_pve9_node. Result: False")
+
+        return meta

proxlb/models/groups.py

@@ -0,0 +1,124 @@
+"""
+The Groups class is responsible for handling the correlations between the guests
+and their groups, such as affinity and anti-affinity groups. It ensures proper balancing
+by grouping guests and evaluating them for further balancing. The class provides methods
+to initialize with ProxLB data and to generate groups based on guest and node data.
+"""
+
+__author__ = "Florian Paul Azim Hoberg <gyptazy>"
+__copyright__ = "Copyright (C) 2025 Florian Paul Azim Hoberg (@gyptazy)"
+__license__ = "GPL-3.0"
+
+
+from typing import Dict, Any
+from utils.logger import SystemdLogger
+from utils.helper import Helper
+
+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.
+
+    Methods:
+        __init__(proxlb_data: Dict[str, Any]):
+            Initializes the Groups class.
+
+        get_groups(guests: Dict[str, Any], nodes: Dict[str, Any]) -> Dict[str, Any]:
+            Generates and returns a dictionary of affinity and anti-affinity groups
+            based on the provided data.
+    """
+
+    def __init__(self, proxlb_data: Dict[str, Any]):
+        """
+        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,215 @@
+"""
+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.
+"""
+
+__author__ = "Florian Paul Azim Hoberg <gyptazy>"
+__copyright__ = "Copyright (C) 2025 Florian Paul Azim Hoberg (@gyptazy)"
+__license__ = "GPL-3.0"
+
+
+from typing import Dict, Any
+from utils.logger import SystemdLogger
+from models.pools import Pools
+from models.ha_rules import HaRules
+from models.tags import Tags
+import time
+
+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.
+
+    Methods:
+        __init__:
+            Initializes the Guests class.
+
+        get_guests(proxmox_api: any, nodes: Dict[str, Any]) -> Dict[str, Any]:
+            Retrieves metrics for all running guests (both VMs and CTs) across all nodes in the Proxmox cluster.
+            It collects resource metrics such as CPU, memory, and disk usage, as well as tags and affinity/anti-affinity groups.
+    """
+    def __init__(self):
+        """
+        Initializes the Guests class with the provided ProxLB data.
+        """
+
+    @staticmethod
+    def get_guests(proxmox_api: any, pools: Dict[str, Any], ha_rules: Dict[str, Any], nodes: Dict[str, Any], meta: Dict[str, Any], proxlb_config: 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.
+            pools (Dict[str, Any]): A dictionary containing information about the pools in the Proxmox cluster.
+            ha_rules (Dict[str, Any]): A dictionary containing information about the HA rules in the
+            nodes (Dict[str, Any]): A dictionary containing information about the nodes in the Proxmox cluster.
+            meta (Dict[str, Any]): A dictionary containing metadata information.
+            proxmox_config (Dict[str, Any]): A dictionary containing the ProxLB configuration.
+
+        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'] = int(guest['cpus'])
+                    guests['guests'][guest['name']]['cpu_used'] = Guests.get_guest_rrd_data(proxmox_api, node, guest['vmid'], guest['name'], 'cpu', None)
+                    guests['guests'][guest['name']]['cpu_pressure_some_percent'] = Guests.get_guest_rrd_data(proxmox_api, node, guest['vmid'], guest['name'], 'cpu', 'some')
+                    guests['guests'][guest['name']]['cpu_pressure_full_percent'] = Guests.get_guest_rrd_data(proxmox_api, node, guest['vmid'], guest['name'], 'cpu', 'full')
+                    guests['guests'][guest['name']]['cpu_pressure_some_spikes_percent'] = Guests.get_guest_rrd_data(proxmox_api, node, guest['vmid'], guest['name'], 'cpu', 'some', spikes=True)
+                    guests['guests'][guest['name']]['cpu_pressure_full_spikes_percent'] = Guests.get_guest_rrd_data(proxmox_api, node, guest['vmid'], guest['name'], 'cpu', 'full', spikes=True)
+                    guests['guests'][guest['name']]['cpu_pressure_hot'] = False
+                    guests['guests'][guest['name']]['memory_total'] = guest['maxmem']
+                    guests['guests'][guest['name']]['memory_used'] = guest['mem']
+                    guests['guests'][guest['name']]['memory_pressure_some_percent'] = Guests.get_guest_rrd_data(proxmox_api, node, guest['vmid'], guest['name'], 'memory', 'some')
+                    guests['guests'][guest['name']]['memory_pressure_full_percent'] = Guests.get_guest_rrd_data(proxmox_api, node, guest['vmid'], guest['name'], 'memory', 'full')
+                    guests['guests'][guest['name']]['memory_pressure_some_spikes_percent'] = Guests.get_guest_rrd_data(proxmox_api, node, guest['vmid'], guest['name'], 'memory', 'some', spikes=True)
+                    guests['guests'][guest['name']]['memory_pressure_full_spikes_percent'] = Guests.get_guest_rrd_data(proxmox_api, node, guest['vmid'], guest['name'], 'memory', 'full', spikes=True)
+                    guests['guests'][guest['name']]['memory_pressure_hot'] = False
+                    guests['guests'][guest['name']]['disk_total'] = guest['maxdisk']
+                    guests['guests'][guest['name']]['disk_used'] = guest['disk']
+                    guests['guests'][guest['name']]['disk_pressure_some_percent'] = Guests.get_guest_rrd_data(proxmox_api, node, guest['vmid'], guest['name'], 'disk', 'some')
+                    guests['guests'][guest['name']]['disk_pressure_full_percent'] = Guests.get_guest_rrd_data(proxmox_api, node, guest['vmid'], guest['name'], 'disk', 'full')
+                    guests['guests'][guest['name']]['disk_pressure_some_spikes_percent'] = Guests.get_guest_rrd_data(proxmox_api, node, guest['vmid'], guest['name'], 'disk', 'some', spikes=True)
+                    guests['guests'][guest['name']]['disk_pressure_full_spikes_percent'] = Guests.get_guest_rrd_data(proxmox_api, node, guest['vmid'], guest['name'], 'disk', 'full', spikes=True)
+                    guests['guests'][guest['name']]['disk_pressure_hot'] = False
+                    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']]['pressure_hot'] = False
+                    guests['guests'][guest['name']]['tags'] = Tags.get_tags_from_guests(proxmox_api, node, guest['vmid'], 'vm')
+                    guests['guests'][guest['name']]['pools'] = Pools.get_pools_for_guest(guest['name'], pools)
+                    guests['guests'][guest['name']]['ha_rules'] = HaRules.get_ha_rules_for_guest(guest['name'], ha_rules, guest['vmid'])
+                    guests['guests'][guest['name']]['affinity_groups'] = Tags.get_affinity_groups(guests['guests'][guest['name']]['tags'], guests['guests'][guest['name']]['pools'], guests['guests'][guest['name']]['ha_rules'], proxlb_config)
+                    guests['guests'][guest['name']]['anti_affinity_groups'] = Tags.get_anti_affinity_groups(guests['guests'][guest['name']]['tags'], guests['guests'][guest['name']]['pools'], guests['guests'][guest['name']]['ha_rules'], proxlb_config)
+                    guests['guests'][guest['name']]['ignore'] = Tags.get_ignore(guests['guests'][guest['name']]['tags'])
+                    guests['guests'][guest['name']]['node_relationships'] = Tags.get_node_relationships(guests['guests'][guest['name']]['tags'], nodes, guests['guests'][guest['name']]['pools'], guests['guests'][guest['name']]['ha_rules'], proxlb_config)
+                    guests['guests'][guest['name']]['node_relationships_strict'] = Pools.get_pool_node_affinity_strictness(proxlb_config, guests['guests'][guest['name']]['pools'])
+                    guests['guests'][guest['name']]['type'] = 'vm'
+
+                    logger.debug(f"Resources of Guest {guest['name']} (type VM) added: {guests['guests'][guest['name']]}")
+                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'] = int(guest['cpus'])
+                    guests['guests'][guest['name']]['cpu_used'] = Guests.get_guest_rrd_data(proxmox_api, node, guest['vmid'], guest['name'], 'cpu', None)
+                    guests['guests'][guest['name']]['cpu_pressure_some_percent'] = Guests.get_guest_rrd_data(proxmox_api, node, guest['vmid'], guest['name'], 'cpu', 'some')
+                    guests['guests'][guest['name']]['cpu_pressure_full_percent'] = Guests.get_guest_rrd_data(proxmox_api, node, guest['vmid'], guest['name'], 'cpu', 'full')
+                    guests['guests'][guest['name']]['cpu_pressure_some_spikes_percent'] = Guests.get_guest_rrd_data(proxmox_api, node, guest['vmid'], guest['name'], 'cpu', 'some', spikes=True)
+                    guests['guests'][guest['name']]['cpu_pressure_full_spikes_percent'] = Guests.get_guest_rrd_data(proxmox_api, node, guest['vmid'], guest['name'], 'cpu', 'full', spikes=True)
+                    guests['guests'][guest['name']]['cpu_pressure_hot'] = False
+                    guests['guests'][guest['name']]['memory_total'] = guest['maxmem']
+                    guests['guests'][guest['name']]['memory_used'] = guest['mem']
+                    guests['guests'][guest['name']]['memory_pressure_some_percent'] = Guests.get_guest_rrd_data(proxmox_api, node, guest['vmid'], guest['name'], 'memory', 'some')
+                    guests['guests'][guest['name']]['memory_pressure_full_percent'] = Guests.get_guest_rrd_data(proxmox_api, node, guest['vmid'], guest['name'], 'memory', 'full')
+                    guests['guests'][guest['name']]['memory_pressure_some_spikes_percent'] = Guests.get_guest_rrd_data(proxmox_api, node, guest['vmid'], guest['name'], 'memory', 'some', spikes=True)
+                    guests['guests'][guest['name']]['memory_pressure_full_spikes_percent'] = Guests.get_guest_rrd_data(proxmox_api, node, guest['vmid'], guest['name'], 'memory', 'full', spikes=True)
+                    guests['guests'][guest['name']]['memory_pressure_hot'] = False
+                    guests['guests'][guest['name']]['disk_total'] = guest['maxdisk']
+                    guests['guests'][guest['name']]['disk_used'] = guest['disk']
+                    guests['guests'][guest['name']]['disk_pressure_some_percent'] = Guests.get_guest_rrd_data(proxmox_api, node, guest['vmid'], guest['name'], 'disk', 'some')
+                    guests['guests'][guest['name']]['disk_pressure_full_percent'] = Guests.get_guest_rrd_data(proxmox_api, node, guest['vmid'], guest['name'], 'disk', 'full')
+                    guests['guests'][guest['name']]['disk_pressure_some_spikes_percent'] = Guests.get_guest_rrd_data(proxmox_api, node, guest['vmid'], guest['name'], 'disk', 'some', spikes=True)
+                    guests['guests'][guest['name']]['disk_pressure_full_spikes_percent'] = Guests.get_guest_rrd_data(proxmox_api, node, guest['vmid'], guest['name'], 'disk', 'full', spikes=True)
+                    guests['guests'][guest['name']]['disk_pressure_hot'] = False
+                    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']]['pressure_hot'] = False
+                    guests['guests'][guest['name']]['tags'] = Tags.get_tags_from_guests(proxmox_api, node, guest['vmid'], 'ct')
+                    guests['guests'][guest['name']]['pools'] = Pools.get_pools_for_guest(guest['name'], pools)
+                    guests['guests'][guest['name']]['ha_rules'] = HaRules.get_ha_rules_for_guest(guest['name'], ha_rules, guest['vmid'])
+                    guests['guests'][guest['name']]['affinity_groups'] = Tags.get_affinity_groups(guests['guests'][guest['name']]['tags'], guests['guests'][guest['name']]['pools'], guests['guests'][guest['name']]['ha_rules'], proxlb_config)
+                    guests['guests'][guest['name']]['anti_affinity_groups'] = Tags.get_anti_affinity_groups(guests['guests'][guest['name']]['tags'], guests['guests'][guest['name']]['pools'], guests['guests'][guest['name']]['ha_rules'], proxlb_config)
+                    guests['guests'][guest['name']]['ignore'] = Tags.get_ignore(guests['guests'][guest['name']]['tags'])
+                    guests['guests'][guest['name']]['node_relationships'] = Tags.get_node_relationships(guests['guests'][guest['name']]['tags'], nodes, guests['guests'][guest['name']]['pools'], guests['guests'][guest['name']]['ha_rules'], proxlb_config)
+                    guests['guests'][guest['name']]['node_relationships_strict'] = Pools.get_pool_node_affinity_strictness(proxlb_config, guests['guests'][guest['name']]['pools'])
+                    guests['guests'][guest['name']]['type'] = 'ct'
+
+                    logger.debug(f"Resources of Guest {guest['name']} (type CT) added: {guests['guests'][guest['name']]}")
+                else:
+                    logger.debug(f'Metric for CT {guest["name"]} ignored because CT is not running.')
+
+        logger.debug("Finished: get_guests.")
+        return guests
+
+    @staticmethod
+    def get_guest_rrd_data(proxmox_api, node_name: str, vm_id: int, vm_name: str, object_name: str, object_type: str, spikes=False) -> float:
+        """
+        Retrieves the rrd data metrics for a specific resource (CPU, memory, disk) of a guest VM or CT.
+
+        Args:
+            proxmox_api (Any): The Proxmox API client instance.
+            node_name (str): The name of the node hosting the guest.
+            vm_id (int): The ID of the guest VM or CT.
+            vm_name (str): The name of the guest VM or CT.
+            object_name (str): The resource type to query (e.g., 'cpu', 'memory', 'disk').
+            object_type (str, optional): The pressure type ('some', 'full') or None for average usage.
+            spikes (bool, optional): Whether to consider spikes in the calculation. Defaults to False.
+
+        Returns:
+            float: The calculated average usage value for the specified resource.
+        """
+        logger.debug("Starting: get_guest_rrd_data.")
+        time.sleep(0.1)
+
+        try:
+            if spikes:
+                logger.debug(f"Getting spike RRD data for {object_name} from guest: {vm_name}.")
+                guest_data_rrd = proxmox_api.nodes(node_name).qemu(vm_id).rrddata.get(timeframe="hour", cf="MAX")
+            else:
+                logger.debug(f"Getting average RRD data for {object_name} from guest: {vm_name}.")
+                guest_data_rrd = proxmox_api.nodes(node_name).qemu(vm_id).rrddata.get(timeframe="hour", cf="AVERAGE")
+        except Exception:
+            logger.error(f"Failed to retrieve RRD data for guest: {vm_name} (ID: {vm_id}) on node: {node_name}. Using 0.0 as value.")
+            logger.debug("Finished: get_guest_rrd_data.")
+            return float(0.0)
+
+        if object_type:
+
+            lookup_key = f"pressure{object_name}{object_type}"
+            if spikes:
+                # RRD data is collected every minute, so we look at the last 6 entries
+                # and take the maximum value to represent the spike
+                logger.debug(f"Getting RRD data (spike: {spikes}) of pressure for {object_name} {object_type} from guest: {vm_name}.")
+                rrd_data_value = [row.get(lookup_key) for row in guest_data_rrd if row.get(lookup_key) is not None]
+                rrd_data_value = max(rrd_data_value[-6:], default=0.0)
+            else:
+                # Calculate the average value from the RRD data entries
+                logger.debug(f"Getting RRD data (spike: {spikes}) of pressure for {object_name} {object_type} from guest: {vm_name}.")
+                rrd_data_value = sum(entry.get(lookup_key, 0.0) for entry in guest_data_rrd) / len(guest_data_rrd)
+
+        else:
+            logger.debug(f"Getting RRD data of cpu usage from guest: {vm_name}.")
+            rrd_data_value = sum(entry.get("cpu", 0.0) for entry in guest_data_rrd) / len(guest_data_rrd)
+
+        logger.debug(f"RRD data (spike: {spikes}) for {object_name} from guest: {vm_name}: {rrd_data_value}")
+        logger.debug("Finished: get_guest_rrd_data.")
+        return rrd_data_value

proxlb/models/ha_rules.py

@@ -0,0 +1,126 @@
+"""
+The HaRules class retrieves all HA rules defined on a Proxmox cluster
+including their affinity settings and member resources.
+"""
+
+__author__ = "Florian Paul Azim Hoberg <gyptazy>"
+__copyright__ = "Copyright (C) 2025 Florian Paul Azim Hoberg (@gyptazy)"
+__license__ = "GPL-3.0"
+
+
+from typing import Dict, Any
+from utils.logger import SystemdLogger
+
+logger = SystemdLogger()
+
+
+class HaRules:
+    """
+    The HaRules class retrieves all HA rules defined on a Proxmox cluster
+    including their (anti)a-ffinity settings and member resources and translates
+    them into a ProxLB usable format.
+
+    Methods:
+        __init__:
+            Initializes the HaRules class.
+
+        get_ha_rules(proxmox_api: any) -> Dict[str, Any]:
+            Retrieve HA rule definitions from the Proxmox cluster.
+            Returns a dict with a top-level "ha_rules" mapping each rule id to
+            {"rule": <rule_id>, "type": <affinity_type>, "members": [<resource_ids>...]}.
+            Converts affinity settings to descriptive format (affinity or anti-affinity).
+    """
+    def __init__(self):
+        """
+        Initializes the HA Rules class with the provided ProxLB data.
+        """
+
+    @staticmethod
+    def get_ha_rules(proxmox_api: any, meta: dict) -> Dict[str, Any]:
+        """
+        Retrieve all HA rules from a Proxmox cluster.
+
+        Queries the Proxmox API for HA rule definitions and returns a dictionary
+        containing each rule's id, affinity type, and member resources (VM/CT IDs).
+        This function processes rule affinity settings and converts them to a more
+        descriptive format (affinity or anti-affinity).
+
+        Args:
+            proxmox_api (any):      Proxmox API client instance.
+            meta (dict):            The metadata dictionary containing cluster information.
+
+        Returns:
+            Dict[str, Any]:         Dictionary with a top-level "ha_rules" key mapping rule id
+                                    to {"rule": <rule_id>, "type": <affinity_type>, "members": [<resource_ids>...]}.
+        """
+        logger.debug("Starting: get_ha_rules.")
+        ha_rules = {"ha_rules": {}}
+
+        # If any node is non PVE 9, skip fetching HA rules as they are unsupported
+        if meta["meta"]["cluster_non_pve9"]:
+            logger.debug("Skipping HA rule retrieval as non Proxmox VE 9 systems detected.")
+            return ha_rules
+        else:
+            logger.debug("Cluster running Proxmox VE 9 or newer, proceeding with HA rule retrieval.")
+
+        for rule in proxmox_api.cluster.ha.rules.get():
+
+            # Skip disabled rules (disable key exists AND is truthy)
+            if rule.get("disable", 0):
+                logger.debug(f"Skipping ha-rule: {rule['rule']} of type {rule['type']} affecting guests: {rule['resources']}. Rule is disabled.")
+                continue
+
+            # Create a resource list by splitting on commas and stripping whitespace containing
+            # the VM and CT IDs that are part of this HA rule
+            resources_list_guests = [int(r.split(":")[1]) for r in rule["resources"].split(",") if r.strip()]
+
+            # Convert the affinity field to a more descriptive type
+            if rule.get("affinity", None) == "negative":
+                affinity_type = "anti-affinity"
+            else:
+                affinity_type = "affinity"
+
+            # Create affected nodes list
+            resources_list_nodes = []
+            if rule.get("nodes", None):
+                resources_list_nodes = [n for n in rule["nodes"].split(",") if n]
+
+            # Create the ha_rule element
+            ha_rules['ha_rules'][rule['rule']] = {}
+            ha_rules['ha_rules'][rule['rule']]['rule'] = rule['rule']
+            ha_rules['ha_rules'][rule['rule']]['type'] = affinity_type
+            ha_rules['ha_rules'][rule['rule']]['nodes'] = resources_list_nodes
+            ha_rules['ha_rules'][rule['rule']]['members'] = resources_list_guests
+
+            logger.debug(f"Got ha-rule: {rule['rule']} as type {affinity_type} affecting guests: {rule['resources']}")
+
+        logger.debug("Finished: ha_rules.")
+        return ha_rules
+
+    @staticmethod
+    def get_ha_rules_for_guest(guest_name: str, ha_rules: Dict[str, Any], vm_id: int) -> Dict[str, Any]:
+        """
+        Return the list of HA rules that include the given guest.
+
+        Args:
+            guest_name (str):               Name of the VM or CT to look up.
+            ha_rules (Dict[str, Any]):      HA rules structure as returned by get_ha_rules(),
+                                            expected to contain a top-level "ha_rules" mapping each rule id to
+                                            {"rule": <rule_id>, "type": <affinity_type>, "members": [<resource_ids>...]}.
+            vm_id (int):                    VM or CT ID of the guest.
+
+        Returns:
+            list:                           IDs of HA rules the guest is a member of (empty list if none).
+        """
+        logger.debug("Starting: get_ha_rules_for_guest.")
+        guest_ha_rules = []
+
+        for rule in ha_rules["ha_rules"].values():
+            if vm_id in rule.get("members", []):
+                logger.debug(f"Guest: {guest_name} (VMID: {vm_id}) is member of HA Rule: {rule['rule']}.")
+                guest_ha_rules.append(rule)
+            else:
+                logger.debug(f"Guest: {guest_name} (VMID: {vm_id}) is NOT member of HA Rule: {rule['rule']}.")
+
+        logger.debug("Finished: get_ha_rules_for_guest.")
+        return guest_ha_rules