Deployments
Deployments are how you run an analytic pipeline with a video source. This section outlines how to create, manage and use deployments.
0A Pipeline needs to be deployed on a Gateway with a source ( Camera & Streams or Clip & File Processing ) in order to run the analytic.
Quick Deploy
Quick Deploy is a feature designed for deployment teams that makes it easy to deploy bulk deploy and configure existing Pipeline from Solutions gallery and your library.
A brief overview of Quick Deploy steps is provided below or see the Quick Deploy Guide for an in-depth tutorial.
Start Quick Deploy
Head to Deploy and click the Quick Deploy button in the left sidebar, and pick the Gateway you want to deploy to.
Quick deploy -> Select a gateway -> Continue
Pick a video source
You can pick one or more video cameras / sources to deploy analytics to at this step.
On memory-constrained Gateways such as Jetson devices, and if you are deploying a new analytic for the first time, we recommend that you (1) pick one video source at a time and (2) stop other running deployments when deploying a new analytic. After you have deployed each new analytic once, you can then start them all up.
Select a video source -> Continue
Select an analytic pipeline template
Next, select a new or previously used analytic template to deploy.
Tip: Analytic templates that push data and recordings to Lumeo cloud will mention compatible Dashboard templates and widgets that you can use for visualization. Make a note of those so you can setup the Dashboards later on if need be.
Click Select analytic pipeline
Pre-built analytics templates are broadly organized with the following attributes:
| Attribute | How to identify | Typical Options |
|---|---|---|
| Use case | Title of the pre-built analytic | Various |
| Integrations | Title and description. | Dashboard : Will push data to Lumeo Cloud Dashboard Search : Will push recordings to Lumeo Cloud Email : Will send an email when a specific event happens VMS : Will push alarm or event to one or more VMS If you need an integration other than these typical options, it requires these pre-built templates to be customized using the Pipeline editor. You can do so yourself or reach out to Lumeo support for help. |
| Events & data generated | Description | Type of events & data generated by the analytic. If the analytic integrates with Dashboard, you can filter by these Events in the Dashboards . If it integrates with Search, you can Search recordings using this data. |
Use Analytic templates to select pre-built templates, or Your analytic pipelines to select a previously used template or custom analytic
Pick an appropriate pre-built analytics template based on your use case & integrations.
Configure & Deploy
Configure analytic pipeline settings
Wait for Deployment start
Wait for deployment to go from Deploying to Running. Click on the deployment title to view details. Note that this stage can take between 15-30 minutes on the first run.
After a deployment is running, you can play the output stream or manage it.
Labels
Deployments automatically inherit Labels from their sources.
Labels are hierarchical and selecting a particular label will filter the list of Deployments to those tagged with that Label or it's descendants.
Manage a Deployment
Once deployed, the parameters for that Pipeline Deployment are frozen till you update the deployment manually. For any Streaming output nodes, Lumeo will create those streams once the Pipeline is deployed as well and list them under the Output streams tab.
Overview, Start, Stop, Duplicate, Delete
You can view the output streams and deployment information on the deployment detail view (Deploy -> Deployments). This view also lets you start, stop, duplicate and delete the deployment.
Deleting a Deployment deletes associated recordings
Heads up that deleting a gateway or source will delete all associated deployments, and deleting a deployment deletes all associated recorded media.
Deployment details view
Recorded Media
Any media that is captured by the Save Clip and Save Snapshot nodes will show up under the Recordings tab. Click on the menu on the right of each recording to download it or download the analytics metadata saved with it.
Tip: Recorded Media is also available under Monitor -> Search recordings view, where you can filter, view, delete (and on a Search-enabled plan, search) recordings saved across your workspace.
Recordings
Logs
When building or troubleshooting your analytic, the deployment logs & events are available via the deployment detail view as well.
Deployment logs
Events
Deployment state events
Update a Deployment
After a deployment is created, you are still free to make changes to the source Pipeline - these changes do not impact existing deployments.
If you modify the Pipeline after deploying it, or wish to change the node properties, you can Update (an existing) Deployment from the Pipeline Editor or by clicking the Edit configuration button. Note that whenever the configuration is edited or updated, Lumeo will deploy the then-latest version of the PIpeline.
Update single deployment
Head to deployment detail view and click Edit Configuration
Edit configuration
Edit the configuration and hit Deploy to save and restart the deployment.
Bulk update with same configuration
Use this approach to update multiple deployments of a particular pipeline with the same value for a specific property, for example to set a time period or IP address in node properties.
Note: This process will only work for deployments of the same pipeline. If you select deployments belonging to different pipelines, the Bulk update button will be disabled.
Select multiple deployments of the same pipeline -> Bulk Update (right bottom corner)
Shows you all deployments of this pipeline with your selection. Continue with the selected deployments.
Select the property to override, set it's value and Update!
API Reference
See deployments
Updated about 1 month ago