Skip to content

Installation

This guide provides step-by-step instructions to deploy QMigrator on a Kubernetes cluster using Helm.
It assumes that your cluster (AKS, EKS, GKE, or Minikube) is already provisioned and accessible via kubectl.

Step 1: Prepare the Values File

  • Customize the values.yaml file with the required properties.
  • A minimal configuration is available in values.example.yaml, which can be further modified as needed.

Tip

See the values for full reference

Step 2: Set Kubernetes Context

Make sure you’re connected to the correct Kubernetes cluster:

kubectl config get-contexts
kubectl config use-context <cluster-context>

Step 3: Create a Namespace (Optional)

kubectl create namespace qmigrator
kubectl config set-context --current --namespace=qmigrator

Step 4: Helm Login and Installation

helm registry login qmigrator.azurecr.io \
  --username <registry-user> \
  --password <registry-password>

helm install qmigrator oci://qmigrator.azurecr.io/helm/qmig -n qmigrator --create-namespace -f values.example.yaml

To upgrade later:

helm upgrade qmigrator oci://qmigrator.azurecr.io/helm/qmig -n qmigrator -f values.example.yaml

Step 5: Verify Deployment

Check if the pods are running:

kubectl get pods -n qmigrator

Post-Installation: Gateway API Setup

  • To expose QMigrator externally, follow the Gateway Controller for gateway configuration.