Skip to content

Commit f40a7a6

Browse files
rohitkatakolajagadi1
rohitkatakol
and
ajagadi1
authored
[Manufacturing AI Suite] DLStreamer pipeline server: Add explanation to (#618)
Signed-off-by: Katakol, Rohit <rohit.katakol@intel.com> Co-authored-by: Ashish Jagadish <ashish.jagadish@intel.com>
1 parent 5faaf3b commit f40a7a6

1 file changed

Lines changed: 87 additions & 37 deletions

File tree

‎microservices/dlstreamer-pipeline-server/docs/user-guide/environment-variables.md‎

Lines changed: 87 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -3,72 +3,122 @@ DL Streamer Pipeline Server microservice's configuration is defined via environm
33

44
## Mandatory
55
### Enable and specify port for REST server
6-
- **REST_SERVER_PORT** `(integer)`
6+
- **REST_SERVER_PORT (Integer)** - Port on which REST Server is hosted
7+
- Example: `REST_SERVER_PORT=8080`
78

89
### RTSP related config
9-
- **ENABLE_RTSP** `(boolean)`
10-
- **RTSP_PORT** `(integer)`
11-
- **RTSP_CAMERA_IP** `(string)`
10+
- **RTSP_CAMERA_IP (String)** - IP address of RTSP camera.
11+
- Example: `RTSP_CAMERA_IP=<ip-addr>`
1212

1313
### Username and ID
14-
- **PIPELINE_SERVER_USER** `(string)`
15-
- **UID** `(integer)`
14+
- **PIPELINE_SERVER_USER (String)** - Name of the user inside the dlstreamer pipeline server container
15+
- Example: `PIPELINE_SERVER_USER=intelmicroserviceuser`
16+
- **UID (Integer)** - User ID permissions for the above defined user
17+
- Example: `UID=1999`
1618

1719
### proxy settings
18-
- **http_proxy** `(boolean)`
19-
- **https_proxy** `(boolean)`
20-
- **no_proxy** `(string)`
20+
- **http_proxy (String)** - IP address and port of `http_proxy` server.
21+
- Example: `http_proxy=http:<ip-addr>:<port>`
22+
- **https_proxy (String)** - - IP address and port of `https_proxy` server.
23+
- Example: `https_proxy=http:<ip-addr>:<port>`
24+
- **no_proxy (String)** - - IP address and port of `no_proxy` server.
25+
- Example: `no_proxy=http:<ip-addr>:<port>`
2126

2227
## Optional
2328

2429
### MQTT related configs
25-
- **MQTT_HOST** `(string)`
26-
- **MQTT_PORT** `(integer)`
30+
- **MQTT_HOST (String)** - IP address of machine on which MQTT broker is hosted
31+
- Example: `MQTT_HOST=<ip-addr>`
32+
- **MQTT_PORT (Integer)** - Port on which MQTT service is running
33+
- Example: `MQTT_PORT=1883`
2734

2835
### S3 related settings (Configure only if S3 integration is enabled)
29-
- **S3_STORAGE_HOST** `(string)`
30-
- **S3_STORAGE_PORT** `(integer)`
31-
- **S3_STORAGE_USER** `(string)`
32-
- **S3_STORAGE_PASS** `(string)`
36+
- **S3_STORAGE_HOST (String)** - IP address of machine on which S3 storage service is hosted
37+
- Example: `S3_STORAGE_HOST=<ip-addr>`
38+
- **S3_STORAGE_PORT (Integer)** - Port on which S3 stroage service is running
39+
- Example: `S3_STORAGE_PORT=9000`
40+
- **S3_STORAGE_USER (String)** - Username to login into S3 storage service
41+
- Example: `S3_STORAGE_USER=minioadmin`
42+
- **S3_STORAGE_PASS (String)** - Password to login into S3 storage service
43+
- Example: `S3_STORAGE_PASS=minioadmin`
3344

3445
### OPCUA related configuration (Configure only if OPCUA is enabled)
35-
- **OPCUA_SERVER_IP** `(string)`
36-
- **OPCUA_SERVER_PORT** `(integer)`
37-
- **OPCUA_SERVER_USERNAME** `(string)`
38-
- **OPCUA_SERVER_PASSWORD** `(string)`
46+
- **OPCUA_SERVER_IP (String)** - IP address of the OPCUA server
47+
- Example: `OPCUA_SERVER_IP=<ip-addr>`
48+
- **OPCUA_SERVER_PORT (Integer)** - Port on which OPCUA service is running
49+
- Example: `OPCUA_SERVER_PORT=48010`
50+
- **OPCUA_SERVER_USERNAME (String)** - Username to login into OPCUA server
51+
- Example: `OPCUA_SERVER_USERNAME=root`
52+
- **OPCUA_SERVER_PASSWORD (String)** - Password to login into OPCUA server
53+
- Example: `OPCUA_SERVER_PASSWORD=secret`
3954

4055
### Open Telemetry related config (Configure only if open telemetry is enabled)
41-
- **ENABLE_OPEN_TELEMETRY** `(boolean)`
42-
- **OTEL_COLLECTOR_HOST** `(string)`
43-
- **OTEL_COLLECTOR_PORT** `(integer)`
44-
- **OTEL_EXPORT_INTERVAL_MILLIS** `(integer)`
45-
- **SERVICE_NAME** `(string)`
46-
- **PROMETHEUS_PORT** `(int)`
56+
- **ENABLE_OPEN_TELEMETRY (Boolean)** - Set to `true` to enable open telemetry. Set to `false` to disable open telemetry
57+
- Example: `ENABLE_OPEN_TELEMETRY=true`
58+
- Example: `ENABLE_OPEN_TELEMETRY=false`
59+
- **OTEL_COLLECTOR_HOST (String)** - Name of open telemetry service or IP address of machine on which open telemetry service is hosted
60+
- Example: `OTEL_COLLECTOR_HOST=otel-collector`
61+
- Example: `OTEL_COLLECTOR_HOST=<ip-addr>`
62+
- **OTEL_COLLECTOR_PORT (Integer)** - Port on which open telemetry service is running
63+
- Example: `OTEL_COLLECTOR_PORT=4318`
64+
- **OTEL_EXPORT_INTERVAL_MILLIS (Integer)** - Time interval (in milliseconds) between each export of telemetry data
65+
- Example: `OTEL_EXPORT_INTERVAL_MILLIS=5000`
66+
- **SERVICE_NAME (String)** - Name given to service or application producing telemetry data
67+
- Example: `SERVICE_NAME=my-service`
68+
- **PROMETHEUS_PORT (Integer)** - Port on which Prometheus metrics are exposed
69+
- Example: `PROMETHEUS_PORT=9999`
4770

4871
### Webrtc related config (Configure only if WebRTC is enabled)
49-
- **ENABLE_WEBRTC** `(boolean)`
50-
- **WHIP_SERVER_IP** `(string)`
51-
- **WHIP_SERVER_PORT** `(integer)`
72+
- **WHIP_SERVER_IP (String)** - IP address of machine on which open mediamtx container is running
73+
- Example: `WHIP_SERVER_IP=<ip-addr>`
74+
- **WHIP_SERVER_PORT (Integer)** - Port on which mediamtx server is running
75+
- Example: `WHIP_SERVER_PORT=8889`
5276

5377
### Miscellaneous env variables
54-
- **GST_DEBUG**=1 : Enable GST debug logs
55-
- **ADD_UTCTIME_TO_METADATA**=true : Add UTC timestamp in metadata by DL Streamer Pipeline Server publisher
56-
- **HTTPS**=false : Make it `true` to enable SSL/TLS secure mode, mount the generated certificates
57-
- **MTLS_VERIFICATION**=false : Enable/disable client certificate verification for mTLS Model Registry Microservice
58-
- **MR_URL**= : Sets the URL where the model registry microservice is accessible (e.g., `http://10.100.10.100:32002` or `http://model-registry:32002`).
78+
- **GST_DEBUG (Integer)** - Enable GST debug logs
79+
- Example: `GST_DEBUG=1`
80+
- **ADD_UTCTIME_TO_METADATA (Boolean)** - Add UTC timestamp in metadata by DL Streamer Pipeline Server publisher
81+
- Example: `ADD_UTCTIME_TO_METADATA=true`
82+
- Example: `ADD_UTCTIME_TO_METADATA=false`
83+
- **HTTPS (Boolean)** - Make it `true` to enable SSL/TLS secure mode, mount the generated certificates
84+
- Example: `HTTPS=true`
85+
- Example: `HTTPS=false`
86+
- **MTLS_VERIFICATION (Boolean)** - Enable/disable client certificate verification for mTLS Model Registry Microservice
87+
- Example: `MTLS_VERIFICATION=true`
88+
- Example: `MTLS_VERIFICATION=false`
89+
- **MR_URL (String)** - Sets the URL where the model registry microservice is accessible
90+
- Example: MR_URL=`http://10.100.10.100:32002`
91+
- Example: MR_URL=`http://model-registry:32002`
5992
- In order to connect to the model registry using its hostname, the DL Streamer Pipeline Server and model registry has to belong to the same shared network.
6093
- If not set or left empty, the DL Streamer Pipeline Server will not be able to connect to the model registry successfully.
61-
- **MR_SAVED_MODELS_DIR**=./mr_models : Sets the directory path where the DL Streamer Pipeline Server stores models downloaded from the model registry microservice.
94+
- **MR_SAVED_MODELS_DIR (String)** - Sets the directory path where the DL Streamer Pipeline Server stores models downloaded from the model registry microservice.
95+
- Example: `MR_SAVED_MODELS_DIR=./mr_models`
6296
- The `.` (dot) refers to the current working directory inside the DL Streamer Pipeline Server container.
6397
- For example, if the container's working directory is `/home/pipeline-server`, then `./mr_models` means `/home/pipeline-server/mr_models`.
6498
- You can configure the volume mount for this directory in your respective `docker-compose.yml` file.
6599
- If not set, it defaults to `./mr_models`.
66-
- **MR_REQUEST_TIMEOUT**=300 : Sets the timeout for requests sent to the model registry microservice.
100+
- **MR_REQUEST_TIMEOUT (Integer)** - Sets the timeout for requests sent to the model registry microservice.
101+
- Example: `MR_REQUEST_TIMEOUT=300`
67102
- If not set, it defaults to `300`.
68-
- **MR_VERIFY_CERT**=/run/secrets/ModelRegistry_Server/ca-bundle.crt : Specifies how SSL certificate verification is handled when communicating with the model registry microservice.
103+
- **MR_VERIFY_CERT (String)** - Specifies how SSL certificate verification is handled when communicating with the model registry microservice.
104+
- Example: `MR_VERIFY_CERT=/run/secrets/ModelRegistry_Server/ca-bundle.crt`
105+
- Example: `MR_VERIFY_CERT=yes`
69106
- This variable is only used if `MR_URL` contains `https`
70107
- If not set, it defaults to `/run/secrets/ModelRegistry_Server/ca-bundle.crt`
71108
- To enable SSL certificate verification using the system's default CA bundle, set this variable to: `yes`, `y`, `true`, `t`, or `1`
72109
- To verify the certificates issued by CAs not included in the system's default bundle, set it to the file or directory path that contains the custom CA bundle
73110
- To disable verification, set it to: `no`, `n`, `false`, `f`, `0`, or leave it empty
74-
- **LOG_LEVEL**=INFO : Set the logging level for DL Streamer Pipeline Server
111+
- **LOG_LEVEL (String)** - Set the logging level for DL Streamer Pipeline Server
112+
- Example: `LOG_LEVEL=INFO`
113+
- Example: `LOG_LEVEL=DEBUG`
114+
- Example: `LOG_LEVEL=ERROR`
115+
- Example: `LOG_LEVEL=WARN`
116+
- **BASE_IMAGE (String)** - Base image name to be used to build the DLStreamer pipeline server docker
117+
- Example: `BASE_IMAGE=<base-image-name>`
118+
- **DLSTREAMER_PIPELINE_SERVER_IMAGE (String)** - Final image name to be given after successful build of DLStreamer pipeline server
119+
- Example: `DLSTREAMER_PIPELINE_SERVER_IMAGE=intel/dlstreamer-pipeline-server:3.1.0-ubuntu22`
120+
- **BUILD_TARGET (String)** - Option to select the target build for DLStreamer pipeline server. Use `dlstreamer-pipeline-server` for optimized image and `dlstreamer-pipeline-server-extended` for extended image
121+
- Example: `BUILD_TARGET=dlstreamer-pipeline-server`
122+
- Example: `BUILD_TARGET=dlstreamer-pipeline-server-extended`
123+
- **DLSTREAMER_PIPELINE_SERVER_DOCKERFILE (String)** - Path to docker file during building of DLStreamer pipeline server
124+
- Example: `DLSTREAMER_PIPELINE_SERVER_DOCKERFILE=Dockerfile`

0 commit comments

Comments
 (0)