Skip to content

Commit de7c8d5

Browse files
committed
docs: Update README files for v2.0.0 changes
- Remove deprecated grafana.enabled=false requirement for PostgreSQL - Update note about Grafana compatibility with both MySQL and PostgreSQL - Add Gateway API HTTPRoute deployment scenario documentation - Regenerate charts/devlake/README.md with helm-docs to reflect: - httpRoute configuration options (9 new parameters) - grafana.enabled default changed to true - database.type default to mysql - database.externalPort updated to match database type
1 parent f832cb4 commit de7c8d5

2 files changed

Lines changed: 37 additions & 7 deletions

File tree

‎README.md‎

Lines changed: 25 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -132,8 +132,7 @@ helm install devlake devlake/devlake \
132132
helm install devlake devlake/devlake \
133133
--set database.type=postgresql \
134134
--set database.password=<strong-password> \
135-
--set lake.encryptionSecret.secret=$ENCRYPTION_SECRET \
136-
--set grafana.enabled=false
135+
--set lake.encryptionSecret.secret=$ENCRYPTION_SECRET
137136
```
138137

139138
5. **Access the application**:
@@ -261,7 +260,7 @@ database:
261260
database: "lake"
262261
```
263262
264-
**Important**: PostgreSQL support requires `grafana.enabled=false` unless using external Grafana configured for PostgreSQL.
263+
**Note**: Grafana is enabled by default (since v2.0.0) and supports both MySQL and PostgreSQL databases.
265264
266265
### Storage Configuration
267266
@@ -367,6 +366,29 @@ helm install devlake devlake/devlake \
367366

368367
Access at: `https://devlake.example.com`
369368

369+
### Gateway API HTTPRoute
370+
371+
For Kubernetes Gateway API integration:
372+
373+
```bash
374+
helm install devlake devlake/devlake \
375+
--set httpRoute.enabled=true \
376+
--set httpRoute.gatewayName=my-gateway \
377+
--set httpRoute.gatewayNamespace=gateway-system \
378+
--set httpRoute.hostnames[0]=devlake.example.com \
379+
--set database.password=<password> \
380+
--set database.mysql.rootPassword=<root-password> \
381+
--set lake.encryptionSecret.secret=$ENCRYPTION_SECRET
382+
```
383+
384+
**Configuration options**:
385+
- `httpRoute.prefix`: Path prefix (default: `/`)
386+
- `httpRoute.sectionName`: Gateway listener name (optional)
387+
- `httpRoute.annotations`: Additional HTTPRoute annotations
388+
- `httpRoute.extraPaths`: Additional path-based routes
389+
390+
Access at: `http://devlake.example.com` (HTTPS via Gateway TLS configuration)
391+
370392
### Production Deployment (Full Security)
371393

372394
```bash

‎charts/devlake/README.md‎

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ Apache DevLake is an open-source dev data platform that ingests, analyzes, and v
3737
| database.containerSecurityContext.readOnlyRootFilesystem | bool | `true` | |
3838
| database.containerSecurityContext.runAsNonRoot | bool | `true` | |
3939
| database.database | string | `"lake"` | |
40-
| database.externalPort | int | `5432` | |
40+
| database.externalPort | int | `3306` | |
4141
| database.externalServer | string | `"127.0.0.1"` | |
4242
| database.extraLabels | object | `{}` | |
4343
| database.image.pullPolicy | string | `"IfNotPresent"` | |
@@ -68,7 +68,7 @@ Apache DevLake is an open-source dev data platform that ingests, analyzes, and v
6868
| database.storage.size | string | `"50Gi"` | |
6969
| database.storage.type | string | `"pvc"` | |
7070
| database.tolerations | list | `[]` | |
71-
| database.type | string | `"postgresql"` | |
71+
| database.type | string | `"mysql"` | |
7272
| database.useExternal | bool | `false` | |
7373
| database.username | string | `"merico"` | |
7474
| externalSecrets.enabled | bool | `false` | |
@@ -84,7 +84,7 @@ Apache DevLake is an open-source dev data platform that ingests, analyzes, and v
8484
| grafana."grafana.ini".server.serve_from_subpath | string | `"true"` | |
8585
| grafana.adminPassword | string | `""` | |
8686
| grafana.deploymentStrategy.type | string | `"Recreate"` | |
87-
| grafana.enabled | bool | `false` | |
87+
| grafana.enabled | bool | `true` | |
8888
| grafana.env.TZ | string | `"UTC"` | |
8989
| grafana.envFromConfigMaps[0].name | string | `"devlake-db-auth-config"` | |
9090
| grafana.envFromSecrets[0].name | string | `"devlake-db-auth"` | |
@@ -98,6 +98,15 @@ Apache DevLake is an open-source dev data platform that ingests, analyzes, and v
9898
| grafana.persistence.size | string | `"4Gi"` | |
9999
| grafana.serviceAccount.create | bool | `false` | |
100100
| grafana.serviceAccount.nameOverride | string | `"{{ include \"devlake.serviceAccountName\" . }}"` | |
101+
| httpRoute.annotations | object | `{}` | |
102+
| httpRoute.enabled | bool | `false` | |
103+
| httpRoute.extraLabels | object | `{}` | |
104+
| httpRoute.extraPaths | list | `[]` | |
105+
| httpRoute.gatewayName | string | `""` | |
106+
| httpRoute.gatewayNamespace | string | `""` | |
107+
| httpRoute.hostnames | list | `[]` | |
108+
| httpRoute.prefix | string | `"/"` | |
109+
| httpRoute.sectionName | string | `""` | |
101110
| imageDigests.database.mysql | string | `""` | |
102111
| imageDigests.database.postgresql | string | `""` | |
103112
| imageDigests.grafana | string | `""` | |
@@ -110,7 +119,6 @@ Apache DevLake is an open-source dev data platform that ingests, analyzes, and v
110119
| ingress.enableHttps | bool | `false` | |
111120
| ingress.enabled | bool | `false` | |
112121
| ingress.extraLabels | object | `{}` | |
113-
| ingress.extraPaths | list | `[]` | |
114122
| ingress.hostname | string | `"localhost"` | |
115123
| ingress.httpPort | int | `80` | |
116124
| ingress.httpsPort | int | `443` | |

0 commit comments

Comments
 (0)