Skip to content

Commit 42bc379

Browse files
authored
[index.rst] Fix for clarity.
1 parent ab099db commit 42bc379

1 file changed

Lines changed: 17 additions & 29 deletions

File tree

docs/source/docker/index.rst

Lines changed: 17 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,8 @@
1-
How is Murilo using :program:`docker`
2-
=====================================
1+
Happy days with :program:`docker`
2+
=================================
33

4-
.. important::
5-
6-
This section is a working draft.
74

8-
It is an Ubuntu 24.04 host tutorial. It might work in other host systems in some cases
9-
but the support is finicky for more advanced elements.
5+
.. include:: ../the_topic_is_under_heavy_construction.rst
106

117
Installation
128
------------
@@ -78,8 +74,7 @@ Basic testing
7874
SAS testing
7975
-----------
8076

81-
For the purposes of this illustration we will use the image
82-
``murilomarinho/sas``.
77+
For the purposes of this illustration we will use the image ``murilomarinho/sas``.
8378

8479
Docker run interactively
8580
++++++++++++++++++++++++
@@ -133,9 +128,7 @@ Then, in the container and in the host we do as follows.
133128
be also modified in the host or they will not find and communicate with each other.
134129

135130
Notice that host and container will communicate without any issues. Changing the network settings of the
136-
docker container may cause this to stop working. For instance, a very popular setting is to use
137-
``--net=host``. This is not recommended unless strictly necessary because it will generate issues
138-
with :program:`ROS2` networking.
131+
docker container may cause this to stop working.
139132

140133
Docker compose
141134
++++++++++++++
@@ -182,8 +175,8 @@ Install PREEMPT_RT
182175

183176
.. seealso::
184177

185-
*. https://ubuntu.com/real-time
186-
*. https://canonical-ubuntu-pro-client.readthedocs-hosted.com/en/latest/howtoguides/enable_realtime_kernel/
178+
#. https://ubuntu.com/real-time
179+
#. https://canonical-ubuntu-pro-client.readthedocs-hosted.com/en/latest/howtoguides/enable_realtime_kernel/
187180

188181
.. code-block:: console
189182
@@ -199,8 +192,8 @@ Install PREEMPT_RT
199192
200193
ps -eLfc | grep FF
201194
202-
Common issues
203-
-------------
195+
Tips and troubeshooting
196+
-----------------------
204197

205198
This documents part of my own misunderstandings when getting used to docker (which is an ongoing process) and other difficulties that are
206199
contributed by others.
@@ -248,17 +241,17 @@ Noninteractive shells by default do not expand aliases.
248241

249242
The "easiest" solution is
250243

251-
#. Set your :file:`Dockerfile` to source /etc/bash_env`
244+
#. Set your :file:`Dockerfile` to source ``/etc/bash_env``
252245
#. Add ``source source /etc/bash_env`` to your :file:`~/.bashrc` exactly once.
253246

254-
--net=host
255-
++++++++++
247+
Stop with the ``--net=host`` for everything
248+
+++++++++++++++++++++++++++++++++++++++++++
256249

257250
.. seealso::
258251

259-
*. https://robotics.stackexchange.com/questions/98161/ros2-foxy-nodes-cant-communicate-through-docker-container-border
260-
*. https://github.com/rosblox/ros-template
261-
*. https://github.com/eProsima/Fast-DDS/issues/1750
252+
#. https://robotics.stackexchange.com/questions/98161/ros2-foxy-nodes-cant-communicate-through-docker-container-border
253+
#. https://github.com/rosblox/ros-template
254+
#. https://github.com/eProsima/Fast-DDS/issues/1750
262255

263256
Although this command can help in some situations it is not recommended unless strictly
264257
necessary. It can for instance cause :program:`ros2` to no longer be able to communicate between
@@ -312,13 +305,8 @@ Then, in the container, you can set before the nodes.
312305
313306
export FASTRTPS_DEFAULT_PROFILES_FILE="~/ros2_tutorial_workspace/docker/fastrtps_profile.xml"
314307
315-
Notes on rootless docker
316-
++++++++++++++++++++++++
317-
318-
.. note::
319-
320-
I am a strong proponent of this capability and will be happy to use it when
321-
it's working in a less demanding way.
308+
Sad notes on rootless :program:`docker`
309+
+++++++++++++++++++++++++++++++++++++++
322310

323311
Although ideally having a rootless docker environment is what would be expected
324312
in a situation with shared computers and equipment the experience as of now adds

0 commit comments

Comments
 (0)