[ROS] Update Official Docker image docs #2578
Conversation
as final ROS 1 version, Noetic, is now EOL
as docs page is more up-to-date and pertinent for users
to avoid docs from becoming stale
as example to save on image size as well as on build time using caching
for readability of each stage
and update rosdep along with apt list to ensure package index is fresh
to include additional relevant entries
to focus on primary targets
accounting for included docker-clean default
to avoid running rosdep update for each source change as docker build --no-cache can still be used to force update
|
@mikaelarguedas or @tfoote , could you take a look this? Think it's about ready to go. Thanks! |
|
looks great overall ! agreed with Tully's comment maybe using |
while keeping with uniquely spelled noun that is self descriptive yet unmistakable
For reproducibility, I'd generally like to discourage implicit or explicit use of Also, this exemplifies how to postfix an ARG to minimize the runtime image, and Line 113 in 5f3ac57 |
|
Oof, sorry, I was under the assumption it was still a WIP because GitHub doesn't send an email for "ruffsl marked this pull request as ready for review 3 weeks ago" 🙃 🙇 Will review ASAP. |
| cat <<EOF > /etc/apt/apt.conf.d/docker-clean && apt-get update | ||
| APT::Install-Recommends "false"; | ||
| APT::Install-Suggests "false"; | ||
| EOF |
There was a problem hiding this comment.
This file (/etc/apt/apt.conf.d/docker-clean) already exists in the image -- did you overwrite that content on purpose, or did you intend for this to go to a different filename?
There was a problem hiding this comment.
Yeah, the overwrite was intentional to remove the prior rule that cleans the deb cache after dpkg is invoked.
It might be a too cute, but wanted to keep the example succinct , avoiding unnecessary rm or mv commands.
There was a problem hiding this comment.
It wasn't immediately clear to me why you'd want to remove that configuration -- maybe it warrants a comment that explains why / that this is intentional?
| COPY --from=cacher /tmp/exec_debs.txt /tmp/exec_debs.txt | ||
| RUN --mount=type=cache,target=/etc/apt/apt.conf.d,from=cacher,source=/etc/apt/apt.conf.d \ |
There was a problem hiding this comment.
You could do this in the builder stage too, but since this is the final stage it might be worth adding exec_debs.txt to a --mount instead so the file doesn't end up in the final image.
| COPY --from=cacher /tmp/exec_debs.txt /tmp/exec_debs.txt | |
| RUN --mount=type=cache,target=/etc/apt/apt.conf.d,from=cacher,source=/etc/apt/apt.conf.d \ | |
| RUN --mount=type=bind,from=cacher,source=/tmp/exec_debs.txt,target=/tmp/exec_debs.txt \ | |
| --mount=type=cache,target=/etc/apt/apt.conf.d,from=cacher,source=/etc/apt/apt.conf.d \ |
There was a problem hiding this comment.
I thought about doing that, but figured including the derived list of runtime dependencies in the output image could be more helpful for traceability and transparent debugging of the same layerer downstream. Users could of course docker build --target=cacher ... and inspect that intermediate image, but wouldn't propagate receipts.
Refreshes the ROS documentation using updated links, cleans out old content, and improves the demo examples.
Related: