Skip to content

Commit 4c1c555

Browse files
author
Murilo M. Marinho
committed
[docker] Adding draft notice.
1 parent f681298 commit 4c1c555

File tree

1 file changed

+15
-2
lines changed

1 file changed

+15
-2
lines changed

docs/source/docker/index.rst

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
How is Murilo using :program:`docker`
22
=====================================
33

4+
.. important::
5+
6+
This section is a working draft.
7+
48
Installation
59
------------
610
.. note::
@@ -101,12 +105,13 @@ Docker compose
101105
++++++++++++++
102106

103107
If your host does not have :program:`ROS2` you can also have multiple containers communicating with each
104-
other without any direct involvement of the host. For instance with the following compose file.
108+
other without any direct involvement of the host. For instance with the following compose file named
109+
:file:`compose.yml` below.
105110

106111
.. literalinclude:: scripts/composer/simple_example/compose.yml
107112
:language: yaml
108113

109-
That we can execute with the following command
114+
In the folder where :file:`compose.yml` exists, we do
110115

111116
.. code-block::
112117
@@ -118,6 +123,9 @@ That we can execute with the following command
118123
around for docker compose to do something similar to ``--rm`` as in :program:`docker`. In tutorials it
119124
is convenient to always start frash but this will cause data to be lost in the container when it's closed.
120125

126+
This will show the output of the two images communicating over :program:`ROS2`. Notice that there is no input
127+
from the host and no complicated network setup involved.
128+
121129
You can stop the process with ``CTRL+C``. Note that we are using ``stop_signal: SIGINT`` in the docker compose
122130
file because otherwise it will send ``SIGTERM``. In this toy example this is not an issue, but this is a major
123131
issue for nodes that control real resources. This can mean that a robot will not be safely disconnected before
@@ -126,6 +134,11 @@ to give the container enough time to close safely. Depending on your resource yo
126134
value so that it is not escalated into a ``SIGTERM`` or ``SIGKILL`` before your container had enough time to
127135
sort out its shutdown procedure.
128136

137+
Docker container in a realtime kernel
138+
-------------------------------------
139+
140+
TODO
141+
129142
Common mistakes
130143
---------------
131144

0 commit comments

Comments
 (0)