Install locally on minikube

Self-managed Materialize requires:

A Kubernetes (v1.29+) cluster.
PostgreSQL as a metadata database.
Blob storage.

The following tutorial deploys the following components onto your local minikube:

Materialize Operator using Helm into your local minikube cluster.
MinIO object storage as the blob storage for your Materialize.
PostgreSQL database as the metadata database for your Materialize.
Materialize as a containerized application into your local minikube cluster.

! Important: For testing purposes only.

Prerequisites

minikube

Install minikube.

Container or virtual machine manager

The following tutorial uses Docker as the container or virtual machine manager. To use another container or virtual machine manager as listed on the minikube documentation, refer to the specific container/VM manager documentation.

Install Docker.

Resource requirements

For this local deployment, you will need:

3 CPUs
20GB memory

Helm 3.2.0+

If you don’t have Helm version 3.2.0+ installed, refer to the Helm documentation.

`kubectl`

This tutorial uses kubectl. To install, refer to the kubectl documentationq.

For help with kubectl commands, see kubectl Quick reference.

Sample configuration files

Download the following sample configuration files from the Materialize repo:

values.yaml
postgres.yaml
minio.yaml
materialize.yaml

curl -o values.yaml https://raw.githubusercontent.com/MaterializeInc/materialize/refs/heads/lts-v0.130/misc/helm-charts/operator/values.yaml
curl -o sample-postgres.yaml https://raw.githubusercontent.com/MaterializeInc/materialize/refs/heads/lts-v0.130/misc/helm-charts/testing/postgres.yaml
curl -o sample-minio.yaml https://raw.githubusercontent.com/MaterializeInc/materialize/refs/heads/lts-v0.130/misc/helm-charts/testing/minio.yaml
curl -o sample-materialize.yaml https://raw.githubusercontent.com/MaterializeInc/materialize/refs/heads/lts-v0.130/misc/helm-charts/testing/materialize.yaml

Installation

Start Docker if it is not already running.
Open a Terminal window.
Create a minikube cluster.
```
minikube start
```

Install the Materialize Helm chart.

Add the Materialize Helm chart repository.

helm repo add materialize https://materializeinc.github.io/materialize
helm repo update materialize

Install the Materialize Operator.

helm install my-materialize-operator materialize/materialize-operator \
    --namespace=materialize --create-namespace \
    --version v25.1.1 \
    --set operator.cloudProvider.region=minikube \
    -f values.yaml

Verify the installation and check the status:

kubectl get all -n materialize

Wait for the components to be in the Running state:

NAME                                           READY   STATUS    RESTARTS   AGE
pod/my-materialize-operator-669d674ccf-h5842   1/1     Running   0          12m

NAME                                      READY   UP-TO-DATE   AVAILABLE   AGE
deployment.apps/my-materialize-operator   1/1     1            1           12m

NAME                                                 DESIRED   CURRENT         READY   AGE
replicaset.apps/my-materialize-operator-669d674ccf   1         1               1       12m

If you run into an error during deployment, refer to the Troubleshooting guide.

Install PostgreSQL and minIO.
1. Use the sample-postgres.yaml file to install PostgreSQL as the metadata database:
```
kubectl apply -f sample-postgres.yaml
```
2. Use the sample-minio.yaml file to install minIO as the blob storage:
```
kubectl apply -f sample-minio.yaml
```

Optional. Install the following metrics service for certain system metrics but not required.

kubectl apply -f https://github.com/kubernetes-sigs/metrics-server/releases/latest/download/components.yaml

Install Materialize into a new materialize-environment namespace:

Use the sample-materialize.yaml file to create the materialize-environment namespace and install Materialize:
```
kubectl apply -f sample-materialize.yaml
```