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 manual authorization management for Enterprise MCP resources

Đang mở Phù hợp với người mới
  • Có gì không ổn?
#1,258 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

Chưa có ai nhận issue này.

Đánh giá

Độ khó
2/5
Thời gian dự kiến
1-3 giờ
Mức phù hợp với người mới
82/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ệ
javascript
Lĩnh vực
documentation

Hướng nghiên cứu

Đọc docs/platform/enterprise-authz/intro.mdx, docs/platform/enterprise-authz/namespace-self-service.mdx và docs/toolhive/guides-k8s/authorization-k8s.mdx để làm theo hướng dẫn hiện có và tìm vị trí đặt liên kết. Thêm bài hướng dẫn thực hành tập trung trong docs/platform/enterprise-authz/ và thêm tham chiếu chéo từ hai hướng dẫn. Hoàn tất khi bài viết giải thích ngữ nghĩa của annotation, hành vi khi di chuyển và chuyển chế độ, cũng như cách nhận biết các đích policy không được quản lý.

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?

Add customer-facing guidance for preserving hand-authored Cedar authorization on MCPServer, MCPRemoteProxy, and VirtualMCPServer resources when Enterprise Manager is installed.

Enterprise Manager manages authorization by default. Administrators can opt a resource out of enterprise-managed authorization with:

metadata:
  annotations:
    enterprise.toolhive.stacklok.dev/authz-management: manual

The manual resource owns its authzConfig; Enterprise Manager skips authorization compilation, ConfigMap writes, patching, drift correction, and cleanup for that resource.

The guide should cover:

  • Choosing enterprise-managed authorization or manual Cedar, with examples for MCPServer/MCPRemoteProxy.spec.authzConfig and VirtualMCPServer.spec.incomingAuth.authzConfig.
  • Safely migrating existing OSS-authored inline Cedar manifests. Without the annotation, Enterprise Manager owns authzConfig and clears it when no ToolhiveAuthorizationPolicy targets the resource.
  • Exact annotation semantics: only manual opts out. Absent or empty values remain managed; other values remain managed and emit AuthzManagementValueIgnored.
  • Recognizing ignored policies: a ToolhiveAuthorizationPolicy targeting a manual resource emits AuthzUnmanaged and has Applied=False with reason TargetManuallyManaged.
  • Switching modes safely. Entering manual mode does not itself replace an existing generated ConfigMap reference; the administrator must supply the intended authzConfig. Returning to managed mode resumes reconciliation and can clear inline configuration when no policy targets the resource.

Context and references

The existing Enterprise authorization guidance does not explain this management choice or the annotation.

Suggested placement: a focused how-to under docs/platform/enterprise-authz/, linked from the enterprise authorization introduction. Add a short cross-reference from the ToolHive Kubernetes authorization guide so operators bringing existing manifests to Enterprise can find the migration guidance.

Related source pages:

  • docs/platform/enterprise-authz/intro.mdx
  • docs/platform/enterprise-authz/namespace-self-service.mdx
  • docs/toolhive/guides-k8s/authorization-k8s.mdx

Use case

As a platform operator moving existing MCP resources from OSS ToolHive to Enterprise, I need to preserve their hand-authored authorization policies and understand which controller owns them, so reconciliation does not remove the access restrictions I intended to enforce.

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.