Skip to content

Update Installation API references #2504

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ctauchen merged 1 commit into from
Feb 3, 2026
Merged

Update Installation API references #2504

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
224 changes: 224 additions & 0 deletions calico-enterprise_versioned_docs/version-3.22-2/reference/installation/_api.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ Resource Types
- [ImageSet](#imageset)
- [Installation](#installation)
- [IntrusionDetection](#intrusiondetection)
- [Istio](#istio)
- [LogCollector](#logcollector)
- [LogStorage](#logstorage)
- [ManagementCluster](#managementcluster)
Expand Down Expand Up @@ -3798,6 +3799,170 @@ _Appears in:_
| `conditions` _[Condition](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#condition-v1-meta) array_ | (Optional) Conditions represents the latest observed set of conditions for the component. A component may be one or more of Ready, Progressing, Degraded or other customer types. |


### Istio



Istio is the Schema for the istios API

| Field | Description |
| --- | --- |
| `apiVersion` _string_ | `operator.tigera.io/v1` |
| `kind` _string_ | `Istio` |
| `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. |
| `spec` _[IstioSpec](#istiospec)_ | |
| `status` _[IstioStatus](#istiostatus)_ | |


### IstioCNIDaemonset



IstioCNIDaemonset defines customized settings for the Istio CNI plugin.

_Appears in:_
- [IstioSpec](#istiospec)

| Field | Description |
| --- | --- |
| `spec` _[IstioCNIDaemonsetSpec](#istiocnidaemonsetspec)_ | (Optional) Spec allows users to specify custom fields for the Istio CNI Daemonset. |


### IstioCNIDaemonsetPodSpec



IstioCNIDaemonsetPodSpec defines the pod spec for customizing the Istio CNI Daemonset.

_Appears in:_
- [IstioCNIDaemonsetSpecTemplate](#istiocnidaemonsetspectemplate)

| Field | Description |
| --- | --- |
| `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. |
Comment on lines +3842 to +3845
Copy link

Copilot AI Feb 3, 2026

Choose a reason for hiding this comment

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

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. |

Copilot uses AI. Check for mistakes.


### IstioCNIDaemonsetSpec



IstioCNIDaemonsetSpec defines the spec for customizing the Istio CNI Daemonset.

_Appears in:_
- [IstioCNIDaemonset](#istiocnidaemonset)

| Field | Description |
| --- | --- |
| `template` _[IstioCNIDaemonsetSpecTemplate](#istiocnidaemonsetspectemplate)_ | (Optional) Template allows users to specify custom fields for the Istio CNI Daemonset. |


### IstioCNIDaemonsetSpecTemplate



IstioCNIDaemonsetSpecTemplate defines the template for customizing the Istio CNI Daemonset.

_Appears in:_
- [IstioCNIDaemonsetSpec](#istiocnidaemonsetspec)

| Field | Description |
| --- | --- |
| `spec` _[IstioCNIDaemonsetPodSpec](#istiocnidaemonsetpodspec)_ | (Optional) Spec allows users to specify custom fields for the Istio CNI Daemonset. |


### IstioSpec



IstioSpec defines the desired state of Istio

_Appears in:_
- [Istio](#istio)

| Field | Description |
| --- | --- |
| `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. |
Copy link

Copilot AI Feb 3, 2026

Choose a reason for hiding this comment

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

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. |

Copilot uses AI. Check for mistakes.
Copy link

Copilot AI Feb 3, 2026

Choose a reason for hiding this comment

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

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.

Copilot uses AI. Check for mistakes.


### IstioStatus



IstioStatus defines the observed state of Istio

_Appears in:_
- [Istio](#istio)

| Field | Description |
| --- | --- |
| `conditions` _[Condition](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#condition-v1-meta) array_ | Conditions represents the latest observed set of conditions for the component. A component may be one or more of Ready, Progressing, Degraded or other customer types. |


### IstiodDeployment



IstiodDeployment defines customized settings for the Istio deployment.

_Appears in:_
- [IstioSpec](#istiospec)

| Field | Description |
| --- | --- |
| `spec` _[IstiodDeploymentSpec](#istioddeploymentspec)_ | (Optional) Spec allows users to specify custom fields for the Istiod Deployment. |


### IstiodDeploymentPodSpec



IstiodDeploymentPodSpec defines the pod spec for customizing the Istiod Deployment.

_Appears in:_
- [IstiodDeploymentSpecTemplate](#istioddeploymentspectemplate)

| Field | Description |
| --- | --- |
| `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. |


### IstiodDeploymentSpec



IstiodDeploymentSpec defines the spec for customizing the Istiod Deployment.

_Appears in:_
- [IstiodDeployment](#istioddeployment)

| Field | Description |
| --- | --- |
| `template` _[IstiodDeploymentSpecTemplate](#istioddeploymentspectemplate)_ | (Optional) Template allows users to specify custom fields for the Istiod Deployment. |


### IstiodDeploymentSpecTemplate



IstiodDeploymentSpecTemplate defines the template for customizing the Istiod Deployment.

_Appears in:_
- [IstiodDeploymentSpec](#istioddeploymentspec)

| Field | Description |
| --- | --- |
| `spec` _[IstiodDeploymentPodSpec](#istioddeploymentpodspec)_ | (Optional) Spec allows users to specify custom fields for the Istiod Deployment. |


### Kibana


Expand Down Expand Up @@ -6040,3 +6205,62 @@ _Appears in:_
| `vxlanMACPrefix` _string_ | (Optional) VXLANMACPrefix is the prefix used when generating MAC addresses for virtual NICs |
| `vxlanAdapter` _string_ | (Optional) VXLANAdapter is the Network Adapter used for VXLAN, leave blank for primary NIC |


### ZTunnelDaemonset



ZTunnelDaemonset defines customized settings for the ZTunnelDaemonset component.

_Appears in:_
- [IstioSpec](#istiospec)

| Field | Description |
| --- | --- |
| `spec` _[ZTunnelDaemonsetSpec](#ztunneldaemonsetspec)_ | (Optional) Spec allows users to specify custom fields for the ZTunnel Daemonset. |


### ZTunnelDaemonsetPodSpec



ZTunnelDaemonsetPodSpec defines the pod spec for customizing the ZTunnel Daemonset.

_Appears in:_
- [ZTunnelDaemonsetSpecTemplate](#ztunneldaemonsetspectemplate)

| Field | Description |
| --- | --- |
| `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. |
Comment on lines +6234 to +6237
Copy link

Copilot AI Feb 3, 2026

Choose a reason for hiding this comment

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

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. |

Copilot uses AI. Check for mistakes.


### ZTunnelDaemonsetSpec



ZTunnelDaemonsetSpec defines the spec for customizing the ZTunnel Daemonset.

_Appears in:_
- [ZTunnelDaemonset](#ztunneldaemonset)

| Field | Description |
| --- | --- |
| `template` _[ZTunnelDaemonsetSpecTemplate](#ztunneldaemonsetspectemplate)_ | (Optional) Template allows users to specify custom fields for the ZTunnel Daemonset. |


### ZTunnelDaemonsetSpecTemplate



ZTunnelDaemonsetSpecTemplate defines the template for customizing the ZTunnel Daemonset.

_Appears in:_
- [ZTunnelDaemonsetSpec](#ztunneldaemonsetspec)

| Field | Description |
| --- | --- |
| `spec` _[ZTunnelDaemonsetPodSpec](#ztunneldaemonsetpodspec)_ | (Optional) Spec allows users to specify custom fields for the ZTunnel Daemonset. |

Loading