DOCS-2914: Mirror CE kube-controllers collapse into Calico Cloud#2742
Merged
Conversation
Mirrors the structural fix from tigera#2701 into both Calico Cloud trees (current and version-22-2). The kube-controllers configuration page documents a manifest install path that does not exist for operator-only installs and contains the incorrect "federation controller disabled by default" statement that triggered DOCS-2914. Delete the page in both trees, fold the conceptual prose into the KubeControllersConfiguration resource page, update inbound links to deep-link the resource page, remove sidebar entries, and add a Calico Cloud redirect alongside the existing CE redirect. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
✅ Deploy Preview for calico-docs-preview-next ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
✅ Deploy Preview succeeded!Built without sensitive environment variables
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 mirrors the DOCS-2914 structural fix from Calico Enterprise into Calico Cloud (both next and released 22-2 content) by removing the misleading kube-controllers configuration page and consolidating controller explanations into the KubeControllersConfiguration resource reference, updating navigation, links, and redirects accordingly.
Changes:
- Collapses kube-controllers configuration content into
reference/resources/kubecontrollersconfig.mdxand deletes the oldcomponent-resources/kube-controllers/configuration.mdxpage (both Cloud trees). - Replaces the kube-controllers component index from a
DocCardListto a short prose entry-point, and updates inbound links to deep-link the federated services controller section. - Updates sidebars / reference card grids and adds a Netlify redirect from the deleted URL to the resource reference.
Reviewed changes
Copilot reviewed 13 out of 13 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| static/_redirects | Adds Calico Cloud redirect from deleted kube-controllers configuration page to the resource reference. |
| sidebars-calico-cloud.js | Removes the deleted configuration page from the Cloud sidebar category. |
| calico-cloud/reference/resources/kubecontrollersconfig.mdx | Adds “what each controller does” prose and improves FederatedServicesController guidance. |
| calico-cloud/reference/index.mdx | Removes the DocCardLink pointing at the deleted page. |
| calico-cloud/reference/component-resources/kube-controllers/index.mdx | Replaces DocCardList with prose links to configuration resource + metrics page. |
| calico-cloud/reference/component-resources/kube-controllers/configuration.mdx | Deletes obsolete/misleading configuration page. |
| calico-cloud/multicluster/services-controller.mdx | Updates the “Federated services controller” link to deep-link into the resource reference section. |
| calico-cloud_versioned_sidebars/version-22-2-sidebars.json | Removes the deleted configuration page from the released 22-2 sidebar. |
| calico-cloud_versioned_docs/version-22-2/reference/resources/kubecontrollersconfig.mdx | Mirrors the consolidated controller prose and updated federated services guidance into released docs. |
| calico-cloud_versioned_docs/version-22-2/reference/index.mdx | Removes the DocCardLink pointing at the deleted page (released). |
| calico-cloud_versioned_docs/version-22-2/reference/component-resources/kube-controllers/index.mdx | Mirrors the prose-based kube-controllers index page into released docs. |
| calico-cloud_versioned_docs/version-22-2/reference/component-resources/kube-controllers/configuration.mdx | Deletes obsolete/misleading configuration page (released). |
| calico-cloud_versioned_docs/version-22-2/multicluster/services-controller.mdx | Mirrors the updated deep-link to the resource reference (released). |
| - **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/services-controller.mdx) for the usage guide. | ||
| - **Load balancer controller** — manages IPAM for Services of type `LoadBalancer`. | ||
|
|
Comment on lines
+13
to
+15
| - **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/services-controller.mdx) for the usage guide. | ||
| - **Load balancer controller** — manages IPAM for Services of type `LoadBalancer`. |
| @@ -1,11 +1,11 @@ | |||
| --- | |||
| description: Reference content for the kube-controllers component in Calico Cloud connected clusters that watches Kubernetes API events and reconciles cluster state. | |||
| description: kube-controllers is a set of Kubernetes controllers for Calico Cloud. | |||
| @@ -1,11 +1,11 @@ | |||
| --- | |||
| description: Reference content for the kube-controllers component in Calico Cloud connected clusters that watches Kubernetes API events and reconciles cluster state. | |||
| description: kube-controllers is a set of Kubernetes controllers for Calico Cloud. | |||
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
Mirrors the structural fix from #2701 into both Calico Cloud trees (
calico-cloud/andcalico-cloud_versioned_docs/version-22-2/).The
kube-controllers/configuration.mdxpage exists in both Calico Cloud trees with the same factual error that triggered DOCS-2914 — it states that the federation controller is disabled by default when it is actually enabled. The underlying problem is the same as in CE: the page documents a manifest-install env-var path (ENABLED_CONTROLLERS) that doesn't apply to operator-managed installs.Per tree (mirrored across
calico-cloud/andcalico-cloud_versioned_docs/version-22-2/)reference/component-resources/kube-controllers/configuration.mdx.reference/resources/kubecontrollersconfig.mdx, including the node / federated services / load balancer bullets. Updated the body's FederatedServicesController section to point at the federated services usage guide.reference/component-resources/kube-controllers/index.mdx(was a<DocCardList>over sidebar children — withconfigurationremoved it would render as a single bare card) with a prose intro pointing at the resource reference for configuration and the prometheus page for metrics.multicluster/services-controller.mdxto deep-link#federatedservicescontrolleron the resource page (also fixes the singular "service" → plural "services" wording from the CE PR).<DocCardLink>for the deleted page fromreference/index.mdx.Sidebars and redirect
reference/component-resources/kube-controllers/configurationentry fromsidebars-calico-cloud.js(current/next) andcalico-cloud_versioned_sidebars/version-22-2-sidebars.json(released).static/_redirects's deletion-redirects block. (No/next/redirect — matches the CE precedent of only redirecting the released URL.)Cloud-specific notes
multicluster/federation/subdirectory; the services-controller page is atmulticluster/services-controller.mdxdirectly. Link depth adjusted accordingly.operations/decommissioning-a-node.mdx, so that CE inbound-link fix has no Cloud analogue.Context
Follow-up to #2701 (CE current). Ticket: https://tigera.atlassian.net/browse/DOCS-2914
Test plan
prometheusunder it (both trees)multicluster/services-controller.mdx"Federated services controller" link resolves to#federatedservicescontrollerreference/index.mdxComponent resources card grid no longer shows the deleted page/calico-cloud/reference/component-resources/kube-controllers/configurationredirects to the resource page🤖 Generated with Claude Code