feat(docker-compose): added docs

Signed-off-by: Neethu Elizabeth Simon <[email protected]>

Makefile

@@ -2,8 +2,9 @@
 # SPDX-License-Identifier: Apache-2.0
 
 .PHONY: build-dlstreamer build-dlstreamer-realsense build-grpc-python build-grpc-go build-python-apps build-telegraf build-gst-capi
-.PHONY: run-camera-simulator run-telegraf
-.PHONY: clean-grpc-go clean-segmentation clean-ovms-server clean-ovms clean-all clean-results clean-telegraf clean-models clean-webcam
+.PHONY: run-camera-simulator run-telegraf run-portainer run-pipelines
+.PHONY: clean-grpc-go clean-segmentation clean-ovms-server clean-ovms clean-all clean-results clean-telegraf clean-models clean-webcam 
+.PHONY: down-portainer down-pipelines
 .PHONY: clean clean-simulator clean-object-detection clean-classification clean-gst clean-capi_face_detection
 .PHONY: list-profiles
 .PHONY: unit-test-profile-launcher build-profile-launcher profile-launcher-status clean-profile-launcher webcam-rtsp
@@ -34,6 +35,9 @@ run-telegraf:
 run-portainer:
 	docker compose -p portainer -f docker-compose-portainer.yml up -d
 
+run-pipelines:
+	docker compose -f docker-compose.yml up -d
+
 clean:
 	./clean-containers.sh automated-self-checkout
 
@@ -98,7 +102,10 @@ clean-webcam:
 down-portainer:
 	docker compose -p portainer -f docker-compose-portainer.yml down
 
-clean-all: clean clean-ovms clean-simulator clean-results clean-telegraf clean-webcam down-portainer
+down-pipelines:
+	docker compose -f docker-compose.yml down
+
+clean-all: clean clean-ovms clean-simulator clean-results clean-telegraf clean-webcam down-pipelines
 
 docs: clean-docs
 	mkdocs build

docs_src/OVMS/pipelineDockerCompose.md

@@ -0,0 +1,36 @@
+# Docker-Compose for Developer Toolbox
+
+Pipelines can be run using docker-compose files. Changes are custom made inside  the docker-compose for integration with the Developer Toolbox.
+
+!!! Note
+    To utilize all the features offered by Automated Self-Checkout, run the pipelines as illustrated in the section [Run Pipelines](./quick_pipelinerun.md).
+
+## Steps to Run Pipelines
+
+1. Prerequisites
+
+    Before running, [Set Up the Pipelines](./pipelinesetup.md).
+
+1. Customize the `docker-compose.yml` to add the number of camera simulators required and the number of different type of pipelines that need to be run
+
+    !!! Note
+        Follow all the instructions in `docker-compose.yml` for customizations.
+
+1. Run the pipelines
+
+    ```bash
+    make run-pipelines
+    ```
+
+1. All the containers i.e camera simulators, OVMS server and pipelines should start without any errors in portainer as shown below in Figure 1 -
+
+    <figure class="figure-image">
+    <img src="../images/portainer_dashobaord_docker_compose.png" alt="Figure 1: Pipelines Running Successfully">
+    <figcaption>Figure 1: Pipelines Running Successfully</figcaption>
+    </figure>
+
+1. Stop the pipeline
+
+    ```bash
+    make down-pipelines
+    ```

docs_src/OVMS/pipelinerun.md

@@ -48,13 +48,13 @@ Use run.sh to run the pipeline, here is the table of basic scripts for each comb
 | Video file      | <code>sudo ./run.sh --workload ovms --platform core&#124;xeon&#124;dgpu.x --inputsrc file:my_video_file.mp4</code>              |
 
 !!! Note
-   For simulated camera as input source, please [run camera simulator first](../run_camera_simulator.md).
+    For simulated camera as input source, please [run camera simulator first](../run_camera_simulator.md).
 
 !!! Note
-   The value of x in `dgpu.x` can be 0, 1, 2, and so on depending on the number of discrete GPUs in the system.
+    The value of x in `dgpu.x` can be 0, 1, 2, and so on depending on the number of discrete GPUs in the system.
 
 !!! Note
-   Follow these [steps](../query_usb_camera.md) to see the output formats supported by your USB camera.
+    Follow these [steps](../query_usb_camera.md) to see the output formats supported by your USB camera.
 
 
 ### Supporting different programming languages for OVMS grpc client

mkdocs.yml

@@ -37,6 +37,7 @@ nav:
       - Supporting Different Languages: './OVMS/supportingDifferentLanguage.md'
       - Supporting Different Models: './OVMS/supportingDifferentModel.md'
       - C-API Face Detection Pipeline: './OVMS/capiPipelineRun.md'
+      - Run Pipelines with Docker-Compose for Developer Toolbox: './OVMS/pipelineDockerCompose.md'
   - Utilities:
     - Camera Simulator: './run_camera_simulator.md'
     - Telemetry: './telemetry/setup.md'