chore: add INSTALL_WORKERS_PATH var and docs for it (#52)

Author: leoparente

agent/docker/orb-agent-entry.sh

@@ -22,6 +22,12 @@ if [ "${INSTALL_DRIVERS_PATH}" != '' ]; then
   pip3 install -r ${INSTALL_DRIVERS_PATH}
 fi
 
+if [ "${INSTALL_WORKERS_PATH}" != '' ]; then
+  cd $(dirname "$(realpath "$INSTALL_WORKERS_PATH")")
+  echo "Installing custom orb workers"
+  pip3 install -r ${INSTALL_WORKERS_PATH}
+fi
+
 # check geodb folder and extract db
 cd /geo-db/
 if [ -f "asn.mmdb.gz" ]; then

docs/backends/worker.md

@@ -49,4 +49,24 @@ orb:
           schedule: "* * * * *"
           custom_config: custom
         scope:
-          custom: any
+          custom: any
+```
+
+### Custom Workers
+To specify required custom workers packages, use the environment variable `INSTALL_WORKERS_PATH`. Ensure that the required files are placed in the mounted volume (`/opt/orb`).
+
+Mounted folder example:
+```sh
+/local/orb/
+├── agent.yaml
+├── workers.txt
+├── my-worker/
+└── nbl-custom-worker-1.0.2.tar.gz
+```
+
+Example `workers.txt`:
+```txt
+my-custom-wkr==0.1.2 # try install from pypi
+nbl-custom-worker-1.0.2.tar.gz # try install from a tar.gz
+./my-worker # try to install from a folder that contains project.toml
+```

docs/config_samples.md

@@ -96,4 +96,55 @@ Run command:
  docker run -v /local/orb:/opt/orb/ \
  -e DIODE_API_KEY={YOUR_API_KEY} \
  netboxlabs/orb-agent:latest run -c /opt/orb/agent.yaml
-```
+```
+
+## Worker backend
+```yaml
+orb:
+  config_manager:
+    active: local
+  backends:
+    worker:
+    common:
+      diode:
+        target: grpc://192.168.31.114:8080/diode
+        api_key: ${DIODE_API_KEY}
+        agent_name: agent02
+  policies:
+    worker:
+      policy_1:
+        config:
+          package: my_worker #Required
+          schedule: "0 */2 * * *"
+          custom_config: config
+        scope:
+          custom_val: value
+```
+
+### Custom Workers
+To specify required custom workers packages, use the environment variable `INSTALL_WORKERS_PATH`. Ensure that the required files are placed in the mounted volume (`/opt/orb`).
+
+Mounted folder example:
+```sh
+/local/orb/
+├── agent.yaml
+├── workers.txt
+├── my-worker/
+└── nbl-custom-worker-1.0.2.tar.gz
+```
+
+Example `workers.txt`:
+```txt
+my-custom-wkr==0.1.2 # try install from pypi
+nbl-custom-worker-1.0.2.tar.gz # try install from a tar.gz
+./my-worker # try to install from a folder that contains project.toml
+```
+
+Run command:
+```sh
+ docker run -v /local/orb:/opt/orb/ \
+ -e DIODE_API_KEY={YOUR_API_KEY} \
+ -e INSTALL_WORKERS_PATH=/opt/orb/workers.txt \
+ netboxlabs/orb-agent:latest run -c /opt/orb/agent.yaml
+```
+The relative path used by `pip install` should point to the directory containing the `.txt` file.