docs(configuration): point examples at canonical ~/.clio/clio.yaml#14
Merged
Conversation
- Installation: lead with pip as the recommended portable installer
(self-contained wheel, no system deps). Call out that newer/advanced
features (CUDA/ROCm, MPI, HDF5, ADIOS2, FUSE, compression, custom
ChiMods, sanitizers) require a source build via Conda/Docker/Spack.
- Quick Start: reorder the activation tabs to put pip first, matching
the new installer order.
- Replace stale C++ naming across the SDK and deployment docs to match
the renamed codebase:
* hshm:: → ctp::
* HSHM_<X> macros → CTP_<X>
* binary names wrp_* → clio_* (clio_cte_bench, clio_run_thrpt_benchmark,
clio_cae_omni, etc.)
* HSHM_LOG_LEVEL env var → CTP_LOG_LEVEL
- Drop WRP_RUNTIME_CONF fallback wherever it was documented; only
CHI_SERVER_CONF + ~/.chimaera/chimaera.yaml are honored now.
- Rewrite all #include <hermes_shm/...> and #include "hermes_shm/..." examples to clio_ctp/... to match the renamed include subtree in the context-transport-primitives source. - Update inline "Source:" path callouts that quoted the hermes_shm/ layout (ring_buffer_guide, string_guide, unordered_map_guide, vector_guide, etc.). - Replace the hermes_shm::cxx CMake target alias with ctp::cxx (the alias was renamed alongside the namespace). - Adjust a sample log-file path /tmp/hermes_shm.log → /tmp/clio_ctp.log in the logging guide. The library name hermes_shm_host (in gpu-cte.md's target_link_libraries example) is intentionally left alone — that physical CMake target name still exists in the build; only the include subtree was renamed.
Mirror the codebase rename across the SDK + deployment + API guides: - wrp_cte_* / namespace wrp_cte:: → clio_cte_* / clio_cte:: - wrp_cae_* / namespace wrp_cae:: → clio_cae_* / clio_cae:: - wrp_cee_* / namespace wrp_cee:: → clio_cee_* / clio_cee:: - wrp_llm_* → clio_llm_* - hermes_shm_host (CMake target) → clio_ctp_host - libwrp_*.so example mentions → libclio_*.so - wrp_conf.yaml / wrp_runtime_conf.yaml example filenames → clio_*.yaml Build/runtime examples now match what the build actually produces (libclio_cte_core_*.so, ChiMod mod_name "clio_cte_core", pool_name "clio_cte", etc.).
…rd into Monitoring Phases B-E of the rebrand applied to the docs submodule. - chimaera CLI commands: `chimaera <subcmd>` -> `clio_run <subcmd>` in every doc that shows runtime invocation (e.g. `clio_run runtime start`, `clio_run monitor`, `clio_run compose`, `clio_run migrate`, `clio_run repo refresh`). - Env-var names: every CHI_<NAME> mentioned in docs renamed to CLIO_<NAME> for the known set (WITH_RUNTIME, IPC_MODE, SERVER_CONF, REPO_PATH, NUM_CONTAINERS, GPU_*, INIT_*, CLIENT_RETRY_TIMEOUT, CLIENT_TRY_NEW_SERVERS, LBM_*, MEMFD_DIR, TEST_DATA_DIR, WAIT_SERVER, ZMQ_IO_THREADS). The C++ helper still reads both (CLIO_ first, then CHI_ fallback), so legacy deployments aren't affected. - "ChiMod" -> "Module" everywhere in prose, including the two page titles "ChiMod Developer Guide" -> "Module Developer Guide" and "ChiMod Unit Testing Guide" -> "Module Unit Testing Guide". CHI_CHIMOD_CC macro identifier (uppercase) untouched. - chimaera_mod.yaml -> clio_mod.yaml, chimaera_repo.yaml -> clio_repo.yaml in doc text (both filenames still parsed by CMake; the new names match what the IOWarp Core repo migrated to). - Brand prose "Chimaera runtime/framework/cluster/daemon/server" -> "Clio runtime/framework/..." where it appears in prose. Code-accurate references to `chimaera::cxx`, `chimaera::admin_client`, `chimaera_admin_runtime` etc. (real CMake target / C++ namespace names) left intact. Dashboard + Monitoring merge: - docs/deployment/dashboard.md content merged into docs/deployment/ monitoring.md as the "Runtime Dashboard" section. monitoring.md now covers Logging, Runtime Dashboard (full prior dashboard content), and Darshan I/O analysis as a single page. - docs/deployment/dashboard.md deleted. - sidebars.ts: removed the standalone 'deployment/dashboard' entry.
Mirrors the C++ runtime's new lookup order (see ConfigManager:: GetServerConfigPath in the main repo): 1. CLIO_SERVER_CONF (legacy CHI_SERVER_CONF) 2. ~/.clio/clio.yaml 3. ~/.clio/chimaera.yaml 4. ~/.chimaera/clio.yaml 5. ~/.chimaera/chimaera.yaml 6. Built-in defaults Updated docs that reference the per-user config: - docs/deployment/configuration.md — full 5-row priority table. - docs/deployment/monitoring.md — added ~/.clio rows next to legacy. - docs/deployment/hpc-cluster.md — added preferred + legacy fallback rows. - docs/getting-started/quick-start.mdx — rewrote the "Default Configuration" section to document dual-seed install + 5-row priority list. - docs/getting-started/installation.mdx and a couple of inline mentions — rewritten to `~/.clio/clio.yaml` (legacy: `~/.chimaera/chimaera.yaml`). Networking env var rename in docs: CHI_PORT -> CLIO_PORT and CHI_SERVER_ADDR -> CLIO_SERVER_ADDR. Neither is actually parsed by the runtime today, but renaming keeps doc naming consistent with the rest of the env-var rebrand.
Both pages described the removed bidirectional GPU runtime
(LocalGpuBcast / ToLocalGpu / RouteToGpu / GPU work orchestrator /
CHI_CLIENT_GPU_INIT / CHIMAERA_GPU_ORCHESTRATOR_INIT). Rewritten
around the current producer-only architecture: kernels submit via
the per-device gpu2cpu_queue and the CPU runtime's Worker::
ProcessNewTaskGpu consumes. Slot layout, MemKind, and
AllocateAndRegisterGpuBackend are sourced from
clio_runtime/gpu/gpu_ipc_manager.h. Worked examples mirror
test_gpu_kernel_stress_{gpu,sycl}.cc and test_cte_devmem_putget.cc.
6.gpu_clients.md: 1319 -> 538 lines.
gpu-cte.md: 325 -> 278 lines (now a short integration guide that
points at 6.gpu_clients.md for the producer model and lists the
__device__-safe surface of clio_cte::core::Client).
Removed-API table in 6.gpu_clients.md lists every name migrators are
likely to grep for, so old code searches still land somewhere useful.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Unifies three competing forms ("IOWarp Runtime", "Clio runtime",
"Chimaera") into "CLIO Runtime" (all-caps CLIO to match sibling
product names CLIO Kit / CLIO Core / CLIO Agent, Title-case Runtime).
Touched all prose, including code-fence comments and CLI invocations
that referenced the legacy `chimaera` binary by name (now `clio_run`).
Code identifiers and config field values are left alone:
- C++ identifiers: ChimaeraMode, ChimaeraManager, CHIMAERA_INIT, ...
- Module/binary/config names: chimaera_bdev, chimaera_pool_list,
chimaera_methods, chimaera.yaml, ~/.chimaera, find_package(chimaera)
- YAML field values: `namespace: chimaera` in clio_mod.yaml
Also: rename stale CMake option in docs and integration scripts.
WRP_CTE_ENABLE_FUSE_ADAPTER -> CLIO_CTE_ENABLE_FUSE_ADAPTER
(matches the actual option() declaration in /workspace/CMakeLists.txt:144).
Touched 15 docs in this submodule; companion change in main repo
fixes the two FUSE integration test scripts and bumps the gitlink.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
The clio_run binary now dispatches flat subcommands directly: clio_run start | restart | stop | refresh | monitor | compose | migrate The nested form (`clio_run runtime start`, `clio_run repo refresh`) still works for backward compat. Docs use the flat form as the canonical, shorter style. Also: clio_cae_omni -> clio_cae across docs (matches the binary rename in the main repo; clio_cae_omni remains as an install-time symlink for backward compat). Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
…yment New docs/deprecation-notes.md catalogs every legacy name that still works as a backward-compat alias (CLI binaries, subcommand forms, config files/directories, env vars, C++ header paths, macros, and transport-primitive namespaces). Distilled from the internal rebranding.md, but rewritten for end-users. The user-facing pages now use only canonical names + point at deprecation-notes for the full list: - quick-start.mdx: dropped the 5-row "(legacy …)" priority table and the "(and its legacy `chimaera` alias)" gloss; activation tab is now one sentence, default-config section is a paragraph. - installation.mdx: dropped "(legacy: ~/.chimaera/chimaera.yaml)" gloss. - configuration.md: 5-row table -> 3-row table + link to deprecation-notes. - hpc-cluster.md: 3-row table -> 2-row + link. - monitoring.md: dashboard config-discovery table -> canonical-only + link. - adapter.md: dropped the inline "(legacy: …)" gloss in the example config. sidebars.ts: added 'deprecation-notes' as a top-level entry after 'tutorials' so it's discoverable from the sidebar. Net change: -43 +28 in inline-mention churn, +214 in the new dedicated page (which lives in one place instead of fragmented across every guide). Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Mirrors the parent-repo clio-core PR #449 (chore/standardize-clio-yaml-paths)
where every Docker image, jarvis package, CI workflow, and installer
moved from ~/.chimaera/chimaera.yaml to the canonical ~/.clio/clio.yaml.
Two example snippets in deployment/configuration.md still pointed at
the legacy spelling and would have confused new users about which
path to use. The configuration overview table above already lists
~/.clio/clio.yaml as the 2nd-priority lookup; the examples below now
match:
- $CLIO_SERVER_CONF override example: /etc/iowarp/chimaera.yaml ->
/etc/iowarp/clio.yaml
- docker-compose snippet: bind ./clio.yaml -> /home/iowarp/.clio/clio.yaml
(and switch the command: line from "clio_run runtime start" to the
canonical flat "clio_run start" form to match the rest of the docs)
The legacy-paths callout on line 23 ("a handful of legacy paths are
also accepted for backward compat — see Deprecation Notes") is kept
verbatim — that one explicitly describes the deprecation and points
readers at the deprecation-notes page for the full lookup order, so
removing the old spellings there would lose the back-compat doc.
lukemartinlogan
added a commit
to iowarp/clio-core
that referenced
this pull request
May 26, 2026
iowarp/docs PR #14 (chore/clio-yaml-example-config-path) updates the two example snippets in docs/deployment/configuration.md that still pointed at the legacy ~/.chimaera/chimaera.yaml. Bump the submodule pointer here so the parent repo PR #449 ships with the docs in sync. 913f7d7c -> 4c2eb02f If iowarp/docs#14 lands as a squash-merge, the resulting docs/main commit will have the same tree but a different SHA; this pointer still references a real commit in the docs repo either way, just slightly off-mainline. Re-bumping to docs/main HEAD after that merge is a trivial follow-up (or can ride the next docs change).
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.
Follow-up to the parent-repo PR iowarp/clio-core#449, which standardized every Docker image, jarvis package, CI workflow, and installer on the canonical
~/.clio/clio.yaml. Two example snippets indocs/deployment/configuration.mdstill pointed at the legacy~/.chimaera/chimaera.yamlspelling and would have confused new users about which path to use.Changes
CLIO_SERVER_CONF=/etc/iowarp/chimaera.yaml→CLIO_SERVER_CONF=/etc/iowarp/clio.yaml./clio.yaml → /home/iowarp/.clio/clio.yaml, and switch thecommand:line from the legacy nestedclio_run runtime startform to the canonical flatclio_run startform to match the rest of the docs.Preserved
The legacy-paths callout on line 23 ("a handful of legacy paths are also accepted for backward compat — see Deprecation Notes") is kept verbatim — that one explicitly describes the deprecation and points readers at the deprecation-notes page for the full lookup order, so removing the old spellings there would lose the back-compat doc.
🤖 Generated with Claude Code