stacklok / stacklok/docs-website

[Gap]: Document the complete Connector Gateway deployment contract

Open
#1,159 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation enhancement needs-triage
Dominant language
TypeScript
Stars
4
Forks
3
Avg merge
1d 7h
Merged PRs (30d)
41

Description

What needs documentation?

The Configure the Connector Gateway page currently shows only:

  • global.stacklok.connectorGateway.enabled
  • global.stacklok.connectorGatewayId
  • global.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's allowed_audiences.
  • enterpriseConfig.authServer, including its schema, upstream behavior, storage contract, and the fact that auth-less mode is not supported.
  • kek and authServerKeys, including the production recommendation to use existing Secrets rather than render-unstable generated values.
  • enterpriseConfig.directory.addr and 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:

Relevant source pages:

  • docs/platform/enterprise-platform/configure-connector-gateway.mdx
  • docs/platform/enterprise-platform/deployment.mdx
  • docs/platform/enterprise-platform/configure-identity.mdx
  • docs/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.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with docs/platform/enterprise-platform/configure-connector-gateway.mdx and compare it with deployment.mdx, configure-identity.mdx, and docs/platform/enterprise-directory/index.mdx, then trace the referenced chart values and comments. Document one complete secure configuration, focused alternatives, and separate checks for login, gateway registration, an authenticated control-plane call, and the MCP data plane. Done means operators can follow one supported checklist without assembling undocumented contract details.

Written by the indexing model from the issue text.

Assessment

Tech stack
helm, kubernetes
Domain
authentication, devops, documentation, infrastructure
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.