🎃 Add a Helm chart for self-hosted Kubernetes installs
维护者通常 1 天内回复
还没有人认领这个 Issue。
评估
- 难度
- 5/5
- 预计耗时
- 一周以上
- 新手友好度
- 38/100
- Issue 类型
- 功能
- 描述清晰度
- 描述清楚
- 活跃度
- 活跃
- 技术栈
- docker, helm, kubernetes, postgresql, redis, typescript
- 领域
- devops, infrastructure
调研方向
Start with docker-compose.yml:36–110 and Dockerfile:158–175 to map the app’s environment, ports, and runtime, then read the secret validation and health endpoint references. Build and validate the chart under deploy/helm/anythingmcp with helm lint and helm template, then test installation and upgrade on kind or minikube. Done means the acceptance criteria pass, including stable generated secrets and the Helm documentation.
由索引模型根据 Issue 内容生成。
描述
Part of the October Challenge #846.
Why
Companies that self-host AnythingMCP increasingly run everything on Kubernetes (AKS, EKS, OpenShift, k3s) and do not want to translate docker-compose.yml by hand. A maintained chart in the repo is the standard entry point (n8n, Langfuse, Flowise and Dify all ship one). This issue is the first step: a single-replica chart that mirrors the Compose stack and passes helm lint.
Self-hosted vs Cloud
- Self-hosted: this is the whole point. Works for Community and Business; the license key is entered in the UI as today, nothing edition-specific in the chart.
- Cloud (
DEPLOYMENT_MODE=cloud): not affected. AnythingMCP Cloud is deployed bydocker-compose.cloud.yml+deploy/cloud/; do not change those files, and the chart must not exposeDEPLOYMENT_MODEas a value (it is our operating mode, not a user option). - Who can use it: cluster operators. No app roles involved; the first user who registers becomes
ADMINas with Compose.
What to build
deploy/helm/anythingmcp/ with Chart.yaml (apiVersion v2, appVersion = root package.json version, currently 0.18.0), values.yaml, templates/, README.md.
- App — one
Deploymentfromhelpcodeai/anythingmcp:<appVersion>running the default./start.sh(backend + frontend in one container, migrations on start).replicas: 1andstrategy: Recreatein this first version (see Out of scope for why). Ports3000(http) and4000(api), oneService. - Env — everything the
appservice sets indocker-compose.yml:50–99, as values. Required secrets in a chart-managedSecretorexistingSecret:JWT_SECRET,ENCRYPTION_KEY(min. 32 chars; must never change after install),MCP_API_KEY/MCP_BEARER_TOKEN, DB password. Do not ship defaults: the backend refuses placeholder values at startup (secrets.util.ts:41); userequiredin templates, or generate withrandAlphaNumand keep them stable across upgrades withlookup. - PostgreSQL —
postgresql.enabled: truedeploys a simpleStatefulSetofpostgres:17-alpinewith a PVC (no third-party subchart).externalDatabase.url/existingSecretwhenenabled: false→ buildsDATABASE_URL. - Redis — optional (
redis.enabled: falseby default, like Compose); when on, a smallredis:7-alpineDeployment andREDIS_URLset.externalRedis.urlalternative. - MOTIS — optional (
motis.enabled: false); when on, also addmotistoSSRF_ALLOWED_HOSTSand setMOTIS_INTERNAL_URL(docker-compose.yml:77–85,:135). - Ingress — optional,
className,hosts,tls. Route the backend paths to port 4000 and everything else to 3000. Take the list from therewrites()inpackages/frontend/next.config.ts:19(the Cloud Caddyfile says it must match it):/api,/health,/mcp,/.well-known,/auth,/sso,/authorize,/callback,/token,/register,/userinfo, plus/revokefromsetup.sh:463. (setup.sh:455–467is older and misses/ssoand/userinfo.) Document nginx annotations for SSE/streaming (proxy-buffering: off, longproxy-read-timeout). SetSERVER_URL,FRONTEND_URL,CORS_ORIGIN,NEXT_PUBLIC_API_URLfrom the first host. - Probes —
startupProbeHTTPGET /healthon 4000 with a generousfailureThreshold(migrations run first);readinessProbeGET /health;livenessProbetcpSocket 4000, not/health(it checks the database, and a DB blip must not restart the app —health.controller.ts:74). securityContext: non-root (the image runs asappuser,Dockerfile:158),resources,nodeSelector/tolerations/affinity,podAnnotations,serviceAccount.- CI (optional but welcome): a job in
.github/workflows/ci.ymlrunninghelm lintandhelm template(orchart-testingct lint).
Where to look
docker-compose.yml:36–110(app),:113(postgres),:135(motis),:156(commented redis) — source of truth for services and env.start.sh:57,:64—frontend/allmodes;run_migrationsat the top.Dockerfile:158–175— user, ports, healthcheck, CMD.packages/backend/src/health/health.controller.ts:74—/health(DB, Redis, heap).packages/backend/src/common/secrets.util.ts:41— startup secret validation.setup.sh:455— path routing the Compose Caddy setup uses.deploy/cloud/Caddyfile:76–123— explains why a split frontend/backend needs explicit backend routes (Next rewrites are baked withlocalhost:4000).docs/deployment.md:159— production deployment docs to extend.
Acceptance criteria
-
helm lint deploy/helm/anythingmcppasses with default values and withpostgresql.enabled=false,externalDatabase.url=…. -
helm installon kind/minikube: pod becomes Ready, UI reachable via port-forward/Ingress, registration works,/mcp/<serverId>answers with an API key. Put the exact commands you ran in the PR. -
helm upgradekeeps generated secrets (no newENCRYPTION_KEY, which would make stored credentials unreadable). - No secret value appears in
helm templateoutput unless the user passed it. - Docs:
deploy/helm/anythingmcp/README.md(values table) + a "Kubernetes (Helm)" section indocs/deployment.md.
Out of scope
- Multiple replicas / HPA / split frontend+backend pods. Needs Redis for shared rate limits,
MCP_STATEFUL_SESSIONSoff or sticky sessions (mcp-session.manager.ts:67), and migrations moved to a Job — follow-up issue. - Publishing the chart to a Helm repo / OCI registry, Artifact Hub listing.
- Operator, Kustomize, Terraform.
- Prometheus
ServiceMonitor(comes after the metrics endpoint in #854).
Size
L (several days, may be split: chart + lint first, Ingress/MOTIS second).
How to claim
Comment "I'd like to work on this" and we'll assign you. Rules in #846.
- 主要语言
- TypeScript
- 星标
- 856
- 派生
- 82
- 平均合并
- 6 小时 30 分钟
- 30 天内合并 PR
- 205
环境准备
这个项目没有提供开发容器、Dockerfile 或贡献指南,环境需要你自己搭建:先看它的 README,通用步骤见我们的新手贡献指南。
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
HelpCode-ai/anythingmcp 的其他 Issue
-
Docs: document all SMTP_* and other undocumented env vars for self-hosting可能已有人在做 @notlakshitha 于 7 天前认领。 未关闭enhancement
难度 2/5 1-3 小时 新手友好度 82/100
HelpCode-ai/anythingmcp#1049 · 3 条评论 ·
维护者通常 1 天内回复
-
good first issue hacktoberfest
难度 2/5 半天 新手友好度 70/100
HelpCode-ai/anythingmcp#996 ·
维护者通常 1 天内回复
-
good first issue hacktoberfest
难度 2/5 半天 新手友好度 72/100
HelpCode-ai/anythingmcp#995 ·
维护者通常 1 天内回复
-
enhancement good first issue hacktoberfest help wanted
难度 2/5 1-3 小时 新手友好度 78/100
HelpCode-ai/anythingmcp#982 · 2 条评论 ·
维护者通常 1 天内回复
-
难度 5/5 一周以上 新手友好度 18/100
HelpCode-ai/anythingmcp#1174 · 1 条评论 ·
维护者通常 1 天内回复
查看 HelpCode-ai/anythingmcp 的全部 Issue
相似的 Issue
-
check:passed streams:edit
难度 2/5 1-3 小时 新手友好度 68/100
维护者通常 1 天内回复
-
area:mcp bug has repro platform:vscode regression
难度 2/5 1-3 小时 新手友好度 68/100
anthropics/claude-code#103970 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 78/100
维护者通常 1 天内回复
-
bug
难度 2/5 1-3 小时 新手友好度 84/100
维护者通常 1 天内回复
-
sdk-typescript: unquoted COPY globs in shell form are silently dropped from the image build context未关闭bug javascript
难度 2/5 1-3 小时 新手友好度 78/100
维护者通常 1 天内回复