Skip to content

Commit 65f051c

Browse files
committed
Document changes for nginx architecture
1 parent f2071f0 commit 65f051c

File tree

5 files changed

+12
-5
lines changed

5 files changed

+12
-5
lines changed

metro-ai-suite/image-based-video-search/README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Image-Based Video Search Sample Application
1+
# Image-Based Video Search (IBVS) Sample Application
22
<!--REQUIRED: Add a short description without including the name of the RI/Application/microservice in the description. Ensure it's at least 50 characters (excluding spaces) and doesn't exceed 150 characters (excluding spaces). This will enable the content to be properly displayed in the catalog's card layout.-->
33
Performs near real-time analysis and image-based search to detect and retrieve objects of interest in large video datasets.
44

@@ -12,7 +12,7 @@ You can use this foundation to build solutions for diverse use cases, including
1212
## How it Works
1313
The application workflow has three stages: inputs, processing, and outputs.
1414

15-
![Diagram illustrating the components and interactions within the Image-Based Video Search system, including inputs, processing, and outputs.](docs/user-guide/_images/architecture_simplified.png)
15+
![Diagram illustrating the components and interactions within the Image-Based Video Search system, including inputs, processing, and outputs.](docs/user-guide/_images/architecture.png)
1616

1717
### Inputs
1818

@@ -23,6 +23,7 @@ The application includes a demonstration video for testing. The video loops cont
2323

2424
### Processing
2525

26+
- **Nginx reverse proxy server**: All interactions with user happens via Nginx server. It protects IBVS app by handling SSL/TLS encryption, filtering and validating requests and making the app directly inaccessible from external access.
2627
- **Video analysis with Deep Learning Streamer Pipeline Server and MediaMTX**: Select **Analyze Stream** to start the DL Streamer Pipeline Server pipeline. The Pipeline Server processes video through **MediaMTX**, which simulates remote video cameras and publishes live streams. The Pipeline Server extracts frames and detects objects in each frame, publishing predictions through **MQTT**.
2728
- **Feature extraction with Feature Matching**: DL Streamer Pipeline Server sends metadata and images through MQTT to the Feature Matching microservice. Feature Matching generates feature vectors. If predictions exceed the threshold, the system stores vector embeddings in MilvusDB and saves frames in the Docker file system.
2829
- **Storage and retrieval in MilvusDB**: MilvusDB stores feature vectors. You can review them in MilvusUI.

metro-ai-suite/image-based-video-search/docs/user-guide/Overview.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Image-Based Video Search Sample Application
1+
# Image-Based Video Search (IBVS) Sample Application
22

33
<!--REQUIRED: Add a short description without including the name of the RI/Application/microservice in the description. Ensure it's at least 50 characters (excluding spaces) and doesn't exceed 150 characters (excluding spaces). This will enable the content to be properly displayed in the catalog's card layout.-->
44

@@ -23,7 +23,7 @@ quickly locate objects of interest across large video datasets.
2323

2424
The application workflow has three stages: inputs, processing, and outputs.
2525

26-
![Diagram illustrating the components and interactions within the Image-Based Video Search system, including inputs, processing, and outputs.](_images/architecture_simplified.png)
26+
![Diagram illustrating the components and interactions within the Image-Based Video Search system, including inputs, processing, and outputs.](_images/architecture.png)
2727

2828
### Inputs
2929

@@ -35,6 +35,7 @@ continuously and appears in the UI as soon as the application starts.
3535

3636
### Processing
3737

38+
- **Nginx reverse proxy server**: All interactions with user happens via Nginx server. It protects IBVS app by handling SSL/TLS encryption, filtering and validating requests and making the app directly inaccessible from external access.
3839
- **Video analysis with Deep Learning Streamer Pipeline Server and MediaMTX**:
3940
Select **Analyze Stream** to start the DL Streamer Pipeline Server pipeline.
4041
The Pipeline Server processes video through **MediaMTX**, which simulates
19.6 KB
Loading

metro-ai-suite/image-based-video-search/docs/user-guide/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ How it Works
2525

2626
The application workflow has three stages: inputs, processing, and outputs.
2727

28-
.. figure:: ./_images/architecture_simplified.png
28+
.. figure:: ./_images/architecture.png
2929
:alt: Diagram illustrating the components and interactions within the Image-Based Video Search system, including inputs, processing, and outputs.
3030

3131
Figure 1: Diagram illustrating the components and interactions within the Image-Based Video Search system, including inputs, processing, and outputs.

metro-ai-suite/image-based-video-search/docs/user-guide/overview-architecture.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,11 @@ Architecture of the Image-Based Video Search Application.*
5353

5454
## Key Components and Their Roles
5555

56+
1. **Nginx reverse proxy server**
57+
- **What it is**: An Nginx reverse proxy acts as an intermediary server that forwards client requests to backend servers, helping with load balancing, SSL termination, caching, and centralized access control.
58+
- **How it’s used**: It acts as proxy server. All interactions to IBVS app happens via nginx server. It forwards all the requests from outside world to internal serices based on routing configuration.
59+
- **Benefits**: It acts as protective gateway that receives external requests and securely forwards them to internal services, keeping those backend apps hidden and inaccessible from direct external access.
60+
5661
1. **MediaMTX (Third-Party Microservice)**
5762

5863
- **What it is**: A service that simulates remote video cameras.

0 commit comments

Comments
 (0)