proxsync 2.0.0__py3-none-any.whl

pve_sync_plugin/sync/config_bridge.py

@@ -0,0 +1,221 @@
+"""Config bridge: translates plugin DB settings into the format expected by
+the standalone sync engine (OptimizedPVEToNetBoxSync).
+
+This module allows the sync engine to be driven either from:
+  1. Plugin DB models (PvePluginSettings / PveClusterConfig)
+  2. A YAML config file + env vars (standalone mode)
+"""
+
+import logging
+import os
+import tempfile
+
+import yaml
+
+logger = logging.getLogger(__name__)
+
+# Environment variable keys managed by the config bridge.
+# Used for setup and cleanup to avoid cross-worker pollution.
+_ENV_KEYS = [
+    "PVE_SYNC_CONFIG_FILE",
+    "PVE_API_HOST",
+    "PVE_API_USER",
+    "PVE_API_TOKEN",
+    "PVE_API_SECRET",
+    "PVE_API_VERIFY_SSL",
+    "NB_API_URL",
+    "NB_API_TOKEN",
+    "TELEGRAM_BOT_TOKEN",
+    "TELEGRAM_CHAT_ID",
+]
+
+
+class ConfigValidationError(Exception):
+    """Raised when required configuration values are missing."""
+
+
+def validate_config(config_data):
+    """Validate that required fields are present and non-empty.
+
+    Raises:
+        ConfigValidationError: if critical connection details are missing.
+    """
+    cluster = config_data.get("clusters", [{}])[0]
+    pve = cluster.get("pve", {})
+    netbox = cluster.get("netbox", {})
+
+    missing = []
+    if not pve.get("host"):
+        missing.append("pve.host (PVE API host)")
+    if not pve.get("token"):
+        missing.append("pve.token (PVE API token)")
+    if not pve.get("secret"):
+        missing.append("pve.secret (PVE API secret)")
+    if not netbox.get("url"):
+        missing.append("netbox.url (NetBox API URL)")
+    if not netbox.get("token"):
+        missing.append("netbox.token (NetBox API token)")
+
+    if missing:
+        raise ConfigValidationError(
+            f"Missing required config fields: {', '.join(missing)}"
+        )
+
+
+def build_runtime_config_from_db(cluster_name="default"):
+    """Read plugin DB models and produce a config dict compatible with
+    the standalone sync engine.
+
+    Returns:
+        dict: config in the same schema as config.yaml
+    """
+    from pve_sync_plugin.models import PveClusterConfig
+    from pve_sync_plugin.utils import get_plugin_config
+
+    cluster = PveClusterConfig.objects.filter(
+        name=cluster_name, enabled=True
+    ).first()
+
+    if cluster:
+        pve_host = cluster.pve_host
+        pve_user = cluster.pve_user
+        pve_token = cluster.pve_token
+        pve_secret = cluster.pve_secret
+        verify_ssl = cluster.pve_verify_ssl
+        site_name = (
+            cluster.netbox_site.name
+            if cluster.netbox_site
+            else get_plugin_config("default_site", "Main Datacenter")
+        )
+        cluster_type = (
+            cluster.netbox_cluster_type.name
+            if cluster.netbox_cluster_type
+            else get_plugin_config("default_cluster_type", "Proxmox")
+        )
+        netbox_cluster = (
+            cluster.netbox_cluster.name
+            if cluster.netbox_cluster
+            else get_plugin_config("default_netbox_cluster", "Proxmox Cluster")
+        )
+        logical_name = cluster.name
+        notify_on_sync = cluster.notify_on_sync
+    else:
+        raise ConfigValidationError(
+            f"No enabled PVE cluster config found for cluster '{cluster_name}'. "
+            "Please add a cluster in PVE Clusters → Add Cluster."
+        )
+
+    telegram_enabled = notify_on_sync and bool(
+        get_plugin_config("telegram_bot_token", "")
+        and get_plugin_config("telegram_chat_id", "")
+    )
+
+    return {
+        "clusters": [
+            {
+                "name": logical_name,
+                "pve": {
+                    "host": pve_host,
+                    "user": pve_user,
+                    "token": pve_token,
+                    "secret": pve_secret,
+                    "verify_ssl": bool(verify_ssl),
+                },
+                "netbox": {
+                    "url": get_plugin_config("netbox_url", ""),
+                    "token": get_plugin_config("netbox_token", ""),
+                },
+                "settings": {
+                    "cluster_name": netbox_cluster,
+                    "site_name": site_name,
+                    "cluster_type": cluster_type,
+                },
+            }
+        ],
+        "telegram": {
+            "enabled": telegram_enabled,
+            "bot_token": get_plugin_config("telegram_bot_token", ""),
+            "chat_id": get_plugin_config("telegram_chat_id", ""),
+        },
+        "monitoring": {
+            "node_offline_alert": True,
+            "config_drift_alert": True,
+            "tag_change_alert": True,
+            "resource_alert": {
+                "enabled": True,
+                "memory_threshold": 85,
+                "cpu_threshold": 90,
+                "disk_threshold": 10,
+            },
+        },
+        "sync": {
+            "incremental": True,
+            "force_full_sync": False,
+            "batch_size": 50,
+            "default_node_role": get_plugin_config(
+                "default_node_role", "PVE"
+            ),
+            "default_node_type": get_plugin_config(
+                "default_node_type", "Standard Server"
+            ),
+        },
+        "state_db": {
+            "path": get_plugin_config(
+                "state_db_path", "/var/lib/pve-sync/state.db"
+            ),
+            "cleanup_days": 90,
+        },
+    }
+
+
+def write_runtime_config_file(cluster_name="default"):
+    """Write a temporary YAML config file and set env vars.
+
+    Returns:
+        str: path to the temporary config file (caller must clean up)
+
+    Raises:
+        ConfigValidationError: if required config values are missing.
+    """
+    config_data = build_runtime_config_from_db(cluster_name)
+    validate_config(config_data)
+
+    config_file = tempfile.NamedTemporaryFile(
+        "w", prefix="pve-sync-", suffix=".yaml", delete=False
+    )
+    with config_file:
+        yaml.safe_dump(config_data, config_file, allow_unicode=True, sort_keys=False)
+
+    _apply_runtime_env(config_file.name, config_data)
+    return config_file.name
+
+
+def _apply_runtime_env(config_path, config_data):
+    """Set environment variables expected by the standalone sync engine."""
+    os.environ["PVE_SYNC_CONFIG_FILE"] = config_path
+    cluster = config_data["clusters"][0]
+    pve = cluster["pve"]
+    netbox = cluster["netbox"]
+    telegram = config_data.get("telegram", {})
+
+    os.environ["PVE_API_HOST"] = str(pve.get("host", ""))
+    os.environ["PVE_API_USER"] = str(pve.get("user", ""))
+    os.environ["PVE_API_TOKEN"] = str(pve.get("token", ""))
+    os.environ["PVE_API_SECRET"] = str(pve.get("secret", ""))
+    os.environ["PVE_API_VERIFY_SSL"] = (
+        "true" if pve.get("verify_ssl") else "false"
+    )
+    os.environ["NB_API_URL"] = str(netbox.get("url", ""))
+    os.environ["NB_API_TOKEN"] = str(netbox.get("token", ""))
+    os.environ["TELEGRAM_BOT_TOKEN"] = str(telegram.get("bot_token", ""))
+    os.environ["TELEGRAM_CHAT_ID"] = str(telegram.get("chat_id", ""))
+
+
+def cleanup_runtime_env():
+    """Remove temporary environment variables set by _apply_runtime_env.
+
+    Must be called in a finally block after sync completes to prevent
+    env var pollution across RQ worker invocations.
+    """
+    for key in _ENV_KEYS:
+        os.environ.pop(key, None)

pve_sync_plugin/sync/engine.py

@@ -0,0 +1,50 @@
+import importlib
+import logging
+
+logger = logging.getLogger(__name__)
+
+
+class PVESyncEngine:
+    """Plugin-facing wrapper around the standalone OptimizedPVEToNetBoxSync.
+
+    Usage in tasks.py::
+
+        from pve_sync_plugin.sync import PVESyncEngine
+
+        engine = PVESyncEngine(config_path="/tmp/pve-sync-xxx.yaml")
+        engine.run()
+        stats = engine.stats
+    """
+
+    def __init__(self, config_path=None, job_id=None):
+        self.config_path = config_path
+        self.job_id = job_id
+        self._sync_instance = None
+        self.stats = {}
+
+    def run(self):
+        """Execute a full sync cycle using the standalone engine."""
+        try:
+            config_module = importlib.import_module("config")
+            sync_module = importlib.import_module("pve_sync")
+        except ImportError as exc:
+            logger.error(
+                "Cannot import standalone sync modules. "
+                "Make sure the project root is accessible: %s",
+                exc,
+            )
+            raise
+
+        # Re-initialize config with our temp file
+        if self.config_path:
+            config_module._global_config = None
+            config_module.init_config(self.config_path)
+
+        # Run the sync
+        self._sync_instance = sync_module.OptimizedPVEToNetBoxSync(job_id=self.job_id)
+        self._sync_instance.sync()
+
+        # Capture stats
+        self.stats = dict(getattr(self._sync_instance, "stats", {}))
+
+        return self.stats

pve_sync_plugin/tables.py

@@ -0,0 +1,278 @@
+"""NetBox tables for PVE Sync plugin list views."""
+
+import django_tables2 as tables
+
+from netbox.tables import NetBoxTable, columns
+
+from .models import (
+    PbsServerConfig,
+    PveBackupStatus,
+    PveClusterConfig,
+    PveDriftEvent,
+    PveSyncJob,
+    PveWebhookEvent,
+)
+
+
+# ---------------------------------------------------------------------------
+# PveSyncJob
+# ---------------------------------------------------------------------------
+
+class PveSyncJobTable(NetBoxTable):
+    """Table for sync job history with status badges and timing information."""
+
+    id = tables.Column(linkify=True)
+    cluster_name = tables.Column(linkify=True)
+    status = columns.ChoiceFieldColumn()
+    trigger = columns.ChoiceFieldColumn()
+    start_time = columns.DateTimeColumn()
+    end_time = columns.DateTimeColumn()
+    success_rate = tables.Column(
+        accessor="success_rate",
+        verbose_name="Success %",
+        orderable=False,
+    )
+    triggered_by = tables.Column(linkify=True)
+    actions = columns.ActionsColumn(actions=("delete", "changelog"))
+
+    class Meta(NetBoxTable.Meta):
+        model = PveSyncJob
+        fields = (
+            "pk",
+            "id",
+            "cluster_name",
+            "status",
+            "trigger",
+            "start_time",
+            "end_time",
+            "total_vms",
+            "success_vms",
+            "failed_vms",
+            "success_rate",
+            "nodes_offline",
+            "config_drifts",
+            "resource_alerts",
+            "triggered_by",
+        )
+        default_columns = (
+            "id",
+            "cluster_name",
+            "status",
+            "trigger",
+            "start_time",
+            "end_time",
+            "total_vms",
+            "success_rate",
+        )
+
+
+# ---------------------------------------------------------------------------
+# PveWebhookEvent
+# ---------------------------------------------------------------------------
+
+class PveWebhookEventTable(NetBoxTable):
+    """Table for webhook events received from PVE."""
+
+    id = tables.Column(linkify=True)
+    event_type = columns.ChoiceFieldColumn()
+    node = tables.Column()
+    vmid = tables.Column(verbose_name="VM ID")
+    vm_name = tables.Column()
+    processed = columns.BooleanColumn()
+    received_at = columns.DateTimeColumn()
+    sync_job = tables.Column(linkify=True)
+    actions = columns.ActionsColumn(actions=("delete", "changelog"))
+
+    class Meta(NetBoxTable.Meta):
+        model = PveWebhookEvent
+        fields = (
+            "pk",
+            "id",
+            "event_type",
+            "node",
+            "vmid",
+            "vm_name",
+            "processed",
+            "received_at",
+            "sync_job",
+        )
+        default_columns = (
+            "id",
+            "event_type",
+            "node",
+            "vmid",
+            "vm_name",
+            "processed",
+            "received_at",
+        )
+
+
+# ---------------------------------------------------------------------------
+# PveClusterConfig
+# ---------------------------------------------------------------------------
+
+class PveClusterConfigTable(NetBoxTable):
+    """Table for PVE cluster connection profiles."""
+
+    name = tables.Column(linkify=True)
+    pve_host = tables.Column()
+    enabled = columns.BooleanColumn()
+    sync_schedule = columns.ChoiceFieldColumn()
+    netbox_site = tables.Column(linkify=True)
+    netbox_cluster = tables.Column(linkify=True)
+    last_sync = columns.DateTimeColumn()
+    last_sync_status = tables.Column()
+
+    class Meta(NetBoxTable.Meta):
+        model = PveClusterConfig
+        fields = (
+            "pk",
+            "name",
+            "pve_host",
+            "pve_user",
+            "enabled",
+            "sync_schedule",
+            "netbox_site",
+            "netbox_cluster",
+            "last_sync",
+            "last_sync_status",
+        )
+        default_columns = (
+            "name",
+            "pve_host",
+            "enabled",
+            "sync_schedule",
+            "netbox_site",
+            "netbox_cluster",
+            "last_sync",
+            "last_sync_status",
+        )
+
+
+# ---------------------------------------------------------------------------
+# PbsServerConfig
+# ---------------------------------------------------------------------------
+
+class PbsServerConfigTable(NetBoxTable):
+    """Table for PBS server connection profiles."""
+
+    name = tables.Column(linkify=True)
+    pbs_host = tables.Column()
+    pbs_node_name = tables.Column()
+    enabled = columns.BooleanColumn()
+    netbox_site = tables.Column(linkify=True)
+    last_sync = columns.DateTimeColumn()
+    last_sync_status = tables.Column()
+    actions = columns.ActionsColumn(actions=("edit", "delete", "changelog"))
+
+    class Meta(NetBoxTable.Meta):
+        model = PbsServerConfig
+        fields = (
+            "pk",
+            "name",
+            "pbs_host",
+            "pbs_node_name",
+            "enabled",
+            "netbox_site",
+            "last_sync",
+            "last_sync_status",
+        )
+        default_columns = (
+            "name",
+            "pbs_host",
+            "pbs_node_name",
+            "enabled",
+            "netbox_site",
+            "last_sync",
+            "last_sync_status",
+        )
+
+
+# ---------------------------------------------------------------------------
+# PveDriftEvent
+# ---------------------------------------------------------------------------
+
+class PveDriftEventTable(NetBoxTable):
+    """Table for VM configuration drift events."""
+
+    id = tables.Column(linkify=True)
+    vm_name = tables.Column(verbose_name="VM 名稱")
+    vmid = tables.Column(verbose_name="VM ID")
+    cluster_name = tables.Column(verbose_name="叢集")
+    drift_type = columns.ChoiceFieldColumn(verbose_name="變更類型")
+    field_name = tables.Column(verbose_name="欄位")
+    old_value = tables.Column(verbose_name="舊值")
+    new_value = tables.Column(verbose_name="新值")
+    notified_telegram = columns.BooleanColumn(verbose_name="已通知")
+    created = columns.DateTimeColumn(verbose_name="偵測時間")
+    sync_job = tables.Column(linkify=True, verbose_name="同步任務")
+    actions = columns.ActionsColumn(actions=("delete",))
+
+    class Meta(NetBoxTable.Meta):
+        model = PveDriftEvent
+        fields = (
+            "pk",
+            "id",
+            "vm_name",
+            "vmid",
+            "cluster_name",
+            "drift_type",
+            "field_name",
+            "old_value",
+            "new_value",
+            "notified_telegram",
+            "created",
+            "sync_job",
+        )
+        default_columns = (
+            "id",
+            "vm_name",
+            "vmid",
+            "cluster_name",
+            "drift_type",
+            "field_name",
+            "old_value",
+            "new_value",
+            "notified_telegram",
+            "created",
+        )
+
+
+# ---------------------------------------------------------------------------
+# PveBackupStatus
+# ---------------------------------------------------------------------------
+
+class PveBackupStatusTable(NetBoxTable):
+    """Table for per-VM backup tracking."""
+
+    id = tables.Column(linkify=True)
+    vm = tables.Column(linkify=True, verbose_name="Virtual Machine")
+    backup_status = columns.ChoiceFieldColumn()
+    last_backup = columns.DateTimeColumn()
+    backup_age_days = tables.Column(
+        accessor="backup_age_days",
+        verbose_name="Age (days)",
+        orderable=False,
+    )
+    next_backup = columns.DateTimeColumn()
+    actions = columns.ActionsColumn(actions=("changelog",))
+
+    class Meta(NetBoxTable.Meta):
+        model = PveBackupStatus
+        fields = (
+            "pk",
+            "id",
+            "vm",
+            "backup_status",
+            "last_backup",
+            "backup_age_days",
+            "backup_size",
+            "next_backup",
+        )
+        default_columns = (
+            "id",
+            "vm",
+            "backup_status",
+            "last_backup",
+            "backup_age_days",
+        )