🔧 Fix GitHub Actions docs workflow

- Update mkdocs dependencies to latest versions
- Add permissions for GitHub Pages deployment
- Add workflow_dispatch for manual trigger
- Fix build command with fallback
This commit is contained in:
Apple
2026-01-10 07:57:36 -08:00
parent 90758facae
commit fb4f4a16d5
168 changed files with 124284 additions and 8954 deletions

View File

@@ -0,0 +1,806 @@
<!doctype html>
<html lang="en" class="no-js">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<link rel="canonical" href="https://IvanTytar.github.io/microdao-daarion/tasks/TASK_PHASE_NODE_DASHBOARD_API_MVP/">
<link rel="icon" href="../../assets/images/favicon.png">
<meta name="generator" content="mkdocs-1.5.3, mkdocs-material-9.5.18">
<title>TASK PHASE — NODE DASHBOARD API (MVP) - DAARION Documentation</title>
<link rel="stylesheet" href="../../assets/stylesheets/main.66ac8b77.min.css">
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
<style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
<script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce((e,_)=>(e<<5)-e+_.charCodeAt(0),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
</head>
<body dir="ltr">
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
<label class="md-overlay" for="__drawer"></label>
<div data-md-component="skip">
<a href="#task-phase-node-dashboard-api-mvp" class="md-skip">
Skip to content
</a>
</div>
<div data-md-component="announce">
</div>
<header class="md-header md-header--shadow" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="Header">
<a href="../.." title="DAARION Documentation" class="md-header__button md-logo" aria-label="DAARION Documentation" data-md-component="logo">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54Z"/></svg>
</a>
<label class="md-header__button md-icon" for="__drawer">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></svg>
</label>
<div class="md-header__title" data-md-component="header-title">
<div class="md-header__ellipsis">
<div class="md-header__topic">
<span class="md-ellipsis">
DAARION Documentation
</span>
</div>
<div class="md-header__topic" data-md-component="header-topic">
<span class="md-ellipsis">
TASK PHASE — NODE DASHBOARD API (MVP)
</span>
</div>
</div>
</div>
<script>var media,input,key,value,palette=__md_get("__palette");if(palette&&palette.color){"(prefers-color-scheme)"===palette.color.media&&(media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']"),palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent"));for([key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>
<label class="md-header__button md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg>
</label>
<div class="md-search" data-md-component="search" role="dialog">
<label class="md-search__overlay" for="__search"></label>
<div class="md-search__inner" role="search">
<form class="md-search__form" name="search">
<input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
<label class="md-search__icon md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12Z"/></svg>
</label>
<nav class="md-search__options" aria-label="Search">
<button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41Z"/></svg>
</button>
</nav>
</form>
<div class="md-search__output">
<div class="md-search__scrollwrap" data-md-scrollfix>
<div class="md-search-result" data-md-component="search-result">
<div class="md-search-result__meta">
Initializing search
</div>
<ol class="md-search-result__list" role="presentation"></ol>
</div>
</div>
</div>
</div>
</div>
</nav>
</header>
<div class="md-container" data-md-component="container">
<main class="md-main" data-md-component="main">
<div class="md-main__inner md-grid">
<div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer">
<a href="../.." title="DAARION Documentation" class="md-nav__button md-logo" aria-label="DAARION Documentation" data-md-component="logo">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54Z"/></svg>
</a>
DAARION Documentation
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../public/" class="md-nav__link">
<span class="md-ellipsis">
Home
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../public/getting-started/" class="md-nav__link">
<span class="md-ellipsis">
Getting Started
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../public/architecture-overview/" class="md-nav__link">
<span class="md-ellipsis">
Architecture
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../public/daiS_daos_overview/" class="md-nav__link">
<span class="md-ellipsis">
DAIS & DAOS
</span>
</a>
</li>
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" >
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="">
<span class="md-ellipsis">
Internal
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_5">
<span class="md-nav__icon md-icon"></span>
Internal
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5_1" >
<label class="md-nav__link" for="__nav_5_1" id="__nav_5_1_label" tabindex="0">
<span class="md-ellipsis">
Infra
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_5_1_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_5_1">
<span class="md-nav__icon md-icon"></span>
Infra
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../internal/infra/INFRA_AUTOMATION_PACK_V1/" class="md-nav__link">
<span class="md-ellipsis">
Infra Automation Pack v1
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../internal/infra/monitoring_overview/" class="md-nav__link">
<span class="md-ellipsis">
Monitoring Overview
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../internal/infra/nodes_registry_v0/" class="md-nav__link">
<span class="md-ellipsis">
Nodes Registry v0
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5_2" >
<label class="md-nav__link" for="__nav_5_2" id="__nav_5_2_label" tabindex="0">
<span class="md-ellipsis">
Specs
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_5_2_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_5_2">
<span class="md-nav__icon md-icon"></span>
Specs
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../internal/specs/matrix_presence_aggregator/" class="md-nav__link">
<span class="md-ellipsis">
Matrix Presence Aggregator
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../internal/specs/city_map_spec/" class="md-nav__link">
<span class="md-ellipsis">
City Map Spec
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../internal/specs/node_join_protocol_draft/" class="md-nav__link">
<span class="md-ellipsis">
Node Join Protocol (Draft)
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#1" class="md-nav__link">
<span class="md-ellipsis">
1. Мета
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#2" class="md-nav__link">
<span class="md-ellipsis">
2. Поточний стан
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#3-backend-city-service" class="md-nav__link">
<span class="md-ellipsis">
3. Завдання для backend (city-service)
</span>
</a>
<nav class="md-nav" aria-label="3. Завдання для backend (city-service)">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#31-node-dashboard-endpoint" class="md-nav__link">
<span class="md-ellipsis">
3.1. Створити Node Dashboard endpoint
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#32-legacy-" class="md-nav__link">
<span class="md-ellipsis">
3.2. Legacy-роут (опційно)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#33-repo" class="md-nav__link">
<span class="md-ellipsis">
3.3. Repo / модель
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#4-frontend-appsweb" class="md-nav__link">
<span class="md-ellipsis">
4. Завдання для frontend (apps/web)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#5" class="md-nav__link">
<span class="md-ellipsis">
5. Перевірки
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#6-out-of-scope" class="md-nav__link">
<span class="md-ellipsis">
6. Подальші кроки (out of scope)
</span>
</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-content" data-md-component="content">
<article class="md-content__inner md-typeset">
<h1 id="task-phase-node-dashboard-api-mvp">TASK PHASE — NODE DASHBOARD API (MVP)<a class="headerlink" href="#task-phase-node-dashboard-api-mvp" title="Permanent link">&para;</a></h1>
<p>Version: 1.0<br />
Target: NODE1 (city-service + daarion-web)</p>
<hr />
<h2 id="1">1. Мета<a class="headerlink" href="#1" title="Permanent link">&para;</a></h2>
<p>Замість 404-заглушки для <code>/api/node/dashboard</code> зробити мінімальний Node Dashboard API, який:</p>
<ul>
<li>повертає базову інформацію про ноду (status, tags, agents_online, uptime);</li>
<li>не ламає сторінку ноди, навіть якщо метрик поки немає;</li>
<li>має чітку структуру для подальшого розширення (Prometheus, NATS events, тощо).</li>
</ul>
<hr />
<h2 id="2">2. Поточний стан<a class="headerlink" href="#2" title="Permanent link">&para;</a></h2>
<ul>
<li><code>/nodes</code> і <code>/nodes/:nodeId</code> вже працюють через <code>/public/nodes</code>.</li>
<li>На сторінці <code>nodes/[nodeId]</code> фронт робить запит на <code>/api/node/dashboard</code>, отримує 404 та показує банер (graceful degradation).</li>
<li>бекенд не має відповідного endpointа.</li>
</ul>
<hr />
<h2 id="3-backend-city-service">3. Завдання для backend (city-service)<a class="headerlink" href="#3-backend-city-service" title="Permanent link">&para;</a></h2>
<h3 id="31-node-dashboard-endpoint">3.1. Створити Node Dashboard endpoint<a class="headerlink" href="#31-node-dashboard-endpoint" title="Permanent link">&para;</a></h3>
<ol>
<li>Додати новий роутер, наприклад <code>routes_node_dashboard.py</code>, або розширити існуючий <code>routes_city</code>.</li>
<li>Маршрут:
<code>GET /api/v1/nodes/{node_id}/dashboard</code></li>
<li>
<p>Реалізація:
```python
@router.get("/api/v1/nodes/{node_id}/dashboard")
async def get_node_dashboard(node_id: str):
node = await repo_city.get_node_by_id(node_id)
if not node:
raise HTTPException(status_code=404, detail="Node not found")</p>
<p>return {
"node_id": node["node_id"],
"name": node["name"],
"kind": node.get("kind"),
"status": node.get("status", "unknown"),
"tags": node.get("roles", []),
"agents_total": node.get("agents_total", 0),
"agents_online": node.get("agents_online", 0),
"uptime": None, # placeholder
"metrics_available": False # флаг, що метрик ще немає
}
<code>``
4. Під’єднати роутер у</code>main.py`.</p>
</li>
</ol>
<h3 id="32-legacy-">3.2. Legacy-роут (опційно)<a class="headerlink" href="#32-legacy-" title="Permanent link">&para;</a></h3>
<p>Якщо фронт все ще звертається до <code>/api/node/dashboard?nodeId=...</code>, додати невеликий alias:</p>
<div class="codehilite"><pre><span></span><code><span class="nd">@router</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;/api/node/dashboard&quot;</span><span class="p">)</span>
<span class="k">async</span> <span class="k">def</span><span class="w"> </span><span class="nf">get_node_dashboard_legacy</span><span class="p">(</span><span class="n">node_id</span><span class="p">:</span> <span class="nb">str</span><span class="p">):</span>
<span class="k">return</span> <span class="k">await</span> <span class="n">get_node_dashboard</span><span class="p">(</span><span class="n">node_id</span><span class="p">)</span>
</code></pre></div>
<h3 id="33-repo">3.3. Repo / модель<a class="headerlink" href="#33-repo" title="Permanent link">&para;</a></h3>
<p>Перевірити, що <code>repo_city.get_node_by_id</code> повертає словник з потрібними полями (node_id, name, roles, status, agents_total, agents_online).</p>
<hr />
<h2 id="4-frontend-appsweb">4. Завдання для frontend (apps/web)<a class="headerlink" href="#4-frontend-appsweb" title="Permanent link">&para;</a></h2>
<ol>
<li>В <code>apps/web/src/lib/api/nodes.ts</code> (або аналогічному файлі):
<code>ts
export async function getNodeDashboard(nodeId: string) {
return api.get(`/api/nodes/${encodeURIComponent(nodeId)}/dashboard`);
}</code></li>
<li>В <code>nodes/[nodeId]/page.tsx</code>:</li>
<li>використовувати новий API;</li>
<li>якщо <code>metrics_available === false</code>, показувати банер “детальний дашборд у розробці”, але рендерити базову інформацію;</li>
<li>якщо відповідь 404 → fallback до вже наявної логіки (профіль з <code>/public/nodes</code>).</li>
</ol>
<hr />
<h2 id="5">5. Перевірки<a class="headerlink" href="#5" title="Permanent link">&para;</a></h2>
<ol>
<li><code>GET https://daarion.space/api/nodes/node-1-hetzner-gex44/dashboard</code>
<code>json
{
"node_id": "node-1-hetzner-gex44",
"name": "...",
"status": "online",
"tags": ["core","gateway",...],
"agents_total": 9,
"agents_online": 1,
"uptime": null,
"metrics_available": false
}</code></li>
<li>UI <code>https://daarion.space/nodes/node-1-hetzner-gex44</code>:</li>
<li>сторінка відкривається без помилок;</li>
<li>зверху банер (поки API повертає <code>metrics_available=false</code>);</li>
<li>базова інформація про ноду видно.</li>
<li>У логах Next.js немає помилок “Failed to fetch node dashboard”.</li>
</ol>
<hr />
<h2 id="6-out-of-scope">6. Подальші кроки (out of scope)<a class="headerlink" href="#6-out-of-scope" title="Permanent link">&para;</a></h2>
<ul>
<li>Коли з’являться реальні метрики (Prometheus, Agent runtime), заповнити поля <code>uptime</code>, <code>metrics_available=True</code>, додати масив графіків/alerts.</li>
<li>Додати історію подій ноди (restart, incident, deployment) через <code>event_outbox</code>.</li>
</ul>
</article>
</div>
<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
</div>
</main>
<footer class="md-footer">
<div class="md-footer-meta md-typeset">
<div class="md-footer-meta__inner md-grid">
<div class="md-copyright">
Made with
<a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
Material for MkDocs
</a>
</div>
</div>
</div>
</footer>
</div>
<div class="md-dialog" data-md-component="dialog">
<div class="md-dialog__inner md-typeset"></div>
</div>
<script id="__config" type="application/json">{"base": "../..", "features": ["navigation.sections", "navigation.instant", "content.code.copy"], "search": "../../assets/javascripts/workers/search.b8dbb3d2.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>
<script src="../../assets/javascripts/bundle.3220b9d7.min.js"></script>
</body>
</html>