kento-core 1.6.0.dev1__py3-none-any.whl

kento/vm_hook.py

@@ -0,0 +1,256 @@
+"""Generate per-VM PVE hookscripts (qm hookscripts)."""
+
+import subprocess
+from pathlib import Path
+
+from kento.defaults import VM_CONFIG_FILE, load_config
+from kento.errors import StateError, SubprocessError
+
+_STORAGE_CFG = Path("/etc/pve/storage.cfg")
+
+
+def generate_vm_hook(container_dir: Path, layers: str, name: str,
+                     state_dir: Path) -> str:
+    """Return a hookscript with baked-in paths for a PVE VM.
+
+    The script receives VMID as $1 and phase as $2 from qm.
+    """
+    return f"""#!/bin/sh
+set -eu
+
+VMID="$1"
+PHASE="$2"
+
+NAME="{name}"
+CONTAINER_DIR="{container_dir}"
+STATE_DIR="{state_dir}"
+LAYERS="{layers}"
+
+case "$PHASE" in
+    pre-start)
+        # 1. Validate memory consistency
+        QM_CONF="/etc/pve/qemu-server/${{VMID}}.conf"
+        if [ -f "$QM_CONF" ]; then
+            CONF_MEM=$(sed -n 's/^memory: *//p' "$QM_CONF")
+            ARGS_MEM=$(sed -n 's/.*size=\\([0-9]*\\)M.*/\\1/p' "$QM_CONF")
+            if [ -n "$CONF_MEM" ] && [ -n "$ARGS_MEM" ]; then
+                if [ "$CONF_MEM" != "$ARGS_MEM" ]; then
+                    echo "kento-hook: error: memory mismatch — memory: ${{CONF_MEM}}M but memfd size=${{ARGS_MEM}}M in args." >&2
+                    echo "kento-hook: run: kento vm scrub $NAME to regenerate config with matching values." >&2
+                    exit 1
+                fi
+            fi
+        fi
+
+        # 2. Validate layer paths
+        IFS=:
+        for dir in $LAYERS; do
+            if [ ! -d "$dir" ]; then
+                echo "kento-hook: error: layer path missing: $dir" >&2
+                echo "kento-hook: image may have changed. Run: kento vm scrub $NAME" >&2
+                exit 1
+            fi
+        done
+        unset IFS
+
+        # 3. Mount overlayfs
+        ROOTFS="$CONTAINER_DIR/rootfs"
+        mkdir -p "$STATE_DIR/upper" "$STATE_DIR/work" "$ROOTFS"
+        export LIBMOUNT_FORCE_MOUNT2=always
+        mount -t overlay overlay \\
+            -o "lowerdir=$LAYERS,upperdir=$STATE_DIR/upper,workdir=$STATE_DIR/work" \\
+            "$ROOTFS"
+
+        # 4. Validate kernel and initramfs
+        if [ ! -f "$ROOTFS/boot/vmlinuz" ]; then
+            umount "$ROOTFS" 2>/dev/null || true
+            echo "kento-hook: error: kernel not found at $ROOTFS/boot/vmlinuz" >&2
+            exit 1
+        fi
+        if [ ! -f "$ROOTFS/boot/initramfs.img" ]; then
+            umount "$ROOTFS" 2>/dev/null || true
+            echo "kento-hook: error: initramfs not found at $ROOTFS/boot/initramfs.img" >&2
+            exit 1
+        fi
+
+        # 5. Inject guest-side config (hostname/network/tz/env/ssh-key) into
+        # the mounted rootfs before virtiofsd starts. A failing inject is a
+        # start failure — don't boot a misconfigured VM. set -eu at the top
+        # causes the hookscript to abort on non-zero exit, which PVE treats
+        # as a VM start failure.
+        sh "$CONTAINER_DIR/kento-inject.sh" "$ROOTFS" "$CONTAINER_DIR"
+
+        # 6. Find and start virtiofsd
+        VIRTIOFSD=""
+        for p in virtiofsd /usr/libexec/virtiofsd /usr/lib/qemu/virtiofsd /usr/lib/virtiofsd /usr/bin/virtiofsd; do
+            if command -v "$p" >/dev/null 2>&1 || [ -x "$p" ]; then
+                VIRTIOFSD="$p"
+                break
+            fi
+        done
+        if [ -z "$VIRTIOFSD" ]; then
+            umount "$ROOTFS" 2>/dev/null || true
+            echo "kento-hook: error: virtiofsd not found" >&2
+            exit 1
+        fi
+
+        SOCKET="$CONTAINER_DIR/virtiofsd.sock"
+        setsid $VIRTIOFSD --socket-path="$SOCKET" --shared-dir="$ROOTFS" --cache=auto \
+            </dev/null >"$CONTAINER_DIR/virtiofsd.log" 2>&1 &
+        VFS_PID=$!
+        echo "$VFS_PID" > "$CONTAINER_DIR/kento-virtiofsd-pid"
+
+        # 7. Wait for socket (5s timeout)
+        TRIES=50
+        while [ $TRIES -gt 0 ]; do
+            [ -e "$SOCKET" ] && break
+            sleep 0.1
+            TRIES=$((TRIES - 1))
+        done
+        if [ ! -e "$SOCKET" ]; then
+            kill "$VFS_PID" 2>/dev/null || true
+            umount "$ROOTFS" 2>/dev/null || true
+            echo "kento-hook: error: virtiofsd socket did not appear at $SOCKET" >&2
+            exit 1
+        fi
+        ;;
+
+    post-stop)
+        # 1. Kill virtiofsd
+        PID_FILE="$CONTAINER_DIR/kento-virtiofsd-pid"
+        if [ -f "$PID_FILE" ]; then
+            VFS_PID=$(cat "$PID_FILE")
+            # Guard against an empty/garbage pid file: a non-numeric VFS_PID
+            # would make "[ -d /proc/$VFS_PID ]" test "/proc/" (always true)
+            # and stall the post-stop hook for 5s. Blank it unless numeric.
+            case "$VFS_PID" in
+                ''|*[!0-9]*) VFS_PID='' ;;
+            esac
+            if [ -n "$VFS_PID" ] && [ -d "/proc/$VFS_PID" ]; then
+                kill "$VFS_PID" 2>/dev/null || true
+                # Wait up to 5s for exit
+                TRIES=50
+                while [ $TRIES -gt 0 ] && [ -d "/proc/$VFS_PID" ]; do
+                    sleep 0.1
+                    TRIES=$((TRIES - 1))
+                done
+                # Force kill if still alive
+                if [ -d "/proc/$VFS_PID" ]; then
+                    kill -9 "$VFS_PID" 2>/dev/null || true
+                fi
+            fi
+            rm -f "$PID_FILE"
+        fi
+
+        # 2. Unmount overlayfs
+        ROOTFS="$CONTAINER_DIR/rootfs"
+        mountpoint -q "$ROOTFS" 2>/dev/null && umount "$ROOTFS" || true
+
+        # 3. Clean up socket
+        rm -f "$CONTAINER_DIR/virtiofsd.sock"
+        ;;
+esac
+"""
+
+
+def generate_snippets_wrapper(hook_path: str) -> str:
+    """Return a thin wrapper script that forwards to the real hook."""
+    return f"""#!/bin/sh
+exec "{hook_path}" "$@"
+"""
+
+
+def write_vm_hook(container_dir: Path, layers: str, name: str,
+                  state_dir: Path) -> Path:
+    """Generate and write the VM hook script into the container directory."""
+    hook_path = container_dir / "kento-hook"
+    hook_path.write_text(generate_vm_hook(container_dir, layers, name, state_dir))
+    hook_path.chmod(0o755)
+    return hook_path
+
+
+def find_snippets_dir() -> tuple[Path, str]:
+    """Find the PVE snippets directory and storage name.
+
+    Returns (snippets_path, storage_name).
+    """
+    config = load_config(VM_CONFIG_FILE)
+    storage_name = config.get("snippets_storage")
+
+    if not storage_name:
+        first_dir_storage = None
+        first_dir_content = None
+        if _STORAGE_CFG.is_file():
+            current_storage = None
+            current_type = None
+            for line in _STORAGE_CFG.read_text().splitlines():
+                stripped = line.strip()
+                if stripped.startswith(("dir:", "nfs:", "cifs:", "glusterfs:",
+                                       "zfspool:", "btrfs:", "lvmthin:", "lvm:")):
+                    current_type = stripped.split(":")[0]
+                    current_storage = stripped.split(":", 1)[1].strip().split()[0]
+                elif stripped.startswith("content") and current_storage:
+                    content = stripped.split(None, 1)[1] if len(stripped.split(None, 1)) > 1 else ""
+                    if "snippets" in content.split(","):
+                        storage_name = current_storage
+                        break
+                    if first_dir_storage is None and current_type == "dir":
+                        first_dir_storage = current_storage
+                        first_dir_content = content.strip()
+
+        if not storage_name:
+            msg = "no PVE storage has 'snippets' in its content types."
+            if first_dir_storage and first_dir_content:
+                msg += (f"\n\nEnable snippets on your '{first_dir_storage}' storage:\n"
+                        f"  pvesm set {first_dir_storage} --content "
+                        f"{first_dir_content},snippets")
+            else:
+                msg += ("\n\nEnable snippets on a storage (e.g. 'local'):\n"
+                        "  pvesm set local --content iso,vztmpl,backup,snippets")
+            msg += (f"\n\nOr set a specific storage in /etc/kento/vm.conf:\n"
+                    f"  snippets_storage = <name>")
+            raise StateError(msg)
+
+    # Resolve the filesystem path via pvesm
+    result = subprocess.run(
+        ["pvesm", "path", f"{storage_name}:snippets/probe"],
+        capture_output=True, text=True,
+    )
+    if result.returncode != 0:
+        raise SubprocessError(
+            f"failed to resolve snippets path for storage '{storage_name}': "
+            f"{result.stderr.strip()}",
+            cmd=["pvesm", "path", f"{storage_name}:snippets/probe"],
+            returncode=result.returncode,
+        )
+
+    # pvesm path returns something like /var/lib/vz/snippets/probe
+    # Strip the filename to get the directory
+    snippets_path = Path(result.stdout.strip()).parent
+    return snippets_path, storage_name
+
+
+def write_snippets_wrapper(vmid: int, hook_path: Path, *,
+                           snippets_dir: Path | None = None,
+                           storage_name: str | None = None) -> str:
+    """Write a snippets wrapper and return the PVE storage reference.
+
+    Returns e.g. "local:snippets/kento-vm-100.sh"
+    """
+    if snippets_dir is None or storage_name is None:
+        snippets_dir, storage_name = find_snippets_dir()
+    wrapper_name = f"kento-vm-{vmid}.sh"
+    wrapper_path = snippets_dir / wrapper_name
+    wrapper_path.write_text(generate_snippets_wrapper(str(hook_path)))
+    wrapper_path.chmod(0o755)
+    return f"{storage_name}:snippets/{wrapper_name}"
+
+
+def delete_snippets_wrapper(vmid: int) -> None:
+    """Delete the snippets wrapper for a given VMID."""
+    try:
+        snippets_dir, _ = find_snippets_dir()
+        wrapper = snippets_dir / f"kento-vm-{vmid}.sh"
+        wrapper.unlink(missing_ok=True)
+    except StateError:
+        pass  # No snippets storage = nothing to clean up

kento_core-1.6.0.dev1.dist-info/METADATA

@@ -0,0 +1,8 @@
+Metadata-Version: 2.4
+Name: kento-core
+Version: 1.6.0.dev1
+Summary: Kento core library — compose OCI images into LXC/VM system containers (importable engine)
+License-Expression: GPL-3.0-only
+Requires-Python: >=3.11
+License-File: LICENSE.md
+Dynamic: license-file

kento_core-1.6.0.dev1.dist-info/RECORD

@@ -0,0 +1,34 @@
+kento/__init__.py,sha256=YcBS6rMrMGSJOljQyeXGtcWt_YGVp84FIQvSMhRgFN0,17440
+kento/attach.py,sha256=Dp2xOvooWUSGRafi3ji0cB_PUPzfCHbnkGseNKrviz4,6779
+kento/cloudinit.py,sha256=czC0Nk0PKHIIM6shn49SsUcdD-1-uKMkzGl-y-BBBfY,7427
+kento/create.py,sha256=xjq7uSMHTwvFyeFFhRf9NoKP1UP5ekIl1oKxRl1Pr5g,56318
+kento/defaults.py,sha256=IYXgklBNl1Bi3fp9GoeYXBpmdAf7_9d1PQyu8mdHdMw,7220
+kento/destroy.py,sha256=0j-R9-ghv-FRlnfSevix9ZhSeXLq4NeLJZVAMINLaDA,5496
+kento/diagnose.py,sha256=mbZTtdlrDg0vsitdaAlZqA1K1pEJdjsD-KXwCHNwdw0,21478
+kento/errors.py,sha256=eVjHhPEvg5BSR_yYUD09jCKMos1HSz7Hs3nPHfcHFxo,1448
+kento/exec_cmd.py,sha256=t1Q13tTFoCmKFPjaU26liGGbeb73GefzGXpOfnUH0R4,1659
+kento/hook.py,sha256=GspBk7SaQUuyAoXZDf-vEJJZSO0ulBfJfFLrDdxcmvY,1035
+kento/hook.sh,sha256=4_t3IMvL15V3mejmZ8aWLyUfeEEOK8cCovakX3d-K0c,27463
+kento/images.py,sha256=0sz2RpvIGlujhCtNyZTLbk4aYMPd9RFZWPGRGoOx-ks,7963
+kento/info.py,sha256=R-3o9pQV8nHzIx9zaEM0iv-KM7zddYYeiaiTFNe1E94,9962
+kento/inject.py,sha256=ChUhUrkXRG9Cj_3tzjG9pvrmjyUdgwIeAJ6YUDAskpc,973
+kento/inject.sh,sha256=Gv389XggJfmrGcxBnHMbzH4uwCoIj3MdBWlrPN8u9lw,10971
+kento/layers.py,sha256=zbhvRK8sOzMuXSo9--kv7a2vVFj8J7LD5iJg_AWeqQc,2367
+kento/list.py,sha256=UhmwofwHp5xJkTJZ5nW2txUDaUWSzT-HpSVz8JI0e5g,6142
+kento/locking.py,sha256=bXdcnZtF40kwH7F38RwVfprPiHGa3jYHYwEnKGt4M68,2032
+kento/logs.py,sha256=q8aU8Ne9xEybc0x-q3YIAMBrfdyVRFjW0nNV3X4NJOo,1524
+kento/lxc_hook.py,sha256=6LGudwN47MXBfUx6W165-uOkpVlwD25xegLODOl9CLU,2224
+kento/pve.py,sha256=DfBJVwj3mgJQkx8nUf51UK5YYs7Lq3QPWDkqbvnCe-s,25770
+kento/reset.py,sha256=FvfPGB3BsiZq5xgR7YyXip6ZtFOaMQv2vZcfrL5NqGA,9470
+kento/set_cmd.py,sha256=mB5eWjsJTsh50ceqhHpKx6dtmiC-kkMDMp6beFuP2mc,42713
+kento/start.py,sha256=mBnz6joLpKCtWzw2SsVapYsSeBvnJLJyxhr4fJ9E5mg,2267
+kento/stop.py,sha256=lU2_nEvcbVKrbghBi6uBMwyzhSSkm-gR5MRRje2zxW4,8003
+kento/subprocess_util.py,sha256=V44cpaMZlQ6fszQcLIZIBKG-jQdPvzUy3bFmqDF7rS8,2770
+kento/suspend.py,sha256=laPvgY9pYjO0zndYXDlWgyuEitcDO0ERq0YvdSnnzJs,7373
+kento/vm.py,sha256=MoHlrYhM7BrTb3GkhZRP2jK1lARZHjNy9itOU30tZo0,20238
+kento/vm_hook.py,sha256=Rv2GQRyecXAQdZDzMX5YRsMpM3SKYZrbXvr8kNGNr5I,9797
+kento_core-1.6.0.dev1.dist-info/licenses/LICENSE.md,sha256=myGniuZJOzblT1ZUaSVj9hNBLxPw3J80w6xujEYC_4c,34904
+kento_core-1.6.0.dev1.dist-info/METADATA,sha256=qkdhEQYmns-fKXraDxZCHIuFwzg8YeDR-m9emSsEDKE,264
+kento_core-1.6.0.dev1.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+kento_core-1.6.0.dev1.dist-info/top_level.txt,sha256=jUOZ34N2uIdurIGNjatioce-AvnLtwDKspYSO7jk2lo,6
+kento_core-1.6.0.dev1.dist-info/RECORD,,

kento_core-1.6.0.dev1.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (82.0.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+