[Feature][Grafana][config-ui] Gaps when running DevLake with a managed PostgreSQL and an external Grafana
维护者通常 3 天内回复
还没有人认领这个 Issue。
评估
- 难度
- 3/5
- 预计耗时
- 1-2 天
- 新手友好度
- 42/100
- Issue 类型
- 功能
- 描述清晰度
- 基本清楚
- 活跃度
- 活跃
- 技术栈
- docker-compose, nginx, postgresql, shell, typescript, vite
- 领域
- devops, frontend, observability
调研方向
This is a tracking issue for several separate gaps, so pick one item and work only on it. For the Grafana side, start in grafana/scripts/entrypoint.sh, where DATABASE_SSL_MODE and the hard-coded admin user are read, and check docker-compose-dev-postgresql.yml and env.example for the missing pass-through. For the config-ui side, start in nginx.conf for the external-Grafana redirect and in config-ui/routes/onboard/step-4.tsx and components/card.tsx for the Check Dashboard button. Done means the chosen item works as described with defaults unchanged.
由索引模型根据 Issue 内容生成。
描述
Search before asking
- I had searched in the issues and found no similar feature requirement.
Use case
We run DevLake in Kubernetes with a managed PostgreSQL (TLS with a
corporate CA, sslmode=verify-full) and want to use a managed / external
Grafana. Data sources are GitHub, GitLab, Jira and SonarQube.
The backend handles this setup fine (DB_URL is passed unchanged to pgx, so
sslmode=verify-full&sslrootcert=… works). The gaps are in the dashboard image
(grafana/scripts/entrypoint.sh) and in the config-ui. This issue collects
them in one place, so that the small PRs below can refer to it.
Description
Verified on main @ 4ad2f66df, PostgreSQL mode only. We do not run MySQL,
so MySQL paths are left unchanged and untested.
A. Dashboard image ↔ managed PostgreSQL over TLS (one small, additive PR planned)
-
DATABASE_SSL_MODEis read byentrypoint.sh(defaultdisable), but
docker-compose-dev-postgresql.yml/env.exampledo not pass it
through (follow-up to #9207). Proposal:GRAFANA_DATABASE_SSL_MODE
→DATABASE_SSL_MODE, defaultdisable. - The PostgreSQL datasource payload has no
sslRootCertFile/
sslCertFile/sslKeyFile, soverify-ca/verify-fullagainst a
private CA fails. Proposal: optionalDATABASE_SSL_ROOT_CERT
(+_CERT/_KEY) →jsonData.tlsConfigurationMethod: "file-path". - The API calls use a hard-coded
admin:user. Renaming the admin via
GF_SECURITY_ADMIN_USERsilently breaks datasource creation, because
the POST status is not checked. Proposal:${GF_SECURITY_ADMIN_USER:-admin}
plus a status check with a log message. - The entrypoint deletes all datasources on every start ("clean
slate"). This is destructive when the Grafana state is shared (GF_DATABASE_*,
several replicas, manually added datasources). Proposal for the PR: an
opt-outDATASOURCE_CLEAN_SLATE=false. The default staystrue, so
the current behaviour is unchanged.
B. config-ui ↔ Grafana links (one small bug-fix PR planned)
- With
USE_EXTERNAL_GRAFANA=true,nginx.confreturns
302 "${GRAFANA_ENDPOINT}"and drops the path and query, so every
/grafana/d/<uid>/…deep link lands on the Grafana home page. Proposal:
append the remaining path +$is_args$args. - Onboarding "Check Dashboard" (GitHub / GitLab,
routes/onboard/step-4.tsx,components/card.tsx) calls
window.open(import.meta.env.DEVLAKE_DASHBOARD_URL_*). The released
image is built without a.envand the code has no fallback, so the
button opens an empty tab. The example values inconfig-ui/env.example
point to the MySQL UIDs (KXWvOFQnz,msSjEq97z), while the PostgreSQL
dashboards use…-pg. Proposal: a DB-independent fallback (e.g.
/grafana/dashboards?query=GitHub), or hide the button when the
variable is empty. Also document the PostgreSQL UIDs.
C. Open points, no PR planned for now (feedback welcome)
- Clean slate, alternatives to the opt-out: (i) delete only the DevLake
datasource (UIDdevlake-postgres-api/devlake-mysql-api), or
(iii) switch to file provisioning with env interpolation instead of the
API. - Root-level dashboards
ClaudeCodeAdoption*.json,Incidentio.json,
Linear.jsonandRootly.jsonreference the MySQL datasource
devlake-mysql-api, but are also shipped in PostgreSQL mode, where they
show datasource errors. Moving them todashboards/mysql/(plus
PostgreSQL variants), and adding a dashboard-check rule against files
directly underdashboards/, would fix this. -
DEVLAKE_GRAFANA_PATH/DEVLAKE_DASHBOARD_URL_*are build-time only
(ViteenvPrefix). With relative/grafana/…links and the redirect
fix from B this is fine for us. Runtime configuration (e.g. an
env-config.jsgenerated bynginx.sh) would only matter for setups
with different dashboard UIDs or a non-default Grafana org. Noted here
for completeness.
Related issues
- #5009 — config-ui image support for optional/external Grafana (introduced
USE_EXTERNAL_GRAFANA) - #9207 — Grafana against an external database via Compose (
GRAFANA_DATABASE_*) - #4286 — deploying DevLake in a production setting
Are you willing to submit a PR?
- Yes I am willing to submit a PR!
I will open the PRs for A and B one after another and link them here. They
are small and additive, and the defaults are unchanged.
Code of Conduct
- I agree to follow this project's Code of Conduct
- 主要语言
- Go
- 星标
- 3.2k
- 派生
- 819
- 平均合并
- 2 天 21 小时
- 30 天内合并 PR
- 46
环境准备
在浏览器里用你自己的 GitHub 账号启动这个项目的开发容器。
- 没有 Dockerfile 或 Docker Compose 文件
- 有 Pull Request 模板
- 没有贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
apache/devlake 的其他 Issue
-
[Bug][e2e] Several plugin e2e tests fail on a fresh database because they depend on tables created by other tests可能已有人在做 @chenwei791129 今天认领。 未关闭
难度 4/5 3-5 天 新手友好度 35/100
维护者通常 3 天内回复
-
难度 5/5 一周以上 新手友好度 15/100
维护者通常 3 天内回复
-
难度 3/5 半天 新手友好度 62/100
维护者通常 3 天内回复
-
难度 4/5 3-5 天 新手友好度 35/100
维护者通常 3 天内回复
-
难度 2/5 1-3 小时 新手友好度 55/100
维护者通常 3 天内回复
相似的 Issue
-
copilot-api domain:platform go
难度 2/5 1-3 小时 新手友好度 72/100
维护者通常 1 天内回复
-
docs: clarify gh api -f vs -F and @-file expansion in the gh skill可能已有人在做 @MatiasOlivera 今天认领。 未关闭enhancement
难度 2/5 半天 新手友好度 62/100
维护者通常 1 天内回复
-
bug
难度 2/5 1-3 小时 新手友好度 88/100
aws/aws-advanced-go-wrapper#612 ·
-
Say in the changelog that the text-index update cannot be rolled back可能已有人在做 @praetorianer777 今天认领。 未关闭
难度 1/5 1 小时以内 新手友好度 88/100
praetorianer777/GoTome#275 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 62/100
SAP/crossplane-provider-btp#1118 ·
维护者通常 1 天内回复