Skip to content

docs: Document host path translation in orchestrator [doc-updater] - #810

Merged
jwbron merged 1 commit into
mainfrom
egg/doc-update-host-path-translation
Feb 17, 2026
Merged

docs: Document host path translation in orchestrator [doc-updater]#810
jwbron merged 1 commit into
mainfrom
egg/doc-update-host-path-translation

Conversation

@james-in-a-box

Copy link
Copy Markdown
Contributor

docs: Document host path translation in orchestrator [doc-updater]

Update docs/architecture/orchestrator.md to reflect changes from b4b1ecd (Fix orchestrator crash on host paths in egg-state dirs, #806):

  • Add explanation of HOST_HOME-based path translation in the Phase-based readonly mounts section
  • Add HOST_HOME to the environment variables table

The fix introduced _host_to_local_volumes() in container_spawner.py which translates host-absolute worktree paths (e.g., /home/jwies/.egg-worktrees/...) to orchestrator-accessible paths (/home/egg/...) for is_dir() checks and directory creation, while keeping Docker mount sources as host paths. This was previously undocumented.

Triggered by: #806

Test plan:

  • Review doc changes reflect the new path translation behavior accurately

Authored-by: egg

Update orchestrator architecture doc to explain the HOST_HOME-based
path translation introduced in #806 and add HOST_HOME to the
environment variables table.

Authored-by: egg

@egg-reviewer egg-reviewer Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No agent-mode design concerns. This is a documentation-only change that adds accurate descriptions of existing host path translation behavior and the HOST_HOME env var to the orchestrator architecture doc.

— Authored by egg

@james-in-a-box

This comment has been minimized.

@egg-reviewer egg-reviewer Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Documentation-only change (3 lines). Verified all claims against the implementation:

  • _host_to_local_volumes() in container_spawner.py:96-113 matches the described behavior exactly — uses HOST_HOME env var, translates host paths for filesystem operations, preserves original paths for Docker mount sources.
  • HOST_HOME env var is set in docker-compose.yml and bin/egg-deploy, defaulting to /home/egg (passthrough when host and container paths match).
  • The new paragraph is placed correctly after the existing ensure_egg_state_dirs() / phase_readonly_mounts() description.
  • Env var table entry is accurate.

No issues.

— Authored by egg

@james-in-a-box

Copy link
Copy Markdown
Contributor Author

egg review completed. View run logs

1 previous review(s) hidden.

@jwbron
jwbron merged commit 537cafa into main Feb 17, 2026
21 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant