Helm Chart

Preflight Check

If you'd like to verify your environment's compatibility, use the following script:

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

Prerequisites

• Kubernetes cluster on a Linux Host with supported Kernel (5.10+)

• Helm

• Kubectl

• For cloud-connected mode: Registration Token

  • A valid registration token from app.qpoint.io (Settings -> Installation)

• For local mode: Configuration File

  • Prepare your Qtap YAML config file

Install Qpoint Helm Repo

First, add the Qpoint Helm Repo:

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

helm repo update

helm search repo qpoint/qtap --versions

helm show values qpoint/qtap

Deploy Qtap

Cloud-Connected Mode

Direct

helm install qtap qpoint/qtap \
  -n qpoint \
  --create-namespace \
  --set logLevel=info \
  --set registrationToken=$TOKEN

Kubernetes Secrets

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

kubectl create namespace qpoint

1. Create a secret containing your registration token:

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

1. Deploy Qtap using Helm, referencing the secret:

helm install qtap qpoint/qtap \
  -n qpoint \
  --set logLevel=info \
  --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.

Local Mode

For local mode, you'll need to provide your Qtap configuration using a YAML file. First, create your configuration file qtap-config.yaml and supply it via your helm command:

helm install qtap qpoint/qtap \
  -n qpoint \
  --create-namespace \
  --set logLevel=info \
  --set-file config=./qtap-config.yaml

Verifying the Deployment

To verify that Qtap is running:

kubectl get pods -n qpoint

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

Uninstalling Qtap

To uninstall Qtap:

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.7.0"

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.