Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
102 changes: 102 additions & 0 deletions .github/upstream-projects.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -146,6 +146,108 @@ projects:
destination: static/api-specs/connector-gateway-api.json
- source: enterprise/ai-gateway/docs/operator-guide/management-api.openapi.yaml
destination: static/api-specs/ai-gateway-management-api.yaml
public_sources: false
helm:
- source: enterprise/stacklok-enterprise-platform/helm
page: docs/platform/reference/helm/platform.mdx
title: Platform Helm values
description: Values, types, and defaults for the Stacklok Enterprise platform chart.
intro: Configure the platform chart with these Helm values.
related:
- label: Platform Helm chart references
href: ./index.mdx
- label: Deploy the platform
href: ../../enterprise-platform/deployment.mdx
- source: enterprise/toolhive-cloud-ui/helm
page: docs/platform/reference/helm/console.mdx
title: Console Helm values
description: Values, types, and defaults for the console chart in Stacklok Enterprise.
intro: Configure the console chart with these Helm values.
related:
- label: Platform Helm chart references
href: ./index.mdx
- label: Deploy the platform
href: ../../enterprise-platform/deployment.mdx
- source: enterprise/toolhive-enterprise/helm
page: docs/platform/reference/helm/enterprise-manager.mdx
title: Enterprise Manager Helm values
description: Values, types, and defaults for the Enterprise Manager chart in Stacklok Enterprise.
intro: Configure the Enterprise Manager chart with these Helm values.
related:
- label: Platform Helm chart references
href: ./index.mdx
- label: Deploy the platform
href: ../../enterprise-platform/deployment.mdx
- source: enterprise/toolhive/helm/operator
page: docs/platform/reference/helm/toolhive-operator.mdx
title: ToolHive operator Helm values
description: Values, types, and defaults for the ToolHive operator chart in Stacklok Enterprise.
intro: Configure the ToolHive operator chart with these Helm values.
related:
- label: Platform Helm chart references
href: ./index.mdx
- label: Deploy the platform
href: ../../enterprise-platform/deployment.mdx
- source: enterprise/toolhive/helm/operator-crds
page: docs/platform/reference/helm/toolhive-operator-crds.mdx
title: ToolHive operator CRD Helm values
description: Values, types, and defaults for the ToolHive operator CRD chart in Stacklok Enterprise.
intro: Configure the ToolHive operator CRD chart with these Helm values.
related:
- label: Platform Helm chart references
href: ./index.mdx
- label: Deploy the platform
href: ../../enterprise-platform/deployment.mdx
- source: enterprise/toolhive-registry-server/helm/registry-server
page: docs/platform/reference/helm/registry-server.mdx
title: Registry Server Helm values
description: Values, types, and defaults for the Registry Server chart in Stacklok Enterprise.
intro: Configure the Registry Server chart with these Helm values.
related:
- label: Platform Helm chart references
href: ./index.mdx
- label: Deploy the platform
href: ../../enterprise-platform/deployment.mdx
- source: enterprise/ai-gateway/helm/operator
page: docs/platform/reference/helm/ai-gateway-operator.mdx
title: AI Gateway operator Helm values
description: Values, types, and defaults for the AI Gateway operator chart in Stacklok Enterprise.
intro: Configure the AI Gateway operator chart with these Helm values.
related:
- label: Platform Helm chart references
href: ./index.mdx
- label: Deploy the platform
href: ../../enterprise-platform/deployment.mdx
- source: enterprise/ai-gateway/helm/operator-crds
page: docs/platform/reference/helm/ai-gateway-operator-crds.mdx
title: AI Gateway operator CRD Helm values
description: Values, types, and defaults for the AI Gateway operator CRD chart in Stacklok Enterprise.
intro: Configure the AI Gateway operator CRD chart with these Helm values.
related:
- label: Platform Helm chart references
href: ./index.mdx
- label: Deploy the platform
href: ../../enterprise-platform/deployment.mdx
- source: enterprise/connector-gateway/helm
page: docs/platform/reference/helm/connector-gateway.mdx
title: Connector Gateway Helm values
description: Values, types, and defaults for the Connector Gateway chart in Stacklok Enterprise.
intro: Configure the Connector Gateway chart with these Helm values.
related:
- label: Platform Helm chart references
href: ./index.mdx
- label: Deploy the platform
href: ../../enterprise-platform/deployment.mdx
- source: enterprise/sprout/helm
page: docs/platform/reference/helm/ai-gateway.mdx
title: AI Gateway inference Helm values
description: Values, types, and defaults for the AI Gateway inference chart in Stacklok Enterprise.
intro: Configure the AI Gateway inference chart with these Helm values.
related:
- label: Platform Helm chart references
href: ./index.mdx
- label: Deploy the platform
href: ../../enterprise-platform/deployment.mdx
crds:
- source: enterprise/toolhive-enterprise/helm/files/crds
out: static/api-specs/enterprise-crds
Expand Down
8 changes: 4 additions & 4 deletions .github/workflows/upstream-release-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -460,7 +460,7 @@ jobs:
--id "$PROJECT_ID" \
--clone "$CLONE_DIR" \
--tag "$NEW_TAG"
npx --no-install eslint docs/toolhive/reference/helm
npx --no-install eslint docs/toolhive/reference/helm docs/platform/reference/helm

# toolhive-specific: bundle the upstream-registry schema to resolve
# remote MCP-server $refs for the JSON-Schema viewer.
Expand Down Expand Up @@ -840,7 +840,7 @@ jobs:

Do not hand-edit auto-generated
reference under static/api-specs/, docs/toolhive/reference/cli/,
docs/toolhive/reference/helm/,
docs/toolhive/reference/helm/ and docs/platform/reference/helm/,
or any CRD pages dirs (${{ steps.crd_pages.outputs.dirs }}) --
earlier workflow steps sync those from release assets.

Expand Down Expand Up @@ -980,7 +980,7 @@ jobs:

Do NOT re-run /upstream-release-docs. Do NOT touch files
under static/api-specs/, docs/toolhive/reference/cli/,
docs/toolhive/reference/helm/,
docs/toolhive/reference/helm/ and docs/platform/reference/helm/,
or any CRD pages dirs (${{ steps.crd_pages.outputs.dirs }}) --
those are regenerated from release assets and aren't yours to edit.

Expand Down Expand Up @@ -1197,7 +1197,7 @@ jobs:
[ "$PROJECT_ID" = "toolhive" ] && DIFF_ARGS+=('docs/toolhive/reference/cli/')
DIFF_ARGS+=('static/api-specs/')
# Helm pages are generated by the refresh step, like CLI references.
DIFF_ARGS+=('docs/toolhive/reference/helm/')
DIFF_ARGS+=('docs/toolhive/reference/helm/' 'docs/platform/reference/helm/')
for dir in $CRD_PAGES_DIRS; do
DIFF_ARGS+=("${dir}/")
done
Expand Down
2 changes: 1 addition & 1 deletion AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ This is the user-facing documentation for ToolHive, an open source tool that hel

NEVER hand-edit or delete these files, even when asked to remove or change the content they contain. They are regenerated from upstream sources on every release sync, so hand edits are silently overwritten by the next release PR. To change or remove their content, the change must land in the upstream repo (for example, marking a CLI command `Hidden: true` in the ToolHive source); it then flows into these files at the next release sync. If content must disappear from the site before an upstream release makes that happen, say so and flag it to a human instead of editing.

- `/docs/toolhive/reference/helm/*.mdx`: Helm values references generated by `scripts/upstream-release/generate-helm-reference.mjs`. Descriptions and defaults come from upstream chart comments and values; page introductions and curated descriptions for passthrough blocks live in `.github/upstream-projects.yaml`.
- `/docs/toolhive/reference/helm/*.mdx` and `/docs/platform/reference/helm/*.mdx`: Helm values references generated by `scripts/upstream-release/generate-helm-reference.mjs`. Descriptions and defaults come from upstream chart comments and values; page introductions and curated descriptions for passthrough blocks live in `.github/upstream-projects.yaml`.
- `/docs/toolhive/reference/cli/*.md`: auto-generated CLI reference documentation from the ToolHive CLI source code.
- `/docs/toolhive/reference/crds/*.mdx` and `/docs/platform/reference/crds/*.mdx`: CRD reference pages generated by `scripts/upstream-release/extract-crds.mjs`. Hand-written page intros live in `scripts/lib/crd-intros.mjs`, which is the file to edit.
- `/src/components/CRDReference/all-schemas.ts`: consolidated CRD schema barrel generated by `scripts/generate-crd-barrel.mjs`.
Expand Down
3 changes: 3 additions & 0 deletions docs/platform/enterprise-platform/deployment.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -261,6 +261,9 @@ either:

## Deploy with Helm

Use the [platform Helm values reference](../reference/helm/index.mdx) to look up
chart settings, types, and defaults when preparing your values file.

### 1. Authenticate to the Replicated registry

Stacklok distributes the platform through Replicated. Your license, the umbrella
Expand Down
31 changes: 31 additions & 0 deletions docs/platform/reference/helm/ai-gateway-operator-crds.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
title: AI Gateway operator CRD Helm values
description:
Values, types, and defaults for the AI Gateway operator CRD chart in Stacklok
Enterprise.
---

{/* Generated by scripts/upstream-release/generate-helm-reference.mjs. Edit upstream values or the helm entries in .github/upstream-projects.yaml. */}

Configure the AI Gateway operator CRD chart with these Helm values.

This reference lists values declared in the chart's default `values.yaml`.
Templates can also accept optional settings and inherited `global` values.

Chart: `stacklok-ai-gateway-operator-crds`. Chart version: `0.22.0`. Generated
from the platform source at `e71926418e98c7598815d0abf07039d3c1646f21`.

## Values

### `upstream`

**Type:** `object`

**Default:** `{}`

Values passed to the upstream AI Gateway CRD chart.

## Related information

- [Platform Helm chart references](./index.mdx)
- [Deploy the platform](../../enterprise-platform/deployment.mdx)
Loading
Loading