Skip to content

Document operator autoscaling and tuning#949

Merged
danbarr merged 2 commits into
mainfrom
docs-k8s-operator-tuning
Jun 18, 2026
Merged

Document operator autoscaling and tuning#949
danbarr merged 2 commits into
mainfrom
docs-k8s-operator-tuning

Conversation

@danbarr

@danbarr danbarr commented Jun 16, 2026

Copy link
Copy Markdown
Collaborator

Description

Documents operator-level tuning in deploy-operator.mdx:

  • Enabling the HorizontalPodAutoscaler (operator.autoscaling, disabled by default).
  • Adjusting resource requests/limits and Go runtime tuning (operator.gc for GOMEMLIMIT/GOGC).
  • Running on OpenShift, which the operator auto-detects and handles with no special configuration.

Helm value paths and defaults were verified against the operator chart (deploy/charts/operator/values.yaml), and the OpenShift behavior against the operator source (DetectPlatform / SecurityContextBuilder).

Note: the original gap analysis in #655 listed operator feature flags (ENABLE_SERVER/ENABLE_REGISTRY/ENABLE_AGGREGATION and crds.install.virtualMCP). Those are intentionally not documented: the implementing PR (stacklok/toolhive#2729) was closed unmerged, and the values do not exist in the current chart.

Type of change

  • Documentation update

Related issues/PRs

Addresses gaps in #655.

Submitter checklist

Content and formatting

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

Reviewer checklist

Content

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

Add subsections to the operator deploy guide covering
HorizontalPodAutoscaler config, resource and Go runtime tuning,
and OpenShift support with no special configuration.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Copilot AI review requested due to automatic review settings June 16, 2026 16:04
@vercel

vercel Bot commented Jun 16, 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 16, 2026 4:24pm

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

This PR updates the Kubernetes operator deployment guide to cover operator-level operational tuning, including autoscaling, resource sizing, Go runtime GC/memory tuning, and OpenShift behavior.

Changes:

  • Added documentation for enabling operator HorizontalPodAutoscaler (operator.autoscaling) and its metrics-server prerequisite.
  • Documented operator resource requests/limits defaults and Go runtime tuning via operator.gc (GOMEMLIMIT, GOGC).
  • Added an OpenShift section explaining the operator’s platform detection and security context adjustments for restricted SCCs.

Comment thread docs/toolhive/guides-k8s/deploy-operator.mdx Outdated
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@danbarr danbarr merged commit 27595c7 into main Jun 18, 2026
6 checks passed
@danbarr danbarr deleted the docs-k8s-operator-tuning branch June 18, 2026 12:58
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