feature(API): Add ProxLB API

Fixes: #8

.changelogs/1.0.0/10_add_container_support.yml

@@ -1,2 +1,2 @@
 added:
-  - Add Docker/Podman support. [#10 by @daanbosch]
+  - Add container (e.g., Docker, Podman) support. [#10 by @daanbosch]

.changelogs/1.0.0/16_add_rebalancing_by_assigned_resources.yml

@@ -1,2 +0,0 @@
-added:
-  - Add option to rebalance by assigned VM resources to avoid overprovisioning. [#16]

.changelogs/1.0.0/17-add-configurable-log-verbosity.yml

@@ -1,4 +0,0 @@
-added:
-   - Add feature to make log verbosity configurable [#17].
-changed:
-   - Adjusted general logging and log more details.

.changelogs/1.0.0/27_add_container_lxc_support.yml

@@ -1,2 +0,0 @@
-added:
-  - Add LXC/Container integration. [#27]

.changelogs/1.0.0/29_add_option_rebalance_by_node_percent.yml

@@ -1,2 +0,0 @@
-added:
-  - Add option_mode to rebalance by node's free resources in percent (instead of bytes). [#29]

.changelogs/1.0.0/release_meta.yml

@@ -1 +1 @@
-date: 2024-08-01
+date: TBD

.changelogs/1.0.2/40_add_option_to_run_only_on_cluster_master_node.yml

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

.changelogs/1.0.2/41_add_option_run_migration_parallel_or_sequential.yml

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

.changelogs/1.0.2/45_fix_daemon_timer.yml

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

.changelogs/1.0.2/49_fix_cmake_debian_packaging.yml

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

.changelogs/1.0.2/release_meta.yml

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

.changelogs/1.0.3/51_add_storage_balancing.yml

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

.changelogs/1.0.3/53_code_improvements.yml

@@ -1,6 +0,0 @@
-added:
-  - Add a convert function to cast all bool alike options from configparser to bools. [#53]
-  - Add a config parser options for future features. [#53]
-  - Add a config versio schema that must be supported by ProxLB. [#53]
-changed:
-  - Improve the underlying code base for future implementations. [#53]

.changelogs/1.0.3/60_allow_api_hosts_to_be_given_as_an_optional_list.yml

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

.changelogs/1.0.3/64_improve_error_handling_and_validations.yml

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

.changelogs/1.0.3/67_fix_anti_affinity_rules.yml

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

.changelogs/1.0.3/68_adjust_logging_ha_services.yml

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

.changelogs/1.0.3/71_fix_ignore_vm_node_handling_if_unset.yml

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

.changelogs/1.0.3/74_fix_documentation_master_only.yml

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

.changelogs/1.0.3/8_add_best_next_node_for_placement.yml

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

.changelogs/1.0.3/bug_fix_cluster_master_only.yml

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

.changelogs/1.0.3/docs_fix_default_config_add_dedicated_user_howto.yml

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

.changelogs/1.0.3/release_meta.yml

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

.changelogs/1.0.4/58_add_maintenance_mode.yml

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

.changelogs/1.0.4/75_fix_cpu_balancing.yml

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

.changelogs/1.0.4/79_storage_balancing_whitelist.yml

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

.changelogs/1.0.4/81_documentation_infrastrucutre.yml

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

.changelogs/1.0.4/89_add_version_output.yml

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

.changelogs/1.0.4/91_make_api_timeout_configureable.yml

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

.changelogs/1.0.4/release_meta.yml

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

.changelogs/1.0.5/104_docs_bool_adjustment.yml

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

.changelogs/1.0.5/106_fix_maintenance_mode_compare_str_list.yml

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

.changelogs/1.0.5/107_fix_offline_node_eval.yml

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

.changelogs/1.0.5/113_fix_migration_from_local_disk.yml

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

.changelogs/1.0.5/98_fix_log_verbosity_opts.yml

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

.changelogs/1.0.5/release_meta.yml

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

.changelogs/1.0.6/115_fix_daemon_scheduler_bool_time_fix.yml

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

.changelogs/1.0.6/119_fix_maintenance_mode_cli_and_config.yml

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

.changelogs/1.0.6/release_meta.yml

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

.changelogs/1.1.0/114_refactor_code_base.yml

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

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

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

.changelogs/1.1.0/137_fix_systemd_unit_file.yml

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

.changelogs/1.1.0/release_meta.yml

@@ -1 +0,0 @@
-date: 2025-04-01

.changelogs/1.1.1/163_fix_ignore_vm_tag.yml

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

.changelogs/1.1.1/165_improve_logging_servity.yml

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

.changelogs/1.1.1/168_add_more_flexible_schedules.yml

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

.changelogs/1.1.1/171_set_correct_python_path_docker_image.yml

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

.changelogs/1.1.1/174_honor_balancing_activation_value.yml

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

.changelogs/1.1.1/176_change_turn_daemon_mode_on_default.yml

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

.changelogs/1.1.1/180_change_default_balancing_to_used_instead_assigned.yml

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

.changelogs/1.1.1/184_validate_for_sufficient_user_permissions.yml

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

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

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

.changelogs/1.1.1/187_allow_use_of_minutes_instead_of_hours.yml

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

.changelogs/1.1.1/195_set_cpu_used_to_cpu_usage_times_core_count.yml

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

.changelogs/1.1.1/197_remove_hard_coded_memory_usage_from_lowest_usage_node.yml

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

.changelogs/1.1.1/200_requery_zero_guest_cpu_used.yml

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

.changelogs/1.1.1/204_fix_migration_log_relationship_of_guest_type.yml

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

.changelogs/1.1.1/205_add_api_upstream_error_message_on_migration_failure.yml

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

.changelogs/1.1.1/release_meta.yml

@@ -1 +0,0 @@
-date: 2025-04-20

.changelogs/1.1.10/335-prevalidate-affinity-matrix.yml

@@ -1,2 +0,0 @@
-added:
-  - Prevent redundant rebalancing by validating existing affinity enforcement before taking actions (@gyptazy). [#335]

.changelogs/1.1.10/359-add-pve8-user-protections-for-conntrack-aware-migrations.yml

@@ -1,2 +0,0 @@
-added:
-  - Add safety-guard for PVE 8 users when activating conntrack-aware migrations mistakenly (@gyptazy). [#359]

.changelogs/1.1.10/361_fix_proxmox_api_connection_validation.yml

@@ -1,3 +0,0 @@
-fixed:
-  - Fixed the Proxmox API connection validation which returned a false-positive logging message of timeouts (@gyptazy). [#361]
-  - Refactored Proxmox API connection functions

.changelogs/1.1.10/368_fix_crash_enumerating_pools_with_storage_members.yml

@@ -1,2 +0,0 @@
-fixed:
-  - Fixed a crash during PVE resource pool enumeration by skipping members not having a 'name' property (@stefanoettl). [#368]

.changelogs/1.1.10/release_meta.yml

@@ -1 +0,0 @@
-date: 2025-11-25

.changelogs/1.1.11/275_add_overprovisioning_safety_guard.yml

@@ -1,2 +0,0 @@
-fixed:
-  - Fixed missing overprovisioning safety guard to avoid node overprovisioning (@gyptazy). [#275]

.changelogs/1.1.11/335_fix_affinity_matrix_prevalidation.yml

@@ -1,2 +0,0 @@
-fixed:
-  - Fixed affinity matrix pre-validation by inverting validations (@Thalagyrt). [#335]

.changelogs/1.1.11/373_add_node_resource_reservation_support.yml

@@ -1,2 +0,0 @@
-added:
-  - Add resource reservation support for PVE nodes (@Chipmonk2). [#373]

.changelogs/1.1.11/378_change_and_improve_balancing_decisions.yml

@@ -1,3 +0,0 @@
-changed:
-  - Changed balancing and sorting behaviour (@gyptazy). [#378]
-  - Balancing objects will be ordered by: count of objects in affinity-rules, followed by memory size 

.changelogs/1.1.11/387_select_balancing_workloads_by_size.yml

@@ -1,2 +0,0 @@
-added:
-  - Add possibility to sort and select balancing workloads by smaller/larger guest objects (@gyptazy). [#387]

.changelogs/1.1.11/391_add_native_proxmox_ha_rules_support.yml

@@ -1,3 +0,0 @@
-added:
-  - Add support for Proxmox's native HA (affinity/anti-affinity) rules (@gyptazy). [#391]
-  - Add support for Proxmox's native HA (node-affinity) rules for pinning guests to nodes (@gyptazy). [#391]

.changelogs/1.1.11/395_fix_pool_based_node_pinning.yml

@@ -1,2 +0,0 @@
-fixed:
-  - Fixed pool based node pinning (@gyptazy). [#395]

.changelogs/1.1.11/402_add_ha_job_validation.yml

@@ -1,2 +0,0 @@
-added:
-  - Add HA job validation for migration jobs (@gytazy). [#402]

.changelogs/1.1.11/406_add_stricness_for_node_pinning_of_pools.yml

@@ -1,2 +0,0 @@
-added:
-  - Add support for configuring node-pinning strictness (default: true) within pools (@gyptazy). [#406]

.changelogs/1.1.11/408_fix_moving_ignored_guests.yml

@@ -1,2 +0,0 @@
-fixed:
-  - Fixed that ignored VMs/CTs got moved to another node when being ignored (@gyptazy). [#408]

.changelogs/1.1.11/414_add_pinning_enforcement.yml

@@ -1,2 +0,0 @@
-added:
-  - Add new option to enforce node/guest pinning even when cluster is balanced from a resource perspective (@gyptazy). [#414]

.changelogs/1.1.11/release_meta.yml

@@ -1 +0,0 @@
-date: 2026-01-12

.changelogs/1.1.12/420_fix_psi_based_balancing_key_error.yml

@@ -1,2 +0,0 @@
-fixed:
-  - Fix PSI based balancing which resulted in a Python KeyError (@gyptazy). [#420]

.changelogs/1.1.12/release_meta.yml

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

.changelogs/1.1.2/137_fix_systemd_unit_file.yml

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

.changelogs/1.1.2/157_add_proxmox_api_retry_mechanism.yml

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

.changelogs/1.1.2/218_add_1_to_one_relationship_guest_node_pinning.yml

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

.changelogs/1.1.2/222_fix_force_type_cast_cpu_metrics_to_int.yml

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

.changelogs/1.1.2/release_meta.yml

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

.changelogs/1.1.3/189_add_reload_function.yml

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

.changelogs/1.1.3/232_align_maintenance_mode_proxmox_ha.yml

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

.changelogs/1.1.3/239_add_optional_delay_time_until_service_starts.yml

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

.changelogs/1.1.3/241_make_amount_of_parallel_migrations_configurable.yml

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

.changelogs/1.1.3/94_cpu_balancing_use_avg_instead_current_consumption.yml

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

.changelogs/1.1.3/release_meta.yml

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

.changelogs/1.1.4/245_add_guest_pinning_to_groups_of_nodes.yml

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

.changelogs/1.1.4/248_fix_dry_run_combination_balancing_disabled.yml

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

.changelogs/1.1.4/255_fix_loglevels.yml

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

.changelogs/1.1.4/release_meta.yml

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

.changelogs/1.1.5/260_allow_custom_api_ports.yml

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

.changelogs/1.1.5/release_meta.yml

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

.changelogs/1.1.6/268_fix_balancing_type_eval.yml

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

.changelogs/1.1.6/290_validate_user_token_syntax.yml

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

.changelogs/1.1.6/291_fix_stack_trace_no_user_permissions_testing.yml

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

.changelogs/1.1.6/295_fix_overprovisioning_first_node_if_anti_affinity_group_has_only_one-member.yml

@@ -1,3 +0,0 @@
-fixed:
-  - Fix Overprovisioning first node if anti_affinity_group has only one member (@MiBUl-eu). [#295]
-  

.changelogs/1.1.6/296_fix_validate_node_presence_when_pinning_guests.yml

@@ -1,3 +0,0 @@
-fixed:
-  - Validate for node presence when pinning guests to avoid crashing (@gyptazy). [#296]
-