pixie-lab 0.1.0__py3-none-any.whl

pixie_lab-0.1.0.dist-info/METADATA

@@ -0,0 +1,107 @@
+Metadata-Version: 2.4
+Name: pixie-lab
+Version: 0.1.0
+Summary: Bare-metal netboot appliance: catalog + fetch + NBD + PXE + TFTP + operator TUI in one container
+Project-URL: Homepage, https://github.com/safl/pixie
+Project-URL: Repository, https://github.com/safl/pixie
+Author-email: "Simon A. F. Lund" <os@safl.dk>
+License-Expression: GPL-3.0-only
+License-File: LICENSE
+Keywords: appliance,bare-metal,flashing,imaging,ipxe,nbd,netboot,pxe
+Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Python: >=3.11
+Requires-Dist: fastapi>=0.115
+Requires-Dist: httpx>=0.27
+Requires-Dist: itsdangerous>=2.1
+Requires-Dist: jinja2>=3.1
+Requires-Dist: python-multipart>=0.0.9
+Requires-Dist: rich>=13
+Requires-Dist: tomlkit>=0.12
+Requires-Dist: uvicorn[standard]>=0.30
+Description-Content-Type: text/markdown
+
+# pixie
+
+Bare-metal netboot appliance in one container. Catalog + fetch + NBD
+serving + PXE plan renderer + TFTP + operator UI, on one FastAPI
+process with one state.db and one admin password.
+
+Pixie folds into a single service what bty (operator UI + machine
+registry + PXE plan renderer + Rich TUI), nbdmux (NBD-export
+multiplexer + netboot artifact serve), and a hard-fork of withcache
+(catalog + fetch + blob store) implement as three separate FastAPI
+services. bty, nbdmux, and withcache continue as their own projects;
+pixie is a sibling appliance that starts from a merged design. See
+`PLAN.md` for the design rationale, locked decisions, and roadmap.
+
+## Run
+
+The reference deploy is a single podman-compose stack under
+`--network=host`. The `pixie-lab` CLI (installed with the package)
+generates the compose file, the envvars template, and a per-deploy
+README:
+
+    pixie-lab init /opt/pixie
+    "$EDITOR" /opt/pixie/envvars.example    # set PIXIE_HOST_ADDR + PIXIE_ADMIN_PASSWORD
+    mv /opt/pixie/envvars.example /opt/pixie/envvars
+    cd /opt/pixie
+    podman compose --env-file envvars up -d
+
+`pixie-lab deploy` fills in an admin password + host address + waits
+for `/healthz` in one shot, useful for a fresh lab machine.
+
+Log in at http://<host>:8080/. First landing after login is a
+dashboard summarising machines, catalog, and NBD-serving state; the
+top nav has Machines, Catalog, Events, and Settings.
+
+## Operator workflow
+
+1. Point catalog import at a `catalog.toml` URL on `/ui/catalog`.
+   Entries land staged (rows only, no bytes yet).
+2. Click Fetch on a row to download it. The status pill ticks
+   through downloading -> decompressing -> unpacking with a
+   `bytes / total` counter so you see progress live.
+3. Power-cycle a target with pixie in its DHCP next-server chain.
+   A first contact shows up on `/ui/machines` with the default
+   `ipxe-exit` boot mode. Open the row to bind a mode + image.
+4. `pixie-inventory` prompts the live env to POST an inventory
+   blob; the target's disks + NICs + memory show up on the
+   machine detail page.
+5. Flash modes (`pixie-flash-once`, `pixie-flash-always`) require
+   a target disk serial that came in on the inventory. The
+   binding form disables Save until that prerequisite is met.
+
+## State
+
+Everything writable lives under `PIXIE_DATA_DIR` (default
+`/var/lib/pixie`). `state.db` holds catalog rows, machine rows,
+event log, settings, and NBD-export records. `blobs/<sha>/blob`
+holds fetched disk images. `artifacts/<sha>/{vmlinuz,initrd,
+manifest.json}` holds unpacked netboot bundles. `live-env/` holds
+the pixie live env kernel + initrd + squashfs the netboot-pc bake
+produced.
+
+Both admin password and display timezone / strftime pattern have
+env-var overrides plus DB overrides via `/ui/settings`; env wins
+so a compose deploy pins behaviour deterministically.
+
+## Development
+
+    uv sync
+    uv run pytest
+    uv run ruff check src tests
+    uv run mypy src
+
+The integration tests spin real QEMU VMs behind a real pixie
+container to exercise the PXE bootstrap + ramboot chains. They are
+gated behind a marker so plain `pytest` skips them.
+
+## License
+
+pixie is licensed under GPL-3.0-only. See `LICENSE`.

pixie_lab-0.1.0.dist-info/RECORD

@@ -0,0 +1,70 @@
+pixie/__init__.py,sha256=XhfE52sqfEOUpzoYuuO8GpRNTCjigL28LBiNKVrHf2A,615
+pixie/_util.py,sha256=BdjD_n0pGGrnZJYTN2rwrEvKpXFQN5d6hzZDkKNYa5c,1221
+pixie/disks.py,sha256=RTATvHaBEpDJzC5y1YiLe1P1GzkHfTDRRMUZDbCdPio,3388
+pixie/flash.py,sha256=xG7f9EG5EUd6MmA-qfkTF7fnauWbMlme_lNSwoo7R3k,78414
+pixie/images.py,sha256=rlzylYayYjKdg9mVmV5hW49o8WJRLxB0UeCEsDNsWVk,17495
+pixie/oras.py,sha256=zKKqYcSghgguOIIrGcJ6C3hZusmORZmDfv7zZDDFslM,22509
+pixie/tui_catalog.py,sha256=1lmweyRTZg3lLMbDTozxTY5VQi0m6-xZw9rkCXnpsdI,26679
+pixie/catalog/__init__.py,sha256=Ipv-Uxes1sC0Irb9qA9c_PfClsz3EOGcQKqEdWVUwIY,1160
+pixie/catalog/_fetcher.py,sha256=j4rwDs6RX_iC8hNjUIfWRDnrDDBqhetj7XmzWnE-tIY,20130
+pixie/catalog/_routes.py,sha256=QJPwAiX2qtvyuUwyXojG--5R1iKm8CricG2ppv8MBV4,14771
+pixie/catalog/_schema.py,sha256=KC6RcKlToX1DgcRjn25djKMx78-eS-4WzNRY267h0I0,9769
+pixie/catalog/_store.py,sha256=5nZ69Md65cnHWIAVG2TVH2BMXqHGN0lX_KKnGm_8GhQ,8936
+pixie/deploy/__init__.py,sha256=3PvSvrIRdqxLCz0nTdVSBiPzEtDl359XSUBgyMBkMT8,1019
+pixie/deploy/_main.py,sha256=JzYTfU57wAxuHaG1MNEtxdR8dXg72hNJ5IvT1orlDL4,10483
+pixie/deploy/_templates.py,sha256=WkkKRDU00FDWVZM0XeKR-BCtSBPvaZ2QHM1TBeq0RYg,5418
+pixie/events/__init__.py,sha256=3Quxl56ePkKD9-PjbomCOOZOpmqJ3wHcYa7VcT9KXv8,923
+pixie/events/_kinds.py,sha256=EJjTFU1Aacl8AX8l5wjCAb6XiB3ysFBjL-4O5LQ7YoM,8081
+pixie/events/_log.py,sha256=UT8KCXqZv95_FoNq93GKPRcKvKtz2UCyK0DnnYbehO0,6569
+pixie/events/_routes.py,sha256=MbY69aZKDEzy4O8AizHtv_POPbdNMqz94imccFbtelM,1363
+pixie/exports/__init__.py,sha256=Hmst9a3zd_8a8s9UQhpDSeer6q6viEbHijk-xMU0ls8,814
+pixie/exports/_routes.py,sha256=_snNhDakW5AAG2iWGFR5rDAUUXnVPtXBAX2132tPv5A,7528
+pixie/exports/_store.py,sha256=Ma5oVFZPCNmqp4juzts6DD6JxK8oqY9G8IPPezupw7c,4784
+pixie/exports/_supervisor.py,sha256=bB9bm0Zy4qMctDWgUCVtcmsZF2zCsL3ql9hvrmPTFGg,8717
+pixie/machines/__init__.py,sha256=iSyEkYm6_oP5TNRVks-HrudMjX2Wr7v6t3RSOyl3eps,725
+pixie/machines/_routes.py,sha256=e240Ui01fC8VKuk82V_1lkcivDpivp4Xi6oJAHJk1Gs,7431
+pixie/machines/_store.py,sha256=-GOPqPa4DUXzbQ7E5Tg9BVZDgdzqpthitN8DhOSaWx4,25033
+pixie/pivot/__init__.py,sha256=k_yIUOrIu-DKCJ_8XmRtnoVV7Rr9URagHU2Y76HB2ew,6195
+pixie/pivot/nbdboot,sha256=TdOPFqCv-248Ya90mpSLcUe4JImOkMWjRF824FRnP6w,16321
+pixie/pxe/__init__.py,sha256=AKBRKQYdlH7DdNBvES9EwYTzPOkeNbWBN1S7IH1UEyw,784
+pixie/pxe/_renderer.py,sha256=pO5ZXir5yF4U2B2OkBCaaZCzEFhZkuljB9Fg8UQgCZE,9914
+pixie/pxe/_routes.py,sha256=PrR4i1fHVfYQhWwxpcNmcQpNH69AYVEwTy63OF1F0FA,16673
+pixie/tftp/__init__.py,sha256=FuHn1KF5_NoGOM_dHXSbubX5lJr0tuMugJGFxxwuUws,774
+pixie/tftp/_supervisor.py,sha256=khpjgWqdMzdnhRaPYM4j25PoKijbBnvr-GjJLybP_rY,4659
+pixie/tui/__init__.py,sha256=oo46ZLI1QMDQngb277PcDLCVNNS-qcuxhUOJzhtTUPo,8602
+pixie/tui/_app.py,sha256=eoJE0kA89tBWSlmDOD54avBs2ZmlTtgHdAS5pV6a3dk,96101
+pixie/web/__init__.py,sha256=xuFjJvK82vsOOVayEstgErHicVb0nyepXtSOObkhaTY,200
+pixie/web/_auth.py,sha256=ppFJaFft5IykgKoNgCEpHcU9e6oh2TgaBxiaSO9ZPNI,2471
+pixie/web/_settings_store.py,sha256=xDrRmE0irbEH9JTiVwPeSUDHSDm2S-OXKf6iWYjNSJ4,8276
+pixie/web/_table_state.py,sha256=zGH5oZ-XlMqUFQqmYglYqT_fu1Yrtaw-g5yhPtAKAEc,9524
+pixie/web/main.py,sha256=WxNbWS_qwRc2T_aNmch2mAkB4mearSk2j1BkmsINkWw,79426
+pixie/web/_static/.gitkeep,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+pixie/web/_static/bootstrap-icons.min.css,sha256=pdY4ejLKO67E0CM2tbPtq1DJ3VGDVVdqAR6j3ZwdiE4,87008
+pixie/web/_static/bootstrap.min.css,sha256=NXgoHLHuUWz0lbqh8PRwCIl7_QhZE74v-FCwrYdCW1E,234717
+pixie/web/_static/htmx.min.js,sha256=4gndpcgjVHnzFm3vx3UOHbzVpcGAi3eS_C5nM3aPtEc,50917
+pixie/web/_static/pixie-favicon.png,sha256=lZMkON01uQbkeCI2bOYaoGAaDBdRPlEjhLaNb3TXoo4,31810
+pixie/web/_static/sse.js,sha256=g-ym-gYR_isL8XALQkuIteztOO9Ejvl2Ci6gj7yHVhE,8896
+pixie/web/_static/fonts/bootstrap-icons.woff,sha256=9VUTt7WRy4SjuH_w406iTUgx1v7cIuVLkRymS1tUShU,180288
+pixie/web/_static/fonts/bootstrap-icons.woff2,sha256=bHVxA2ShylYEJncW9tKJl7JjGf2weM8R4LQqtm_y6mE,134044
+pixie/web/_templates/catalog.html,sha256=Z7LwkbC39ouonnlxYdFllpxpqjIwvYEt7lx7IHJcL74,19411
+pixie/web/_templates/catalog_detail.html,sha256=u7Q0Fk8eyQL6mK4QOsE2NTmnmYfXydKOjFMkbM4_z_8,18182
+pixie/web/_templates/dashboard.html,sha256=IfxhT8rvFc1w5CedD0rUmHBvuuQipWIeGzN6ixor0UY,11745
+pixie/web/_templates/events.html,sha256=7-xTokjdv1jqA0XbePHqqz77jWg74vh2wY7_ks5_MqM,6587
+pixie/web/_templates/layout.html,sha256=2z4lMbp_8TLyrr-p1s4D5nFkJ0SWApqar3LEd5ECpZQ,13454
+pixie/web/_templates/login.html,sha256=d60N8kmr7YaAoTKRBaOiGN5Srdy8-BgB8_Zz9TQvGwc,1810
+pixie/web/_templates/machine_detail.html,sha256=B6ITlu6BqbjxFDL9-wKDtNvU3l6LQ470XjFGQlbavqY,38623
+pixie/web/_templates/machines.html,sha256=5fbpEVZXh0nCZo4On7ZPXApIZwau5dJukTcM2OJ3H4U,9146
+pixie/web/_templates/settings.html,sha256=m3XqfqPsQ3wufAz_SBgT9i_B2uxgZd3QsUyl8ind2Qs,13211
+pixie/web/_templates/_partials/page_description.html,sha256=ubJFzFvmu5NcX1w4wk7X3yp6Hb2O9QPC_yxKVWWCSwE,962
+pixie/web/_templates/_partials/recent_events.html,sha256=CrpMr-q1RaNYi0pWHrc5Aa_3zdMbOz9yDYS-ekUhJ7E,1886
+pixie/web/_templates/_partials/table_helpers.html,sha256=xObkXvfOSoM9rB5Ni_W3nnUO78T2ans8eMOz_bDdZyM,8116
+pixie/web/_templates/ipxe/bootstrap.j2,sha256=xt13H2dHf-SeLhWRQvptqGY51sJ_L24C2ExnLj9uXPc,490
+pixie/web/_templates/ipxe/exit.j2,sha256=pbTXTwjgiEsPZlRuv7_J0Q3BepXEqXnb82mv1sxDW24,371
+pixie/web/_templates/ipxe/nbdboot.j2,sha256=cNmGyrqBDzg7l48TqlEJ_CXHOtZTj7lXnOjeu9SFCIQ,3426
+pixie/web/_templates/ipxe/pixie-live-env.j2,sha256=dPWuYCFrkXwwatPSnTRSfWuMUMgvs3VLDHqbJTG1pP0,3048
+pixie/web/_templates/ipxe/unavailable.j2,sha256=zt4DYfYRXmOIjL13diYPxEApTP3CRnn5Beszeh3BPBw,440
+pixie_lab-0.1.0.dist-info/METADATA,sha256=iQ7ftVF-Ixmf3fNvs0LzChyAQEyZEERZBG2LGY1RNTc,4315
+pixie_lab-0.1.0.dist-info/WHEEL,sha256=lCkmxWfQsSc9CfIClYeavTdQeEX2toPqufh9gI35EQA,87
+pixie_lab-0.1.0.dist-info/entry_points.txt,sha256=G3vtKpg_gQtisiyS31EjdvC4QC52Kfw2K7iMsfsnj5A,71
+pixie_lab-0.1.0.dist-info/licenses/LICENSE,sha256=jOtLnuWt7d5Hsx6XXB2QxzrSe2sWWh3NgMfFRetluQM,35147
+pixie_lab-0.1.0.dist-info/RECORD,,

pixie_lab-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.31.0
+Root-Is-Purelib: true
+Tag: py3-none-any

pixie_lab-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,3 @@
+[console_scripts]
+pixie = pixie.tui:main
+pixie-lab = pixie.deploy:main