Skip to content

docs(modules): document sidecar services in compose fragments (follow-up to #426) #429

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
andrewjong merged 1 commit into from
Sep 11, 2026
Merged

docs(modules): document sidecar services in compose fragments (follow-up to #426) #429

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .env
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ PROJECT_NAME="airstack"
# If you've run ./airstack.sh setup, then this will auto-generate from the git commit hash every time a change is made
# to a Dockerfile or docker-compose.yaml file. Otherwise this can also be set explicitly to make a release version.
# auto-generated from git commit hash
VERSION="0.21.0-dev.14"
VERSION="0.21.0-dev.15"
# Image-tag discriminator ONLY (appears in the image tag suffix, e.g. ..._robot-x86-64_dev).
# No Dockerfile consumes it: "prebuilt" does NOT bake the built ros_ws into the image today —
# a real prebuilt (workspace-baked) stage is future work. Keep "dev" (mounted code, built live).
Expand Down
13 changes: 9 additions & 4 deletions docs/development/modules.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,10 +124,15 @@ Placement is driven by the manifest's `type` and `targets`:
`sys.path.insert(0, os.environ.get("AIRSTACK_LAUNCH_SCRIPTS_DIR", "/isaac-sim/AirStack/simulation/isaac-sim/launch_scripts"))`
instead of baking in the mount path.
- **`compose:` fragments** (any type) — the fragment's `services:` are merged
into the generated file, with relative host paths rewritten to absolute
(compose resolves relative bind sources against different bases depending on
how files are merged; the generated file is machine-local and regenerated on
every sync, so absolute is the unambiguous choice).
into the generated file, with relative host paths rewritten to absolute:
bind-mount sources, `build.context` / `build.dockerfile`, and `env_file`
entries (compose resolves relative paths against different bases depending
on how files are merged; the generated file is machine-local and regenerated
on every sync, so absolute is the unambiguous choice). A fragment may
therefore declare a whole **sidecar service** with its own `build:` section
— a second container next to the robot, built on first `airstack up` — which
is how the `raven` module runs its GPU-heavy RayFronts mapper on the robot's
DDS domain without touching the robot image.
- **`data`** — no overlay action yet (asset fetching lands with a later phase).

Everything is idempotent: re-running `sync` converges, `module remove` (or
Expand Down
Loading