[Gap]: Document the complete Connector Gateway deployment contract
メンテナーはふだん 1 日以内に返信
まだ誰も着手していません。
評価
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 初心者へのやさしさ
- 55/100
- issue の種類
- ドキュメント
- 明瞭さ
- おおむね明確
- 活発さ
- 活発
- 技術スタック
- helm, kubernetes
調査の方向性
まず docs/platform/enterprise-platform/configure-connector-gateway.mdx を起点に、deployment.mdx、configure-identity.mdx、docs/platform/enterprise-directory/index.mdx と比較し、次に参照されている chart の値とコメントを追跡します。完全な安全な構成、焦点を絞った代替案、そしてログイン、gateway の登録、認証済みの control-plane 呼び出し、MCP data plane について個別の検証を文書化します。完了の条件は、オペレーターが文書化されていない契約の詳細を組み立てることなく、サポート対象の単一のチェックリストに従えることです。
索引モデルが issue の本文から書いたものです。
説明
What needs documentation?
The Configure the Connector Gateway page currently shows only:
global.stacklok.connectorGateway.enabledglobal.stacklok.connectorGatewayIdglobal.stacklok.authServerIssuer
That is not enough to deploy a working Connector Gateway. The chart requires a coupled set of auth-server, incoming-auth, directory, key-management, storage, corporate-IdP, and Enterprise Manager values. Operators currently discover them one failure at a time from Helm errors, pod logs, and the chart's very long values.yaml comments.
Add a complete, task-oriented configuration path that covers at least:
vmcpConfig.incomingAuth.type: oidc, issuer, audience/resource, and how those values must match the auth server'sallowed_audiences.enterpriseConfig.authServer, including its schema, upstream behavior, storage contract, and the fact that auth-less mode is not supported.kekandauthServerKeys, including the production recommendation to use existing Secrets rather than render-unstable generated values.enterpriseConfig.directory.addrand binding claims.- The two supported Directory transport arms:
- production TLS, projected ServiceAccount token, caller issuer/audience, and subject allowlists on Enterprise Manager;
- the development-only cleartext configuration, which currently requires matching client and server flags.
- The corporate primary IdP's audience/client requirements for both cloud-ui and the Connector Gateway control plane.
- The Enterprise Manager platform-admin role/binding required to use the admin connector/directory endpoints. The current directory landing page says "The platform admin grant covers" this work but does not show how to create that grant or identify
admin.enterprise.stacklok.com. - A verification sequence that tests login, gateway registration, an authenticated control-plane call, and the data-plane MCP endpoint separately.
Prefer one complete secure example, followed by focused alternatives, rather than making readers assemble fragments from component chart comments.
Context and references
This gap surfaced while moving stacklok-enterprise-demo-sandbox to Stacklok Enterprise Platform v0.17.0.
Related platform issues found during the same deployment:
- https://github.com/stacklok/stacklok-enterprise-platform/issues/4307
- https://github.com/stacklok/stacklok-enterprise-platform/issues/4309
- https://github.com/stacklok/stacklok-enterprise-platform/issues/4312
Relevant source pages:
docs/platform/enterprise-platform/configure-connector-gateway.mdxdocs/platform/enterprise-platform/deployment.mdxdocs/platform/enterprise-platform/configure-identity.mdxdocs/platform/enterprise-directory/index.mdx
Use case
As a platform operator, I need to enable Connector Gateway from a single supported checklist and understand which values form one contract across the umbrella chart, so that a successful Helm install produces a usable login, control plane, and MCP data plane without iterative crash-loop debugging.
- 主要言語
- JavaScript
- スター
- 4
- フォーク
- 4
- 平均マージ
- 23時間 10分
- マージ済み PR（30日）
- 71
環境構築
このプロジェクトの開発コンテナを、あなたの GitHub アカウントでブラウザ上に起動します。
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートあり
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
stacklok/docs-website のほかの issue
-
documentation enhancement needs-triage
難易度 2/5 1〜3時間 初心者へのやさしさ 82/100
stacklok/docs-website#1258 ·
メンテナーはふだん 1 日以内に返信
-
documentation enhancement needs-triage
難易度 1/5 1時間未満 初心者へのやさしさ 85/100
stacklok/docs-website#1241 ·
メンテナーはふだん 1 日以内に返信
-
bug documentation needs-triage
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
stacklok/docs-website#1149 · コメント 2 件 ·
メンテナーはふだん 1 日以内に返信
-
needs-triage
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
stacklok/docs-website#1143 ·
メンテナーはふだん 1 日以内に返信
-
needs-triage
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
stacklok/docs-website#564 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
stacklok/docs-website の issue をすべて見る
似ている issue
-
correction via-web
難易度 2/5 1〜3時間 初心者へのやさしさ 67/100
ch-bas/cctv-camera-database#416 ·
メンテナーはふだん 1 日以内に返信
-
bug effort:medium model:light tests
難易度 2/5 1〜3時間 初心者へのやさしさ 76/100
メンテナーはふだん 1 日以内に返信
-
documentation help wanted
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
piskyRpapalo/preceptoros-web#231 ·
メンテナーはふだん 1 日以内に返信
-
type/bug type/docs type/enhancement
難易度 1/5 1時間未満 初心者へのやさしさ 86/100
Redo-San/RedoSan-Authenticity#574 ·
メンテナーはふだん 1 日以内に返信
-
Place search spins forever when nominatim fails対応中かも @jgt87 が今日担当しました。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
anvaka/city-roads#213 ·