Skip to content

Added verified Dockerised workflows' instructions for running Interactive Web & Nav2 Integration demos - #48

Open
cardboardcode wants to merge 14 commits into
open-rmf:mainfrom
cardboardcode:feature/dockerfile_nav2sim
Open

Added verified Dockerised workflows' instructions for running Interactive Web & Nav2 Integration demos #48
cardboardcode wants to merge 14 commits into
open-rmf:mainfrom
cardboardcode:feature/dockerfile_nav2sim

Conversation

@cardboardcode

@cardboardcode cardboardcode commented Aug 21, 2026

Copy link
Copy Markdown
Collaborator

New Feature Implementation 🌟

Implemented Feature(s) 📚

  • Provided docker-specific build and run instructions in root README.md and nav2_integration/README.md.
  • Created a verified Dockerfile.nav2 base image file under docker/ which includes the manual steps defined in Setup section of nav2_integration/README.md
  • Surfaced link to Nav2 Integration Demonstration README.md in root README.md to make it more accessible and apparent for new users.

Implementation Description 💬

The docker-centric instructions complement the existing 2 build and run approaches, namely local and distrobox, in root README.md.

It is mainly catered to users who are more familiar with using just docker and to make explicit environment and configurations needed to allow GUI display for Nav2 Integration demonstration.

GenAI Use

We follow OSRA's policy on GenAI tools

  • I used a GenAI tool in this PR.
  • I did not use GenAI ❌

… of the box for docker users.

Signed-off-by: Gary Bey <beyhy94@gmail.com>
…er build approach.

Signed-off-by: Gary Bey <beyhy94@gmail.com>
…yle of previous section header.

Signed-off-by: Gary Bey <beyhy94@gmail.com>
…prototype with linked sub-README.md.

Signed-off-by: Gary Bey <beyhy94@gmail.com>
… README.md with reference to Dockerfile.nav2.

Signed-off-by: Gary Bey <beyhy94@gmail.com>
@mxgrey mxgrey added this to PMC Board Aug 21, 2026
@github-project-automation github-project-automation Bot moved this to Inbox in PMC Board Aug 21, 2026
@cardboardcode cardboardcode self-assigned this Aug 21, 2026
@cardboardcode cardboardcode added the documentation Improvements or additions to documentation label Aug 21, 2026
@cardboardcode
cardboardcode requested a review from arjo129 August 21, 2026 15:10
…ADME.md.

Signed-off-by: Gary Bey <beyhy94@gmail.com>
…vailable for containerized display.

Signed-off-by: Gary Bey <beyhy94@gmail.com>
Comment thread docker/Dockerfile.nav2 Outdated
@@ -0,0 +1,37 @@
ARG ROS_DISTRO=jazzy

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thanks for this docker file! It makes sense to create a separate image for nav2 robots, however right now this docker file will essentially have exactly the same deps as our custom ros2_rust_base development image. This makes me wonder what value this current docker file adds. I do think packaging the nice project nicely is very important so we should think carefully about what "artifacts" we'd like exported.

(PS Id also recommend adding a CI workflow that actually builds any dockerfile that we produce otherwise it'll lead to random floating dockerfiles that are broken/untested later on down the line).

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Ah noted.

The original intent of this Dockerfile.nav2 is to automate the manual installation steps in Manual Setup of Nav2 Demo README.md so users need not have to do so.

Let me run the nav2 simulation with Dockerfile.base file shortly. If the simulation still runs as expected, I would probably have Dockerfile.nav2 removed in favour of less random floating dockerfiles.

Will also look into adding the CI workflow in a seperate PR. Will link here in the thread once available.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Progress Update 💬

Managed to get nav2 integration demo working with just Dockerfile.base and a few proposed changes.

Will remove Dockerfile.nav2 for now.

Signed-off-by: Gary Bey <beyhy94@gmail.com>
…stead of Dockerfile.nav2.

Signed-off-by: Gary Bey <beyhy94@gmail.com>
… colcon-building workspace.

Signed-off-by: Gary Bey <beyhy94@gmail.com>
…tions in wall of text.

Signed-off-by: Gary Bey <beyhy94@gmail.com>
…blish example in nav2 integration package README.md.

Signed-off-by: Gary Bey <beyhy94@gmail.com>
@mxgrey mxgrey moved this from Inbox to In Review in PMC Board Aug 25, 2026
Signed-off-by: Gary Bey <beyhy94@gmail.com>
…lt-in switch to zenoh and cyclone DDS.

Signed-off-by: Gary Bey <beyhy94@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

Status: In Review

Development

Successfully merging this pull request may close these issues.

3 participants