Skip to content

Commit 22ede66

Browse files
committed
Cleanup unnecessary details
1 parent 2b63a49 commit 22ede66

21 files changed

Lines changed: 34 additions & 1883 deletions

DEPLOYMENT_GUIDE.md

Lines changed: 17 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -46,18 +46,27 @@ MYSQL_PASSWORD=<generated>
4646

4747
### Kubernetes / Helm
4848

49-
The RAGFlow Helm chart lives in `deployment/ragflow/` in the implementation repository. Chart version: 0.2.0, app image: `infiniflow/ragflow:v0.23.1`.
49+
Use the official upstream RAGFlow Helm chart:
50+
51+
- Chart source: https://github.com/infiniflow/ragflow/tree/main/helm
52+
- Upstream README: https://github.com/infiniflow/ragflow/blob/main/helm/README.md
53+
- Upstream values: https://github.com/infiniflow/ragflow/blob/main/helm/values.yaml
5054

5155
**Install:**
5256

5357
```sh
54-
helm install ragflow ./deployment/ragflow \
58+
git clone https://github.com/infiniflow/ragflow.git
59+
cd ragflow/helm
60+
61+
helm upgrade --install ragflow . \
5562
-n <namespace> \
56-
-f deployment/ragflow/values.yaml \
57-
-f values-<env>.yaml
63+
--create-namespace \
64+
-f values.override.yaml
5865
```
5966

60-
**Architecture** (what the chart deploys):
67+
Maintain your own `values.override.yaml` outside this repository and keep it aligned with the upstream chart version you deploy.
68+
69+
**Upstream chart architecture**:
6170

6271
- RAGFlow application (port 80 web, 9380 API, 9381 admin)
6372
- Elasticsearch 8.11.3 (20Gi storage)
@@ -67,7 +76,7 @@ helm install ragflow ./deployment/ragflow \
6776

6877
### Helm Values Reference
6978

70-
Base values (`values.yaml`):
79+
Use the upstream chart's `values.yaml` as the source of truth. The most important settings to review are:
7180

7281
| Key | Default | Description |
7382
|---|---|---|
@@ -82,7 +91,7 @@ Base values (`values.yaml`):
8291
| `ingress.enabled` | `true` | Enable ingress |
8392
| `env.REGISTER_ENABLED` | (unset) | Set `"0"` to disable self-registration |
8493

85-
Environment overrides (per-env files):
94+
Typical environment-specific overrides:
8695

8796
| Setting | Dev | Prod |
8897
|---|---|---|
@@ -92,7 +101,7 @@ Environment overrides (per-env files):
92101

93102
### Security
94103

95-
**Database credentials:** Create Kubernetes secrets for all passwords. Never put credentials in `values.yaml`.
104+
**Database credentials:** Create Kubernetes secrets for all passwords. Never put credentials in `values.yaml` or commit them into this repository.
96105

97106
```sh
98107
kubectl create secret generic ragflow-mysql \

deployment/ragflow/.helmignore

Lines changed: 0 additions & 23 deletions
This file was deleted.

deployment/ragflow/Chart.yaml

Lines changed: 0 additions & 24 deletions
This file was deleted.

0 commit comments

Comments
 (0)