docs: runtime-served dashboard (wt-990), Dashboard getting-started page, filesystem quick start - #20
Merged
Merged
Conversation
…ge, filesystem quick start The Python context-visualizer was retired in core PR #993 (branch 990-cpp-context-visualizer): the runtime now serves its own dashboard from the admin ChiMod, every ChiMod can ship a viz/ directory and register routes via Container::RegisterViz, and pools can be created and destroyed from the browser. Bring the docs in line, and use the moment to simplify the getting-started path. Monitoring: rewrite the Runtime Dashboard section — clio_run start serves it on :8080 (--viz/--no-viz/--viz-port/--viz-bind, the viz: YAML block, CLIO_VIZ_* env), loopback-only and off-for-embedded defaults, the Cluster/Pools/Config pages and per-module websites, the full REST API with curl examples, asset lookup, the Poco build requirement, Docker / tunnel access, and the (now 8-node) interactive cluster. Configuration: new "Web Dashboard (viz)" section and CLIO_VIZ_* rows in the env-var tables. Deprecation notes: context-visualizer entry with an old -> new table (command, port 5000 -> 8080, pip extra, CMake option, API paths, the removed SSH shutdown/restart). Module dev guide: "Web Dashboard Integration (RegisterViz)" — shipping pages, api.js helpers, a RegisterViz example against the real APIs, the prototype-instance / no-`this` rule, handler threading rules, the Add Pool form convention; plus clio_add_viz_assets() in the build-function reference. Getting Started: new Dashboard page (a tour: open it, the tabs, create a pool with Add Pool, watch real work, turn it off). Quick Start is now the simplified filesystem deployment — clio_run start with the default config, mount with clio_cte_fuse per platform, use it with ordinary tools, watch it in the dashboard, stop — with the CEE Python example kept as an optional step. Also: CTE and bdev module docs cross-reference their dashboard pages; installation no longer claims the pip wheel lacks FUSE (only macOS does); intro's reader path ends at the Dashboard page. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Documents the context-visualizer changes merged into core
devas iowarp/clio-core#993 (990-cpp-context-visualizer): the Python/Flaskcontext_visualizeris retired and the runtime serves its own dashboard (admin ChiMod HTTP server, per-ChiModviz/pages,Container::RegisterVizroutes, pool create/destroy from the UI). Also adds a Getting Started Dashboard page and turns the Quick Start into the simplified filesystem deployment.Every flag, env var, config key, route, and page was checked against the merged source (
context-runtime/src/viz/viz_server.cc,modules/admin/src/admin_viz.cc,util/clio_run_cmd_runtime_start.cc,config/clio_default.yaml, the moduleviz/JS) rather than onlycontext-runtime/docs/web_dashboard.md.Changes
clio_run startserves it on:8080,--viz/--no-viz/--viz-port/--viz-bind,viz:YAML,CLIO_VIZ_*, loopback-only / off-for-embedded defaults, Cluster/Pools/Config pages, module websites (bdev, safe-bdev, CTE core), full REST API + curl examples, asset lookup paths, Poco build requirement, Docker/tunnel access, the 8-node interactive cluster. Retirement callout links to the migration table.viz) section +CLIO_VIZ_*env-var rows.context-visualizerentry with old→new mapping (command, port 5000→8080, pip extra, CMake option, API paths, removed SSH shutdown/restart).api.jshelpers,RegisterVizexample, prototype-instance/no-thisrule, handler threading rules, Add Pool form convention) +clio_add_viz_assets()in the build-function reference.clio_run startwith the default config, mount withclio_cte_fuseper platform, use it with ordinary tools, watch it in the dashboard, stop; CEE Python example kept as optional.installation.mdxno longer says the pip wheel lacks FUSE (only macOS does); intro reader path → Dashboard; sidebar entry.Verification
npm run buildpasses withonBrokenLinks: 'throw'; all new cross-page anchors resolve in the built HTML.Heads-up for the core repo (not addressed here)
build_deps_manylinux.sh) and the deb/rpm CI jobs don't install Poco, so those packages build with the dashboard disabled; the Dashboard page has a callout for this.deploy-cpu.Dockerfile's runtime stage also doesn't ship Poco's runtime libs.test/integration/interactive/run.shhard-codesNODE1_IP=172.28.0.10while the compose/hostfile use172.23.0.10(pre-existing).🤖 Generated with Claude Code