Upgrade on Azure

The following tutorial upgrades your Materialize deployment running on Azure Kubernetes Service (AKS). The tutorial assumes you have installed the example on Install on Azure.

Upgrade guidelines

When upgrading:

NOTE: For major version upgrades, you can only upgrade one major version at a time. For example, upgrades from v26.1.0 to v27.3.0 is permitted but v26.1.0 to v28.0.0 is not.
NOTE: Downgrading is not supported.

Prerequisites

Required Tools

Upgrade process

! Important: The following procedure performs a rolling upgrade, where both the old and new Materialize instances are running before the old instances are removed. When performing a rolling upgrade, ensure you have enough resources to support having both the old and new Materialize instances running.

Step 1: Set up

  1. Open a Terminal window.

  2. Configure Azure CLI with your Azure credentials. For details, see the Azure documentation.

  3. Go to the Terraform directory for your Materialize deployment. For example, if you deployed from the azure/examples/simple directory:

    cd materialize-terraform-self-managed/azure/examples/simple
    
  4. Configure kubectl to connect to your AKS cluster, replacing:

    • <your-resource-group-name> with your resource group name; i.e., the resource_group_name in the Terraform output or in the terraform.tfvars file.

    • <your-aks-cluster-name> with your cluster name; i.e., the aks_cluster_name in the Terraform output. For the sample example, your cluster name has the form {prefix_name}-aks; e.g., simple-demo-aks`.

    # az aks get-credentials --resource-group <your-resource-group-name> --name <your-aks-cluster-name>
    az aks get-credentials --resource-group $(terraform output -raw resource_group_name) --name $(terraform output -raw aks_cluster_name)
    

    To verify that you have configured correctly, run the following command:

    kubectl get nodes
    

    For help with kubectl commands, see kubectl Quick reference.

Step 2: Update the Helm Chart

! Important: Always upgrade the Materialize Operator before upgrading the Materialize instances.

To update your Materialize Helm Chart repository:

  1. Update the Helm repo:

    helm repo update materialize
    
  2. View the available chart versions:

    helm search repo materialize/materialize-operator --versions
    

Step 3: Upgrade the Materialize Operator

! Important: Always upgrade the Materialize Operator before upgrading the Materialize instances.
  1. Use helm list to find the release name. The sample example deployment using the unified Terraform module deploys the Operator in the materialize namespace.

    helm list -n materialize
    

    Retrieve the release name (corresponds to the name_prefix variable specified in your terraform.tfvars) associated with the materialize-operator CHART; for example, simple-demo in the following output:

    NAME    	    NAMESPACE    REVISION   UPDATED                               STATUS     CHART                         APP VERSION
    simple-demo  materialize  1         2025-12-08 11:39:50.185976 -0500 EST   deployed  materialize-operator-v26.1.0  v26.1.0
    
  2. Export your current values to a file to preserve any custom settings:

    helm get values -n materialize simple-demo -o yaml > my-values.yaml
    
  3. Upgrade your Operator. For example, the following upgrades the Operator to v26.1.1:

    NOTE: For major version upgrades, you can only upgrade one major version at a time. For example, upgrades from v26.1.0 to v27.3.0 is permitted but v26.1.0 to v28.0.0 is not.
    helm upgrade -n materialize simple-demo materialize/materialize-operator  \
      -f my-values.yaml \
      --version v26.1.1
    
  4. Verify that the Operator is running:

    kubectl -n materialize get all
    
  5. Get the APP VERSION of the Operator.

    helm list -n materialize
    

    The APP VERSION will be the value that you will use for upgrading Materialize instances.

Step 4: Upgrading Materialize Instances

! Important: Always upgrade the Materialize Operator before upgrading the Materialize instances.

After you have upgraded your Materialize Operator, upgrade your Materialize instance(s) to the APP Version of the Operator. When upgrading Materialize Instances versions, changes are not automatically rolled out by the Operator in order to minimize unexpected downtime and avoid connection drops at critical periods. Instead, the upgrade process involves two steps:

  • First, staging the version change to the Materialize custom resource.
  • Second, rolling out the changes via a requestRollout flag.
  1. Find the name of the Materialize instance to upgrade. The sample example deployment using the unified Terraform module deploys the Materialie instance in thematerialize-environment namespace.

    kubectl get materialize -n  materialize-environment
    

    In the example deployment, the name of the instance is main.

    NAME
    main
    
  2. Stage, but not rollout, the Materialize instance version upgrade.

    kubectl patch materialize main\
      -n materialize-environment \
      --type='merge' \
      -p "{\"spec\": {\"environmentdImageRef\": \"docker.io/materialize/environmentd:v26.1.1\"}}"
    
  3. Rollout the Materialize instance version change.

    kubectl patch materialize main \
      -n materialize-environment \
      --type='merge' \
      -p "{\"spec\": {\"requestRollout\": \"$(uuidgen)\"}}"
    
  4. Verify the upgrade by checking the environmentd events:

    kubectl -n materialize-environment describe pod -l app=environmentd
    

See also

Back to top ↑