Media connector updates (#112)

Updates to media connector sample including those from #111

---------

Co-authored-by: Sam Chang <[email protected]>

Author: dominicbetts

samples/media-connector-invoke-test/.config_aio_connectors_namespace

@@ -0,0 +1 @@
+azure-iot-operations

samples/media-connector-invoke-test/.config_aio_namespace

@@ -0,0 +1 @@
+azure-iot-operations

samples/media-connector-invoke-test/.config_resources_path

@@ -0,0 +1 @@
+${PSScriptRoot}/resources

samples/media-connector-invoke-test/Install-ResourceFile.ps1

@@ -0,0 +1,34 @@
+#Requires -Version 7
+<#
+    Install a resource file.
+#>
+param (
+    [Parameter(
+        Mandatory=$true,
+        HelpMessage="The resource file.")]
+    [string]$resourceFile
+)
+
+Write-Host "`n"
+Write-Host (Split-Path -Path $PSCommandPath -Leaf).ToUpper() -ForegroundColor White
+
+$aioConnectorsNamespace = (Get-Content -Path (Join-Path -Path $PSScriptRoot -ChildPath ".config_aio_connectors_namespace") -Raw).Trim()
+Write-Host "AIO connectors namespace: $aioConnectorsNamespace"
+
+$resourcesDirectory = (Get-Content -Path (Join-Path -Path $PSScriptRoot -ChildPath ".config_resources_path") -Raw).Trim()
+$resourcesDirectory = $ExecutionContext.InvokeCommand.ExpandString(${resourcesDirectory})
+Write-Host "Resources directory: $resourcesDirectory"
+
+Write-Host "Resource file: $resourceFile"
+
+$fileFullPath=(Join-Path -Path $resourcesDirectory -ChildPath $resourceFile)
+Write-Host "Resource file full path: ${fileFullPath}"
+
+Write-Host "Applying the resource..."
+. kubectl apply -n ${aioConnectorsNamespace} -f ${fileFullPath}
+If ($LastExitCode -ne 0) {
+    Write-Host "Error: The resource could not be applied."
+    Exit $LastExitCode
+} Else {
+    Write-Host "The resource was applied successfully.`n"
+}

samples/media-connector-invoke-test/Invoke-ResourceInstallMonitorAndUninstall.ps1

@@ -0,0 +1,60 @@
+#Requires -Version 7
+<#
+    Install a resource pair (aep/asset), monitor it, and uninstall it.
+#>
+param (
+    [Parameter(
+        Mandatory,
+        HelpMessage="The AEP name.")]
+    [string]$aepName = "",
+    [Parameter(
+        Mandatory,
+        HelpMessage="The asset name.")]
+    [string]$assetName = "",
+    [Parameter(
+        Mandatory,
+        HelpMessage="The datapoint name.")]
+    [string]$datapointName = "",
+    [Parameter(
+        Mandatory,
+        HelpMessage="The monitor expression.")]
+    [string]$monitorExpresion = ""
+)
+
+Write-Host "`n"
+Write-Host (Split-Path -Path $PSCommandPath -Leaf).ToUpper() -ForegroundColor White
+
+. (Join-Path $PSScriptRoot "Test-Prerequisites.ps1") | Out-Null
+
+$aioNamespace = (Get-Content -Path (Join-Path $PSScriptRoot ".config_aio_namespace") -Raw).Trim()
+Write-Host "AIO namespace: $aioNamespace"
+
+$aioConnectorsNamespace = (Get-Content -Path (Join-Path $PSScriptRoot ".config_aio_connectors_namespace") -Raw).Trim()
+Write-Host "AIO connectors namespace: $aioConnectorsNamespace"
+
+Write-Host "AEP Name: $aepName"
+
+Write-Host "Asset Name: $assetName"
+
+Write-Host "Datapoint Name: $datapointName"
+
+Write-Host "Installing the resource files..."
+. (Join-Path $PSScriptRoot "Install-ResourceFile.ps1") -resourceFile "${aepName}.yaml"
+. (Join-Path $PSScriptRoot "Install-ResourceFile.ps1") -resourceFile "${assetName}.yaml"
+
+Write-Host "Waiting for the snapshot-to-mqtt task to be ready...`n"
+Start-Sleep -Seconds 3
+
+try {
+    Write-Host "Starting the monitor command...`n"
+    $monitorExpresion = $ExecutionContext.InvokeCommand.ExpandString(${monitorExpresion})
+    Invoke-Expression "${monitorExpresion}"
+
+} finally {
+
+    Write-Host "Uninstalling the resource files...`n"
+    . (Join-Path $PSScriptRoot "Uninstall-ResourceFile.ps1") -resourceFile "${assetName}.yaml"
+    . (Join-Path $PSScriptRoot "Uninstall-ResourceFile.ps1") -resourceFile "${aepName}.yaml"
+
+    Write-Host "Snapshot-to-mqtt task test completed.`n"
+}

samples/media-connector-invoke-test/Invoke-TestClipToFsAutostart.ps1

@@ -0,0 +1,20 @@
+#Requires -Version 7
+
+$aioConnectorsNamespace = (Get-Content -Path (Join-Path -Path $PSScriptRoot -ChildPath ".config_aio_connectors_namespace") -Raw).Trim()
+Write-Host "AIO connectors namespace: $aioConnectorsNamespace"
+
+$aepName = "aep-public-http-anonymous-1"
+Write-Host "AEP name: $aepName"
+
+$assetName = "asset-public-http-anonymous-1-clip-to-fs-autostart"
+Write-Host "Asset name: $assetName"
+
+$datapointName = "clip-to-fs"
+Write-Host "Datapoint name: $datapointName"
+
+. (Join-Path -Path $PSScriptRoot -ChildPath "Invoke-ResourceInstallMonitorAndUninstall.ps1") `
+    -aepName $aepName `
+    -assetName $assetName `
+    -datapointName $datapointName `
+    -monitorExpresion `
+        "& (Join-Path -Path $PSScriptRoot -ChildPath `"Start-FileSystemMonitor.ps1`") -pathToMonitor /tmp/$aioConnectorsNamespace/data/$assetName/"

samples/media-connector-invoke-test/Invoke-TestSnapshotToFsAutostart.ps1

@@ -0,0 +1,20 @@
+#Requires -Version 7
+
+$aioConnectorsNamespace = (Get-Content -Path (Join-Path -Path $PSScriptRoot -ChildPath ".config_aio_connectors_namespace") -Raw).Trim()
+Write-Host "AIO connectors namespace: $aioConnectorsNamespace"
+
+$aepName = "aep-public-http-anonymous-1"
+Write-Host "AEP name: $aepName"
+
+$assetName = "asset-public-http-anonymous-1-snapshot-to-fs-autostart"
+Write-Host "Asset name: $assetName"
+
+$datapointName = "snapshot-to-fs"
+Write-Host "Datapoint name: $datapointName"
+
+. (Join-Path -Path $PSScriptRoot -ChildPath "Invoke-ResourceInstallMonitorAndUninstall.ps1") `
+    -aepName $aepName `
+    -assetName $assetName `
+    -datapointName $datapointName `
+    -monitorExpresion `
+        "& (Join-Path -Path $PSScriptRoot -ChildPath `"Start-FileSystemMonitor.ps1`") -pathToMonitor /tmp/$aioConnectorsNamespace/data/$assetName/"

samples/media-connector-invoke-test/Invoke-TestSnapshotToMqttAutostart.ps1

@@ -0,0 +1,20 @@
+#Requires -Version 7
+
+$aioConnectorsNamespace = (Get-Content -Path (Join-Path -Path $PSScriptRoot -ChildPath ".config_aio_connectors_namespace") -Raw).Trim()
+Write-Host "AIO connectors namespace: $aioConnectorsNamespace"
+
+$aepName = "aep-public-http-anonymous-1"
+Write-Host "AEP name: $aepName"
+
+$assetName = "asset-public-http-anonymous-1-snapshot-to-mqtt-autostart"
+Write-Host "Asset name: $assetName"
+
+$datapointName = "snapshot-to-mqtt"
+Write-Host "Datapoint name: $datapointName"
+
+. (Join-Path -Path $PSScriptRoot -ChildPath "Invoke-ResourceInstallMonitorAndUninstall.ps1") `
+    -aepName $aepName `
+    -assetName $assetName `
+    -datapointName $datapointName `
+    -monitorExpresion `
+        "& (Join-Path -Path $PSScriptRoot -ChildPath `"Start-MqttListener.ps1`") -listenTopics $aioConnectorsNamespace/data/$assetName/#"

samples/media-connector-invoke-test/Invoke-TestStreamToRtspAutostart.ps1

@@ -0,0 +1,21 @@
+#Requires -Version 7
+
+$aioConnectorsNamespace = (Get-Content -Path (Join-Path -Path $PSScriptRoot -ChildPath ".config_aio_connectors_namespace") -Raw).Trim()
+Write-Host "AIO connectors namespace: $aioConnectorsNamespace"
+
+$aepName = "aep-public-http-anonymous-1"
+Write-Host "AEP name: $aepName"
+
+$assetName = "asset-public-http-anonymous-1-stream-to-rtsp-autostart"
+Write-Host "Asset name: $assetName"
+
+$datapointName = "stream-to-rtsp"
+Write-Host "Datapoint name: $datapointName"
+
+. (Join-Path -Path $PSScriptRoot -ChildPath "Invoke-ResourceInstallMonitorAndUninstall.ps1") `
+    -aepName $aepName `
+    -assetName $assetName `
+    -datapointName $datapointName `
+    -monitorExpresion `
+        "& (Join-Path -Path $PSScriptRoot -ChildPath `"Start-RtspStreamViewer.ps1`") -assetName $assetName ; `
+        try { Write-Host `"`nHit Ctrl+C to terminate`" ; Start-Sleep -Seconds 3600 } finally { Write-Host `"`nContinuing...`n`" }"

samples/media-connector-invoke-test/Overview.md

@@ -0,0 +1,29 @@
+# What is the media connector?
+
+The media connector makes media from media sources such as edge attached cameras available to other Azure IoT Operations components. The media connector is secure, performant, and can connect to the following media sources:
+
+| Media source | Example URLs | Notes |
+|--------------| ---------------|-------|
+| Edge attached camera | `file://host/dev/video0`<br/>`file://host/dev/usb0` | No authentication required. The URL refers to the device file. Connects to a node using USB, FireWire, MIPI, or proprietary interface. |
+| IP camera | `rtsp://192.168.178.45:554/stream1` | JPEG over HTTP for snapshots, RTSP/RTCP/RTP/MJPEG-TS for video streams. An IP camera might also expose a standard ONVIF control interface. |
+| Media server | `rtsp://192.168.178.45:554/stream1` | JPEG over HTTP for snapshots, RTSP/RTCP/RTP/MJPEG-TS for video streams. A media server can also serve images and videos using URLs such as `ftp://host/path` or `smb://host/path` |
+| Media file | `http://camera1/snapshot/profile1`<br/>`nfs://server/path/file.extension`<br/>` file://localhost/media/path/file.mkv`  | Any media file with a URL accessible from the cluster. |
+| Media folder | `file://host/path/to/folder/`<br/>`ftp://server/path/to/folder/` | A folder, accessible from the cluster, that contain media files such as snapshots or clips. |
+
+Example uses of the media connector include:
+
+- Capture snapshots from a video stream or from an image URL and publish them to an MQTT topic. A subscriber to the MQTT topic can use the captured images for further processing or analysis.
+
+- Save video streams to a local file system on your cluster. [Edge Storage Accelerator](https://learn.microsoft.com/azure/azure-arc/edge-storage-accelerator/) can provide a reliable and fault-tolerant solution for uploading the captured video to the cloud for storage or processing.
+
+- Proxy a live video stream from a camera to an endpoint that an operator can access. For security and performance reasons, only the media connector should have direct access to an edge camera. The media connector uses a separate media server component to stream video to an operator's endpoint. This media server can transcode to a variety of protocols such as RTSP, RTCP, SRT, and HLS.
+
+## How does it relate to Azure IoT Operations?
+
+The media connector component is part of Azure IoT Operations. The connector deploys to an Arc-enabled Kubernetes cluster on the edge as part of an Azure IoT Operations deployment. The connector interacts with other Azure IoT Operations elements, such as:
+
+- _Asset endpoints_, which are custom resources in your Kubernetes cluster that define connections to resources such as cameras. An asset endpoint configuration includes the URL of the media source, the type of media source, and any credentials that are needed to access the media source. The media connector uses an asset endpoint to access the media source.
+
+- _Assets_, which in Azure IoT Operations Preview are logical entities that you create to represent a real assets such as cameras. An Azure IoT Operations camera asset can have properties, tags, and video streams.
+
+- The Azure IoT Operations portal, which is a web UI that provides a unified experience for you to manage assets such as cameras. You can use the portal to configure the assets and asset endpoints that the media connector uses to access media sources.