Deploy to Kubernetes

#Prepare a Kubernetes cluster

Make sure you have a running Kubernetes cluster and it's configured in your kubectl config.

To quickly try deploying OpenMeter to a local Kubernetes cluster, we recommend using Kind:

kind create cluster

#Deploy OpenMeter with Helm

The official OpenMeter Helm chart is published on GitHub Container Registry.

For development deployments, the OpenMeter Helm chart deploys Kafka and ClickHouse as part of the installation.

Install the OpenMeter Helm chart with default values:

helm upgrade --install openmeter oci://ghcr.io/openmeterio/helm-charts/openmeter

See the available values in here.

Once the openmeter pod is ready, you can use port-forward to access the API. The chart exposes the API on a Service named <release-name>-api listening on port 80:

kubectl port-forward svc/openmeter-api 8888:80

You can follow the quickstart guide to send data to OpenMeter.