Skip to content

Commit

Permalink
Refs #22575: Updated and corrected the Docker section
Browse files Browse the repository at this point in the history
Signed-off-by: Juanjo Garcia <[email protected]>
  • Loading branch information
juanjo4936 committed Jan 14, 2025
1 parent 4b07c8d commit 1279e6b
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 37 deletions.
38 changes: 8 additions & 30 deletions docs/rst/docker/docker_demo/fast_dds_suite.rst
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ To load this image into your Docker repository, from a terminal run

.. code-block:: bash
$ docker load -i ubuntu-fastdds-suite:<FastDDS-Version>.tar
$ docker load -i ubuntu-fastdds-suite\ <FastDDS-Version>.tar
You can run this Docker container as follows

Expand Down Expand Up @@ -70,9 +70,9 @@ This is a minimal example that will perform a Publisher/Subscriber match and sta
.. code-block:: bash
$ goToExamples
$ cd HelloWorldExample/bin
$ tmux new-session "./HelloWorldExample publisher 0 1000" \; \
split-window "./HelloWorldExample subscriber" \; \
$ cd hello_world/bin
$ tmux new-session "./hello_world publisher 0 1000" \; \
split-window "./hello_world subscriber" \; \
select-layout even-vertical
This example is not constrained to the current instance. It is possible to run several instances of this
Expand All @@ -81,38 +81,16 @@ container to check the communication between them by running the following from
.. code-block:: bash
$ goToExamples
$ cd HelloWorldExample/bin
$ ./HelloWorldExample publisher
$ cd hello_world/bin
$ ./hello_world publisher
or

.. code-block:: bash
$ goToExamples
$ cd HelloWorldExample/bin
$ ./HelloWorldExample subscriber
Benchmark Example
^^^^^^^^^^^^^^^^^

This example creates either a Publisher or a Subscriber and on a successful match starts sending samples. After a
few seconds the process that launched the Publisher will show a report with the number of samples transmitted.

On the subscriber side, run:

.. code-block:: bash
$ goToExamples
$ cd Benchmark/bin
$ ./Benchmark subscriber udp
On the publisher side, run:

.. code-block:: bash
$ goToExamples
$ cd Benchmark/bin
$ ./Benchmark publisher udp
$ cd hello_world/bin
$ ./hello_world subscriber
.. _fast_dds_suite_shapes_demo:

Expand Down
6 changes: 4 additions & 2 deletions docs/rst/docker/includes/intro.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
eProsima provides the eProsima Fast DDS Suite Docker image for those who want a quick demonstration of Fast DDS running on an Ubuntu
platform. It can be downloaded from `eProsima's downloads page <https://eprosima.com/index.php/downloads-all>`_.
platform. It can be downloaded from `eProsima's downloads page <https://eprosima.com/index.php/downloads-all>`_,
under eProsima Fast DDS. Choosing a suitable FastDDS version, the file is named
``ubuntu-fastdds-suite <FastDDS-Version>.tar``.

This Docker image was built for Ubuntu 20.04 (Focal Fossa).
This Docker image was built for Ubuntu 22.04 (Jammy Jellyfish).

To run this container you need Docker installed. From a terminal run

Expand Down
9 changes: 4 additions & 5 deletions docs/rst/installation/linux.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,9 @@ There are two mechanisms for running the monitor application.
============================

The first option is to install the *Fast DDS monitor* application together with all its dependencies.
To do so, first run the ``eProsima_Fast-DDS-Monitor-vX.X.X-Linux.run`` executable, , where ``vX.X.X`` is the version
of the application,
(you might need to make the file executable by running ``chmod +x eProsima_Fast-DDS-Monitor-vX.X.X-Linux.run`` first)
To do so, first run the ``eProsima_Fast-DDS-Monitor-<FastDDS-Version>-Linux.run`` executable,
(you might need to make the file executable by running
``chmod +x eProsima_Fast-DDS-Monitor-<FastDDS-Version>-Linux.run`` first)
and follow the instructions it provides to install the program in a directory on the system.

.. figure:: /rst/figures/installer_linux.png
Expand All @@ -34,8 +34,7 @@ and follow the instructions it provides to install the program in a directory on
In this case, download this version from the
`eProsima Downloads website <https://www.eprosima.com/index.php/downloads-all>`_ and run the downloaded
file to launch the monitor.
The name of this file is ``eProsima_Fast-DDS-Monitor-vX.X.X-Linux.AppImage``, where ``VX.X.X`` is the version of the
application.
The name of this file is ``eProsima_Fast-DDS-Monitor-<FastDDS-Version>-Linux.AppImage``.


.. warning::
Expand Down

0 comments on commit 1279e6b

Please sign in to comment.