standarize snapshot functions

Author: boddumanohar

src/_util/backup_config.py

@@ -0,0 +1,5 @@
+import os
+
+SNAPSHOT_TIMEOUT_SEC = int(os.environ.get("SNAPSHOT_TIMEOUT_SEC", "120"))
+SNAPSHOT_POLL_INTERVAL_SEC = int(os.environ.get("SNAPSHOT_POLL_INTERVAL_SEC", "5"))
+VOLUME_SNAPSHOT_CLASS = os.environ.get("VOLUME_SNAPSHOT_CLASS", "simplyblock-csi-snapshotclass")

src/api/backup.py

@@ -33,11 +33,7 @@
 from ..models.project import Project
 from ._util.backups import _remove_existing_schedule, _validate_project_retention_budget
 from .auth import authenticated_user
-from .backup_snapshots import (
-    SNAPSHOT_POLL_INTERVAL_SEC,
-    create_branch_snapshot,
-    delete_branch_snapshot,
-)
+from .backup_snapshots import build_snapshot_metadata, create_branch_db_snapshot, delete_snapshot
 from .db import SessionDep
 from .dependencies import OrganizationDep
 
@@ -46,7 +42,6 @@
 # ---------------------------
 # Constants
 # ---------------------------
-VOLUME_SNAPSHOT_CLASS = os.environ.get("VOLUME_SNAPSHOT_CLASS", "simplyblock-csi-snapshotclass")
 MANUAL_BACKUP_TIMEOUT_SEC = int(os.environ.get("MANUAL_BACKUP_TIMEOUT_SEC", "10"))
 
 UNIT_MULTIPLIER = {
@@ -541,13 +536,10 @@ async def manual_backup(session: SessionDep, branch_id: Identifier) -> BackupCre
     recorded_at = datetime.now(UTC)
 
     try:
-        snapshot = await create_branch_snapshot(
+        snapshot = await create_branch_db_snapshot(
             branch.id,
             backup_id=backup_id,
-            snapshot_class=VOLUME_SNAPSHOT_CLASS,
-            poll_interval=SNAPSHOT_POLL_INTERVAL_SEC,
             label="manual",
-            time_limit=MANUAL_BACKUP_TIMEOUT_SEC,
         )
     except Exception as exc:
         logger.exception("Manual backup failed for branch %s within timeout", branch.id)
@@ -588,15 +580,13 @@ async def delete_backup(session: SessionDep, backup_id: Identifier) -> BackupDel
     if not backup:
         raise HTTPException(status_code=404, detail="Backup not found")
 
-    try:
-        await delete_branch_snapshot(
-            name=backup.snapshot_name,
-            namespace=backup.snapshot_namespace,
-            content_name=backup.snapshot_content_name,
-        )
-    except Exception as exc:
-        logger.exception("Failed to delete snapshot for backup %s", backup_id)
-        raise HTTPException(status_code=500, detail="Failed to delete backup snapshot") from exc
+    metadata = build_snapshot_metadata(backup)
+    if metadata is not None:
+        try:
+            await delete_snapshot(metadata)
+        except Exception as exc:
+            logger.exception("Failed to delete snapshot for backup %s", backup_id)
+            raise HTTPException(status_code=500, detail="Failed to delete backup snapshot") from exc
 
     await session.delete(backup)
 

src/api/backup_snapshots.py

@@ -7,8 +7,18 @@
 from dataclasses import dataclass
 from typing import TYPE_CHECKING
 
+from pydantic import BaseModel, Field
+
 from .._util import Identifier, quantity_to_bytes
-from ..deployment import AUTOSCALER_PVC_SUFFIX, get_autoscaler_vm_identity
+from .._util.backup_config import (
+    SNAPSHOT_POLL_INTERVAL_SEC,
+    SNAPSHOT_TIMEOUT_SEC,
+    VOLUME_SNAPSHOT_CLASS,
+)
+from ..deployment import (
+    AUTOSCALER_DB_PVC_SUFFIX,
+    get_autoscaler_vm_identity,
+)
 from ..deployment.kubernetes.snapshot import (
     create_snapshot_from_pvc,
     ensure_snapshot_absent,
@@ -18,14 +28,44 @@
 )
 
 if TYPE_CHECKING:
+
     from ulid import ULID
 
+    from ..models.backups import BackupEntry
+
 logger = logging.getLogger(__name__)
 
 SNAPSHOT_TIMEOUT_SEC = int(os.environ.get("SNAPSHOT_TIMEOUT_SEC", "120"))
 SNAPSHOT_POLL_INTERVAL_SEC = int(os.environ.get("SNAPSHOT_POLL_INTERVAL_SEC", "5"))
 
 _K8S_NAME_MAX_LENGTH = 63
+DEFAULT_SNAPSHOT_TIMEOUT_SEC = float(SNAPSHOT_TIMEOUT_SEC)
+DEFAULT_SNAPSHOT_POLL_INTERVAL_SEC = float(SNAPSHOT_POLL_INTERVAL_SEC)
+
+
+class SnapshotMetadata(BaseModel):
+    name: str = Field(..., min_length=1)
+    namespace: str = Field(..., min_length=1)
+    # content_name stays optional because there are runtime scenarios where the
+    # VolumeSnapshotContent hasn’t been bound yet
+    content_name: str | None
+
+
+def build_snapshot_metadata(backup: BackupEntry) -> SnapshotMetadata | None:
+    name = backup.snapshot_name
+    namespace = backup.snapshot_namespace
+    if not name or not namespace:
+        logger.debug(
+            "Skipping metadata for missing snapshot identifiers (name=%r namespace=%r)",
+            name,
+            namespace,
+        )
+        return None
+    return SnapshotMetadata(
+        name=name,
+        namespace=namespace,
+        content_name=backup.snapshot_content_name,
+    )
 
 
 @dataclass(frozen=True)
@@ -58,20 +98,18 @@ def _build_snapshot_name(*, label: str, backup_id: ULID) -> str:
     return f"{label_component}{separator}{backup_component}"
 
 
-async def create_branch_snapshot(
-    branch_id: Identifier,
+async def _create_snapshot_from_pvc(
     *,
+    namespace: str,
+    pvc_name: str,
     backup_id: ULID,
     snapshot_class: str,
-    poll_interval: float,
     label: str,
+    poll_interval: float,
     time_limit: float,
 ) -> SnapshotDetails:
-    namespace, autoscaler_vm_name = get_autoscaler_vm_identity(branch_id)
-    pvc_name = f"{autoscaler_vm_name}{AUTOSCALER_PVC_SUFFIX}"
     snapshot_name = _build_snapshot_name(label=label, backup_id=backup_id)
-
-    logger.info("Creating VolumeSnapshot %s/%s for branch %s", namespace, snapshot_name, branch_id)
+    logger.info("Creating VolumeSnapshot %s/%s for branch PVC %s", namespace, snapshot_name, pvc_name)
     try:
         async with asyncio.timeout(time_limit):
             await create_snapshot_from_pvc(
@@ -88,10 +126,10 @@ async def create_branch_snapshot(
             )
     except TimeoutError:
         logger.exception(
-            "Timed out creating VolumeSnapshot %s/%s for branch %s within %s seconds",
+            "Timed out creating VolumeSnapshot %s/%s for PVC %s within %s seconds",
             namespace,
             snapshot_name,
-            branch_id,
+            pvc_name,
             time_limit,
         )
         raise
@@ -115,29 +153,43 @@ async def create_branch_snapshot(
     )
 
 
-async def delete_branch_snapshot(
+async def create_branch_db_snapshot(
+    branch_id: Identifier,
     *,
-    name: str | None,
-    namespace: str | None,
-    content_name: str | None,
-    time_limit: float = SNAPSHOT_TIMEOUT_SEC,
-    poll_interval: float = SNAPSHOT_POLL_INTERVAL_SEC,
-) -> None:
-    if not name or not namespace:
-        logger.debug(
-            "Skipping deletion for VolumeSnapshot with missing metadata (name=%s namespace=%s)",
-            name,
-            namespace,
-        )
-        return
+    backup_id: ULID,
+    snapshot_class: str = VOLUME_SNAPSHOT_CLASS,
+    poll_interval: float = DEFAULT_SNAPSHOT_POLL_INTERVAL_SEC,
+    label: str,
+    time_limit: float = DEFAULT_SNAPSHOT_TIMEOUT_SEC,
+) -> SnapshotDetails:
+    namespace, autoscaler_vm_name = get_autoscaler_vm_identity(branch_id)
+    pvc_name = f"{autoscaler_vm_name}{AUTOSCALER_DB_PVC_SUFFIX}"
+    return await _create_snapshot_from_pvc(
+        namespace=namespace,
+        pvc_name=pvc_name,
+        backup_id=backup_id,
+        snapshot_class=snapshot_class,
+        poll_interval=poll_interval,
+        label=label,
+        time_limit=time_limit,
+    )
+
 
-    derived_content_name = content_name
+async def delete_snapshot(
+    metadata: SnapshotMetadata,
+    *,
+    time_limit: float = DEFAULT_SNAPSHOT_TIMEOUT_SEC,
+    poll_interval: float = DEFAULT_SNAPSHOT_POLL_INTERVAL_SEC,
+) -> None:
+    name = metadata.name
+    namespace = metadata.namespace
+    content_name = metadata.content_name
     try:
         async with asyncio.timeout(time_limit):
             snapshot = await read_snapshot(namespace, name)
             if snapshot is not None:
                 status = snapshot.get("status") or {}
-                derived_content_name = derived_content_name or status.get("boundVolumeSnapshotContentName")
+                content_name = content_name or status.get("boundVolumeSnapshotContentName")
                 logger.info("Deleting VolumeSnapshot %s/%s", namespace, name)
                 await ensure_snapshot_absent(
                     namespace,
@@ -148,10 +200,10 @@ async def delete_branch_snapshot(
             else:
                 logger.info("VolumeSnapshot %s/%s already absent", namespace, name)
 
-            if derived_content_name:
-                logger.info("Ensuring VolumeSnapshotContent %s is absent", derived_content_name)
+            if content_name:
+                logger.info("Ensuring VolumeSnapshotContent %s is absent", content_name)
                 await ensure_snapshot_content_absent(
-                    derived_content_name,
+                    content_name,
                     timeout=time_limit,
                     poll_interval=poll_interval,
                 )

src/api/backupmonitor.py

@@ -10,6 +10,7 @@
 from sqlmodel import SQLModel, asc, delete, select
 from ulid import ULID
 
+from .._util.backup_config import SNAPSHOT_POLL_INTERVAL_SEC, SNAPSHOT_TIMEOUT_SEC, VOLUME_SNAPSHOT_CLASS
 from ..models.backups import (
     BackupEntry,
     BackupLog,
@@ -21,18 +22,16 @@
 from ..models.organization import Organization
 from ..models.project import Project
 from .backup_snapshots import (
-    SNAPSHOT_POLL_INTERVAL_SEC,
-    SNAPSHOT_TIMEOUT_SEC,
-    create_branch_snapshot,
-    delete_branch_snapshot,
+    build_snapshot_metadata,
+    create_branch_db_snapshot,
+    delete_snapshot,
 )
 from .organization.project.branch import refresh_branch_status
 from .settings import get_settings
 
 # ---------------------------
 # Config
 # ---------------------------
-VOLUME_SNAPSHOT_CLASS = os.environ.get("VOLUME_SNAPSHOT_CLASS", "csi-snapshot-class")
 POLL_INTERVAL = int(os.environ.get("POLL_INTERVAL", "60"))
 
 logging.basicConfig(
@@ -209,11 +208,15 @@ async def _delete_many(
 
         deleted_ids: list[ULID] = []
         for backup in backups:
+            metadata = build_snapshot_metadata(backup)
+            if metadata is None:
+                logger.warning("Skipping snapshot deletion for backup %s because metadata was incomplete", backup.id)
+                continue
             try:
-                await delete_branch_snapshot(
-                    name=backup.snapshot_name,
-                    namespace=backup.snapshot_namespace,
-                    content_name=backup.snapshot_content_name,
+                await delete_snapshot(
+                    metadata,
+                    time_limit=SNAPSHOT_TIMEOUT_SEC,
+                    poll_interval=SNAPSHOT_POLL_INTERVAL_SEC,
                 )
             except Exception:
                 context = {
@@ -308,13 +311,11 @@ async def execute_backup(self, db: AsyncSession, branch: Branch, row: BackupSche
         backup_id = ULID()
 
         try:
-            snapshot = await create_branch_snapshot(
+            snapshot = await create_branch_db_snapshot(
                 branch.id,
                 backup_id=backup_id,
                 snapshot_class=VOLUME_SNAPSHOT_CLASS,
-                poll_interval=SNAPSHOT_POLL_INTERVAL_SEC,
                 label=f"row-{row.row_index}",
-                time_limit=SNAPSHOT_TIMEOUT_SEC,
             )
         except Exception:
             nb.next_at = next_due

src/api/organization/project/branch/__init__.py

@@ -22,7 +22,7 @@
 from ....._util import DEFAULT_DB_NAME, DEFAULT_DB_USER, Identifier, bytes_to_gb
 from ....._util.crypto import encrypt_with_passphrase, generate_keys
 from .....deployment import (
-    AUTOSCALER_PVC_SUFFIX,
+    AUTOSCALER_DB_PVC_SUFFIX,
     STORAGE_PVC_SUFFIX,
     DeploymentParameters,
     ResizeParameters,
@@ -750,7 +750,7 @@ async def _apply_resize_operations(
     namespace, autoscaler_vm_name = get_autoscaler_vm_identity(branch.id)
     if "database_size" in effective_parameters:
         new_database_size = effective_parameters["database_size"]
-        pvc_name = f"{autoscaler_vm_name}{AUTOSCALER_PVC_SUFFIX}"
+        pvc_name = f"{autoscaler_vm_name}{AUTOSCALER_DB_PVC_SUFFIX}"
         storage_size_gb = f"{bytes_to_gb(new_database_size)}G"
         await kube_service.resize_pvc_storage(namespace, pvc_name, storage_size_gb)
 

src/deployment/__init__.py

@@ -73,7 +73,7 @@
 SIMPLYBLOCK_CSI_SECRET = "simplyblock-csi-secret"
 STORAGE_PVC_SUFFIX = "-db-storage-pvc"
 DATABASE_PVC_SUFFIX = "-db-pvc"
-AUTOSCALER_PVC_SUFFIX = "-block-data"
+AUTOSCALER_DB_PVC_SUFFIX = "-block-data"
 _LOAD_BALANCER_TIMEOUT_SECONDS = float(600)
 _LOAD_BALANCER_POLL_INTERVAL_SECONDS = float(2)
 DNSRecordType = Literal["AAAA", "CNAME"]
@@ -289,7 +289,7 @@ async def resolve_storage_volume_identifiers(namespace: str) -> tuple[str, str |
 
 
 async def resolve_autoscaler_volume_identifiers(namespace: str) -> tuple[str, str | None]:
-    pvc_name = f"{_autoscaler_vm_name(namespace)}{AUTOSCALER_PVC_SUFFIX}"
+    pvc_name = f"{_autoscaler_vm_name(namespace)}{AUTOSCALER_DB_PVC_SUFFIX}"
     return await _resolve_volume_identifiers(namespace, pvc_name)
 
 
@@ -422,7 +422,7 @@ def _configure_vela_values(
     autoscaler_resources["memorySlots"] = memory_slots
 
     autoscaler_persistence = autoscaler_spec.setdefault("persistence", {})
-    autoscaler_persistence["claimName"] = f"{_autoscaler_vm_name(namespace)}{AUTOSCALER_PVC_SUFFIX}"
+    autoscaler_persistence["claimName"] = f"{_autoscaler_vm_name(namespace)}{AUTOSCALER_DB_PVC_SUFFIX}"
     autoscaler_persistence["size"] = f"{bytes_to_gb(parameters.database_size)}G"
     autoscaler_persistence["storageClassName"] = storage_class_name
     autoscaler_persistence.setdefault("accessModes", ["ReadWriteMany"])

src/deployment/kubernetes/volume_clone.py

@@ -6,7 +6,7 @@
 
 from ..._util import Identifier
 from ...exceptions import VelaKubernetesError
-from .. import AUTOSCALER_PVC_SUFFIX, get_autoscaler_vm_identity, kube_service
+from .. import AUTOSCALER_DB_PVC_SUFFIX, get_autoscaler_vm_identity, kube_service
 from ..settings import get_settings
 from .pvc import (
     build_pvc_manifest_from_existing,
@@ -112,8 +112,8 @@ class _VolumeCloneOperation:
     def __post_init__(self) -> None:
         source_ns, source_vm_name = get_autoscaler_vm_identity(self.source_branch_id)
         target_ns, target_vm_name = get_autoscaler_vm_identity(self.target_branch_id)
-        pvc_name = f"{source_vm_name}{AUTOSCALER_PVC_SUFFIX}"
-        target_pvc_name = f"{target_vm_name}{AUTOSCALER_PVC_SUFFIX}"
+        pvc_name = f"{source_vm_name}{AUTOSCALER_DB_PVC_SUFFIX}"
+        target_pvc_name = f"{target_vm_name}{AUTOSCALER_DB_PVC_SUFFIX}"
         if target_pvc_name != pvc_name:
             raise VelaKubernetesError(
                 f"Autoscaler PVC name mismatch between source ({pvc_name}) and target ({target_pvc_name})"
@@ -314,8 +314,8 @@ def __post_init__(self) -> None:
         source_ns = self.snapshot_namespace
         _, source_vm_name = get_autoscaler_vm_identity(self.source_branch_id)
         target_ns, target_vm_name = get_autoscaler_vm_identity(self.target_branch_id)
-        pvc_name = f"{source_vm_name}{AUTOSCALER_PVC_SUFFIX}"
-        target_pvc_name = f"{target_vm_name}{AUTOSCALER_PVC_SUFFIX}"
+        pvc_name = f"{source_vm_name}{AUTOSCALER_DB_PVC_SUFFIX}"
+        target_pvc_name = f"{target_vm_name}{AUTOSCALER_DB_PVC_SUFFIX}"
         if target_pvc_name != pvc_name:
             raise VelaKubernetesError(
                 f"Autoscaler PVC name mismatch between source ({pvc_name}) and target ({target_pvc_name})"