Update Installation API references#2504
Merged
ctauchen merged 1 commit intotigera:mainfrom Feb 3, 2026
Merged
Conversation
✅ Deploy Preview succeeded!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify project configuration. |
✅ Deploy Preview for calico-docs-preview-next ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the Installation API reference documentation to add support for Istio integration across multiple product versions. The changes are backports to versioned documentation directories.
Changes:
- Added new Istio resource type and related type definitions (IstioCNIDaemonset, IstiodDeployment, ZTunnelDaemonset, IstioSpec, IstioStatus, and supporting types)
- Updated Calico Enterprise 3.23-1 container naming from
calico-*totigera-*prefix for Manager deployment components - Updated ManagementClusterConnection TLS secret name references from
calico-management-cluster-connectiontotigera-management-cluster-connectionin Enterprise 3.23-1
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 12 comments.
| File | Description |
|---|---|
| calico_versioned_docs/version-3.31/reference/installation/_api.mdx | Adds Istio resource type to TOC and documents all Istio-related types including IstioCNIDaemonset, IstiodDeployment, ZTunnelDaemonset and their specifications |
| calico-enterprise_versioned_docs/version-3.23-1/reference/installation/_api.mdx | Same Istio additions as OSS version, plus updates Manager component naming from calico- to tigera- prefix and management cluster connection secret references |
| calico-enterprise_versioned_docs/version-3.22-2/reference/installation/_api.mdx | Adds same Istio resource type documentation as other versions |
Comment on lines
+3842
to
+3845
| | `affinity` _[Affinity](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#affinity-v1-core)_ | (Optional) Affinity specifies the affinity for the deployment. | | ||
| | `nodeSelector` _object (keys:string, values:string)_ | (Optional) NodeSelector specifies the node affinity for the deployment. | | ||
| | `resources` _[ResourceRequirements](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#resourcerequirements-v1-core)_ | (Optional) Resources specifies the compute resources required for the deployment. | | ||
| | `tolerations` _[Toleration](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#toleration-v1-core) array_ | (Optional) Tolerations specifies the tolerations for the deployment. | |
There was a problem hiding this comment.
Terminology error: These descriptions refer to "the deployment" but IstioCNIDaemonsetPodSpec is for a DaemonSet, not a Deployment. The descriptions should say "for the daemonset" instead of "for the deployment".
Suggested change
| | `affinity` _[Affinity](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#affinity-v1-core)_ | (Optional) Affinity specifies the affinity for the deployment. | | |
| | `nodeSelector` _object (keys:string, values:string)_ | (Optional) NodeSelector specifies the node affinity for the deployment. | | |
| | `resources` _[ResourceRequirements](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#resourcerequirements-v1-core)_ | (Optional) Resources specifies the compute resources required for the deployment. | | |
| | `tolerations` _[Toleration](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#toleration-v1-core) array_ | (Optional) Tolerations specifies the tolerations for the deployment. | | |
| | `affinity` _[Affinity](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#affinity-v1-core)_ | (Optional) Affinity specifies the affinity for the daemonset. | | |
| | `nodeSelector` _object (keys:string, values:string)_ | (Optional) NodeSelector specifies the node affinity for the daemonset. | | |
| | `resources` _[ResourceRequirements](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#resourcerequirements-v1-core)_ | (Optional) Resources specifies the compute resources required for the daemonset. | | |
| | `tolerations` _[Toleration](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#toleration-v1-core) array_ | (Optional) Tolerations specifies the tolerations for the daemonset. | |
Comment on lines
+3842
to
+3845
| | `affinity` _[Affinity](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#affinity-v1-core)_ | (Optional) Affinity specifies the affinity for the deployment. | | ||
| | `nodeSelector` _object (keys:string, values:string)_ | (Optional) NodeSelector specifies the node affinity for the deployment. | | ||
| | `resources` _[ResourceRequirements](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#resourcerequirements-v1-core)_ | (Optional) Resources specifies the compute resources required for the deployment. | | ||
| | `tolerations` _[Toleration](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#toleration-v1-core) array_ | (Optional) Tolerations specifies the tolerations for the deployment. | |
There was a problem hiding this comment.
Terminology error: These descriptions refer to "the deployment" but IstioCNIDaemonsetPodSpec is for a DaemonSet, not a Deployment. The descriptions should say "for the daemonset" instead of "for the deployment".
Suggested change
| | `affinity` _[Affinity](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#affinity-v1-core)_ | (Optional) Affinity specifies the affinity for the deployment. | | |
| | `nodeSelector` _object (keys:string, values:string)_ | (Optional) NodeSelector specifies the node affinity for the deployment. | | |
| | `resources` _[ResourceRequirements](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#resourcerequirements-v1-core)_ | (Optional) Resources specifies the compute resources required for the deployment. | | |
| | `tolerations` _[Toleration](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#toleration-v1-core) array_ | (Optional) Tolerations specifies the tolerations for the deployment. | | |
| | `affinity` _[Affinity](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#affinity-v1-core)_ | (Optional) Affinity specifies the affinity for the daemonset. | | |
| | `nodeSelector` _object (keys:string, values:string)_ | (Optional) NodeSelector specifies the node affinity for the daemonset. | | |
| | `resources` _[ResourceRequirements](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#resourcerequirements-v1-core)_ | (Optional) Resources specifies the compute resources required for the daemonset. | | |
| | `tolerations` _[Toleration](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#toleration-v1-core) array_ | (Optional) Tolerations specifies the tolerations for the daemonset. | |
| | `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. | |
There was a problem hiding this comment.
Grammar issue: "DSCPMark define" should be "DSCPMark defines" to match subject-verb agreement.
Suggested change
| | `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](#dscp)_ | (Optional) DSCPMark defines the value of the DSCP mark done by Felix and recognised by Istio CNI for Transparent NetworkPolicies. | |
| | `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. | |
There was a problem hiding this comment.
Grammar issue: "DSCPMark define" should be "DSCPMark defines" to match subject-verb agreement.
Suggested change
| | `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](#dscp)_ | (Optional) DSCPMark defines the value of the DSCP mark done by Felix and recognised by Istio CNI for Transparent NetworkPolicies. | |
| | `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. | | ||
|
|
||
|
|
There was a problem hiding this comment.
The dscpMark field references a DSCP type with a link (#dscp), but the DSCP type definition does not appear to be present in this file. This will result in a broken anchor link. Please ensure the DSCP type definition is included in the generated documentation.
Suggested change
| ### DSCP | |
| DSCP represents a Differentiated Services Code Point mark value used for traffic marking. | |
| _Appears in:_ | |
| - [IstioSpec](#istiospec) |
Comment on lines
+6234
to
+6237
| | `affinity` _[Affinity](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#affinity-v1-core)_ | (Optional) Affinity specifies the affinity for the deployment. | | ||
| | `nodeSelector` _object (keys:string, values:string)_ | (Optional) NodeSelector specifies the node affinity for the deployment. | | ||
| | `resources` _[ResourceRequirements](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#resourcerequirements-v1-core)_ | (Optional) Resources specifies the compute resources required for the deployment. | | ||
| | `tolerations` _[Toleration](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#toleration-v1-core) array_ | (Optional) Tolerations specifies the tolerations for the deployment. | |
There was a problem hiding this comment.
Terminology error: These descriptions refer to "the deployment" but ZTunnelDaemonsetPodSpec is for a DaemonSet, not a Deployment. The descriptions should say "for the daemonset" instead of "for the deployment".
Suggested change
| | `affinity` _[Affinity](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#affinity-v1-core)_ | (Optional) Affinity specifies the affinity for the deployment. | | |
| | `nodeSelector` _object (keys:string, values:string)_ | (Optional) NodeSelector specifies the node affinity for the deployment. | | |
| | `resources` _[ResourceRequirements](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#resourcerequirements-v1-core)_ | (Optional) Resources specifies the compute resources required for the deployment. | | |
| | `tolerations` _[Toleration](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#toleration-v1-core) array_ | (Optional) Tolerations specifies the tolerations for the deployment. | | |
| | `affinity` _[Affinity](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#affinity-v1-core)_ | (Optional) Affinity specifies the affinity for the daemonset. | | |
| | `nodeSelector` _object (keys:string, values:string)_ | (Optional) NodeSelector specifies the node affinity for the daemonset. | | |
| | `resources` _[ResourceRequirements](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#resourcerequirements-v1-core)_ | (Optional) Resources specifies the compute resources required for the daemonset. | | |
| | `tolerations` _[Toleration](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#toleration-v1-core) array_ | (Optional) Tolerations specifies the tolerations for the daemonset. | |
Comment on lines
+6234
to
+6237
| | `affinity` _[Affinity](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#affinity-v1-core)_ | (Optional) Affinity specifies the affinity for the deployment. | | ||
| | `nodeSelector` _object (keys:string, values:string)_ | (Optional) NodeSelector specifies the node affinity for the deployment. | | ||
| | `resources` _[ResourceRequirements](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#resourcerequirements-v1-core)_ | (Optional) Resources specifies the compute resources required for the deployment. | | ||
| | `tolerations` _[Toleration](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#toleration-v1-core) array_ | (Optional) Tolerations specifies the tolerations for the deployment. | |
There was a problem hiding this comment.
Terminology error: These descriptions refer to "the deployment" but ZTunnelDaemonsetPodSpec is for a DaemonSet, not a Deployment. The descriptions should say "for the daemonset" instead of "for the deployment".
Suggested change
| | `affinity` _[Affinity](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#affinity-v1-core)_ | (Optional) Affinity specifies the affinity for the deployment. | | |
| | `nodeSelector` _object (keys:string, values:string)_ | (Optional) NodeSelector specifies the node affinity for the deployment. | | |
| | `resources` _[ResourceRequirements](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#resourcerequirements-v1-core)_ | (Optional) Resources specifies the compute resources required for the deployment. | | |
| | `tolerations` _[Toleration](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#toleration-v1-core) array_ | (Optional) Tolerations specifies the tolerations for the deployment. | | |
| | `affinity` _[Affinity](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#affinity-v1-core)_ | (Optional) Affinity specifies the affinity for the daemonset. | | |
| | `nodeSelector` _object (keys:string, values:string)_ | (Optional) NodeSelector specifies the node affinity for the daemonset. | | |
| | `resources` _[ResourceRequirements](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#resourcerequirements-v1-core)_ | (Optional) Resources specifies the compute resources required for the daemonset. | | |
| | `tolerations` _[Toleration](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#toleration-v1-core) array_ | (Optional) Tolerations specifies the tolerations for the daemonset. | |
| | `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. | |
There was a problem hiding this comment.
Grammar issue: "DSCPMark define" should be "DSCPMark defines" to match subject-verb agreement.
Suggested change
| | `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](#dscp)_ | (Optional) DSCPMark defines the value of the DSCP mark done by Felix and recognised by Istio CNI for Transparent NetworkPolicies. | |
| | `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. | |
There was a problem hiding this comment.
The dscpMark field references a DSCP type with a link (#dscp), but the DSCP type definition does not appear to be present in this file. This will result in a broken anchor link. Please ensure the DSCP type definition is included in the generated documentation.
Comment on lines
+1777
to
+1780
| | `affinity` _[Affinity](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#affinity-v1-core)_ | (Optional) Affinity specifies the affinity for the deployment. | | ||
| | `nodeSelector` _object (keys:string, values:string)_ | (Optional) NodeSelector specifies the node affinity for the deployment. | | ||
| | `resources` _[ResourceRequirements](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#resourcerequirements-v1-core)_ | (Optional) Resources specifies the compute resources required for the deployment. | | ||
| | `tolerations` _[Toleration](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#toleration-v1-core) array_ | (Optional) Tolerations specifies the tolerations for the deployment. | |
There was a problem hiding this comment.
Terminology error: These descriptions refer to "the deployment" but IstioCNIDaemonsetPodSpec is for a DaemonSet, not a Deployment. The descriptions should say "for the daemonset" instead of "for the deployment".
Suggested change
| | `affinity` _[Affinity](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#affinity-v1-core)_ | (Optional) Affinity specifies the affinity for the deployment. | | |
| | `nodeSelector` _object (keys:string, values:string)_ | (Optional) NodeSelector specifies the node affinity for the deployment. | | |
| | `resources` _[ResourceRequirements](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#resourcerequirements-v1-core)_ | (Optional) Resources specifies the compute resources required for the deployment. | | |
| | `tolerations` _[Toleration](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#toleration-v1-core) array_ | (Optional) Tolerations specifies the tolerations for the deployment. | | |
| | `affinity` _[Affinity](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#affinity-v1-core)_ | (Optional) Affinity specifies the affinity for the daemonset. | | |
| | `nodeSelector` _object (keys:string, values:string)_ | (Optional) NodeSelector specifies the node affinity for the daemonset. | | |
| | `resources` _[ResourceRequirements](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#resourcerequirements-v1-core)_ | (Optional) Resources specifies the compute resources required for the daemonset. | | |
| | `tolerations` _[Toleration](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#toleration-v1-core) array_ | (Optional) Tolerations specifies the tolerations for the daemonset. | |
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
1 participant
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.
Product Version(s):
Issue:
Link to docs preview:
SME review:
DOCS review:
Additional information:
Merge checklist: