ft-orchestration add settings explanation

Author: pascal260303

tools/ft-orchestration/src/probe/cento.py

@@ -56,6 +56,17 @@
 @typed_dataclass
 @dataclass
 class CentoSettings(ABC):
+    """
+    These settings can be set in the probes.yml under `connector:`\\
+    For example with:
+    ```
+    connector:
+        sample_rate: "1:1"
+    ```
+    For information on possible values see `cento --help`\\
+    If it's not clear which setting affects which arg see `SETTINGS_TO_ARGS` dict above\\
+    Settings not in that dict are ignored
+    """
     # general options
     interfaces: List[str] = required_field()
     active_timeout: int = 300

tools/ft-orchestration/src/probe/nprobe.py

@@ -60,6 +60,17 @@
 @typed_dataclass
 @dataclass
 class NProbeSettings(ABC):
+    """
+    These settings can be set in the probes.yml under `connector:`\\
+    For example with:
+    ```
+    connector:
+        sample_rate: "1:1"
+    ```
+    For information on possible values see `nprobe --help` or `nprobe -H`\\
+    If it's not clear which setting affects which arg see `SETTINGS_TO_ARGS` dict above\\
+    Settings not in that dict are ignored
+    """
     # general options
     interfaces: List[str] = required_field()
     active_timeout: int = 300