Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

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

Đã đóng
  • Có gì không ổn?
#1,161 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

@danbarr đang làm issue này rồi.

Từ ngày 7/10/2026.

  • #1220 của @danbarr — đang mở

Đánh giá

Độ khó
3/5
Thời gian dự kiến
1-2 ngày
Mức phù hợp với người mới
78/100
Loại issue
Tài liệu
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
helm, kubernetes
Lĩnh vực
documentation

Hướng nghiên cứu

Bắt đầu với docs/connector-gateway/connectors.mdx và các trang về cấu hình cũng như triển khai nền tảng, sau đó so sánh mô tả của allow_private_ips trong lược đồ API. Ghi lại các giá trị allowlist của Helm, việc phát hiện Service CIDR, các bước kiểm tra trạng thái connector, cách khôi phục bằng việc lưu lại và việc cấp quyền cho các nhóm thư mục. Hoàn tất khi đường đi từ phát hiện đến cung cấp dịch vụ và trình tự khắc phục sự cố đã rõ ràng mà không phụ thuộc vào CIDR riêng của kind.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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.

Ngôn ngữ chính
JavaScript
Star
4
Fork
4
Merge trung bình
23 giờ 10 phút
Pull request đã merge (30 ngày)
71

Chuẩn bị môi trường

Mở trong Codespaces

Khởi chạy dev container của dự án ngay trên trình duyệt, bằng tài khoản GitHub của bạn.

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của stacklok/docs-website

Tất cả issue của stacklok/docs-website

Issue tương tự

Thêm issue về JavaScript

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.