From 50a9e91633b68e83f52f3e002d1a581cdd8c70c7 Mon Sep 17 00:00:00 2001 From: Florian Paul Azim Hoberg Date: Thu, 10 Oct 2024 19:32:46 +0200 Subject: [PATCH] feature: Add feature to make API timeout configureable Fixes: #91 --- .changelogs/1.0.4/91_make_api_timeout_configureable.yml | 2 ++ README.md | 2 ++ proxlb | 7 ++++--- 3 files changed, 8 insertions(+), 3 deletions(-) create mode 100644 .changelogs/1.0.4/91_make_api_timeout_configureable.yml diff --git a/.changelogs/1.0.4/91_make_api_timeout_configureable.yml b/.changelogs/1.0.4/91_make_api_timeout_configureable.yml new file mode 100644 index 0000000..e6b4225 --- /dev/null +++ b/.changelogs/1.0.4/91_make_api_timeout_configureable.yml @@ -0,0 +1,2 @@ +added: + - Add feature to make API timeout configureable. [#91] diff --git a/README.md b/README.md index 5f775c2..55f068e 100644 --- a/README.md +++ b/README.md @@ -114,6 +114,7 @@ The following options can be set in the `proxlb.conf` file: | | api_user | root@pam | Username for the API. | | | api_pass | FooBar | Password for the API. | | | verify_ssl | 1 | Validate SSL certificates (1) or ignore (0). (default: 1) | +| | timeout | 10 | Timeout for the Proxmox API in sec. (default: 10) | | `vm_balancing` | enable | 1 | Enables VM/CT balancing. | | | method | memory | Defines the balancing method (default: memory) where you can use `memory`, `disk` or `cpu`. | | | mode | used | Rebalance by `used` resources (efficiency) or `assigned` (avoid overprovisioning) resources. (default: used)| @@ -142,6 +143,7 @@ api_host: hypervisor01.gyptazy.com api_user: root@pam api_pass: FooBar verify_ssl: 1 +timeout: 10 [vm_balancing] enable: 1 method: memory diff --git a/proxlb b/proxlb index 3dcc878..c71a858 100755 --- a/proxlb +++ b/proxlb @@ -247,6 +247,7 @@ def initialize_config_options(config_path): proxlb_config['proxmox_api_user'] = config['proxmox']['api_user'] proxlb_config['proxmox_api_pass'] = config['proxmox']['api_pass'] proxlb_config['proxmox_api_ssl_v'] = config['proxmox']['verify_ssl'] + proxlb_config['proxmox_api_timeout'] = config['proxmox'].get('timeout', 10) # VM Balancing proxlb_config['vm_balancing_enable'] = config['vm_balancing'].get('enable', 1) proxlb_config['vm_balancing_method'] = config['vm_balancing'].get('method', 'memory') @@ -323,7 +324,7 @@ def validate_config_minimum_version(proxlb_config): logging.info(f'{info_prefix} ProxLB config version {proxlb_config["config_version"]} is fine. Required: {__config_version__}.') -def api_connect(proxmox_api_host, proxmox_api_user, proxmox_api_pass, proxmox_api_ssl_v): +def api_connect(proxmox_api_host, proxmox_api_user, proxmox_api_pass, proxmox_api_ssl_v, proxmox_api_timeout): """ Connect and authenticate to the Proxmox remote API. """ error_prefix = 'Error: [api-connection]:' warn_prefix = 'Warning: [api-connection]:' @@ -337,7 +338,7 @@ def api_connect(proxmox_api_host, proxmox_api_user, proxmox_api_pass, proxmox_ap proxmox_api_host = __api_connect_get_host(proxmox_api_host) try: - api_object = proxmoxer.ProxmoxAPI(proxmox_api_host, user=proxmox_api_user, password=proxmox_api_pass, verify_ssl=proxmox_api_ssl_v) + api_object = proxmoxer.ProxmoxAPI(proxmox_api_host, user=proxmox_api_user, password=proxmox_api_pass, verify_ssl=proxmox_api_ssl_v, timeout=proxmox_api_timeout) except proxmoxer.backends.https.AuthenticationError as proxmox_api_error: logging.critical(f'{error_prefix} Provided credentials do not work: {proxmox_api_error}') sys.exit(2) @@ -1517,7 +1518,7 @@ def main(): while True: # API Authentication. - api_object = api_connect(proxlb_config['proxmox_api_host'], proxlb_config['proxmox_api_user'], proxlb_config['proxmox_api_pass'], proxlb_config['proxmox_api_ssl_v']) + api_object = api_connect(proxlb_config['proxmox_api_host'], proxlb_config['proxmox_api_user'], proxlb_config['proxmox_api_pass'], proxlb_config['proxmox_api_ssl_v'], proxlb_config['proxmox_api_timeout']) # Get master node of cluster and ensure that ProxLB is only performed on the # cluster master node to avoid ongoing rebalancing.