DOCS-2914: Collapse CE kube-controllers config page into resource reference#2701
Open
ctauchen wants to merge 3 commits intotigera:mainfrom
Open
DOCS-2914: Collapse CE kube-controllers config page into resource reference#2701ctauchen wants to merge 3 commits intotigera:mainfrom
ctauchen wants to merge 3 commits intotigera:mainfrom
Conversation
The kube-controllers configuration page documents a manifest install path
that does not exist for Calico Enterprise (operator-only). Its contents
duplicate the KubeControllersConfiguration resource page, and the env-var
guidance it gives readers (e.g. ENABLED_CONTROLLERS) is not applicable to
operator-managed installs.
Delete the page and fold the conceptual prose ("what each controller
does") into the resource page. Update inbound links to deep-link the
relevant section of the resource page. Add a redirect from the old URL.
Supersedes tigera#2699, which patched a single incorrect sentence on the page
being removed.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
✅ Deploy Preview succeeded!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify project configuration. |
✅ Deploy Preview for calico-docs-preview-next ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR removes the Calico Enterprise “kube-controllers configuration” component-resource page that described a manifest-based install path (not applicable to CE operator installs), and consolidates the relevant “what the controllers do” guidance into the KubeControllersConfiguration resource reference page. It also updates links, sidebar navigation, and adds redirects so existing inbound URLs continue to resolve.
Changes:
- Delete
reference/component-resources/kube-controllers/configuration.mdxand remove it from the Calico Enterprise sidebar. - Expand
reference/resources/kubecontrollersconfig.mdxwith controller purpose/behavior context (node, federated services, load balancer) and improve the FederatedServicesController description. - Update affected docs to deep-link to the appropriate sections on the resource page, and add/update Netlify redirects from old URLs.
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| static/_redirects | Updates legacy redirect to point at the resource page; adds a product-prefixed redirect from the deleted page URL. |
| sidebars-calico-enterprise.js | Removes the deleted kube-controllers configuration page from the CE sidebar category. |
| calico-enterprise/reference/resources/kubecontrollersconfig.mdx | Makes this resource page the canonical entry point and adds controller explanations + updated federated controller prose. |
| calico-enterprise/reference/component-resources/kube-controllers/configuration.mdx | Deletes the manifest/operator tabbed configuration page that was misleading for CE. |
| calico-enterprise/operations/decommissioning-a-node.mdx | Updates the “node controller” link to deep-link into the resource reference section. |
| calico-enterprise/multicluster/federation/services-controller.mdx | Updates the “federated services controller” link to deep-link into the resource reference section. |
|
|
||
| - **Node controller** — garbage collects IP addresses, cleans up $[prodname] node data when Kubernetes nodes are removed, and optionally creates and syncs host endpoints for each node. | ||
| - **Federated services controller** — watches Kubernetes services and endpoints locally and across all remote clusters defined through [RemoteClusterConfigurations](remoteclusterconfiguration.mdx), and programs Kubernetes endpoints for any locally-configured service that specifies a federation selector annotation. See [Configuring federated services](../../multicluster/federation/services-controller.mdx) for the usage guide. | ||
| - **Load balancer controller** — manages IPAM for Services of type `LoadBalancer`. |
- The category landing page was a DocCardList over its sidebar children. With only `prometheus` left as a child, it rendered as a single bare card. Replace with a short prose intro that points readers at the resource reference for configuration and the prometheus page for metrics. - Move the redirect for the deleted page out of the legacy un-prefixed section and into the modern product-prefixed deletion-redirects block, with a comment tying it to the ticket. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
The LoadBalancerController section has existed on the resource page since CE 3.21 but the Controllers table only lists `node` and `federatedservices`. Add the missing row. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Collaborator
Author
|
PTAL @sabags One thing led to another. Turns out, this statement was on a manifest-based page, which isn't supported in CE. What followed was this:
FYI @matthewdupre @pasanw |
MichalFupso
approved these changes
May 8, 2026
pasanw
approved these changes
May 8, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
calico-enterprise/reference/component-resources/kube-controllers/configuration.mdx. The page documents a manifest install path that doesn't exist for CE (operator-only), and its env-var guidance (e.g.ENABLED_CONTROLLERS) isn't applicable to operator-managed installs — making it a source of confusion rather than help.KubeControllersConfigurationresource page (calico-enterprise/reference/resources/kubecontrollersconfig.mdx), which becomes the canonical entry point.services-controller.mdxanddecommissioning-a-node.mdxto deep-link the relevant section of the resource page.Status
Draft — CE current only, for shape review. If the approach looks right, I'll propagate the same pattern to:
calico-enterprise_versioned_docs/version-3.20-2/calico-enterprise_versioned_docs/version-3.21-2/calico-enterprise_versioned_docs/version-3.22-2/calico-enterprise_versioned_docs/version-3.23-1/calico-cloud/calico-cloud_versioned_docs/version-22-2/Then add per-version redirects and verify the build before un-drafting.
Context
Supersedes #2699, which patched a single incorrect sentence on the page being removed (
"The federation controller is disabled by default if ENABLED_CONTROLLERS is not explicitly specified"). That fix is correct in isolation but applied inside a structurally incorrect Manifest tab — the cleaner outcome is to retire the page.Jira: https://tigera.atlassian.net/browse/DOCS-2914
Things worth your eyes
LoadBalancerControllerhas its own section on the resource page but isn't listed in the Controllers table. I added it to the new bullet list but did not patch the table — happy to bundle that in if you prefer.static/_redirectsis right. I added one product-prefixed redirect for/calico-enterprise/latest/...and updated the legacy un-prefixed line. Older versioned URLs (3.20, 3.21, 3.23) get their own redirects when I propagate.Test plan
services-controller.mdx"Federated services controller" link resolves to#federatedservicescontrollerdecommissioning-a-node.mdx"node controller" link resolves to#nodecontroller/calico-enterprise/latest/reference/component-resources/kube-controllers/configurationredirects to the resource page🤖 Generated with Claude Code