# Deploy with Helm

Use Helm to deploy Image-Based Video Search to a Kubernetes cluster. This guide
will help you:

- Add the Helm chart repository.
- Configure the Helm chart to match your deployment needs.
- Deploy and verify the application.

Helm simplifies Kubernetes deployments by streamlining configurations and
enabling easy scaling and updates. For more details, see
[Helm Documentation](https://helm.sh/docs/).

## Prerequisites

Before You Begin, ensure the following:

- **System Requirements**: Verify that your system meets the
  [minimum requirements](./system-requirements.md).
- **Tools Installed**: Install the required tools:
  - Kubernetes CLI (kubectl)
  - Helm 3 or later

## Pull the helm chart (Optional)

> **Note:** The helm chart should be downloaded when you are not using the helm chart provided in `edge-ai-suites/metro-ai-suite/image-based-video-search/chart`

- Download helm chart with the following command
    ```bash
    helm pull oci://registry-1.docker.io/intel/image-based-video-search --version 1.2.0-rc1
    ```
- unzip the package using the following command
    ```bash
    tar -xvf image-based-video-search-1.2.0-rc1.tgz
    ```
- Get into the helm directory
    ```bash
    cd image-based-video-search
    ```

## Steps to Deploy

1. **Clone the repo**:
  - Clone the repo and go to helm directory
    ```bash
    git clone https://github.com/open-edge-platform/edge-ai-suites.git
    cd edge-ai-suites/metro-ai-suite/image-based-video-search/chart
    ```

2. **Start the application**:
  - Run below command in the terminal
    ```bash
    # Install the Image-Based Video Search chart in the ibvs namespace
    helm install ibvs . --create-namespace -n ibvs
    ```

    Some containers in the deployment requires network access. If you are in a proxy
    environment, pass the proxy environment variables as follows:

    ```bash
    # Install the Image-Based Video Search chart in the ibvs namespace
    # Replace the proxy values with the specific ones for your environment:
    helm install ibvs . --create-namespace -n ibvs \
        --set httpProxy="http://proxy.example.com:8080" \
        --set httpsProxy="http://proxy.example.com:8080" \
        --set noProxy="localhost\,127.0.0.1"
    ```

3. **Open IBVS UI**:
  - Now frontend should be accessible at `https://<ip-addr>:30443/`.
    > **Note:** To access the above url remotely, replace the `<ip-addr>` with your system IP address.

4. **Stop the application**:
  - The app can be uninstalled using the following command:
    ```bash
    helm uninstall -n ibvs ibvs
    ```

## Supporting Resources

- [Troubleshooting Helm Deployments](../troubleshooting.md#troubleshooting-helm-deployments)
- [Kubernetes Documentation](https://kubernetes.io/docs/home/)
- [Helm Documentation](https://helm.sh/docs/)