Skip to main content
Reporter generates financial reports, regulatory filings, and custom data exports from Midaz ledger data. It runs a manager and a worker so that report generation scales apart from the API. The chart name is reporter-helm.

​
What the chart installs

The chart installs two workloads:
  • Manager: the API service that stores templates and orchestrates report generation. It gets a Deployment, a Service, a ConfigMap, a Secret, a ServiceAccount, a ClusterRole, a HorizontalPodAutoscaler, a PodDisruptionBudget, and an optional Ingress.
  • Worker: the background processor that renders the reports. It runs as a KEDA ScaledJob and scales on the queue depth.
The manager publishes a job to RabbitMQ. The worker consumes it, reads the ledger data, renders the document, and writes the result to object storage. The chart bundles KEDA, an S3-compatible object store, MongoDB, RabbitMQ, and Valkey, and it enables each of them by default. Disable any of them to use an externally managed service instead. Set keda.external: true when a KEDA operator already runs in the cluster.

​
Prerequisites

  • A running Midaz deployment with reachable API endpoints and a readable database replica.
  • A storage class that supports dynamic provisioning, for MongoDB, RabbitMQ, and the object store.
  • Helm 3.8 or later for OCI registry support.

​
Install

Read the current chart version first, then install:

​
Values you must set

Set these keys under the top-level secrets block, or supply your own Secret: Leave MONGO_PASSWORD empty while the bundled MongoDB subchart is enabled. The subchart generates the password into its own Secret, and the services read it from there.

​
Upgrade and uninstall

Uninstalling removes the Kubernetes resources. It leaves the PersistentVolumeClaims and the generated reports in place. Delete them separately when you want to reclaim the storage.

​
Resources