Add some scripts to use docker and a README.rst

Author: roboticswithjulia

docker/Dockerfile renamed to Dockerfile

@@ -41,7 +41,7 @@ cargo install --debug cargo-ament-build  # --debug is faster to install
 pip install git+https://github.com/colcon/colcon-cargo.git
 pip install git+https://github.com/colcon/colcon-ros-cargo.git
 
-mkdir -p workspace/src && cd workspace
+mkdir -p ~/workspace/src && cd ~/workspace
 git clone https://github.com/ros2-rust/ros2_rust.git src/ros2_rust
 vcs import src < src/ros2_rust/ros2_rust_humble.repos
 . /opt/ros/humble/setup.sh

README.md

@@ -0,0 +1,96 @@
+#.. redirect-from::
+#
+#    Deploying-ROS2-on-IBM-Cloud
+#    Tutorials/Deploying-ROS-2-on-IBM-Cloud
+
+ROS2 Rust Docker Environment
+=========================================================
+
+This folder contains scripts to build, start, and interact with a Docker container for a ROS2 Rust environment.
+
+.. contents:: Table of Contents
+   :depth: 3
+   :local:
+
+Prerequisites
+-------------
+
+Ensure you have the following installed on your system:
+
+-  `Docker <https://docs.docker.com/engine/install/>`__
+- Permissions to run Docker commands (sudo may be required on some systems). 
+
+
+
+Files in the Folder
+-------------------
+
+- `build.sh <./build.sh>`_: Builds the Docker image.
+- `start.sh <./start.sh>`_: Starts the Docker container.
+- `shell.sh <./shell.sh>`_: Accesses the running container
+
+
+Steps to Use
+------------
+
+1. Build the Docker Image
+~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Run the ``build.sh`` script to build the Docker image:
+
+.. code-block:: bash
+
+   $ ./build.sh
+
+This script:
+
+- Builds a Docker image named ``ros2_rust:latest``.
+- Uses ``BUILDKIT`` for efficient caching and builds.
+
+
+2. Start the Docker Container
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Run the ``start.sh`` script to start the container:
+
+.. code-block:: bash
+
+   $ ./start.sh
+
+This script:
+
+- Checks if a container based on the ros2_rust image exists and removes it if necessary.
+- Starts a new container named ros2_rust with the following settings:
+      - **Interactive mode** (``-it``).
+      - **User ID Mapping**: Maps the current user (ID ``1000``) to the container user cuser. 
+      - **Privileges**: Grants ``sudo`` group membership and system capabilities (e.g., sys_nice).
+      - **Networking**: Uses the host's network stack.
+      - **X11 Forwarding**: Allows graphical applications to be displayed on the host system.
+
+
+3. Access the Running Container
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Run the ``shell.sh`` script to open an interactive shell in the running container:
+
+.. code-block:: bash
+
+   $ ./shell.sh
+
+This script:
+
+- Opens a Bash shell as the user ``cuser``.
+- Sets the working directory to ``/home/cuser/workspace``.
+
+
+4. Install ros2 rust packages
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Follow the `README.md <../README.md>`_ file to install the overall packages needed to start working with ROS2 and Rust.
+
+
+Notes
+-----
+- If you encounter permission issues with X11, ensure the host system is configured to allow access in each terminal:
+
+.. code-block:: bash
+
+   $ xhost local:root

docker/README.rst

@@ -1,6 +1,6 @@
 echo -e "Building ros2_rust:lastest image"
 name=ros2_rust
 DOCKER_BUILDKIT=1 \
-docker build --pull --rm -f ./Dockerfile \
+docker build --pull --rm -f ../Dockerfile \
 --build-arg BUILDKIT_INLINE_CACHE=1 \
 --tag $name:latest .

docker/build.sh

@@ -1,2 +1,2 @@
-name=ros2_rust
-exec docker exec -it $name sudo -u cuser -i /bin/bash -c "cd ~/workspace && exec /bin/bash"
+NAME=ros2_rust
+exec docker exec -it $NAME sudo -u cuser -i /bin/bash -c "cd ~/workspace && exec /bin/bash"

docker/shell.sh

@@ -1,21 +1,29 @@
-cuser_id="1000"
-container_user="cuser"
+CUSER_ID="1000"
+CONTAINER_USER="cuser"
 
-name=ros2_rust
+IMAGE_NAME=ros2_rust
 
-docker stop $name
-docker rm -f $name
+# Check if there are any containers created from the image
+CONTAINERS=$(docker ps -a --filter "ancestor=$IMAGE_NAME" -q)
+
+if [ -n "$CONTAINERS" ]; then
+  echo "Image has been used to start a container. Removing it."
+  docker stop $IMAGE_NAME
+  docker rm -f $IMAGE_NAME
+else
+  echo "Image has not been started. Skipping removal."
+fi
 
 echo -e "Starting up ros2_rust container \n >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>"
 
 docker run -it --privileged \
-    --user=${cuser_id}:${cuser_id}\
+    --user=${CUSER_ID}:${CUSER_ID}\
     --group-add sudo \
     --env="DISPLAY" \
     --env="QT_X11_NO_MITSHM=1" \
-    --workdir="/home/${container_user}/workspace" \
+    --workdir="/home/${CONTAINER_USER}/workspace" \
     --volume="/tmp/.X11-unix:/tmp/.X11-unix:rw" \
     --net=host \
     --cap-add=sys_nice \
-    --name=$name \
-    $name \
+    --name=$IMAGE_NAME \
+    $IMAGE_NAME \