-
Notifications
You must be signed in to change notification settings - Fork 184
Description
| Follow the instructions in |
Affected documentation
docs/source/dev_guide/advanced_install/advanced_build_docker_image.md
Section: Step 1 – Setting up prerequisites
Summary
The documented prerequisite steps for building the DL Streamer Docker image are incomplete. Following the documentation verbatim leads to Docker build failures because the build implicitly depends on files and directories that are only available in the full dlstreamer repository with initialized git submodules.
As a result, users following the documented steps are unable to complete the Docker build without additional, undocumented steps.
Documented steps (do not work as written)
From the current documentation:
mkdir -p ~/intel/dlstreamer_gst
cd ~/intel/dlstreamer_gst/
wget -O DLS_install_prerequisites.sh \
https://raw.githubusercontent.com/open-edge-platform/edge-ai-libraries/main/libraries/dl-streamer/scripts/DLS_install_prerequisites.sh
chmod +x DLS_install_prerequisites.shFollowing only these steps leads to Docker build failures because required repository paths are missing.
Actual required steps (what works)
To successfully build the Docker image, the following steps are required but are not currently documented:
git clone https://github.com/open-edge-platform/dlstreamer.git
cd dlstreamer
git submodule update --init --recursiveDocker build command used:
docker build -f docker/ubuntu/ubuntu24.Dockerfile -t dlstreamer-ubuntu24 .Verification of required paths:
ls docker/ubuntu/debian
ls dependencies/patches
ls thirdparty/spdlog/CMakeLists.txtDocker build failures observed
1. Missing patches directory
COPY dependencies/patches/ /tmp/patches/
failed to compute cache key: "/dependencies/patches": not found
2. Missing debian packaging directory
COPY docker/ubuntu/debian /deb-pkg/debian
"/docker/ubuntu/debian": not found
3. CMake error due to missing submodules
The source directory
/home/dlstreamer/dlstreamer/thirdparty/spdlog
does not contain a CMakeLists.txt file.
This error is resolved only after running:
git submodule update --init --recursiveExpected behavior
The documentation should clearly state that:
- The Docker build must be executed from the
dlstreamerrepository root - Git submodules are mandatory for a successful build
- The prerequisite script alone is not sufficient to prepare the build context
Environment
- Host OS: Ubuntu 24.04
- Docker: Docker Engine (default)
- Dockerfile:
docker/ubuntu/ubuntu24.Dockerfile
Impact
Because these prerequisites are not clearly documented, users may encounter repeated Docker build failures and spend significant time identifying missing repository context or submodules. Clarifying the required setup would help avoid confusion and reduce setup time for new users.