Skip to content

Add Stacklok Enterprise platform documentation#972

Merged
danbarr merged 3 commits into
mainfrom
add-enterprise-docs
Jun 24, 2026
Merged

Add Stacklok Enterprise platform documentation#972
danbarr merged 3 commits into
mainfrom
add-enterprise-docs

Conversation

@danbarr

@danbarr danbarr commented Jun 24, 2026

Copy link
Copy Markdown
Collaborator

Description

Introduces a new docs/platform/ section documenting the Stacklok Enterprise distribution alongside the existing open source ToolHive docs. This is the first batch of enterprise documentation, structured so the platform content reads as one product surface rather than a separate site.

New content areas:

  • Enterprise platform: deployment, identity configuration, registry server configuration, distributed and airgapped installs, and artifact verification
  • Enterprise Manager: configuration, degraded mode, and the policy reference (build environment, CA certificate, desktop app, registry, telemetry, non-registry servers)
  • Stacklok Desktop: rollout, policy enforcement, and deep links
  • Enterprise Cloud UI: catalog browsing, administration, AI assistant, and configuration
  • Enterprise authorization: intro, namespace self-service, and an Entra ID quickstart
  • Enterprise CLI and a new AI gateway landing page

Reference and tooling:

  • Adds enterprise CRD reference pages and schemas (ClusterPlatformRole, ClusterPlatformRoleBinding, PlatformRoleBinding, ToolHiveAuthorizationPolicy)
  • Extends the CRD reference generator to support enterprise CRD sets
  • Updates the homepage product grid, styles, and icons for the platform layout
  • Updates the sidebars, Docusaurus config, and Vercel redirects

Also refreshes several OSS reference and guide pages and the upstream-release docs tooling.

Type of change

  • New documentation
  • Navigation/structure change

Submitter checklist

Content and formatting

  • I have reviewed the content for technical accuracy
  • I have reviewed the content for spelling, grammar, and style

Navigation

  • New pages include a frontmatter section with title and description at a minimum
  • Sidebar navigation (sidebars.ts) updated for added, deleted, reordered, or renamed files
  • Redirects added to vercel.json for moved, renamed, or deleted pages (i.e., if the URL slug changed)

Reviewer checklist

Content

  • I have reviewed the content for technical accuracy
  • I have reviewed the content for spelling, grammar, and style

Introduce a new docs/platform/ section documenting the Stacklok
Enterprise distribution alongside the existing OSS ToolHive docs.

New content areas:

- Enterprise platform: deployment, identity config, registry server
  config, distributed and airgapped installs, artifact verification
- Enterprise Manager: configuration, degraded mode, and policy
  reference (build env, CA certificate, desktop app, registry,
  telemetry, non-registry servers)
- Stacklok Desktop: rollout, policy enforcement, and deep links
- Enterprise Cloud UI: catalog browsing, administration, AI
  assistant, and configuration
- Enterprise authorization: intro, namespace self-service, and an
  Entra ID quickstart
- Enterprise CLI and a new AI gateway landing page

Reference and tooling:

- Add enterprise CRD reference pages and schemas
  (ClusterPlatformRole, ClusterPlatformRoleBinding,
  PlatformRoleBinding, ToolHiveAuthorizationPolicy)
- Extend the CRD reference generator to support enterprise CRD sets
- Update the homepage product grid, styles, and icons for the
  platform layout
- Update sidebars, Docusaurus config, and Vercel redirects

Also refresh several OSS reference and guide pages and the
upstream-release docs tooling.

Signed-off-by: Dan Barr <6922515+danbarr@users.noreply.github.com>
Copilot AI review requested due to automatic review settings June 24, 2026 19:21
@vercel

vercel Bot commented Jun 24, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
docs-website Ready Ready Preview, Comment Jun 24, 2026 7:38pm

Request Review

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds a new Stacklok Enterprise “platform” documentation surface alongside the existing ToolHive open source docs, including a new platform sidebar/nav structure, homepage product grid updates, and a multi-CRD-set generation pipeline (ToolHive OSS CRDs + Enterprise CRDs) to power consolidated CRD reference rendering.

Changes:

  • Introduces /docs/platform/ with Enterprise platform, authorization, and client/console documentation plus Enterprise CRD reference pages.
  • Refactors CRD extraction + reference generation to support multiple CRD sets, generating a consolidated schema barrel for <CRDReference>/<CRDFields>.
  • Updates site navigation and homepage layout to present “Stacklok Platform”, “ToolHive MCP & skills”, and “AI Gateway” as top-level entry points.

Reviewed changes

Copilot reviewed 107 out of 142 changed files in this pull request and generated 10 comments.

Show a summary per file
File Description
vercel.json Adds redirect from legacy /toolhive/enterprise to /platform.
STYLE-GUIDE.md Updates product terminology definitions for Stacklok Enterprise and related components.
static/api-specs/toolhive-crds/virtualmcpservers.example.yaml Adds generated example YAML for VirtualMCPServer.
static/api-specs/toolhive-crds/virtualmcpcompositetooldefinitions.example.yaml Adds generated example YAML for VirtualMCPCompositeToolDefinition.
static/api-specs/toolhive-crds/sidebar.json Renames CRD sidebar label/description for ToolHive CRDs.
static/api-specs/toolhive-crds/mcpwebhookconfigs.example.yaml Adds generated example YAML for MCPWebhookConfig.
static/api-specs/toolhive-crds/mcptoolconfigs.schema.json Adds generated JSON schema for MCPToolConfig.
static/api-specs/toolhive-crds/mcptoolconfigs.example.yaml Adds generated example YAML for MCPToolConfig.
static/api-specs/toolhive-crds/mcptelemetryconfigs.example.yaml Adds generated example YAML for MCPTelemetryConfig.
static/api-specs/toolhive-crds/mcpservers.example.yaml Adds generated example YAML for MCPServer.
static/api-specs/toolhive-crds/mcpserverentries.example.yaml Adds generated example YAML for MCPServerEntry.
static/api-specs/toolhive-crds/mcpremoteproxies.example.yaml Adds generated example YAML for MCPRemoteProxy.
static/api-specs/toolhive-crds/mcpregistries.example.yaml Adds generated example YAML for MCPRegistry.
static/api-specs/toolhive-crds/mcpoidcconfigs.example.yaml Adds generated example YAML for MCPOIDCConfig.
static/api-specs/toolhive-crds/mcpgroups.schema.json Adds generated JSON schema for MCPGroup.
static/api-specs/toolhive-crds/mcpgroups.example.yaml Adds generated example YAML for MCPGroup.
static/api-specs/toolhive-crds/mcpexternalauthconfigs.example.yaml Adds generated example YAML for MCPExternalAuthConfig.
static/api-specs/toolhive-crds/mcpauthzconfigs.schema.json Adds generated JSON schema for MCPAuthzConfig.
static/api-specs/toolhive-crds/mcpauthzconfigs.example.yaml Adds generated example YAML for MCPAuthzConfig.
static/api-specs/toolhive-crds/embeddingservers.example.yaml Adds generated example YAML for EmbeddingServer.
static/api-specs/enterprise-crds/toolhiveauthorizationpolicies.example.yaml Adds generated example YAML for enterprise ToolhiveAuthorizationPolicy.
static/api-specs/enterprise-crds/sidebar.json Adds enterprise CRD sidebar fragment for Platform CRDs.
static/api-specs/enterprise-crds/platformrolebindings.schema.json Adds generated JSON schema for PlatformRoleBinding.
static/api-specs/enterprise-crds/platformrolebindings.example.yaml Adds generated example YAML for PlatformRoleBinding.
static/api-specs/enterprise-crds/index.json Adds generated enterprise CRD index/metadata for reference generation.
static/api-specs/enterprise-crds/clusterplatformroles.schema.json Adds generated JSON schema for ClusterPlatformRole.
static/api-specs/enterprise-crds/clusterplatformroles.example.yaml Adds generated example YAML for ClusterPlatformRole.
static/api-specs/enterprise-crds/clusterplatformrolebindings.schema.json Adds generated JSON schema for ClusterPlatformRoleBinding.
static/api-specs/enterprise-crds/clusterplatformrolebindings.example.yaml Adds generated example YAML for ClusterPlatformRoleBinding.
src/pages/index.tsx Updates homepage product grids/cards for platform-oriented entry points.
src/css/custom.css Adds responsive navbar spacing rules to prevent wrapping/overlap.
src/components/ProductGrid/styles.module.css Adds a fixed-1 grid layout style.
src/components/ProductGrid/index.tsx Extends ProductGrid layout union/config with fixed-1.
src/components/CRDReference/schemas.ts Removes old single-set schema map (replaced by consolidated barrel).
src/components/CRDReference/index.tsx Switches CRDReference component to use consolidated all-schemas barrel.
src/components/CRDReference/all-schemas.ts Adds generated consolidated Kind→schema barrel across CRD sets.
scripts/upstream-release/extract-crds.mjs Adds multi-set CRD extract+page-generation driver for upstream-release workflow.
scripts/lib/crd-sets.mjs Adds shared CRD set registry derived from .github/upstream-projects.yaml.
scripts/lib/crd-intros.mjs Adds enterprise-authz CRD intro overrides and updates ToolHive authz text.
scripts/generate-crd-barrel.mjs Adds generator for consolidated schema barrel across all CRD sets.
scripts/extract-crd-schemas.mjs Adds --out support and updates defaults to toolhive-crds output dir.
plugins/crd-reference-remark/index.mjs Adds support for multiple schema dirs and Kind collision detection.
docusaurus.config.ts Updates navbar IA and wires CRD schemaDirs from declared CRD sets.
docs/toolhive/support.mdx Updates support page with dedicated Stacklok Enterprise support section/linking.
docs/toolhive/reference/registry-schema-upstream.mdx Removes explicit displayed sidebar metadata.
docs/toolhive/reference/index.mdx Removes explicit displayed sidebar metadata.
docs/toolhive/reference/crds/virtualmcpserver.mdx Removes explicit displayed sidebar metadata.
docs/toolhive/reference/crds/virtualmcpcompositetooldefinition.mdx Removes explicit displayed sidebar metadata.
docs/toolhive/reference/crds/mcpwebhookconfig.mdx Removes explicit displayed sidebar metadata.
docs/toolhive/reference/crds/mcptoolconfig.mdx Removes explicit displayed sidebar metadata.
docs/toolhive/reference/crds/mcptelemetryconfig.mdx Removes explicit displayed sidebar metadata.
docs/toolhive/reference/crds/mcpserverentry.mdx Removes explicit displayed sidebar metadata.
docs/toolhive/reference/crds/mcpserver.mdx Removes explicit displayed sidebar metadata.
docs/toolhive/reference/crds/mcpremoteproxy.mdx Removes explicit displayed sidebar metadata.
docs/toolhive/reference/crds/mcpregistry.mdx Removes explicit displayed sidebar metadata.
docs/toolhive/reference/crds/mcpoidcconfig.mdx Removes explicit displayed sidebar metadata.
docs/toolhive/reference/crds/mcpgroup.mdx Removes explicit displayed sidebar metadata.
docs/toolhive/reference/crds/mcpexternalauthconfig.mdx Removes explicit displayed sidebar metadata.
docs/toolhive/reference/crds/mcpauthzconfig.mdx Removes explicit displayed sidebar metadata.
docs/toolhive/reference/crds/index.mdx Updates ToolHive CRD landing intro copy.
docs/toolhive/reference/crds/embeddingserver.mdx Removes explicit displayed sidebar metadata.
docs/toolhive/index.mdx Updates ToolHive intro positioning relative to Stacklok Enterprise platform.
docs/toolhive/guides-ui/quickstart.mdx Updates Stacklok Enterprise cross-link path.
docs/toolhive/guides-registry/quickstart.mdx Updates Stacklok Enterprise cross-link path.
docs/toolhive/guides-registry/intro.mdx Adds cross-link to Enterprise Cloud UI as a registry management UI.
docs/toolhive/guides-k8s/quickstart.mdx Updates Stacklok Enterprise cross-link path.
docs/toolhive/guides-cloud-ui/intro.mdx Updates Stacklok Enterprise cross-link path.
docs/toolhive/guides-cli/quickstart.mdx Updates Stacklok Enterprise cross-link path.
docs/toolhive/faq.mdx Updates Stacklok Enterprise positioning/links and adds enterprise deployment Q&A.
docs/toolhive/concepts/cedar-policies.mdx Adds enterprise callout linking Cedar concepts to enterprise authorization.
docs/toolhive/concepts/auth-framework.mdx Adds enterprise callout linking auth framework to enterprise authorization.
docs/theme-preview.mdx Updates Stacklok Enterprise link to new platform location.
docs/platform/reference/crds/toolhiveauthorizationpolicy.mdx Adds Platform CRD reference page for ToolhiveAuthorizationPolicy.
docs/platform/reference/crds/platformrolebinding.mdx Adds Platform CRD reference page for PlatformRoleBinding.
docs/platform/reference/crds/index.mdx Adds Platform CRD landing page with DocCards for enterprise authz CRDs.
docs/platform/reference/crds/clusterplatformrolebinding.mdx Adds Platform CRD reference page for ClusterPlatformRoleBinding.
docs/platform/reference/crds/clusterplatformrole.mdx Adds Platform CRD reference page for ClusterPlatformRole.
docs/platform/enterprise-platform/index.mdx Adds Platform setup landing page and component topology + sequence.
docs/platform/enterprise-platform/distributed-deployments.mdx Adds distributed deployment topologies and values snippets.
docs/platform/enterprise-platform/configure-registry-server.mdx Adds enterprise Registry Server enablement guide referencing OSS config.
docs/platform/enterprise-manager/policies/telemetry.mdx Adds Enterprise Manager telemetry policy how-to.
docs/platform/enterprise-manager/policies/registry.mdx Adds Enterprise Manager registry policy how-to.
docs/platform/enterprise-manager/policies/non-registry-servers.mdx Adds Enterprise Manager non-registry policy how-to.
docs/platform/enterprise-manager/policies/index.mdx Adds Enterprise Manager policies overview and enforcement model.
docs/platform/enterprise-manager/policies/desktop-app.mdx Adds Stacklok Desktop UI policy directive documentation.
docs/platform/enterprise-manager/policies/ca-certificate.mdx Adds CA injection directive documentation.
docs/platform/enterprise-manager/policies/build-env.mdx Adds build environment directive documentation.
docs/platform/enterprise-manager/intro.mdx Adds Enterprise Manager intro/architecture + discovery URL behavior.
docs/platform/enterprise-manager/index.mdx Adds Enterprise Manager section landing page.
docs/platform/enterprise-manager/degraded-mode.mdx Adds degraded mode behavior and configuration docs.
docs/platform/enterprise-manager/configure.mdx Adds Enterprise Manager Helm values/configuration reference.
docs/platform/enterprise-desktop/policy-enforcement.mdx Documents how Enterprise Manager directives affect Stacklok Desktop.
docs/platform/enterprise-desktop/intro.mdx Introduces Stacklok Desktop enterprise behaviors and roll-out concepts.
docs/platform/enterprise-desktop/index.mdx Adds Stacklok Desktop section landing page.
docs/platform/enterprise-desktop/deep-links.mdx Documents enterprise deep link protocol and troubleshooting.
docs/platform/enterprise-cloud-ui/intro.mdx Introduces Enterprise Cloud UI, roles, claims visibility, feature flags.
docs/platform/enterprise-cloud-ui/index.mdx Adds Enterprise Cloud UI section landing page.
docs/platform/enterprise-cloud-ui/browse-catalog.mdx Documents catalog browsing and install paths (Desktop + AI clients).
docs/platform/enterprise-cloud-ui/ai-assistant.mdx Documents Cloud UI AI assistant behavior and model/tool selection.
docs/platform/enterprise-cloud-ui/administration/sources.mdx Documents source management in Cloud UI.
docs/platform/enterprise-cloud-ui/administration/registries.mdx Documents registry management in Cloud UI.
docs/platform/enterprise-cloud-ui/administration/index.mdx Adds registry management landing page and data-origin model.
docs/platform/enterprise-cloud-ui/administration/entries.mdx Documents entry management workflows in Cloud UI.
docs/platform/enterprise-cli/index.mdx Adds Stacklok CLI enterprise behaviors: auth, bootstrap URL, policy enforcement.
docs/platform/enterprise-authz/namespace-self-service.mdx Documents namespace-scoped self-service bindings + attachment workflow.
docs/platform/enterprise-authz/intro.mdx Introduces enterprise authorization model and claim mapping.
docs/platform/enterprise-authz/index.mdx Adds enterprise authorization landing page and CRD reference links.
docs/ai-gateway/index.mdx Adds AI Gateway landing page (documentation-in-progress note).
AGENTS.md Extends terminology list and enterprise constructs guidance.
.github/workflows/upstream-release-docs.yml Updates upstream-release workflow to run CRD extraction per declared CRD set(s).
.github/upstream-projects.yaml Adds crds: declarations for ToolHive OSS and enterprise platform CRD sets.
.claude/skills/upstream-release-docs/SKILL.md Updates skill guidance to reflect multi-set CRD generation pipeline.
.claude/agents/mcp-guide-writer.md Updates CRD reference pointers to match new toolhive-crds schema path.
Comments suppressed due to low confidence (1)

docs/platform/index.mdx:92

  • This table uses the em dash character () to represent "not available", but the style guide asks to avoid em dashes. Consider using a plain-text marker like N/A (and apply consistently across the tables on this page).

Comment thread static/api-specs/enterprise-crds/platformrolebindings.example.yaml
Comment thread docs/platform/reference/crds/platformrolebinding.mdx
Comment thread docs/platform/reference/crds/clusterplatformrolebinding.mdx
Comment thread docs/platform/reference/crds/toolhiveauthorizationpolicy.mdx
Comment thread STYLE-GUIDE.md Outdated
Comment thread STYLE-GUIDE.md Outdated
Comment thread AGENTS.md Outdated
Comment thread docs/platform/enterprise-manager/policies/index.mdx Outdated
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
JAORMX
JAORMX previously approved these changes Jun 24, 2026
Signed-off-by: Dan Barr <6922515+danbarr@users.noreply.github.com>
@danbarr danbarr merged commit 8808ed8 into main Jun 24, 2026
4 checks passed
@danbarr danbarr deleted the add-enterprise-docs branch June 24, 2026 19:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants