docs(docker-new): add compose examples (basic + awsim + planning-sim)#7037
Merged
docs(docker-new): add compose examples (basic + awsim + planning-sim)#7037
Conversation
…ng-simulator) Ship compose file examples under docker-new/examples/ so new users can bring up a working environment without assembling the flags by hand: - basic/: three starter compose files for the devel image on CPU-only hosts, Intel/AMD hosts with DRI, and NVIDIA hosts with the container runtime. Same image, same entrypoint, just different device plumbing. - demos/awsim/: brings up the universe-cuda image alongside the AWSIM simulator for end-to-end testing. - demos/planning-simulator/: runs the planning-simulator scenario with DRI and NVIDIA variants on top of the universe image. Each directory has its own README walking through prerequisites, run steps, and what to verify. Signed-off-by: Mete Fatih Cırıt <mfc@autoware.org>
|
Thank you for contributing to the Autoware project! 🚧 If your pull request is in progress, switch it to draft mode. Please ensure:
|
mitsudome-r
reviewed
Apr 20, 2026
Co-authored-by: Ryohsuke Mitsudome <43976834+mitsudome-r@users.noreply.github.com>
mitsudome-r
approved these changes
Apr 20, 2026
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
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.
universe-devel-*image for the host GPU story:dev-cpu.compose.yaml(LIBGL_ALWAYS_SOFTWARE=1, no GPU),dev-dri.compose.yaml(/dev/dripassthrough for Mesa iris/radeonsi/nouveau),dev-nvidia.compose.yaml(runtime: nvidia+universe-devel-cuda-jazzy). All three forward$DISPLAY, mount~/autoware_map/~/autoware_data, and remap the in-containerawuser to the host UID/GID.planning_simulator.launch.xmlwith the sample map onuniverse-jazzy. Basedocker-compose.yamlships software rendering;docker-compose.dri.yamlanddocker-compose.nvidia.yamlare overlays merged via-f base -f overlayfor Intel/AMD or NVIDIA hardware acceleration.network_mode: hostand launchese2e_simulator.launch.xmlonuniverse-cuda-jazzy. Seedocker-compose.yaml.command:blocks end withexec bashso the container drops to an interactive shell after the launch exits, instead of disappearing.Why
The
docker-newimages landed without any user-facing launch examples — contributors had to reverse-engineer which tag to use, how to forward X11, when to addruntime: nvidiavs/dev/dri, and how theHOST_UID/HOST_GIDentrypoint remap works. These compose files are the canonical "which knob for which host" reference and pair the three GPU passthrough strategies with the three image flavors (universe-devel,universe,universe-cuda) we actually ship.Test plan
glxinfo -Bto reportNVIDIA Corporation:Mesa Intel...orAMD Radeon..., notllvmpipe:llvmpipe:~/autoware_map/sample-map-planningpresent, expect rviz to render the vector map:runtime: nvidiain the resolved config:/dev/driindevices::network_mode: hostandruntime: nvidia:awuser's UID/GID to match the host: