Repository navigation
[Gap]: Document the complete Connector Gateway deployment contract #1159
Description
Activity
Most of the original deployment gap is covered by #1180 and the now-merged #1220. The current guide includes incoming OIDC issuer/audience matching, the embedded authorization server's schema and Redis storage, existing Secrets for key material, directory addressing and binding claims, TLS and development-only cleartext transport, ServiceAccount subject allowlists, and endpoint publishing. #1220 also adds separate checks for gateway registration, OAuth discovery, an authenticated control-plane request, and browser login plus an MCP tool call through the linked quickstart.
The remaining work is:
- Show how to grant platform-admin access. Provide a supported role/binding example for the Enterprise Manager's connector and directory administration endpoints, identify
admin.enterprise.stacklok.com, and show how to verify the grant. Link it from the directory landing page, console prerequisites, and gateway configuration guide. Distinguish this authorization grant from the PostgreSQLBYPASSRLSrole already documented for the admin database connection. - Complete the corporate IdP token contract for the console and gateway control plane. Explain how
global.stacklok.primaryIdp.clientId, the console's OAuth client, andclientClaimrelate; document the actual issuer, audience, and client-claim validation each endpoint performs. Include a worked configuration and token check so operators can obtain the<CORPORATE_ACCESS_TOKEN>used by the new verification step and diagnose a401. Keep this separate from the gateway-issued token and/gw/mcpaudience used by MCP clients. - Explain the projected ServiceAccount token audience. The TLS example covers the cluster issuer and all three subject allowlists, but does not explain how
connector-gateway.directoryTLS.audiencemust match the Enterprise Manager'sgrpc.callerAuth.callerAudience. State the matching defaults and show the paired overrides when an operator changes them. - State explicitly that the embedded authorization server is required. The guide provides the required configuration, but still needs a concise statement that auth-less Connector Gateway deployments are unsupported.
These are the remaining acceptance items for this issue. The endpoint publishing/verification and in-cluster discovery network/recovery work is covered by #1220, which closes #1217 and #1161.
- Show how to grant platform-admin access. Provide a supported role/binding example for the Enterprise Manager's connector and directory administration endpoints, identify
What needs documentation?
The Configure the Connector Gateway page currently shows only:
global.stacklok.connectorGateway.enabledglobal.stacklok.connectorGatewayIdglobal.stacklok.authServerIssuerThat 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.yamlcomments.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.admin.enterprise.stacklok.com.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-sandboxto Stacklok Enterprise Platform v0.17.0.Related platform issues found during the same deployment:
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.mdxUse 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.