DOCS-3019: Remove the calicoctl kubectl plugin install instructions - #2954
Merged
Conversation
✅ 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
Removes documentation that recommends installing calicoctl as a kubectl plugin (kubectl-calico / kubectl calico ...) across Calico OSS, Calico Enterprise, and Calico Cloud docs (including multiple published/versioned doc trees), in order to reduce user confusion and support friction.
Changes:
- Deletes the “Install calicoctl as a kubectl plugin” section and related TOC/description references from
calicoctlinstall docs (OSS + Enterprise, including versioned copies). - Updates Enterprise troubleshooting guidance to use
calicoctl cluster diagsdirectly (instead ofkubectl calico cluster diags). - Removes BGP page notes/examples that recommend or demonstrate the
kubectl calicoplugin invocation (Enterprise + Cloud, including versioned copies).
Reviewed changes
Copilot reviewed 22 out of 22 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| calico/operations/calicoctl/install.mdx | Removes plugin mention from page description/TOC and deletes the plugin install section (next/unversioned). |
| calico-enterprise/operations/troubleshoot/troubleshooting.mdx | Switches diagnostics instructions from kubectl calico ... to calicoctl ... and adjusts wording/link. |
| calico-enterprise/operations/clis/calicoctl/install.mdx | Removes plugin mention from description/body/TOC and deletes the plugin install section (next/unversioned). |
| calico-enterprise/networking/configuring/bgp.mdx | Removes plugin recommendation note and kubectl calico bgp peers example (latest/unversioned). |
| calico-enterprise_versioned_docs/version-3.24-1/operations/troubleshoot/troubleshooting.mdx | Same troubleshooting diagnostics update for v3.24-1 docs. |
| calico-enterprise_versioned_docs/version-3.24-1/operations/clis/calicoctl/install.mdx | Removes plugin section/references for v3.24-1 Enterprise install docs. |
| calico-enterprise_versioned_docs/version-3.24-1/networking/configuring/bgp.mdx | Removes plugin recommendation/example for v3.24-1 Enterprise BGP docs. |
| calico-enterprise_versioned_docs/version-3.23-2/operations/troubleshoot/troubleshooting.mdx | Same troubleshooting diagnostics update for v3.23-2 docs. |
| calico-enterprise_versioned_docs/version-3.23-2/operations/clis/calicoctl/install.mdx | Removes plugin section/references for v3.23-2 Enterprise install docs. |
| calico-enterprise_versioned_docs/version-3.23-2/networking/configuring/bgp.mdx | Removes plugin recommendation/example for v3.23-2 Enterprise BGP docs. |
| calico-enterprise_versioned_docs/version-3.22-2/operations/troubleshoot/troubleshooting.mdx | Same troubleshooting diagnostics update for v3.22-2 docs. |
| calico-enterprise_versioned_docs/version-3.22-2/operations/clis/calicoctl/install.mdx | Removes plugin section/references for v3.22-2 Enterprise install docs. |
| calico-enterprise_versioned_docs/version-3.22-2/networking/configuring/bgp.mdx | Removes plugin recommendation/example for v3.22-2 Enterprise BGP docs. |
| calico-enterprise_versioned_docs/version-3.21-2/operations/troubleshoot/troubleshooting.mdx | Same troubleshooting diagnostics update for v3.21-2 docs. |
| calico-enterprise_versioned_docs/version-3.21-2/operations/clis/calicoctl/install.mdx | Removes plugin section/references for v3.21-2 Enterprise install docs. |
| calico-enterprise_versioned_docs/version-3.21-2/networking/configuring/bgp.mdx | Removes plugin recommendation/example for v3.21-2 Enterprise BGP docs. |
| calico-cloud/networking/configuring/bgp.mdx | Removes plugin recommendation/example from Calico Cloud BGP docs (next/unversioned). |
| calico-cloud_versioned_docs/version-23-2/networking/configuring/bgp.mdx | Removes plugin recommendation/example from Calico Cloud v23-2 BGP docs. |
| calico_versioned_docs/version-3.32/operations/calicoctl/install.mdx | Removes plugin mention from description/TOC and deletes plugin install section for OSS v3.32 docs. |
| calico_versioned_docs/version-3.31/operations/calicoctl/install.mdx | Removes plugin TOC entry and deletes plugin install section for OSS v3.31 docs. |
| calico_versioned_docs/version-3.30/operations/calicoctl/install.mdx | Removes plugin TOC entry and deletes plugin install section for OSS v3.30 docs. |
| calico_versioned_docs/version-3.29/operations/calicoctl/install.mdx | Removes plugin TOC entry and deletes plugin install section for OSS v3.29 docs. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
The docs told users to download calicoctl under the name kubectl-calico, put it on the PATH, and then run commands as kubectl calico. Support has seen users get stuck on the rename, most often when they are trying to collect a diagnostics bundle and are already dealing with a problem. The plugin never became the way people run calicoctl, and it does not do anything the binary cannot do. Running calicoctl directly is one step instead of three. This removes the plugin section from the calicoctl install page and drops the plugin advice from the pages that pointed at it. The troubleshooting page now says calicoctl cluster diags, and the BGP page keeps the calicoctl bgp peers command that was already there. Calico Open Source, Calico Enterprise, and Calico Cloud are all covered, in the next tree and in every published version. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
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.
Jira: https://tigera.atlassian.net/browse/DOCS-3019
Deploy preview, representative pages. The same edit is repeated in every other version.