|
5 | 5 | - The hardware platform must be at least a 10th Generation Intel® Core™ i5 Processor or Intel® Xeon® Scalable processor, with at least 8+GB of RAM and 64+GB of storage. |
6 | 6 | - [How to build Scene Controller from source](How-to-build-source.md) |
7 | 7 |
|
8 | | -## Running the service using Docker Compose |
| 8 | +## Running the service using Docker |
9 | 9 |
|
10 | 10 | - **Navigate to the Directory**: |
11 | 11 |
|
|
16 | 16 | - **Generate secrets**: |
17 | 17 |
|
18 | 18 | ```bash |
19 | | - make build-secrets |
| 19 | + make init-secrets |
20 | 20 | ``` |
21 | 21 |
|
22 | 22 | - **Start the service**: |
|
63 | 63 | - **Access scene controller output through MQTT**: |
64 | 64 | - Refer to [scene-controller-api.yaml](api-docs/scene-controller-api.yaml) on how to access scene controller output |
65 | 65 | - Refer to [scene controller sequence diagram](overview.md#sequence-diagram-scene-controller-workflow) |
| 66 | + |
| 67 | +## Running in Analytics-Only Mode |
| 68 | + |
| 69 | +Analytics-only mode allows the Scene Controller to consume tracked objects from a separate Tracker service via MQTT instead of performing tracking internally. This is useful for distributed deployments where tracking and analytics are handled by separate services. |
| 70 | + |
| 71 | +- **Enable analytics-only mode**: |
| 72 | + |
| 73 | + Add the `--analytics-only` flag to the docker run command: |
| 74 | + |
| 75 | + ```bash |
| 76 | + docker run --rm \ |
| 77 | + --init \ |
| 78 | + --network scenescape \ |
| 79 | + -v scenescape_vol-media:/home/scenescape/SceneScape/media \ |
| 80 | + -v $(pwd)/controller/config/tracker-config.json:/home/scenescape/SceneScape/tracker-config.json \ |
| 81 | + -v $(pwd)/manager/secrets/certs/scenescape-ca.pem:/run/secrets/certs/scenescape-ca.pem:ro \ |
| 82 | + -v $(pwd)/manager/secrets/django:/run/secrets/django:ro \ |
| 83 | + -v $(pwd)/manager/secrets/controller.auth:/run/secrets/controller.auth:ro \ |
| 84 | + --name scene \ |
| 85 | + scenescape-controller \ |
| 86 | + controller \ |
| 87 | + --broker broker.scenescape.intel.com \ |
| 88 | + --ntp ntpserv \ |
| 89 | + --analytics-only |
| 90 | + ``` |
| 91 | + |
| 92 | + Alternatively, use the environment variable: |
| 93 | + |
| 94 | + ```bash |
| 95 | + docker run --rm \ |
| 96 | + --init \ |
| 97 | + --network scenescape \ |
| 98 | + -e CONTROLLER_ENABLE_ANALYTICS_ONLY=true \ |
| 99 | + -v scenescape_vol-media:/home/scenescape/SceneScape/media \ |
| 100 | + -v $(pwd)/controller/config/tracker-config.json:/home/scenescape/SceneScape/tracker-config.json \ |
| 101 | + -v $(pwd)/manager/secrets/certs/scenescape-ca.pem:/run/secrets/certs/scenescape-ca.pem:ro \ |
| 102 | + -v $(pwd)/manager/secrets/django:/run/secrets/django:ro \ |
| 103 | + -v $(pwd)/manager/secrets/controller.auth:/run/secrets/controller.auth:ro \ |
| 104 | + --name scene \ |
| 105 | + scenescape-controller \ |
| 106 | + controller \ |
| 107 | + --broker broker.scenescape.intel.com \ |
| 108 | + --ntp ntpserv |
| 109 | + ``` |
| 110 | + |
| 111 | +- **Note**: In analytics-only mode (experimental feature): |
| 112 | + - The tracker is not initialized |
| 113 | + - Camera and scene detection data processing is skipped |
| 114 | + - The controller subscribes to tracked object data from MQTT topics published by the Tracker service |
| 115 | + - Analytics processing (regions, tripwires, sensors) continues to function normally |
| 116 | + - Child scenes are not supported in analytics-only mode |
| 117 | + - Sensors in Scene not supported and attribute persistence across moving objects not supported on data/scene MQTT topic (data avaliable on events topic). |
0 commit comments