# Helm Chart

## Preflight Check

If you'd like to verify your environment's compatibility, use the [following script](https://github.com/qpoint-io/preflight/tree/main):

{% code overflow="wrap" %}

```bash
curl -sSL https://github.com/qpoint-io/preflight/releases/latest/download/preflight.sh | sudo bash
```

{% endcode %}

## Prerequisites

* Kubernetes cluster on a Linux Host with supported Kernel (5.10+)
* `Helm`
* `Kubectl`
* A valid registration token from [app.qpoint.io](https://app.qpoint.io) (Settings -> Installation)

## Install Qpoint Helm Repo

First, add the Qpoint Helm Repo:

```bash
helm repo add qpoint https://helm.qpoint.io/
```

```bash
helm repo update
```

```bash
helm search repo qpoint/qtap --versions
```

```bash
helm show values qpoint/qtap
```

## Deploy Qtap

{% tabs %}
{% tab title="Direct" %}

```bash
helm install qtap qpoint/qtap \
  -n qpoint \
  --create-namespace \
  --set logLevel=warn \
  --set registrationToken=$TOKEN \
  --set extraArgs="{--tags=Environment:Production\,Cluster:EKS-1}"
```

{% hint style="info" %}
**Tags are optional** (`--tags` flag) but useful for filtering in Qplane dashboards. When using `--set`, escape commas with `\,`. See [Organizations & Environments](/getting-started/qplane/configuration/organizations-and-environments.md#agent-tags) for when to use tags vs installations.
{% endhint %}
{% endtab %}

{% tab title="Kubernetes Secrets" %}

1. Create the `qpoint` namespace if it doesn't exist:

```bash
kubectl create namespace qpoint
```

2. Create a secret containing your registration token:

```bash
kubectl create secret generic qtap-token \
  --from-literal=token='<TOKEN>' \
  -n qpoint
```

3. Deploy Qtap using Helm, referencing the secret:

```bash
helm install qtap qpoint/qtap \
  -n qpoint \
  --set logLevel=warn \
  --set registrationTokenSecretRefName="qtap-token"
```

**Note:** You can use your preferred secret management solution to create the secret, such as HashiCorp Vault, AWS Secrets Manager, or other tools integrated with your cluster.
{% endtab %}
{% endtabs %}

## Verifying the Deployment

To verify that Qtap is running:

```bash
kubectl get pods -n qpoint
```

You should see a pod named `qtap-xxxx` in the Running state.

## Uninstalling Qtap

To uninstall Qtap:

```bash
helm uninstall qtap -n qpoint
```

## Important Notes

1. The Qtap pod requires privileged access for eBPF operations. Ensure your cluster's security policies allow this.
2. To set a specific version, use `--set image.tag="v0.17.1"`
3. For cloud-connected mode, keep your registration token secure and do not share it in public repositories.
4. For local mode, ensure your configuration is correctly formatted and contains all necessary settings.
5. The default configuration mounts the host's `/sys` directory. Ensure this is allowed in your cluster.
6. You may need to adjust resource requests and limits based on your cluster's capacity and Qtap's requirements.
7. When using secret management, ensure proper RBAC permissions are in place for accessing the secret.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.qpoint.io/getting-started/qplane/installation/helm-chart.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.