Formance Stack Helm Charts
To make it easier to deploy Formance Stack components, we provide official Helm charts. To use them, install the Formance repository:
helm repo add formance https://helm.formance.com
helm repo update
You can find all the charts in the GitHub repository formancehq/helm.
We must realistically acknowledge that self-hosting the Formance Stack in a cloud-native environment can be a DevOps intensive experience. If you are not comfortable with the following, we recommend you use Formance Cloud. We are working hard on making the self-hosting experience as easy as possible, across a variety of environments.
Dependencies
Deploying the Formance Helm charts requires some downstream dependencies. Our recommendations for specifics of these below.
| Technology | Recommended Implementation | Used by |
|---|---|---|
| PostgreSQL | AWS Aurora | Ledger |
| MongoDB | MongoDB Atlas | Payments |
| Kafka | RedPanda, AWS Managed Kafka | Ledger, Payments, Search |
| OpenSearch | OpenSearch, AWS Hosted OpenSearch | Control Dashboard |
| Traefik | Traefik | Main Ingress Proxy |
| Redis | AWS Elasticache | Ledger (optional) |
Kubernetes requirements
| Requirement | Version |
|---|---|
| Kubernetes | >= 1.22 |
| Helm | 3 |
Formance Stack components
Ledger
Requirements:
- PostgreSQL
- Redis
- RedPanda or Kafka
Values : Ledger README.md
helm install ledger formance/ledger
Control
Requirements:
- All Formance components
Values : Control README.md
helm install control formance/control
Payments
Requirements:
- MongoDB
- Kafka
Values: Payments README.md
helm install payments formance/payments
Search
Requirements:
- OpenSearch
- Kafka
Values: Search README.md
helm install search formance/search
Gateway
Values: Gateway README.md
helm install gateway formance/gateway
Formance Stack chart
For development purposes and to help you deploy the entire Formance stack as a whole, we provide a Helm Chart that bundles all the components together.
We however do not provide the databases and stateful dependencies in this chart, so you have to provision them as a separate step and properly update the values to point to the correct endpoints.
Values: Stack README.md
helm install stack formance/stack