From 685e8ac5897aec1d9289c0fd92b734075cfb2992 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Alo=C3=AFs=20Micard?= Date: Mon, 21 Apr 2025 15:54:26 +0200 Subject: [PATCH 1/2] Monitoring PVE ha/replication --- README.md | 14 ++++++++------ netbox_pve_sync/__init__.py | 21 ++++++++++++++++++++- 2 files changed, 28 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 21b030b..666a6ef 100644 --- a/README.md +++ b/README.md @@ -34,17 +34,19 @@ You'll also need to perform a minimal configuration on NetBox: - Create the cluster. - Add the following Custom Fields: -| Name | Object types | Label | Type | -|-----------|-----------------|-----------|---------| -| autostart | Virtual Machine | Autostart | Boolean | -| backup | Virtual Disk | Backup | Boolean | -| dns_name | Prefix | DNS Name | Text | +| Name | Object types | Label | Type | +|------------|-----------------|------------|---------| +| autostart | Virtual Machine | Autostart | Boolean | +| replicated | Virtual Machine | Replicated | Boolean | +| ha | Virtual Machine | Failover | Boolean | +| backup | Virtual Disk | Backup | Boolean | +| dns_name | Prefix | DNS Name | Text | ### On the PVE API You'll need to create a dedicated user (ex: netsync) on your PVE cluster and then create an API token. -The user needs to have access to the VM.Monitor, Pool.Audit, VM.Audit permissions. +The user needs to have access to the VM.Monitor, Pool.Audit, VM.Audit, Sys.Audit permissions. The following env variables will need to be set: diff --git a/netbox_pve_sync/__init__.py b/netbox_pve_sync/__init__.py index e25f6ed..882b503 100644 --- a/netbox_pve_sync/__init__.py +++ b/netbox_pve_sync/__init__.py @@ -98,7 +98,9 @@ def _process_pve_virtual_machine( _nb_objects: dict, _nb_device: any, _pve_tags: [str], - _pve_virtual_machine: dict + _pve_virtual_machine: dict, + _is_replicated: bool, + _has_ha: bool, ) -> dict: _pve_node_name = _nb_device.name.lower() @@ -133,6 +135,8 @@ def _process_pve_virtual_machine( tags=list(map(lambda _pve_tag_name: _nb_objects['tags'][_pve_tag_name].id, _pve_tags)), custom_fields={ 'autostart': pve_virtual_machine_config.get('onboot') == 1, + 'replicated': _is_replicated, + 'ha': _has_ha, } ) else: @@ -145,6 +149,8 @@ def _process_pve_virtual_machine( nb_virtual_machine.status = 'active' if _pve_virtual_machine['status'] == 'running' else 'offline' nb_virtual_machine.tags = list(map(lambda _pve_tag_name: _nb_objects['tags'][_pve_tag_name].id, _pve_tags)) nb_virtual_machine.custom_fields['autostart'] = pve_virtual_machine_config.get('onboot') == 1 + nb_virtual_machine.custom_fields['replicated'] = _is_replicated + nb_virtual_machine.custom_fields['ha'] = _has_ha nb_virtual_machine.save() # Handle the VM network interfaces @@ -432,8 +438,19 @@ def main(): if 'tags' in pve_vm_resource: pass # TODO: pve_vm_tags[pve_vm_resource['vmid']].append(pve_vm_resource['tags']) + pve_ha_virtual_machine_ids = list( + map( + lambda r: int(r['sid'].split(':')[1]), + filter(lambda r: r['type'] == 'service', pve_api.cluster.ha.status.current.get()) + ) + ) + # Process Proxmox nodes for pve_node in pve_api.nodes.get(): + pve_replicated_virtual_machine_ids = list( + map(lambda r: r['guest'], pve_api.nodes(pve_node['node']).replication.get()) + ) + # This script does not create the hardware devices. nb_device = nb_objects['devices'].get(pve_node['node'].lower()) if nb_device is None: @@ -452,6 +469,8 @@ def main(): nb_device, pve_vm_tags.get(pve_virtual_machine['vmid'], []), pve_virtual_machine, + pve_virtual_machine['vmid'] in pve_replicated_virtual_machine_ids, + pve_virtual_machine['vmid'] in pve_ha_virtual_machine_ids, ) From eb663ee3c67324a57490306344cc3c3491cf0158 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Alo=C3=AFs=20Micard?= Date: Mon, 21 Apr 2025 15:56:17 +0200 Subject: [PATCH 2/2] Release 0.2.0 --- Changelog.md | 6 ++++++ pyproject.toml | 2 +- 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/Changelog.md b/Changelog.md index 6ec4c67..c0ce759 100644 --- a/Changelog.md +++ b/Changelog.md @@ -2,6 +2,12 @@ ## [Unreleased] +## [0.2.0] - 21/04/2025 + +### New + +- Monitoring PVE HA/Replication. + ## [0.1.1] - 19/02/2025 ### New diff --git a/pyproject.toml b/pyproject.toml index 51aace3..72095db 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -6,7 +6,7 @@ build-backend = "setuptools.build_meta" [project] name = "netbox-pve-sync" -version = "0.1.1" +version = "0.2.0" authors = [ { name = "Aloïs Micard", email = "alois@micard.lu" }, ]