Installation Description

Index SDK can be deployed on a physical machine or in a container. This document describes how to deploy it on a physical machine. If FeatureRetrieval needs to be deployed in the Docker environment, complete containerized deployment of FeatureRetrieval by referring to Index image repository.

For details about how to install Ascend Docker Runtime, see "Installation" > "Installation and Deployment" > "Manual Installation" > "Ascend Docker Runtime" in MindCluster Cluster Scheduling Installation Guide.

Index SDK supports the virtualization environment. You can deploy and run Index SDK services in the virtualization environment. For details about how to deploy the environment, see "Usage" > "Virtual Instance Feature Guide" in MindCluster Cluster Scheduling User Guide.

Index SDK FeatureRetrieval depends on the NPU firmware and driver, CANN, OpenBLAS, and Faiss. You need to install the dependency packages before installing Index SDK. The installation process is as follows:

  1. Install the NPU driver, firmware, and CANN. For details, see Installing the NPU Driver, Firmware, and CANN.
  2. Install OpenBLAS. For details, see Installing OpenBLAS.
  3. Install Faiss. For details, see Installing Faiss.
  4. Install Index SDK. For details, see Downloading the Index SDK Package and Installing Index SDK.

Important Notes

  • When deploying FeatureRetrieval in the Docker container environment, ensure that retrieval-related folders (such as /usr/local/Ascend/driver and /usr/local/Ascend/develop/) are correctly mounted in the Docker container. Otherwise, the retrieval compilation in the container may fail.
  • For third-party open-source software, if its version has vulnerabilities, fix and update them timely based on the corresponding description of the open-source version.