Skip to content

Commit ce85366

Browse files
committed
update README
1 parent 52cd3fe commit ce85366

1 file changed

Lines changed: 6 additions & 31 deletions

File tree

README.md

Lines changed: 6 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,16 @@
11
# Lago Helm Chart
22

3-
This Helm chart deploys the Lago billing system with various optional dependencies such as Redis, PostgreSQL, and MinIO. Below are details about configuring the chart for different environments.
4-
5-
## Current Releases
6-
7-
| Project | Release Badge |
8-
|--------------------|-----------------------------------------------------------------------------------------------------|
9-
| **Lago** | [![Lago Release](https://img.shields.io/github/v/release/getlago/lago)](https://github.com/getlago/lago/releases) |
10-
| **Helm Chart** | [![Helm Chart Release](https://img.shields.io/github/v/release/getlago/lago-helm-charts)](https://github.com/getlago/lago-helm-charts/releases) |
3+
This Helm chart deploys the Lago billing system with optional dependencies on MinIO. Below are details about configuring the chart for different environments.
114

125

136
## Prerequisites
147

158
- Kubernetes 1.19+
169
- Helm 3.5+
1710
- Persistent storage provisioner enabled in the cluster
18-
- Optionally: A managed Redis, Minio and PostgreSQL service for production environments
11+
- Optionally: Minio ervice for staging environments
12+
13+
:warning: Please note that we strongly recommend to use managed PostgreSQL, REDIS and S3 in a production environment.
1914

2015
## Installation
2116

@@ -53,26 +48,6 @@ helm install my-lago-release . \
5348
| `global.googleAuth.enabled` | Enable or disable logging through Google Auth | `true` |
5449
| `global.ingress.enabled` | Enable ingress resources for the application | `false` |
5550

56-
### Redis Configuration
57-
58-
| Parameter | Description | Default |
59-
|---------------------------------|-----------------------------------------------------|-----------|
60-
| `redis.enabled` | Enable Redis as a dependency | `true` |
61-
| `redis.image.tag` | Redis image tag | `6.2.14` |
62-
| `redis.replica.replicaCount` | Number of Redis replicas | `0` |
63-
| `redis.auth.enabled` | Enable Redis authentication | `false` |
64-
| `redis.master.service.ports` | Redis service port | `6379` |
65-
66-
### PostgreSQL Configuration
67-
68-
| Parameter | Description | Default |
69-
|-------------------------------------|----------------------------------------------------|-----------|
70-
| `postgresql.enabled` | Enable PostgreSQL as a dependency | `true` |
71-
| `global.postgresql.auth.username` | PostgreSQL database username | `lago` |
72-
| `global.postgresql.auth.password` | PostgreSQL database password | `lago` |
73-
| `global.postgresql.auth.database` | PostgreSQL database name | `lago` |
74-
| `global.postgresql.service.ports` | PostgreSQL service port | `5432` |
75-
7651
### Frontend Configuration
7752

7853
| Parameter | Description | Default |
@@ -344,11 +319,11 @@ The following keys are expected:
344319

345320
## Storage Recommendation
346321

347-
We **strongly recommend** using either **Amazon S3** or **MinIO** for object storage when deploying Lago. These solutions provide reliable, scalable storage that can be accessed by multiple pods without encountering issues.
322+
We **strongly recommend** using either **Amazon S3** alternatives for object storage when deploying Lago. These solutions provide reliable, scalable storage that can be accessed by multiple pods without encountering issues.
348323

349324
If neither S3 nor MinIO is configured, the system will default to using a Persistent Volume Claim (PVC). However, this approach is **strongly discouraged** as it can lead to issues such as multi-attach errors when volumes are accessed by more than one pod simultaneously. For this reason, it is important to configure S3 or MinIO to avoid potential complications with PVCs.
350325

351-
By opting for S3 or MinIO, you ensure better reliability and scalability for your deployment.
326+
By opting for S3 or alternatives, you ensure better reliability and scalability for your deployment.
352327

353328
For additional customization, refer to the comments in `values.yaml`.
354329

0 commit comments

Comments
 (0)