Hacktoberfest 2026:维护者为十月标记出来的 issue,仍然开放、适合新手。 浏览 Hacktoberfest issue

[Gap]: Document in-cluster connector discovery network prerequisites and recovery

已关闭
#1,161 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

@danbarr 已经在做这个了。

开始于 2026年10月7日。

  • #1220 来自 @danbarr —— 未关闭

评估

难度
3/5
预计耗时
1-2 天
新手友好度
78/100
Issue 类型
文档
描述清晰度
描述清楚
活跃度
活跃
技术栈
helm, kubernetes
领域
documentation

调研方向

先从 docs/connector-gateway/connectors.mdx 以及平台配置和部署页面开始,然后对比 API schema 中 allow_private_ips 的描述。记录 Helm allowlist 值、Service CIDR 发现、connector 状态检查、重新保存后的恢复,以及目录组授权。完成的标准是:无需依赖特定于 kind 的 CIDR,发现到提供服务的路径和故障排查顺序都清晰明确。

由索引模型根据 Issue 内容生成。

描述

documentation enhancement needs-triage

What needs documentation?

The Manage connectors page says discovery picks up MCP servers running in the cluster and that activating a connector performs an endpoint check. It does not explain the operator-side network prerequisite that makes those discovered in-cluster endpoints pass the check.

Document the complete discovery-to-serving path:

  1. Discovery returns an in-cluster Service endpoint and recommends allow_private_ips: true for that candidate.
  2. allow_private_ips alone does not authorize Enterprise Manager's verification dial to arbitrary private addresses.
  3. The platform operator must configure enterprise-manager.directory.connectorVerification.allowedPrivateRanges with the cluster ranges that discovered endpoints may use.
  4. For Kubernetes Service endpoints, the value must include the cluster's actual Service CIDR. Operators should derive it from the target cluster rather than copy a kind-specific default.
  5. Without the allowlist, connector creation can succeed while the connector is persisted in failure; only available connectors are served.
  6. After fixing the allowlist, an existing failed connector must be updated/re-saved to trigger verification again. A Helm upgrade alone does not re-check persisted rows.
  7. A newly available connector still needs directory-group grants before non-admin users can see it.

Include a values example and a verification/troubleshooting sequence that checks connector status after admission.

Context and references

The platform's operator-allowlist design was implemented by:

https://github.com/stacklok/stacklok-enterprise-platform/issues/3644

The current public API schema documents that the discovery result's allow_private_ips value is only a recommendation, but it does not lead operators to the Helm allowlist or explain why a successful create remains unserved.

Relevant source pages:

  • docs/connector-gateway/connectors.mdx
  • docs/platform/enterprise-platform/configure-connector-gateway.mdx
  • docs/platform/enterprise-platform/deployment.mdx
  • static/api-specs/enterprise-manager-api.json

Use case

As a platform operator importing MCP servers discovered in Kubernetes, I need to authorize the correct private cluster range and know how to recover failed verification, so that discovered connectors become available without weakening the SSRF boundary or hardcoding a distribution-specific CIDR.

主要语言
JavaScript
星标
4
派生
4
平均合并
22 小时 31 分钟
30 天内合并 PR
70

环境准备

在 Codespaces 中打开

在浏览器里用你自己的 GitHub 账号启动这个项目的开发容器。

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

stacklok/docs-website 的其他 Issue

查看 stacklok/docs-website 的全部 Issue

相似的 Issue

更多 JavaScript Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。