DOCS-2967: Regenerate the Calico 3.31 Installation API reference - #2941
Merged
Conversation
Generated with the repo's operator reference target against tigera/operator v1.40.14, which is the tip of release-v1.40 and the line that v1.40.15 will be cut from. Calico 3.31.7 pins v1.40.15. Adds spec.cni.specVersion and the CNISpecVersion enum, which the operator gained in v1.40.14. Also links the dscpMark type, which the older generated file left as plain text. Co-Authored-By: Claude Opus 5 (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!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
There was a problem hiding this comment.
Pull request overview
Regenerates the Calico OSS 3.31 versioned Installation API reference, updating the generated CRD schema documentation to reflect operator changes (notably adding spec.cni.specVersion) and improving type linking in the output MDX.
Changes:
- Adds
spec.cni.specVersiontoCNISpecand documents the newCNISpecVersionenum (defaultAuto). - Updates
dscpMarkto render as a linked type (currently producing a broken anchor link in this file).
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
| | `istioCNI` _[IstioCNIDaemonset](#istiocnidaemonset)_ | (Optional) IstioCNIDaemonset defines the resource requirements for the Istio CNI plugin. | | ||
| | `ztunnel` _[ZTunnelDaemonset](#ztunneldaemonset)_ | (Optional) ZTunnelDaemonset defines the resource requirements for the ZTunnelDaemonset component. | | ||
| | `dscpMark` _DSCP_ | (Optional) DSCPMark define the value of the DSCP mark done by Felix and recognised by Istio CNI for Transparent NetworkPolicies. | | ||
| | `dscpMark` _[DSCP](#dscp)_ | (Optional) DSCPMark define the value of the DSCP mark done by Felix and recognised by Istio CNI for Transparent NetworkPolicies. | |
The regeneration relinked dscpMark to #dscp, an anchor the generator emits no section for. Commit ec7d290 unlinked it on purpose, for DOCS-2979. Restoring that leaves this PR purely additive. The generator will keep relinking it on every run, so the durable fix belongs in the templates or a post-processing step. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.
Suppressed comments (2)
calico_versioned_docs/version-3.31/reference/installation/_api.mdx:342
- The
Autovalue description leaks the internal Go identifierCNISpecVersionAutoand has trailing extra spaces before the table delimiter; this reads oddly in user-facing docs and may trigger linters that flag double-spaces.
| `Auto` | CNISpecVersionAuto lets the operator choose the CNI spec version. The chosen version may be raised in future operator versions as older container runtimes fall out of support. |
calico_versioned_docs/version-3.31/reference/installation/_api.mdx:325
- PR description says this regeneration "turns the dscpMark type into a link", but the generated file still shows
dscpMarkwith the unlinked_DSCP_type (see line 1844). Either update the PR description to match the actual diff, or include the intended generator output change if it was missed.
| `specVersion` _[CNISpecVersion](#cnispecversion)_ | (Optional) SpecVersion configures the CNI specification version declared in the CNI configuration ("cniVersion") that the operator generates. Auto (the default) lets the operator choose an appropriate version, which may increase across operator upgrades. Pin an explicit version if a chained CNI plugin or container runtime in your environment requires one. Only relevant when using the Calico CNI plugin.<br />Default: Auto |
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.
Regenerates calico_versioned_docs/version-3.31/reference/installation/_api.mdx. One file changes.
Generated with make calico_versioned_docs/version-3.31__operator_reference against tigera/operator v1.40.14, which is the current tip of release-v1.40.
Pairs with #2939, which publishes Calico Open Source 3.31.7. That release ships the operator that added the new field, so the reference did not document it.
The diff adds spec.cni.specVersion to CNISpec, adds the CNISpecVersion enum with values Auto, 0.3.1, 0.4.0, and 1.0.0, defaulting to Auto, and turns the dscpMark type into a link.
To do:
Flags: