From 2b0da72aee85067d3d426b53f3d554fa0e3a7567 Mon Sep 17 00:00:00 2001 From: "mergify[bot]" <37929162+mergify[bot]@users.noreply.github.com> Date: Thu, 9 May 2024 00:05:46 +0200 Subject: [PATCH] [DOC] add `--no-daemon` and `--spin-time` explanation in readme. (#307) (#308) * add `--no-daemon` and `--spin-time` explanation in readme. * increase `--spin-time` from 3 to 4 seconds based on CI. --------- Signed-off-by: Tomoya Fujita (cherry picked from commit 1a4257d5f2b7f260900286c6722c26904ffdabe3) Co-authored-by: Tomoya Fujita --- SROS2_Linux.md | 11 +++++++---- SROS2_MacOS.md | 11 +++++++---- SROS2_Windows.md | 11 +++++++---- 3 files changed, 21 insertions(+), 12 deletions(-) diff --git a/SROS2_Linux.md b/SROS2_Linux.md index 171c5d07..7caabd56 100644 --- a/SROS2_Linux.md +++ b/SROS2_Linux.md @@ -120,16 +120,19 @@ To be able to use the ros2 CLI tools to interact with your secured system, you n export ROS_SECURITY_ENCLAVE_OVERRIDE=/talker_listener/listener ``` -Then use the CLI as usual: +Then use the CLI with `--no-daemon` and `--spin-time`: + +> [!NOTE] +> Avoid using `ros2 daemon` since it may not have security enclaves, and enough time duration should be given for the discovery in secured network. ```bash -ros2 node list +ros2 node list --no-daemon --spin-time 4 ``` ``` /talker ``` ```bash -ros2 topic list +ros2 topic list --no-daemon --spin-time 4 ``` ``` /chatter @@ -137,7 +140,7 @@ ros2 topic list /rosout ``` ```bash -ros2 topic echo /chatter +ros2 topic echo /chatter --spin-time 4 ``` ``` [INFO] [1714897092.882384995] [rcl]: Found security directory: /root/sros2_demo/demo_keystore/enclaves/talker_listener/listener diff --git a/SROS2_MacOS.md b/SROS2_MacOS.md index 93ca3436..976d1fec 100644 --- a/SROS2_MacOS.md +++ b/SROS2_MacOS.md @@ -130,16 +130,19 @@ To be able to use the ros2 CLI tools to interact with your secured system, you n export ROS_SECURITY_ENCLAVE_OVERRIDE=/talker_listener/listener ``` -Then use the CLI as usual: +Then use the CLI with `--no-daemon` and `--spin-time`: + +> [!NOTE] +> Avoid using `ros2 daemon` since it may not have security enclaves, and enough time duration should be given for the discovery in secured network. ```bash -ros2 node list +ros2 node list --no-daemon --spin-time 4 ``` ``` /talker ``` ```bash -ros2 topic list +ros2 topic list --no-daemon --spin-time 4 ``` ``` /chatter @@ -147,7 +150,7 @@ ros2 topic list /rosout ``` ```bash -ros2 topic echo /chatter +ros2 topic echo /chatter --spin-time 4 ``` ``` [INFO] [1714897092.882384995] [rcl]: Found security directory: /root/sros2_demo/demo_keystore/enclaves/talker_listener/listener diff --git a/SROS2_Windows.md b/SROS2_Windows.md index c0e458d4..0e1db9e1 100644 --- a/SROS2_Windows.md +++ b/SROS2_Windows.md @@ -129,16 +129,19 @@ To be able to use the ros2 CLI tools to interact with your secured system, you n set ROS_SECURITY_ENCLAVE_OVERRIDE=/talker_listener/listener ``` -Then use the CLI as usual: +Then use the CLI with `--no-daemon` and `--spin-time`: + +> [!NOTE] +> Avoid using `ros2 daemon` since it may not have security enclaves, and enough time duration should be given for the discovery in secured network. ```bat -ros2 node list +ros2 node list --no-daemon --spin-time 4 ``` ``` /talker ``` ```bat -ros2 topic list +ros2 topic list --no-daemon --spin-time 4 ``` ``` /chatter @@ -146,7 +149,7 @@ ros2 topic list /rosout ``` ```bat -ros2 topic echo /chatter +ros2 topic echo /chatter --spin-time 4 ``` ``` [INFO] [1714897092.882384995] [rcl]: Found security directory: /root/sros2_demo/demo_keystore/enclaves/talker_listener/listener