diff --git a/metro-ai-suite/image-based-video-search/deployment-package/application.yaml b/metro-ai-suite/image-based-video-search/deployment-package/application.yaml new file mode 100644 index 000000000..0151cae78 --- /dev/null +++ b/metro-ai-suite/image-based-video-search/deployment-package/application.yaml @@ -0,0 +1,31 @@ +# SPDX-FileCopyrightText: (C) 2025 Intel Corporation +# SPDX-License-Identifier: LicenseRef-Intel +--- +specSchema: "Application" +schemaVersion: "0.1" +$schema: "https://schema.intel.com/catalog.orchestrator/0.1/schema" + +name: ibvs-app +version: 1.0.1 +description: "Image-Based Video Search Sample Application" + +helmRegistry: "docker-hub" +chartName: "intel/image-based-video-search" +chartVersion: "1.0.1" + +profiles: + - name: "default" + valuesFileName: "ibvs-values.yaml" + parameterTemplates: + - name: httpProxy + displayName: "Http proxy" + type: string + default: "" + - name: httpsProxy + displayName: "Https proxy" + type: string + default: "" + - name: noProxy + displayName: "No proxy" + type: string + default: "localhost,127.0.0.1" diff --git a/metro-ai-suite/image-based-video-search/deployment-package/deployment-package.yaml b/metro-ai-suite/image-based-video-search/deployment-package/deployment-package.yaml new file mode 100644 index 000000000..ac0152a96 --- /dev/null +++ b/metro-ai-suite/image-based-video-search/deployment-package/deployment-package.yaml @@ -0,0 +1,24 @@ +# SPDX-FileCopyrightText: (C) 2025 Intel Corporation +# SPDX-License-Identifier: LicenseRef-Intel +--- +specSchema: "DeploymentPackage" +schemaVersion: "0.1" +$schema: "https://schema.intel.com/catalog.orchestrator/0.1/schema" + +name: "ibvs" +displayName: "ibvs" +description: "Image-Based Video Search Sample Application" +version: "1.0.1" + +applications: + - name: ibvs-app + version: 1.0.1 + +defaultNamespaces: + ibvs-app: ibvs + +deploymentProfiles: + - name: "default" + applicationProfiles: + - application: "ibvs-app" + profile: "default" diff --git a/metro-ai-suite/image-based-video-search/deployment-package/ibvs-values.yaml b/metro-ai-suite/image-based-video-search/deployment-package/ibvs-values.yaml new file mode 100644 index 000000000..905a0f098 --- /dev/null +++ b/metro-ai-suite/image-based-video-search/deployment-package/ibvs-values.yaml @@ -0,0 +1,6 @@ +# SPDX-FileCopyrightText: (C) 2025 Intel Corporation +# SPDX-License-Identifier: LicenseRef-Intel +--- +httpProxy: # example: httpProxy: http://proxy.example.com:891 +httpsProxy: # example: httpsProxy: http://proxy.example.com:891 +noProxy: # example: noProxy="localhost,127.0.0.1" diff --git a/metro-ai-suite/image-based-video-search/deployment-package/registry.yaml b/metro-ai-suite/image-based-video-search/deployment-package/registry.yaml new file mode 100644 index 000000000..175e919bf --- /dev/null +++ b/metro-ai-suite/image-based-video-search/deployment-package/registry.yaml @@ -0,0 +1,12 @@ +# SPDX-FileCopyrightText: (C) 2025 Intel Corporation +# SPDX-License-Identifier: LicenseRef-Intel +--- +specSchema: "Registry" +schemaVersion: "0.1" +$schema: "https://schema.intel.com/catalog.orchestrator/0.1/schema" + +name: "docker-hub" +description: "docker-hub registry for helm charts" +type: "HELM" + +rootUrl: "oci://registry-1.docker.io" diff --git a/metro-ai-suite/image-based-video-search/docs/user-guide/_images/ibvs-dp.png b/metro-ai-suite/image-based-video-search/docs/user-guide/_images/ibvs-dp.png new file mode 100644 index 000000000..266ea8296 Binary files /dev/null and b/metro-ai-suite/image-based-video-search/docs/user-guide/_images/ibvs-dp.png differ diff --git a/metro-ai-suite/image-based-video-search/docs/user-guide/how-to-deploy-with-edge-orchestrator.md b/metro-ai-suite/image-based-video-search/docs/user-guide/how-to-deploy-with-edge-orchestrator.md new file mode 100644 index 000000000..e6fdeb0f7 --- /dev/null +++ b/metro-ai-suite/image-based-video-search/docs/user-guide/how-to-deploy-with-edge-orchestrator.md @@ -0,0 +1,83 @@ +# Deploy with the Edge Orchestrator + +Edge Orchestrator, part of Intel’s Edge Software, simplifies edge application deployment and management, making it easier to deploy edge solutions at scale. Edge Orchestrator provides: + +* **Secure Infrastructure Management**: Offers secure and efficient remote onboarding and management of your edge node fleet across sites and geographies. Zero-trust security configuration reduces the time required to secure your edge applications. + +* **Deployment Orchestration and Automation**: Lets you roll out and update applications and configure infrastructure nodes across your network from a single pane of glass. Edge Orchestrator provides automated cluster orchestration and dynamic application deployment. + +* **Automated Deployment**: Automates the remote installation and updating of applications at scale. + +* **Deep Telemetry**: Gives you policy-based life cycle management and centralized visibility into your distributed edge infrastructure and deployments. + +* **Flexible Configuration**: From organizing your physical infrastructure to managing the permutations of executing applications in a variety of runtime environments, Edge Orchestrator gives you the flexibility to define the policies, criteria, and hierarchies that make the most sense for your specific business needs. + +To deploy the **Image-Based Video Search** application with Edge Orchestrator, follow the steps described in this document. + +## Procedure to Deploy with Edge Orchestrator + +### Prerequisites + +1. Access to the web interface of the Edge Orchestrator with one or more [Edge Nodes Onboarded]() to the Edge Orchestrator. +1. Clusters with a [privilege template]() have been created on the needed Edge Nodes following the procedures described in [Create Cluster](). + +### Making the Deployment Package Available + +1. Clone the **Image-Based Video Search** repository: + + ``` bash + git clone https://github.com/open-edge-platform/edge-ai-suites + cd edge-ai-suites/metro-ai-suite/image-based-video-search + ``` + +1. From the web browser, open the URL of the Edge Orchestrator and import the Deployment Package present in the folder **deployment-package** following the steps described in [Import Deployment Package](). + +1. Once the deployment package has been imported into Edge Orchestrator, you can see it in the list of Web UI as shown here. + +**![Image](./_images/ibvs-dp.png)** + +See [Deployment Packages]() for more information on deployment packages. + +### Deploy the Application onto the Edge Nodes + +To set up a deployment: + +1. Click the **Deployments** tab on the top menu to view the Deployments page. On the Deployments page, you can view the list of deployments that have been created. The status indicator shows a quick view of the status of the deployment, which depends on many factors. + +1. Select the **Deployments** tab and click the **Setup a Deployment** button. The Setup a Deployment page appears. + +1. On the Setup a Deployment page, select the **ibvs** package for the deployment from the list, and click **Next**. The Select a Profile step appears. + +1. In the Select a Profile step, select the deployment profile, and click **Next**. The Override Profile Values page appears. + +1. The Override Profile Values page shows the deployment profile values that are available for overriding. Provide the necessary overriding values, then click **Next** to proceed to the Select Deployment Type step. + +1. On the Select Deployment Type page, select the type of deployment, and click **Next**: + + 1. If you select **Automatic** as the deployment type, enter the deployment name and metadata in key-value format to select the target cluster. + + 1. If you select **Manual** as the deployment type, enter the deployment name and select the clusters from the list of clusters. + +1. Click **Next** to view the Review page. + +1. Verify if the deployment details are correct and click **Deploy**. + +After a few minutes, the deployment will start and will take about 5 minutes to complete. + +In the Edge Orchestrator Web UI, you can track the application installation through the [View Deployment Details]() view. + +The **Image-Based Video Search** Sample Application is fully deployed when the applications become green and the status is shown as _Running_. + +You can view the deployment status on the Deployments page. + +> Note: If the deployment fails for any reason, the deployment status will display the “Error” or “Down” status. + +For more information on setting up a deployment, see [Set up a Deployment](). + +### Access the **Image-Based Video Search** Sample Application + +1. Download the kubeconfig of the cluster of the Edge Node on which the Application has been deployed. Refer [Kubeconfig Download](). + +1. Follow the steps described in the **Image-Based Video Search** [Documentation]() on usage of the application. + + > Note: Skip the install the helm chart step \ No newline at end of file diff --git a/metro-ai-suite/image-based-video-search/docs/user-guide/index.rst b/metro-ai-suite/image-based-video-search/docs/user-guide/index.rst index 78e67435d..88ef54df5 100644 --- a/metro-ai-suite/image-based-video-search/docs/user-guide/index.rst +++ b/metro-ai-suite/image-based-video-search/docs/user-guide/index.rst @@ -83,5 +83,6 @@ Outputs release-notes get-started how-to-deploy-helm + how-to-deploy-with-edge-orchestrator GitHub support