Skip to content

Add documentation for v3 CRD mode (tech preview)#2545

Open
caseydavenport wants to merge 1 commit intotigera:mainfrom
caseydavenport:casey-v3-crds
Open

Add documentation for v3 CRD mode (tech preview)#2545
caseydavenport wants to merge 1 commit intotigera:mainfrom
caseydavenport:casey-v3-crds

Conversation

@caseydavenport
Copy link
Member

Summary

Adds documentation for the new v3 CRD mode feature in Calico v3.32.0.

In v3 CRD mode, projectcalico.org/v3 resources are backed directly by CRDs, eliminating the need for the Calico aggregation API server. This simplifies installation, removes ordering dependencies (benefiting GitOps tools like ArgoCD/Flux), and allows kubectl to manage Calico resources natively. For v3.32.0, this is tech preview — the default install still uses the API server and users must explicitly opt in. The feature is expected to advance toward GA over subsequent releases.

Changes

  • New page: calico/operations/enable-v3-crd-mode.mdx — primary docs covering what v3 CRD mode is, how to enable it via Helm, behavioral differences, known limitations, and troubleshooting
  • Sidebar: Added nav entry in Operations section
  • install-apiserver.mdx: Added tip linking to v3 CRD mode, updated calicoctl/kubectl concepts and uninstall note
  • helm.mdx: Added tip showing the projectcalico.org.v3 CRD chart alongside the default v1 chart
  • helm_customization.mdx: Clarified v3 apiVersion is always usable in v3 CRD mode
  • architecture/overview.mdx: Updated API server component description
  • calicoctl/install.mdx: Added v3 CRD mode as alternative to API server for kubectl access
  • rbac-tiered-policies.mdx: Added webhook enforcement context and GET/LIST/WATCH limitation note
  • ippool.mdx: Added CIDR overlap validation section documenting async behavior

References

Test plan

  • make start — verify new page renders, sidebar link works, admonitions display correctly
  • Verify all cross-links resolve without broken links
  • yarn test:components — ensure no React component regressions

🤖 Generated with Claude Code

Copilot AI review requested due to automatic review settings February 23, 2026 22:11
@caseydavenport caseydavenport requested a review from a team as a code owner February 23, 2026 22:11
@netlify
Copy link

netlify bot commented Feb 23, 2026

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

Name Link
🔨 Latest commit 00b5a78
🔍 Latest deploy log https://app.netlify.com/projects/calico-docs-preview-next/deploys/699cda2aff38320008862ffc
😎 Deploy Preview https://deploy-preview-2545--calico-docs-preview-next.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

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

@netlify
Copy link

netlify bot commented Feb 23, 2026

Deploy Preview succeeded!

Built without sensitive environment variables

Name Link
🔨 Latest commit 00b5a78
🔍 Latest deploy log https://app.netlify.com/projects/tigera/deploys/699cda2ac1ff3a000895c5eb
😎 Deploy Preview https://deploy-preview-2545--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: 72 (🔴 down 1 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

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

Copy link
Contributor

Copilot AI left a comment

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 adds comprehensive documentation for the new v3 CRD mode feature in Calico v3.32.0 (tech preview). In v3 CRD mode, projectcalico.org/v3 resources are backed directly by CRDs instead of requiring the Calico aggregation API server. This simplifies architecture, improves GitOps compatibility, and allows kubectl to manage Calico resources natively.

Changes:

  • New dedicated page documenting v3 CRD mode installation, behavioral differences, limitations, and troubleshooting
  • Updates to related documentation pages to reference the new mode as an alternative to the aggregation API server
  • Documentation of key behavioral differences including asynchronous CIDR validation and partial tier RBAC enforcement

Reviewed changes

Copilot reviewed 9 out of 9 changed files in this pull request and generated 3 comments.

Show a summary per file
File Description
sidebars-calico.js Adds navigation entry for v3 CRD mode page in Operations section after install-apiserver
calico/operations/enable-v3-crd-mode.mdx New comprehensive page covering v3 CRD mode concept, installation, behavioral differences, limitations, and troubleshooting
calico/getting-started/kubernetes/helm.mdx Adds tip showing v3 CRD chart installation as alternative to default v1 chart
calico/operations/install-apiserver.mdx Adds tip referencing v3 CRD mode and updates calicoctl/kubectl relationship explanations
calico/operations/calicoctl/install.mdx Adds v3 CRD mode as alternative for kubectl access to Calico resources
calico/reference/installation/helm_customization.mdx Clarifies that v3 apiVersion can always be used in v3 CRD mode
calico/reference/architecture/overview.mdx Updates APIServer component description to explain different behavior in v3 CRD mode
calico/network-policy/policy-tiers/rbac-tiered-policies.mdx Documents webhook enforcement and GET/LIST/WATCH limitation in v3 CRD mode
calico/reference/resources/ippool.mdx Adds CIDR overlap validation section documenting asynchronous behavior in v3 CRD mode

@caseydavenport caseydavenport force-pushed the casey-v3-crds branch 9 times, most recently from ab594d3 to f5e1385 Compare February 23, 2026 22:33

```bash
kubectl create -f $[manifestsUrl]/manifests/operator-crds.yaml
kubectl create -f $[manifestsUrl]/manifests/v1_crd_projectcalico_org.yaml
Copy link
Member Author

Choose a reason for hiding this comment

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

FYI the old URL will continue to exist for a while for compatibility reasons, but this new URL is more explicit and is the counterpart to the v3 version.

@caseydavenport caseydavenport force-pushed the casey-v3-crds branch 8 times, most recently from 6a88e6e to b678557 Compare February 23, 2026 22:52
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.

2 participants