Skip to content

Commit 7f4d27b

Browse files
authored
[DL Streamer Pipeline Server] Update helm chart and docs (open-edge-platform#632)
1 parent 44a06ea commit 7f4d27b

File tree

6 files changed

+21
-22
lines changed

6 files changed

+21
-22
lines changed

microservices/dlstreamer-pipeline-server/README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -123,6 +123,8 @@ Now you have successfully run the Deep Learning Streamer Pipeline Server contain
123123

124124
You can build either an optimized or an extended DL Streamer Pipeline Server image (for both Ubuntu22 and Ubuntu24) based on your use case. The extended image contains the Geti SDK, the OpenVINO Model API and ROS2 on top of the optimized image.
125125

126+
Note: Ensure to set the right values in the [.env file](./docker/.env) for building DL Streamer Pipeline Server optimized image and DL Streamer Pipeline Server extended image when you follow the below steps. The mentioned file has the necessary details written as comments.
127+
126128
### Prerequisites
127129
Add the following lines in [.env file](./docker/.env) if you are behind a proxy.
128130

@@ -132,7 +134,7 @@ Add the following lines in [.env file](./docker/.env) if you are behind a proxy.
132134
no_proxy= # example: no_proxy=localhost,127.0.0.1
133135
```
134136

135-
Update the following lines in [.env file](./docker/.env) for choosing the right base image and also for naming the image that gets built.
137+
Update the following lines in [.env file](./docker/.env) for choosing the right base and target images and also for naming the image that gets built.
136138

137139
``` sh
138140
# See .env file for example values
@@ -157,7 +159,7 @@ Run the following commands:
157159
docker compose build
158160
```
159161

160-
The docker image `intel/dlstreamer-pipeline-server:3.1.0-ubuntu22`, `intel/dlstreamer-pipeline-server:3.1.0-ubuntu24`, `intel/dlstreamer-pipeline-server:3.1.0-extended-ubuntu22` or `intel/dlstreamer-pipeline-server:3.1.0-extended-ubuntu24` is now built (based on the .env changes done above) and available for you to run.
162+
The docker image of DL Streamer Pipeline Server is now built (based on the .env changes done above) and available for you to run.
161163

162164
```sh
163165
docker compose up

microservices/dlstreamer-pipeline-server/docs/user-guide/how-to-build-from-source.md

Lines changed: 6 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
# How to build from source
22

3-
You can build either an optimized or an extended DL Streamer Pipeline Server image (for both Ubuntu22 and Ubuntu24) based on your use case. The extended image contains the Geti SDK, the OpenVINO Model API and ROS2 on top of the optimized image.
3+
You can build either an optimized or an extended DL Streamer Pipeline Server image (for both Ubuntu22 and Ubuntu24) based on your use case. The extended image contains the Geti SDK, the OpenVINO Model API and ROS2 on top of the optimized image.
4+
5+
Note: Ensure to set the right values in the `[WORKDIR]/edge-ai-libraries/microservices/dlstreamer-pipeline-server/docker/.env` file for building DL Streamer Pipeline Server optimized image and DL Streamer Pipeline Server extended image when you follow the below steps. The mentioned file has the necessary details written as comments.
46

57
## Steps
68

@@ -21,7 +23,7 @@ You can build either an optimized or an extended DL Streamer Pipeline Server ima
2123
no_proxy= # example: no_proxy=localhost,127.0.0.1
2224
```
2325

24-
3. Update the following lines in `[WORKDIR]/edge-ai-libraries/microservices/dlstreamer-pipeline-server/docker/.env` for choosing the right base image and also for naming the image that gets built.
26+
3. Update the following lines in `[WORKDIR]/edge-ai-libraries/microservices/dlstreamer-pipeline-server/docker/.env` for choosing the right base and target images and also for naming the image that gets built.
2527

2628
``` sh
2729
# See .env file for example values
@@ -45,21 +47,12 @@ You can build either an optimized or an extended DL Streamer Pipeline Server ima
4547
source .env # sometimes this is needed as docker compose doesn't always pick up the necessary env variables
4648
docker compose build
4749
```
48-
---
4950

50-
2. Once the build is complete, list the docker images
51-
```sh
52-
docker image ls
53-
```
54-
Based on the `.env` file changes done above, verify that the appropriate image from the following is present in the system after the build is successful
55-
- `intel/dlstreamer-pipeline-server:<latest-version-number>-ubuntu22`
56-
- `intel/dlstreamer-pipeline-server:<latest-version-number>-ubuntu24`
57-
- `intel/dlstreamer-pipeline-server:<latest-version-number>-extended-ubuntu22`
58-
- `intel/dlstreamer-pipeline-server:<latest-version-number>-extended-ubuntu24`
51+
The docker image of DL Streamer Pipeline Server is now built (based on the .env changes done above) and available for you to run.
5952

6053
---
6154

62-
3. Run the below command to start the container
55+
2. Run the below command to start the container
6356
```sh
6457
docker compose up
6558
```

microservices/dlstreamer-pipeline-server/docs/user-guide/how-to-deploy-with-helm.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,10 +27,10 @@ Follow the steps in this section to quickly pull the latest pre-built DL Streame
2727

2828
- Download helm chart with the following command
2929

30-
`helm pull oci://registry-1.docker.io/intel/dlstreamer-pipeline-server --version 3.1.0-helm`
30+
`helm pull oci://ghcr.io/open-edge-platform/edge-ai-libraries/dlstreamer-pipeline-server --version 20250804-EAL1.2-DLSPS-RC4`
3131
- unzip the package using the following command
3232

33-
`tar xvf dlstreamer-pipeline-server-3.1.0-helm.tgz`
33+
`tar -xvf dlstreamer-pipeline-server-20250804-EAL1.2-DLSPS-RC4.tgz`
3434
- Get into the helm directory
3535

3636
`cd dlstreamer-pipeline-server`

microservices/dlstreamer-pipeline-server/docs/user-guide/how-to-publish-metadata-over-ros2.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,12 @@ DL Streamer Pipeline Server offers publishing the metadata (with or without enco
44

55
## Prerequisite
66

7-
Ensure to build/pull the DL Streamer Pipeline Server extended image i.e., `intel/dlstreamer-pipeline-server:<version>-extended-ubuntu<ubuntu-version>`.
7+
Ensure to build/pull the DL Streamer Pipeline Server extended image.
88

99
[Build instructions](./how-to-build-from-source.md)
1010

11-
[Pull image](https://hub.docker.com/r/intel/dlstreamer-pipeline-server)
11+
Pull DL Streamer Pipeline Server extended image from [dockerhub](https://hub.docker.com/r/intel/dlstreamer-pipeline-server) or [ghcr](https://github.com/open-edge-platform/edge-ai-libraries/pkgs/container/edge-ai-libraries%2Fintel%2Fedge-ai-dlstreamer-pipeline-server)
12+
- Ensure to update the `DLSTREAMER_PIPELINE_SERVER_IMAGE` value in `[WORKDIR]/edge-ai-libraries/microservices/dlstreamer-pipeline-server/docker/.env` file accordingly, in order to run the pulled image.
1213

1314
## Publish
1415

microservices/dlstreamer-pipeline-server/docs/user-guide/how-to-run-udf-pipelines.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,12 @@
22

33
## Prerequisite
44

5-
Ensure to build/pull the DL Streamer Pipeline Server extended image i.e., `intel/dlstreamer-pipeline-server:<version>-extended-ubuntu<ubuntu-version>`.
5+
Ensure to build/pull the DL Streamer Pipeline Server extended image.
66

77
[Build instructions](./how-to-build-from-source.md)
88

9-
[Pull image](https://hub.docker.com/r/intel/dlstreamer-pipeline-server)
9+
Pull DL Streamer Pipeline Server extended image from [dockerhub](https://hub.docker.com/r/intel/dlstreamer-pipeline-server) or [ghcr](https://github.com/open-edge-platform/edge-ai-libraries/pkgs/container/edge-ai-libraries%2Fintel%2Fedge-ai-dlstreamer-pipeline-server)
10+
- Ensure to update the `DLSTREAMER_PIPELINE_SERVER_IMAGE` value in `[WORKDIR]/edge-ai-libraries/microservices/dlstreamer-pipeline-server/docker/.env` file accordingly, in order to run the pulled image.
1011

1112
## Steps
1213
DL Streamer Pipeline Server supports udfloader element which allow user to write an User Defined Function (UDF) that can transform video frames and/or manipulate metadata. You can do this by adding an element called 'udfloader'. You can try simple udfloader pipeline by replacing the following sections in [WORKDIR]/edge-ai-libraries/microservices/dlstreamer-pipeline-server/configs/default/config.json with the following

microservices/dlstreamer-pipeline-server/helm/README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
images:
1414
dlstreamer_pipeline_server: # example: dlstreamer_pipeline_server: intel/dlstreamer-pipeline-server:3.1.0-ubuntu22
1515
```
16-
- Install the helm chart
16+
- Install the helm chart:
1717
`helm install dlsps . -n apps --create-namespace`
1818
- Check if Deep Learning Streamer Pipeline Server is running fine
1919
`kubectl get pods --namespace apps`and monitor its logs using `kubectl logs -f <pod_name> -n apps`
@@ -45,6 +45,8 @@
4545
}'
4646
```
4747
- Open VLC media player on your windows system. Cick on Media -> Open Network Stream -> Enter `rtsp://<Host_IP_where_Deep_Learning_Streamer_Pipeline_Server_is_running>:30025/pallet-defect-detection` in network URL tab and hit Play to see the visualization.
48+
- Uninstall the helm chart:
49+
`helm uninstall dlsps -n apps`
4850

4951
## Troubleshooting
5052
- [Troubleshooting Guide](../docs/user-guide/troubleshooting-guide.md)

0 commit comments

Comments
 (0)