withcache 0.13.1__tar.gz → 0.13.2__tar.gz

{withcache-0.13.1 → withcache-0.13.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: withcache
-Version: 0.13.1
+Version: 0.13.2
 Summary: Operator-curated, URL-keyed artifact cache for a small lab (CUDA/ROCm/DOCA/firmware)
 Project-URL: Homepage, https://github.com/safl/withcache
 Author-email: "Simon A. F. Lund" <safl@safl.dk>

{withcache-0.13.1 → withcache-0.13.2}/shim/build.zig.zon

@@ -2,7 +2,7 @@
     .name = .withcache_shim,
     // Zig requires a literal here; keep it in lockstep with the project's
     // single source (src/withcache/__init__.py) via `make bump` / `make version-check`.
-    .version = "0.13.1",
+    .version = "0.13.2",
     .fingerprint = 0xd7d96c5ed212ccaa,
     .minimum_zig_version = "0.16.0",
     .paths = .{

{withcache-0.13.1 → withcache-0.13.2}/src/withcache/__init__.py

@@ -22,6 +22,6 @@ inherit the framework floor.
 from . import oras
 from .client import blob_url, cache_base, is_cached, serve_url
 
-__version__ = "0.13.1"
+__version__ = "0.13.2"
 
 __all__ = ["__version__", "blob_url", "cache_base", "is_cached", "oras", "serve_url"]

{withcache-0.13.1 → withcache-0.13.2}/src/withcache/_api.py

@@ -256,9 +256,19 @@ def register_api_routes(app: FastAPI) -> None:
         """Insert one catalog entry.
 
         Body: ``{"name": "...", "src": "...", "format?", "arch?",
-        "sha256?", "size_bytes?", "resolved_src?", "description?"}``.
-        Only ``src`` is required; every other field is optional and
-        gets persisted through the ``catalog.toml`` round-trip.
+        "sha256?", "size_bytes?", "resolved_src?", "description?",
+        "netboot_ref?"}``. Only ``src`` is required; every other
+        field is optional and gets persisted through the
+        ``catalog.toml`` round-trip.
+
+        ``netboot_ref`` names another catalog entry (by ``name``)
+        whose bytes are a nosi netboot bundle (vmlinuz + initrd +
+        manifest) that nbdmux extracts at warm time so bty can
+        ramboot the image using its own kernel. Present iff the
+        entry is a disk image that has a matching netboot bundle;
+        the bundle entry itself never carries a ``netboot_ref``.
+        Withcache does not validate that the referenced entry
+        exists -- the sibling may be added in either order.
 
         409 when an entry with the same ``name`` already exists;
         rejecting on duplicate name (not src) because the display
@@ -278,6 +288,7 @@ def register_api_routes(app: FastAPI) -> None:
             "sha256",
             "size_bytes",
             "description",
+            "netboot_ref",
         }
         if not isinstance(body, dict):
             raise HTTPException(status_code=400, detail="body must be a JSON object")

{withcache-0.13.1 → withcache-0.13.2}/src/withcache/client.py

@@ -221,7 +221,10 @@ def add_catalog_entry(
 
     ``entry`` must carry at least ``name`` + ``src``. Optional
     fields: ``format``, ``arch``, ``sha256``, ``size_bytes``,
-    ``resolved_src``, ``description``.
+    ``resolved_src``, ``description``, ``netboot_ref`` (name of
+    a sibling entry carrying the matching nosi netboot bundle;
+    consumed by nbdmux to serve vmlinuz + initrd alongside the
+    disk-image export).
 
     Raises :class:`WithcacheError` on any HTTP failure (409 if the
     entry name already exists; 401 if auth is enabled and no valid

{withcache-0.13.1 → withcache-0.13.2}/src/withcache/server.py

@@ -147,18 +147,31 @@ def _serialise_catalog(entries: list[dict[str, Any]]) -> bytes:
     row can't smuggle arbitrary TOML through.
 
     Scalar keys emitted: ``name``, ``src``, ``resolved_src``,
-    ``format``, ``arch``, ``sha256``, ``description``. Integer:
-    ``size_bytes``. ``resolved_src`` is the canonical fetch URL
-    (for ``oras://`` refs; equal to ``src`` for plain HTTPS);
-    bty needs it to render iPXE flash chains against the byte
-    URL directly. ``description`` is operator-supplied prose so
-    the /ui/images page has something better than the URL to
-    display.
+    ``format``, ``arch``, ``sha256``, ``description``,
+    ``netboot_ref``. Integer: ``size_bytes``. ``resolved_src`` is
+    the canonical fetch URL (for ``oras://`` refs; equal to
+    ``src`` for plain HTTPS); bty needs it to render iPXE flash
+    chains against the byte URL directly. ``description`` is
+    operator-supplied prose so the /ui/images page has something
+    better than the URL to display. ``netboot_ref`` names a
+    sibling catalog entry carrying the matching nosi netboot
+    bundle (kernel + initrd) so nbdmux can pair the disk image
+    with its own kernel at warm time; see the ``add_catalog_entry``
+    docstring in ``_api.py`` for the pairing story.
     """
     out: list[str] = ["version = 1", ""]
     for e in entries:
         out.append("[[images]]")
-        for key in ("name", "src", "resolved_src", "format", "arch", "sha256", "description"):
+        for key in (
+            "name",
+            "src",
+            "resolved_src",
+            "format",
+            "arch",
+            "sha256",
+            "description",
+            "netboot_ref",
+        ):
             val = e.get(key)
             if val is None or val == "":
                 continue

{withcache-0.13.1 → withcache-0.13.2}/tests/test_fastapi_catalog_api.py

@@ -167,12 +167,28 @@ class AddCatalogEntryTests(_CatalogApiBase):
                 "sha256": "b" * 64,
                 "size_bytes": 2048,
                 "description": "Debian sysdev",
+                "netboot_ref": "debian-netboot",
             },
         )
         self.assertEqual(r.status_code, 201, r.text)
         stored = self.catalog.entries[0]
         self.assertEqual(stored["description"], "Debian sysdev")
         self.assertEqual(stored["resolved_src"], "https://example/debian.img.gz")
+        self.assertEqual(stored["netboot_ref"], "debian-netboot")
+
+    def test_netboot_ref_persists_through_toml_round_trip(self) -> None:
+        """netboot_ref must survive the catalog.toml write-then-reload."""
+        self.client.post(
+            "/catalog/entries",
+            json={
+                "name": "debian",
+                "src": "https://example/debian.img.gz",
+                "netboot_ref": "debian-netboot",
+            },
+        )
+        toml_path = os.path.join(self._tmpdir, "catalog.toml")
+        content = open(toml_path, encoding="utf-8").read()
+        self.assertIn('netboot_ref = "debian-netboot"', content)
 
     def test_add_persists_to_disk(self) -> None:
         self.client.post(