Skip to content

Commit 44a06ea

Browse files
authored
Defect fixes for VSS and ChatQnA (open-edge-platform#630)
1 parent 20b7caa commit 44a06ea

File tree

7 files changed

+36
-11
lines changed

7 files changed

+36
-11
lines changed

sample-applications/chat-question-and-answer-core/docs/user-guide/build-from-source.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,9 @@ If you want to build the images via `docker compose`, please refer to the sectio
88

99
Once all the images are built, go back to `chat-question-and-answer-core` directory by using `cd ..` command. Then, you can proceed to start the service using the `docker compose` command as described in the [Get Started](./get-started.md) page.
1010

11+
> **Note:**
12+
> - The build instruction is applicable only on an Ubuntu system. Build from source is not supported for the sample application on [Edge Microvisor Toolkit (EMT)](https://github.com/open-edge-platform/edge-microvisor-toolkit). The user is recommended to use prebuilt images on EMT.
13+
1114
## Building the Backend Image
1215
To build the Docker image for the `Chat Question-and-Answer Core` application, follow these steps:
1316

sample-applications/chat-question-and-answer/docs/user-guide/build-from-source.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22

33
This guide provides step-by-step instructions for building the ChatQ&A Sample Application from source.
44

5+
> **Note:**
6+
> - The dependent microservices must be built separately from their respective microservice folders.
7+
> - The build instruction is applicable only on an Ubuntu system. Build from source is not supported either for the sample application or the dependent microservices on [Edge Microvisor Toolkit (EMT)](https://github.com/open-edge-platform/edge-microvisor-toolkit). The user is recommended to use prebuilt images on EMT.
8+
59
## Prerequisites
610

711
Before you begin, ensure that you have the following prerequisites:

sample-applications/chat-question-and-answer/docs/user-guide/deploy-with-edge-orchestrator.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,9 @@ To deploy the **ChatQ&A** Application with the Edge Orchestrator, follow the ste
1818

1919
### Prerequisites
2020

21-
1. Access to the web interface of the Edge Orchestrator with one or more [Edge Nodes Onboarded](<https://docs.openedgeplatform.intel.com/edge-manage-docs/main/user_guide/set_up_edge_infra/edge_node_onboard.html>) to the Edge Orchestrator.
21+
1. Access to the web interface of the Edge Orchestrator with one or more [Edge Nodes Onboarded](<https://docs.openedgeplatform.intel.com/edge-manage-docs/main/user_guide/set_up_edge_infra/edge_node_onboard/index.html>) to the Edge Orchestrator.
2222

23-
1. Clusters with a [privilege template](<https://docs.openedgeplatform.intel.com/edge-manage-docs/main/user_guide/additional_howtos/set_up_a_cluster_template.html>) have been created on the needed Edge Nodes following the procedures described in [Create Cluster](<https://docs.openedgeplatform.intel.com/edge-manage-docs/main/user_guide/set_up_edge_infra/create_clusters.html#create-cluster>).
23+
1. Clusters with a [privilege template](<https://docs.openedgeplatform.intel.com/edge-manage-docs/main/user_guide/advanced_functionality/set_up_a_cluster_template.html>) have been created on the needed Edge Nodes following the procedures described in [Create Cluster](<https://docs.openedgeplatform.intel.com/edge-manage-docs/main/user_guide/set_up_edge_infra/clusters/create_clusters.html#create-cluster>).
2424

2525
### Making the Deployment Package Available
2626

@@ -79,7 +79,7 @@ For more information on setting up a deployment, see [Set up a Deployment](<http
7979

8080
### Access the **ChatQ&A** AI-Suite
8181

82-
1. Download the kubeconfig of the cluster of the Edge Node on which the Application has been deployed. Refer [Kubeconfig Download](<https://docs.openedgeplatform.intel.com/edge-manage-docs/main/user_guide/set_up_edge_infra/accessing_clusters.html#organize-cluster-access-with-a-kubeconfig-file>).
82+
1. Download the kubeconfig of the cluster of the Edge Node on which the Application has been deployed. Refer [Kubeconfig Download](<https://docs.openedgeplatform.intel.com/edge-manage-docs/main/user_guide/set_up_edge_infra/clusters/accessing_clusters.html>).
8383

8484
1. Follow the steps described in the **ChatQ&A** [Documentation](<deploy-with-helm.md>) on usage of the application.
8585

sample-applications/document-summarization/docs/user-guide/build-from-source.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22

33
This section shows how to build the Document Summarization Sample Application from the source.
44

5+
> **Note:**
6+
> - The build instruction is applicable only on an Ubuntu system. Build from source is not supported for the sample application on [Edge Microvisor Toolkit (EMT)](https://github.com/open-edge-platform/edge-microvisor-toolkit). The user is recommended to use prebuilt images on EMT.
7+
58
## Prerequisites
69

710
Before you begin, ensure that you have the following prerequisites:

sample-applications/video-search-and-summarization/docs/user-guide/build-from-source.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,9 @@
22

33
This section shows how to build the Video Search and Summary sample application from source.
44

5-
> **Note:** The dependent microservices must be built separately from their respective microservice folders.
5+
> **Note:**
6+
> - The dependent microservices can be built separately from their respective microservice folders which is recommended. There is an option provided to build dependencies along with sample application if required.
7+
> - The build instruction is applicable only on an Ubuntu system. Build from source is not supported either for the sample application or the dependent microservices on [Edge Microvisor Toolkit (EMT)](https://github.com/open-edge-platform/edge-microvisor-toolkit). The user is recommended to use prebuilt images on EMT.
68
79
## Prerequisites
810

sample-applications/video-search-and-summarization/docs/user-guide/deploy-with-helm.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ Before you begin, ensure that you have the following:
88
- The cluster must support **dynamic provisioning of Persistent Volumes (PV)**. Refer to the [Kubernetes Dynamic Provisioning Guide](https://kubernetes.io/docs/concepts/storage/dynamic-provisioning/) for more details.
99
- Install `kubectl` on your system. See the [Installation Guide](https://kubernetes.io/docs/tasks/tools/install-kubectl/). Ensure access to the Kubernetes cluster.
1010
- Helm chart installed on your system. See the [Installation Guide](https://helm.sh/docs/intro/install/).
11+
- Video Search and Summary requires PVC storage class to support `RWMany` mode. In case the default storage class used does not support it, consider using storage solution like [LongHorn](https://longhorn.io/docs/) that provides this support. Video Search and Summary intends to remove this prerequisite in future release and use only `RWOnce` mode.
1112

1213
## Steps to deploy with Helm
1314
Do the following to deploy VSS using Helm chart.

sample-applications/video-search-and-summarization/docs/user-guide/release-notes.md

Lines changed: 19 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,25 @@
22

33

44
## Current Release
5+
**Version**: RC4.1 \
6+
**Release Date**: 29 July 2025
7+
8+
**Features**:
9+
- This is an incremental release on top of RC4 providing fixes for issues found on RC4. The notes provided under RC4 apply for this incremental release too.
10+
- Issues fixed are listed below:
11+
- Error message is displayed on the UI when invalid video is uploaded in both video summary and video search modes.
12+
- Only mp4 format is supported currently. For other formats, error message is displayed on the UI.
13+
- Fix to ensure that the sample application can be shutdown in a terminal different from the one in which it was started.
14+
- A few minor documentation issues have been fixed.
15+
- Provided a means to manage the PVC in values.yaml file.
16+
- Fixed an issue where video summary progress is kept in the pipeline manager service even if the specific video summary is deleted
17+
- Issues around tag handling for videos has been fixed.
18+
- Trouble shooting section updated with observed useful information.
19+
- Enabled a minimum configuration of video summary to work on older Xeon configurations. Note that there is no official support for versions of Xeon earlier than Xeon 4.
20+
21+
22+
## Previous releases
23+
524
**Version**: RC4 \
625
**Release Date**: 18 June 2025
726

@@ -29,10 +48,3 @@
2948
- The Helm chart presently supports only CPU deployments.
3049
- Known issues are internally tracked. Reference not provided here.
3150
- `how-to-performance` document is not updated yet. HW sizing details will be added to this section shortly.
32-
33-
## Previous releases
34-
35-
**Version**: \
36-
**Release Date**:
37-
38-
- <Previous release notes>

0 commit comments

Comments
 (0)