From 5cc26eaa292c07c74111e01a3d621dc062ca441b Mon Sep 17 00:00:00 2001 From: Chris Tauchen Date: Thu, 20 Aug 2026 21:01:40 +0100 Subject: [PATCH 1/2] Regenerate the Calico 3.31 Installation API reference 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) --- .../reference/installation/_api.mdx | 21 ++++++++++++++++++- 1 file changed, 20 insertions(+), 1 deletion(-) diff --git a/calico_versioned_docs/version-3.31/reference/installation/_api.mdx b/calico_versioned_docs/version-3.31/reference/installation/_api.mdx index c46ac58e78..3dac39a647 100644 --- a/calico_versioned_docs/version-3.31/reference/installation/_api.mdx +++ b/calico_versioned_docs/version-3.31/reference/installation/_api.mdx @@ -322,10 +322,29 @@ _Appears in:_ | --- | --- | | `type` _[CNIPluginType](#cniplugintype)_ | Specifies the CNI plugin that will be used in the Calico or Calico Enterprise installation. * For KubernetesProvider GKE, this field defaults to GKE. * For KubernetesProvider AKS, this field defaults to AzureVNET. * For KubernetesProvider EKS, this field defaults to AmazonVPC. * If aws-node daemonset exists in kube-system when the Installation resource is created, this field defaults to AmazonVPC. * For all other cases this field defaults to Calico. For the value Calico, the CNI plugin binaries and CNI config will be installed as part of deployment, for all other values the CNI plugin binaries and CNI config is a dependency that is expected to be installed separately.
Default: Calico | | `ipam` _[IPAMSpec](#ipamspec)_ | (Optional) IPAM specifies the pod IP address management that will be used in the Calico or Calico Enterprise installation. | +| `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.
Default: Auto | | `binDir` _string_ | (Optional) BinDir is the path to the CNI binaries directory. If you have changed the installation directory for CNI binaries in the container runtime configuration, please ensure that this field points to the same directory as specified in the container runtime settings. Default directory depends on the KubernetesProvider. * For KubernetesProvider GKE, this field defaults to "/home/kubernetes/bin". * For KubernetesProvider OpenShift, this field defaults to "/var/lib/cni/bin". * Otherwise, this field defaults to "/opt/cni/bin". | | `confDir` _string_ | (Optional) ConfDir is the path to the CNI config directory. If you have changed the installation directory for CNI configuration in the container runtime configuration, please ensure that this field points to the same directory as specified in the container runtime settings. Default directory depends on the KubernetesProvider. * For KubernetesProvider GKE, this field defaults to "/etc/cni/net.d". * For KubernetesProvider OpenShift, this field defaults to "/var/run/multus/cni/net.d". * Otherwise, this field defaults to "/etc/cni/net.d". | +### CNISpecVersion + +_Underlying type:_ _string_ + +CNISpecVersion is the version of the CNI specification declared in the +CNI configuration generated by the operator. + +_Appears in:_ +- [CNISpec](#cnispec) + +| Value | Description | +| --- | --- | +| `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. | +| `0.3.1` | | +| `0.4.0` | | +| `1.0.0` | | + + ### CRDManagement _Underlying type:_ _string_ @@ -1822,7 +1841,7 @@ _Appears in:_ | `istiod` _[IstiodDeployment](#istioddeployment)_ | (Optional) IstiodDeployment defines the resource requirements and node selector for the Istio deployment. | | `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. | ### IstioStatus From 3bb9570c28429a483c1250a9817ec9ffcf5c62dc Mon Sep 17 00:00:00 2001 From: Chris Tauchen Date: Thu, 20 Aug 2026 21:10:36 +0100 Subject: [PATCH 2/2] Keep the DSCP anchor fix in the 3.31 API reference The regeneration relinked dscpMark to #dscp, an anchor the generator emits no section for. Commit ec7d2902 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) --- .../version-3.31/reference/installation/_api.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/calico_versioned_docs/version-3.31/reference/installation/_api.mdx b/calico_versioned_docs/version-3.31/reference/installation/_api.mdx index 3dac39a647..26fcd94c14 100644 --- a/calico_versioned_docs/version-3.31/reference/installation/_api.mdx +++ b/calico_versioned_docs/version-3.31/reference/installation/_api.mdx @@ -1841,7 +1841,7 @@ _Appears in:_ | `istiod` _[IstiodDeployment](#istioddeployment)_ | (Optional) IstiodDeployment defines the resource requirements and node selector for the Istio deployment. | | `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](#dscp)_ | (Optional) DSCPMark define the value of the DSCP mark done by Felix and recognised by Istio CNI for Transparent NetworkPolicies. | +| `dscpMark` _DSCP_ | (Optional) DSCPMark define the value of the DSCP mark done by Felix and recognised by Istio CNI for Transparent NetworkPolicies. | ### IstioStatus