|
|
@@ -0,0 +1,42 @@
|
|
|
+# sm121/recipes — recipe repo (data repo)
|
|
|
+
|
|
|
+The git recipe repo for the [sm121 launcher](https://git.kilork.org/sm121/launcher)
|
|
|
+DGX Spark / GB10 cluster toolkit. The launcher (and the Home Assistant
|
|
|
+add-on) clone/pull this repo and serve from it:
|
|
|
+
|
|
|
+- **`recipes/<name>/recipe.toml`** — the recipes (source layout, exactly as
|
|
|
+ in the launcher repo)
|
|
|
+- **`docker-images/<dir>/`** — the image build contexts (source of truth;
|
|
|
+ optional when the image is prebuilt in the registry)
|
|
|
+- **`config.toml`** — the shared cluster/config source of truth
|
|
|
+ (the add-on's base config)
|
|
|
+
|
|
|
+Design: [`specs/tech-architecture/ha-addon-recipe-repos.md`](https://git.kilork.org/sm121/launcher/blob/main/specs/tech-architecture/ha-addon-recipe-repos.md)
|
|
|
+in the launcher repo.
|
|
|
+
|
|
|
+## Credential-free contract
|
|
|
+
|
|
|
+This repo may be **shared with other users** — nothing secret lives here.
|
|
|
+The add-on's effective config = this `config.toml` + the add-on options
|
|
|
+(the secrets): the SSH user/key, the HA URL/token, the registry base, and
|
|
|
+any `[mikrotik]` block (it carries a password) via the
|
|
|
+`sm121_config_extra` option. A cluster whose `extra_entities` name a
|
|
|
+mikrotik device (`SW2-MUC`) needs that block to resolve the entity —
|
|
|
+supplied per-install, never committed.
|
|
|
+
|
|
|
+## Supersedes the old publish-bundle registry
|
|
|
+
|
|
|
+This repo previously stored `sm121 publish` output (flat self-contained
|
|
|
+bundles at the repo root) as the storage of the public recipe registry
|
|
|
+(`sm121recipes.onlinedb.org`). **That registry is retired** (the
|
|
|
+add-on recipe-repo flow supersedes it); the bundles were removed on the
|
|
|
+restructure. `sm121 publish` (bundles) and `sm121 registry` (browse/
|
|
|
+install) still exist in the launcher but no longer commit to this repo.
|
|
|
+
|
|
|
+## Maintenance
|
|
|
+
|
|
|
+Recipes + build contexts move together (the served image must match the
|
|
|
+recipe revision): update this repo from the launcher repo's tracked state
|
|
|
+(`scripts/seed-recipe-repos.sh` in the launcher repo shows the layout;
|
|
|
+for this repo, copy `recipes/` + `docker-images/` and keep
|
|
|
+`config.toml` current, credential-free).
|