Skip to content

DOCS-3123: Fix calicoctl container instructions - #3119

Open
ctauchen wants to merge 2 commits into
tigera:mainfrom
ctauchen:DOCS-3123-calicoctl-container
Open

ctauchen wants to merge 2 commits into
tigera:mainfrom
ctauchen:DOCS-3123-calicoctl-container

Conversation

@ctauchen

@ctauchen ctauchen commented Oct 16, 2026 •

Copy link
Copy Markdown
Collaborator

Fixes the calicoctl container instructions, which fail as written on 3.33.

https://tigera.atlassian.net/browse/DOCS-3123

  • 3.33 and next: run calicoctl from calico/calico with the ctl subcommand, and pass --user so a 0600 kubeconfig is readable by the image's UID 10001.
  • 3.31 and 3.32: add the missing run example for calico/ctl.
  • Configure overview: link the CalicoAPIConfig example to the KDD and etcd option tables, and drop the advice to exec into a sleeping container (the images have no shell or sleep).
  • Every command was verified on kind clusters running 3.31.7, 3.32.2, and 3.33.0. Not tested with podman.

Preview:

@ctauchen
ctauchen requested a review from a team as a code owner October 16, 2026 10:17
Copilot AI lite review requested due to automatic review settings October 16, 2026 10:17
@netlify

netlify Bot commented Oct 16, 2026 •

Copy link
Copy Markdown

✅ Deploy Preview for calico-docs-preview-next ready!

Name Link
🔨 Latest commit f0373f4
🔍 Latest deploy log https://app.netlify.com/projects/calico-docs-preview-next/deploys/6ad5e7c665b2ee1a3f9dd652
😎 Deploy Preview https://deploy-preview-3119--calico-docs-preview-next.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
🤖 Make changes Run an agent on this branch

To edit notification comments on pull requests, go to your Netlify project configuration.

@netlify

netlify Bot commented Oct 16, 2026 •

Copy link
Copy Markdown

✅ Deploy Preview succeeded!

Built without sensitive environment variables

Name Link
🔨 Latest commit f0373f4
🔍 Latest deploy log https://app.netlify.com/projects/tigera/deploys/6ad5e7c6261ee9fd87527fde
😎 Deploy Preview https://deploy-preview-3119--tigera.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 97 (🟢 up 24 from production)
Accessibility: 98 (no change from production)
Best Practices: 92 (no change from production)
SEO: 100 (no change from production)
PWA: -
View the detailed breakdown and full score reports
🤖 Make changes Run an agent on this branch

To edit notification comments on pull requests, go to your Netlify project configuration.

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.

🟢 Approval recommended

No unresolved review issues remain.

0 open findings

What changed in this PR

Updates calicoctl container documentation for Calico 3.31–3.33 and next, correcting invocation, kubeconfig permissions, networking, and configuration guidance.

Changes:

  • Adds working container run examples.
  • Documents combined-image entrypoints and UID handling.
  • Clarifies datastore options and container limitations.
File Description
calico/​operations/​calicoctl/​install.mdx Updates current container instructions.
calico/​operations/​calicoctl/​configure/​overview.mdx Clarifies configuration options and container usage.
calico_versioned_docs/​version-3.33/​operations/​calicoctl/​install.mdx Updates 3.33 container instructions.
calico_versioned_docs/​version-3.33/​operations/​calicoctl/​configure/​overview.mdx Updates 3.33 configuration guidance.
calico_versioned_docs/​version-3.32/​operations/​calicoctl/​install.mdx Adds the calico/ctl run example.
calico_versioned_docs/​version-3.32/​operations/​calicoctl/​configure/​overview.mdx Updates 3.32 configuration guidance.
calico_versioned_docs/​version-3.31/​operations/​calicoctl/​install.mdx Adds the calico/ctl run example.
calico_versioned_docs/​version-3.31/​operations/​calicoctl/​configure/​overview.mdx Updates 3.31 configuration guidance.

🧠 Review effort: Lite


💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread calico/operations/calicoctl/install.mdx Outdated
--user "$(id -u):$(id -g)" \
-v "$HOME/.kube/config:/kubeconfig:ro" \
-e KUBECONFIG=/kubeconfig \
--entrypoint calicoctl \

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we should prefer to use the /usr/bin/calico entrypoint with ctl passed as the first argument.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done in f0373f4.

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