Installation reference

The Kubernetes resources below configure Calico installation when using the operator. Each resource is responsible for installing and configuring a different subsystem of Calico during installation. Most options can be modified on a running cluster using kubectl.

Packages:

• operator.tigera.io/v1

operator.tigera.io/v1

API Schema definitions for configuring the installation of Calico and Calico Enterprise

Resource Types:

• APIServer
• ApplicationLayer
• EgressGateway
• ImageSet
• Installation
• Monitor
• PacketCaptureAPI
• PolicyRecommendation
• TLSPassThroughRoute
• TLSTerminatedRoute
• Tenant
• TigeraStatus

APIServer

APIServer installs the Tigera API server and related resources. At most one instance of this resource is supported. It must be named “default” or “tigera-secure”.

Field	Description
apiVersion string	operator.tigera.io/v1
kind string	APIServer
metadata Kubernetes meta/v1.ObjectMeta	Refer to the Kubernetes API documentation for the fields of the metadata field.
spec APIServerSpec	Specification of the desired state for the Tigera API server. apiServerDeployment APIServerDeployment APIServerDeployment configures the calico-apiserver (or tigera-apiserver in Enterprise) Deployment. If used in conjunction with ControlPlaneNodeSelector or ControlPlaneTolerations, then these overrides take precedence.
status APIServerStatus	Most recently observed status for the Tigera API server.

ApplicationLayer

ApplicationLayer is the Schema for the applicationlayers API

Field	Description
apiVersion string	operator.tigera.io/v1
kind string	ApplicationLayer
metadata Kubernetes meta/v1.ObjectMeta	Refer to the Kubernetes API documentation for the fields of the metadata field.
spec ApplicationLayerSpec	webApplicationFirewall WAFStatusType WebApplicationFirewall controls whether or not ModSecurity enforcement is enabled for the cluster. When enabled, Services may opt-in to having ingress traffic examed by ModSecurity. logCollection LogCollectionSpec Specification for application layer (L7) log collection. applicationLayerPolicy ApplicationLayerPolicyStatusType Application Layer Policy controls whether or not ALP enforcement is enabled for the cluster. When enabled, NetworkPolicies with HTTP Match rules may be defined to opt-in workloads for traffic enforcement on the application layer. envoy EnvoySettings User-configurable settings for the Envoy proxy. l7LogCollectorDaemonSet L7LogCollectorDaemonSet (Optional) L7LogCollectorDaemonSet configures the L7LogCollector DaemonSet.
status ApplicationLayerStatus

EgressGateway

EgressGateway is the Schema for the egressgateways API

Field	Description
apiVersion string	operator.tigera.io/v1
kind string	EgressGateway
metadata Kubernetes meta/v1.ObjectMeta	Refer to the Kubernetes API documentation for the fields of the metadata field.
spec EgressGatewaySpec	replicas int32 (Optional) Replicas defines how many instances of the Egress Gateway pod will run. ipPools []EgressGatewayIPPool IPPools defines the IP Pools that the Egress Gateway pods should be using. Either name or CIDR must be specified. IPPools must match existing IPPools. externalNetworks []string (Optional) ExternalNetworks defines the external network names this Egress Gateway is associated with. ExternalNetworks must match existing external networks. logSeverity LogLevel (Optional) LogSeverity defines the logging level of the Egress Gateway. Default: Info template EgressGatewayDeploymentPodTemplateSpec (Optional) Template describes the EGW Deployment pod that will be created. egressGatewayFailureDetection EgressGatewayFailureDetection (Optional) EgressGatewayFailureDetection is used to configure how Egress Gateway determines readiness. If both ICMP, HTTP probes are defined, one ICMP probe and one HTTP probe should succeed for Egress Gateways to become ready. Otherwise one of ICMP or HTTP probe should succeed for Egress gateways to become ready if configured. aws AWSEgressGateway (Optional) AWS defines the additional configuration options for Egress Gateways on AWS.
status EgressGatewayStatus

ImageSet

ImageSet is used to specify image digests for the images that the operator deploys. The name of the ImageSet is expected to be in the format <variant>-<release>. The variant used is enterprise if the InstallationSpec Variant isTigeraSecureEnterprise otherwise it is calico. The release must match the version of the variant that the operator is built to deploy, this version can be obtained by passing the --version flag to the operator binary.

Field	Description
apiVersion string	operator.tigera.io/v1
kind string	ImageSet
metadata Kubernetes meta/v1.ObjectMeta	Refer to the Kubernetes API documentation for the fields of the metadata field.
spec ImageSetSpec	images []Image Images is the list of images to use digests. All images that the operator will deploy must be specified.

Installation

Installation configures an installation of Calico or Calico Enterprise. At most one instance of this resource is supported. It must be named “default”. The Installation API installs core networking and network policy components, and provides general install-time configuration.

Field	Description
apiVersion string	operator.tigera.io/v1
kind string	Installation
metadata Kubernetes meta/v1.ObjectMeta	Refer to the Kubernetes API documentation for the fields of the metadata field.
spec InstallationSpec	Specification of the desired state for the Calico or Calico Enterprise installation. variant ProductVariant (Optional) Variant is the product to install - one of Calico or TigeraSecureEnterprise Default: Calico registry string (Optional) Registry is the default Docker registry used for component Docker images. If specified then the given value must end with a slash character (/) and all images will be pulled from this registry. If not specified then the default registries will be used. A special case value, UseDefault, is supported to explicitly specify the default registries will be used. Image format:<registry><imagePath>/<imagePrefix><imageName>:<image-tag> This option allows configuring the <registry> portion of the above format. imagePath string (Optional) ImagePath allows for the path part of an image to be specified. If specified then the specified value will be used as the image path for each image. If not specified or empty, the default for each image will be used. A special case value, UseDefault, is supported to explicitly specify the default image path will be used for each image. Image format:<registry><imagePath>/<imagePrefix><imageName>:<image-tag> This option allows configuring the <imagePath> portion of the above format. imagePrefix string (Optional) ImagePrefix allows for the prefix part of an image to be specified. If specified then the given value will be used as a prefix on each image. If not specified or empty, no prefix will be used. A special case value, UseDefault, is supported to explicitly specify the default image prefix will be used for each image. Image format:<registry><imagePath>/<imagePrefix><imageName>:<image-tag> This option allows configuring the <imagePrefix> portion of the above format. imagePullSecrets []Kubernetes core/v1.LocalObjectReference (Optional) ImagePullSecrets is an array of references to container registry pull secrets to use. These are applied to all images to be pulled. kubernetesProvider Provider (Optional) KubernetesProvider specifies a particular provider of the Kubernetes platform and enables provider-specific configuration. If the specified value is empty, the Operator will attempt to automatically determine the current provider. If the specified value is not empty, the Operator will still attempt auto-detection, but will additionally compare the auto-detected value to the specified value to confirm they match. cni CNISpec (Optional) CNI specifies the CNI that will be used by this installation. calicoNetwork CalicoNetworkSpec (Optional) CalicoNetwork specifies networking configuration options for Calico. typhaAffinity TyphaAffinity (Optional) Deprecated. Please use Installation.Spec.TyphaDeployment instead. TyphaAffinity allows configuration of node affinity characteristics for Typha pods. controlPlaneNodeSelector map[string]string (Optional) ControlPlaneNodeSelector is used to select control plane nodes on which to run Calico components. This is globally applied to all resources created by the operator excluding daemonsets. controlPlaneTolerations []Kubernetes core/v1.Toleration (Optional) ControlPlaneTolerations specify tolerations which are then globally applied to all resources created by the operator. controlPlaneReplicas int32 (Optional) ControlPlaneReplicas defines how many replicas of the control plane core components will be deployed. This field applies to all control plane components that support High Availability. Defaults to 2. nodeMetricsPort int32 (Optional) NodeMetricsPort specifies which port calico/node serves prometheus metrics on. By default, metrics are not enabled. If specified, this overrides any FelixConfiguration resources which may exist. If omitted, then prometheus metrics may still be configured through FelixConfiguration. typhaMetricsPort int32 (Optional) TyphaMetricsPort specifies which port calico/typha serves prometheus metrics on. By default, metrics are not enabled. flexVolumePath string (Optional) FlexVolumePath optionally specifies a custom path for FlexVolume. If not specified, FlexVolume will be enabled by default. If set to ‘None’, FlexVolume will be disabled. The default is based on the kubernetesProvider. kubeletVolumePluginPath string (Optional) KubeletVolumePluginPath optionally specifies enablement of Calico CSI plugin. If not specified, CSI will be enabled by default. If set to ‘None’, CSI will be disabled. Default: /var/lib/kubelet nodeUpdateStrategy Kubernetes apps/v1.DaemonSetUpdateStrategy (Optional) NodeUpdateStrategy can be used to customize the desired update strategy, such as the MaxUnavailable field. componentResources []ComponentResource (Optional) Deprecated. Please use CalicoNodeDaemonSet, TyphaDeployment, and KubeControllersDeployment. ComponentResources can be used to customize the resource requirements for each component. Node, Typha, and KubeControllers are supported for installations. certificateManagement CertificateManagement (Optional) CertificateManagement configures pods to submit a CertificateSigningRequest to the certificates.k8s.io/v1beta1 API in order to obtain TLS certificates. This feature requires that you bring your own CSR signing and approval process, otherwise pods will be stuck during initialization. nonPrivileged NonPrivilegedType (Optional) NonPrivileged configures Calico to be run in non-privileged containers as non-root users where possible. calicoNodeDaemonSet CalicoNodeDaemonSet CalicoNodeDaemonSet configures the calico-node DaemonSet. If used in conjunction with the deprecated ComponentResources, then these overrides take precedence. csiNodeDriverDaemonSet CSINodeDriverDaemonSet CSINodeDriverDaemonSet configures the csi-node-driver DaemonSet. calicoKubeControllersDeployment CalicoKubeControllersDeployment CalicoKubeControllersDeployment configures the calico-kube-controllers Deployment. If used in conjunction with the deprecated ComponentResources, then these overrides take precedence. typhaDeployment TyphaDeployment TyphaDeployment configures the typha Deployment. If used in conjunction with the deprecated ComponentResources or TyphaAffinity, then these overrides take precedence. calicoWindowsUpgradeDaemonSet CalicoWindowsUpgradeDaemonSet Deprecated. The CalicoWindowsUpgradeDaemonSet is deprecated and will be removed from the API in the future. CalicoWindowsUpgradeDaemonSet configures the calico-windows-upgrade DaemonSet. calicoNodeWindowsDaemonSet CalicoNodeWindowsDaemonSet CalicoNodeWindowsDaemonSet configures the calico-node-windows DaemonSet. fipsMode FIPSMode (Optional) FIPSMode uses images and features only that are using FIPS 140-2 validated cryptographic modules and standards. Default: Disabled logging Logging (Optional) Logging Configuration for Components windowsNodes WindowsNodeSpec (Optional) Windows Configuration serviceCIDRs []string (Optional) Kubernetes Service CIDRs. Specifying this is required when using Calico for Windows.
status InstallationStatus	Most recently observed state for the Calico or Calico Enterprise installation.

Monitor

Monitor is the Schema for the monitor API. At most one instance of this resource is supported. It must be named “tigera-secure”.

Field	Description
apiVersion string	operator.tigera.io/v1
kind string	Monitor
metadata Kubernetes meta/v1.ObjectMeta	Refer to the Kubernetes API documentation for the fields of the metadata field.
spec MonitorSpec	externalPrometheus ExternalPrometheus ExternalPrometheus optionally configures integration with an external Prometheus for scraping Calico metrics. When specified, the operator will render resources in the defined namespace. This option can be useful for configuring scraping from git-ops tools without the need of post-installation steps. prometheus Prometheus (Optional) Prometheus is the configuration for the Prometheus. alertManager AlertManager (Optional) AlertManager is the configuration for the AlertManager.
status MonitorStatus

PacketCaptureAPI

PacketCaptureAPI is used to configure the resource requirement for PacketCaptureAPI deployment. It must be named “tigera-secure”.

Field	Description
apiVersion string	operator.tigera.io/v1
kind string	PacketCaptureAPI
metadata Kubernetes meta/v1.ObjectMeta	Refer to the Kubernetes API documentation for the fields of the metadata field.
spec PacketCaptureAPISpec	Specification of the desired state for the PacketCaptureAPI. packetCaptureAPIDeployment PacketCaptureAPIDeployment (Optional) PacketCaptureAPIDeployment configures the PacketCaptureAPI Deployment.
status PacketCaptureAPIStatus	Most recently observed state for the PacketCaptureAPI.

PolicyRecommendation

PolicyRecommendation is the Schema for the policy recommendation API. At most one instance of this resource is supported. It must be named “tigera-secure”.

Field	Description
apiVersion string	operator.tigera.io/v1
kind string	PolicyRecommendation
metadata Kubernetes meta/v1.ObjectMeta	Refer to the Kubernetes API documentation for the fields of the metadata field.
spec PolicyRecommendationSpec	policyRecommendationDeployment PolicyRecommendationDeployment (Optional) PolicyRecommendation configures the PolicyRecommendation Deployment.
status PolicyRecommendationStatus

TLSPassThroughRoute

Field	Description
apiVersion string	operator.tigera.io/v1
kind string	TLSPassThroughRoute
metadata Kubernetes meta/v1.ObjectMeta	Refer to the Kubernetes API documentation for the fields of the metadata field.
spec TLSPassThroughRouteSpec	Dest is the destination URL target TargetType sniMatch SNIMatch SNIMatch is used to match requests based on the server name for the intended destination server. Matching requests will be proxied to the Destination. destination string Destination is the destination url to proxy the request to.

TLSTerminatedRoute

Field	Description
apiVersion string	operator.tigera.io/v1
kind string	TLSTerminatedRoute
metadata Kubernetes meta/v1.ObjectMeta	Refer to the Kubernetes API documentation for the fields of the metadata field.
spec TLSTerminatedRouteSpec	target TargetType pathMatch PathMatch PathMatch is used to match requests based on what’s in the path. Matching requests will be proxied to the Destination defined in this structure. destination string Destination is the destination URL where matching traffic is routed to. caBundle Kubernetes core/v1.ConfigMapKeySelector CABundle is where we read the CA bundle from to authenticate the destination (if non-empty) mtlsCert Kubernetes core/v1.SecretKeySelector (Optional) ForwardingMTLSCert is the certificate used for mTLS between voltron and the destination. Either both ForwardingMTLSCert and ForwardingMTLSKey must be specified, or neither can be specified. mtlsKey Kubernetes core/v1.SecretKeySelector (Optional) ForwardingMTLSKey is the key used for mTLS between voltron and the destination. Either both ForwardingMTLSCert and ForwardingMTLSKey must be specified, or neither can be specified. unauthenticated bool (Optional) Unauthenticated says whether the request should go through authentication. This is only applicable if the Target is UI.

Tenant

Tenant is the Schema for the tenants API

Field	Description
apiVersion string	operator.tigera.io/v1
kind string	Tenant
metadata Kubernetes meta/v1.ObjectMeta	Refer to the Kubernetes API documentation for the fields of the metadata field.
spec TenantSpec	id string ID is the unique identifier for this tenant. name string Name is a human readable name for this tenant. indices []Index Indices defines the how to store a tenant’s data elastic TenantElasticSpec Elastic configures per-tenant ElasticSearch and Kibana parameters. This field is required for clusters using external ES. controlPlaneReplicas int32 (Optional) ControlPlaneReplicas defines how many replicas of the control plane core components will be deployed in the Tenant’s namespace. Defaults to the controlPlaneReplicas in Installation CR linseedDeployment LinseedDeployment LinseedDeployment configures the linseed Deployment. dashboardsJob DashboardsJob DashboardsJob configures the Dashboards job
status TenantStatus

TigeraStatus

TigeraStatus represents the most recently observed status for Calico or a Calico Enterprise functional area.

Field	Description
apiVersion string	operator.tigera.io/v1
kind string	TigeraStatus
metadata Kubernetes meta/v1.ObjectMeta	Refer to the Kubernetes API documentation for the fields of the metadata field.
spec TigeraStatusSpec
status TigeraStatusStatus

APIServerDeployment

(Appears on:

APIServerSpec)

APIServerDeployment is the configuration for the API server Deployment.

Field	Description
metadata Metadata	(Optional) Metadata is a subset of a Kubernetes object’s metadata that is added to the Deployment.
spec APIServerDeploymentSpec	(Optional) Spec is the specification of the API server Deployment.

APIServerDeploymentContainer

(Appears on:

APIServerDeploymentPodSpec)

APIServerDeploymentContainer is an API server Deployment container.

Field	Description
name string	Name is an enum which identifies the API server Deployment container by name. Supported values are: calico-apiserver, tigera-queryserver
resources Kubernetes core/v1.ResourceRequirements	(Optional) Resources allows customization of limits and requests for compute resources such as cpu and memory. If specified, this overrides the named API server Deployment container’s resources. If omitted, the API server Deployment will use its default value for this container’s resources. If used in conjunction with the deprecated ComponentResources, then this value takes precedence.

APIServerDeploymentInitContainer

(Appears on:

APIServerDeploymentPodSpec)

APIServerDeploymentInitContainer is an API server Deployment init container.

Field	Description
name string	Name is an enum which identifies the API server Deployment init container by name. Supported values are: calico-apiserver-certs-key-cert-provisioner
resources Kubernetes core/v1.ResourceRequirements	(Optional) Resources allows customization of limits and requests for compute resources such as cpu and memory. If specified, this overrides the named API server Deployment init container’s resources. If omitted, the API server Deployment will use its default value for this init container’s resources.

APIServerDeploymentPodSpec

(Appears on:

APIServerDeploymentPodTemplateSpec)

APIServerDeploymentDeploymentPodSpec is the API server Deployment’s PodSpec.

Field	Description
initContainers []APIServerDeploymentInitContainer	(Optional) InitContainers is a list of API server init containers. If specified, this overrides the specified API server Deployment init containers. If omitted, the API server Deployment will use its default values for its init containers.
containers []APIServerDeploymentContainer	(Optional) Containers is a list of API server containers. If specified, this overrides the specified API server Deployment containers. If omitted, the API server Deployment will use its default values for its containers.
affinity Kubernetes core/v1.Affinity	(Optional) Affinity is a group of affinity scheduling rules for the API server pods. If specified, this overrides any affinity that may be set on the API server Deployment. If omitted, the API server Deployment will use its default value for affinity. WARNING: Please note that this field will override the default API server Deployment affinity.
nodeSelector map[string]string	NodeSelector is the API server pod’s scheduling constraints. If specified, each of the key/value pairs are added to the API server Deployment nodeSelector provided the key does not already exist in the object’s nodeSelector. If used in conjunction with ControlPlaneNodeSelector, that nodeSelector is set on the API server Deployment and each of this field’s key/value pairs are added to the API server Deployment nodeSelector provided the key does not already exist in the object’s nodeSelector. If omitted, the API server Deployment will use its default value for nodeSelector. WARNING: Please note that this field will modify the default API server Deployment nodeSelector.
topologySpreadConstraints []Kubernetes core/v1.TopologySpreadConstraint	(Optional) TopologySpreadConstraints describes how a group of pods ought to spread across topology domains. Scheduler will schedule pods in a way which abides by the constraints. All topologySpreadConstraints are ANDed.
tolerations []Kubernetes core/v1.Toleration	(Optional) Tolerations is the API server pod’s tolerations. If specified, this overrides any tolerations that may be set on the API server Deployment. If omitted, the API server Deployment will use its default value for tolerations. WARNING: Please note that this field will override the default API server Deployment tolerations.

APIServerDeploymentPodTemplateSpec

(Appears on:

APIServerDeploymentSpec)

APIServerDeploymentPodTemplateSpec is the API server Deployment’s PodTemplateSpec

Field	Description
metadata Metadata	(Optional) Metadata is a subset of a Kubernetes object’s metadata that is added to the pod’s metadata.
spec APIServerDeploymentPodSpec	(Optional) Spec is the API server Deployment’s PodSpec.

APIServerDeploymentSpec

(Appears on:

APIServerDeployment)

APIServerDeploymentSpec defines configuration for the API server Deployment.

Field	Description
minReadySeconds int32	(Optional) MinReadySeconds is the minimum number of seconds for which a newly created Deployment pod should be ready without any of its container crashing, for it to be considered available. If specified, this overrides any minReadySeconds value that may be set on the API server Deployment. If omitted, the API server Deployment will use its default value for minReadySeconds.
template APIServerDeploymentPodTemplateSpec	(Optional) Template describes the API server Deployment pod that will be created.

APIServerSpec

(Appears on:

APIServer)

APIServerSpec defines the desired state of Tigera API server.

Field	Description
apiServerDeployment APIServerDeployment	APIServerDeployment configures the calico-apiserver (or tigera-apiserver in Enterprise) Deployment. If used in conjunction with ControlPlaneNodeSelector or ControlPlaneTolerations, then these overrides take precedence.

APIServerStatus

(Appears on:

APIServer)

APIServerStatus defines the observed state of Tigera API server.

Field	Description
state string	State provides user-readable status.
conditions []Kubernetes meta/v1.Condition	(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.

AWSEgressGateway

(Appears on:

EgressGatewaySpec)

AWSEgressGateway defines the configurations for deploying EgressGateway in AWS

Field	Description
nativeIP NativeIP	(Optional) NativeIP defines if EgressGateway is to use an AWS backed IPPool. Default: Disabled
elasticIPs []string	(Optional) ElasticIPs defines the set of elastic IPs that can be used for Egress Gateway pods. NativeIP must be Enabled if elastic IPs are set.

AnomalyDetectionSpec

Field	Description
storageClassName string	(Optional) StorageClassName is now deprecated, and configuring it has no effect.

ApplicationLayerPolicyStatusType (string alias)

(Appears on:

ApplicationLayerSpec)

ApplicationLayerSpec

(Appears on:

ApplicationLayer)

ApplicationLayerSpec defines the desired state of ApplicationLayer

Field	Description
webApplicationFirewall WAFStatusType	WebApplicationFirewall controls whether or not ModSecurity enforcement is enabled for the cluster. When enabled, Services may opt-in to having ingress traffic examed by ModSecurity.
logCollection LogCollectionSpec	Specification for application layer (L7) log collection.
applicationLayerPolicy ApplicationLayerPolicyStatusType	Application Layer Policy controls whether or not ALP enforcement is enabled for the cluster. When enabled, NetworkPolicies with HTTP Match rules may be defined to opt-in workloads for traffic enforcement on the application layer.
envoy EnvoySettings	User-configurable settings for the Envoy proxy.
l7LogCollectorDaemonSet L7LogCollectorDaemonSet	(Optional) L7LogCollectorDaemonSet configures the L7LogCollector DaemonSet.

ApplicationLayerStatus

(Appears on:

ApplicationLayer)

ApplicationLayerStatus defines the observed state of ApplicationLayer

Field	Description
state string	State provides user-readable status.
conditions []Kubernetes meta/v1.Condition	(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.

BGPOption (string alias)

(Appears on:

CalicoNetworkSpec)

BGPOption describes the mode of BGP to use.

One of: Enabled, Disabled

CAType (string alias)

CAType specifies which verification method the tunnel client should use to verify the tunnel server’s identity.

One of: Tigera, Public

CNILogging

(Appears on:

Logging)

Field	Description
logSeverity LogLevel	(Optional) Default: Info
logFileMaxSize k8s.io/apimachinery/pkg/api/resource.Quantity	(Optional) Default: 100Mi
logFileMaxAgeDays uint32	(Optional) Default: 30 (days)
logFileMaxCount uint32	(Optional) Default: 10

CNIPluginType (string alias)

(Appears on:

CNISpec)

CNIPluginType describes the type of CNI plugin used.

One of: Calico, GKE, AmazonVPC, AzureVNET

CNISpec

(Appears on:

InstallationSpec)

CNISpec contains configuration for the CNI plugin.

Field	Description
type 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	(Optional) IPAM specifies the pod IP address management that will be used in the Calico or Calico Enterprise installation.

CSINodeDriverDaemonSet

(Appears on:

InstallationSpec)

CSINodeDriverDaemonSet is the configuration for the csi-node-driver DaemonSet.

Field	Description
metadata Metadata	(Optional) Metadata is a subset of a Kubernetes object’s metadata that is added to the DaemonSet.
spec CSINodeDriverDaemonSetSpec	(Optional) Spec is the specification of the csi-node-driver DaemonSet.

CSINodeDriverDaemonSetContainer

(Appears on:

CSINodeDriverDaemonSetPodSpec)

CSINodeDriverDaemonSetContainer is a csi-node-driver DaemonSet container.

Field	Description
name string	Name is an enum which identifies the csi-node-driver DaemonSet container by name. Supported values are: calico-csi, csi-node-driver-registrar.
resources Kubernetes core/v1.ResourceRequirements	(Optional) Resources allows customization of limits and requests for compute resources such as cpu and memory. If specified, this overrides the named csi-node-driver DaemonSet container’s resources. If omitted, the csi-node-driver DaemonSet will use its default value for this container’s resources.

CSINodeDriverDaemonSetPodSpec

(Appears on:

CSINodeDriverDaemonSetPodTemplateSpec)

CSINodeDriverDaemonSetPodSpec is the csi-node-driver DaemonSet’s PodSpec.

Field	Description
containers []CSINodeDriverDaemonSetContainer	(Optional) Containers is a list of csi-node-driver containers. If specified, this overrides the specified csi-node-driver DaemonSet containers. If omitted, the csi-node-driver DaemonSet will use its default values for its containers.
affinity Kubernetes core/v1.Affinity	(Optional) Affinity is a group of affinity scheduling rules for the csi-node-driver pods. If specified, this overrides any affinity that may be set on the csi-node-driver DaemonSet. If omitted, the csi-node-driver DaemonSet will use its default value for affinity. WARNING: Please note that this field will override the default csi-node-driver DaemonSet affinity.
nodeSelector map[string]string	(Optional) NodeSelector is the csi-node-driver pod’s scheduling constraints. If specified, each of the key/value pairs are added to the csi-node-driver DaemonSet nodeSelector provided the key does not already exist in the object’s nodeSelector. If omitted, the csi-node-driver DaemonSet will use its default value for nodeSelector. WARNING: Please note that this field will modify the default csi-node-driver DaemonSet nodeSelector.
tolerations []Kubernetes core/v1.Toleration	(Optional) Tolerations is the csi-node-driver pod’s tolerations. If specified, this overrides any tolerations that may be set on the csi-node-driver DaemonSet. If omitted, the csi-node-driver DaemonSet will use its default value for tolerations. WARNING: Please note that this field will override the default csi-node-driver DaemonSet tolerations.

CSINodeDriverDaemonSetPodTemplateSpec

(Appears on:

CSINodeDriverDaemonSetSpec)

CSINodeDriverDaemonSetPodTemplateSpec is the csi-node-driver DaemonSet’s PodTemplateSpec

Field	Description
metadata Metadata	(Optional) Metadata is a subset of a Kubernetes object’s metadata that is added to the pod’s metadata.
spec CSINodeDriverDaemonSetPodSpec	(Optional) Spec is the csi-node-driver DaemonSet’s PodSpec.

CSINodeDriverDaemonSetSpec

(Appears on:

CSINodeDriverDaemonSet)

CSINodeDriverDaemonSetSpec defines configuration for the csi-node-driver DaemonSet.

Field	Description
minReadySeconds int32	(Optional) MinReadySeconds is the minimum number of seconds for which a newly created DaemonSet pod should be ready without any of its container crashing, for it to be considered available. If specified, this overrides any minReadySeconds value that may be set on the csi-node-driver DaemonSet. If omitted, the csi-node-driver DaemonSet will use its default value for minReadySeconds.
template CSINodeDriverDaemonSetPodTemplateSpec	(Optional) Template describes the csi-node-driver DaemonSet pod that will be created.

CalicoKubeControllersDeployment

(Appears on:

InstallationSpec)

CalicoKubeControllersDeployment is the configuration for the calico-kube-controllers Deployment.

Field	Description
metadata Metadata	(Optional) Metadata is a subset of a Kubernetes object’s metadata that is added to the Deployment.
spec CalicoKubeControllersDeploymentSpec	(Optional) Spec is the specification of the calico-kube-controllers Deployment.

CalicoKubeControllersDeploymentContainer

(Appears on:

CalicoKubeControllersDeploymentPodSpec)

CalicoKubeControllersDeploymentContainer is a calico-kube-controllers Deployment container.

Field	Description
name string	Name is an enum which identifies the calico-kube-controllers Deployment container by name. Supported values are: calico-kube-controllers
resources Kubernetes core/v1.ResourceRequirements	(Optional) Resources allows customization of limits and requests for compute resources such as cpu and memory. If specified, this overrides the named calico-kube-controllers Deployment container’s resources. If omitted, the calico-kube-controllers Deployment will use its default value for this container’s resources. If used in conjunction with the deprecated ComponentResources, then this value takes precedence.

CalicoKubeControllersDeploymentPodSpec

(Appears on:

CalicoKubeControllersDeploymentPodTemplateSpec)

CalicoKubeControllersDeploymentPodSpec is the calico-kube-controller Deployment’s PodSpec.

Field	Description
containers []CalicoKubeControllersDeploymentContainer	(Optional) Containers is a list of calico-kube-controllers containers. If specified, this overrides the specified calico-kube-controllers Deployment containers. If omitted, the calico-kube-controllers Deployment will use its default values for its containers.
affinity Kubernetes core/v1.Affinity	(Optional) Affinity is a group of affinity scheduling rules for the calico-kube-controllers pods. If specified, this overrides any affinity that may be set on the calico-kube-controllers Deployment. If omitted, the calico-kube-controllers Deployment will use its default value for affinity. WARNING: Please note that this field will override the default calico-kube-controllers Deployment affinity.
nodeSelector map[string]string	NodeSelector is the calico-kube-controllers pod’s scheduling constraints. If specified, each of the key/value pairs are added to the calico-kube-controllers Deployment nodeSelector provided the key does not already exist in the object’s nodeSelector. If used in conjunction with ControlPlaneNodeSelector, that nodeSelector is set on the calico-kube-controllers Deployment and each of this field’s key/value pairs are added to the calico-kube-controllers Deployment nodeSelector provided the key does not already exist in the object’s nodeSelector. If omitted, the calico-kube-controllers Deployment will use its default value for nodeSelector. WARNING: Please note that this field will modify the default calico-kube-controllers Deployment nodeSelector.
tolerations []Kubernetes core/v1.Toleration	(Optional) Tolerations is the calico-kube-controllers pod’s tolerations. If specified, this overrides any tolerations that may be set on the calico-kube-controllers Deployment. If omitted, the calico-kube-controllers Deployment will use its default value for tolerations. WARNING: Please note that this field will override the default calico-kube-controllers Deployment tolerations.

CalicoKubeControllersDeploymentPodTemplateSpec

(Appears on:

CalicoKubeControllersDeploymentSpec)

CalicoKubeControllersDeploymentPodTemplateSpec is the calico-kube-controllers Deployment’s PodTemplateSpec

Field	Description
metadata Metadata	(Optional) Metadata is a subset of a Kubernetes object’s metadata that is added to the pod’s metadata.
spec CalicoKubeControllersDeploymentPodSpec	(Optional) Spec is the calico-kube-controllers Deployment’s PodSpec.

CalicoKubeControllersDeploymentSpec

(Appears on:

CalicoKubeControllersDeployment)

CalicoKubeControllersDeploymentSpec defines configuration for the calico-kube-controllers Deployment.

Field	Description
minReadySeconds int32	(Optional) MinReadySeconds is the minimum number of seconds for which a newly created Deployment pod should be ready without any of its container crashing, for it to be considered available. If specified, this overrides any minReadySeconds value that may be set on the calico-kube-controllers Deployment. If omitted, the calico-kube-controllers Deployment will use its default value for minReadySeconds.
template CalicoKubeControllersDeploymentPodTemplateSpec	(Optional) Template describes the calico-kube-controllers Deployment pod that will be created.

CalicoNetworkSpec

(Appears on:

InstallationSpec)

CalicoNetworkSpec specifies configuration options for Calico provided pod networking.

Field	Description
linuxDataplane LinuxDataplaneOption	(Optional) LinuxDataplane is used to select the dataplane used for Linux nodes. In particular, it causes the operator to add required mounts and environment variables for the particular dataplane. If not specified, iptables mode is used. Default: Iptables
windowsDataplane WindowsDataplaneOption	(Optional) WindowsDataplane is used to select the dataplane used for Windows nodes. In particular, it causes the operator to add required mounts and environment variables for the particular dataplane. If not specified, it is disabled and the operator will not render the Calico Windows nodes daemonset. Default: Disabled
bgp BGPOption	(Optional) BGP configures whether or not to enable Calico’s BGP capabilities.
ipPools []IPPool	(Optional) IPPools contains a list of IP pools to create if none exist. At most one IP pool of each address family may be specified. If omitted, a single pool will be configured if needed.
mtu int32	(Optional) MTU specifies the maximum transmission unit to use on the pod network. If not specified, Calico will perform MTU auto-detection based on the cluster network.
nodeAddressAutodetectionV4 NodeAddressAutodetection	(Optional) NodeAddressAutodetectionV4 specifies an approach to automatically detect node IPv4 addresses. If not specified, will use default auto-detection settings to acquire an IPv4 address for each node.
nodeAddressAutodetectionV6 NodeAddressAutodetection	(Optional) NodeAddressAutodetectionV6 specifies an approach to automatically detect node IPv6 addresses. If not specified, IPv6 addresses will not be auto-detected.
hostPorts HostPortsType	(Optional) HostPorts configures whether or not Calico will support Kubernetes HostPorts. Valid only when using the Calico CNI plugin. Default: Enabled
multiInterfaceMode MultiInterfaceMode	(Optional) MultiInterfaceMode configures what will configure multiple interface per pod. Only valid for Calico Enterprise installations using the Calico CNI plugin. Default: None
containerIPForwarding ContainerIPForwardingType	(Optional) ContainerIPForwarding configures whether ip forwarding will be enabled for containers in the CNI configuration. Default: Disabled
sysctl []Sysctl	(Optional) Sysctl configures sysctl parameters for tuning plugin
linuxPolicySetupTimeoutSeconds int32	(Optional) LinuxPolicySetupTimeoutSeconds delays new pods from running containers until their policy has been programmed in the dataplane. The specified delay defines the maximum amount of time that the Calico CNI plugin will wait for policy to be programmed. Only applies to pods created on Linux nodes. A value of 0 disables pod startup delays. Default: 0

CalicoNodeDaemonSet

(Appears on:

InstallationSpec)

CalicoNodeDaemonSet is the configuration for the calico-node DaemonSet.

Field	Description
metadata Metadata	(Optional) Metadata is a subset of a Kubernetes object’s metadata that is added to the DaemonSet.
spec CalicoNodeDaemonSetSpec	(Optional) Spec is the specification of the calico-node DaemonSet.

CalicoNodeDaemonSetContainer

(Appears on:

CalicoNodeDaemonSetPodSpec)

CalicoNodeDaemonSetContainer is a calico-node DaemonSet container.

Field	Description
name string	Name is an enum which identifies the calico-node DaemonSet container by name. Supported values are: calico-node
resources Kubernetes core/v1.ResourceRequirements	(Optional) Resources allows customization of limits and requests for compute resources such as cpu and memory. If specified, this overrides the named calico-node DaemonSet container’s resources. If omitted, the calico-node DaemonSet will use its default value for this container’s resources. If used in conjunction with the deprecated ComponentResources, then this value takes precedence.

CalicoNodeDaemonSetInitContainer

(Appears on:

CalicoNodeDaemonSetPodSpec)

CalicoNodeDaemonSetInitContainer is a calico-node DaemonSet init container.

Field	Description
name string	Name is an enum which identifies the calico-node DaemonSet init container by name. Supported values are: install-cni, hostpath-init, flexvol-driver, mount-bpffs, node-certs-key-cert-provisioner, calico-node-prometheus-server-tls-key-cert-provisioner
resources Kubernetes core/v1.ResourceRequirements	(Optional) Resources allows customization of limits and requests for compute resources such as cpu and memory. If specified, this overrides the named calico-node DaemonSet init container’s resources. If omitted, the calico-node DaemonSet will use its default value for this container’s resources. If used in conjunction with the deprecated ComponentResources, then this value takes precedence.

CalicoNodeDaemonSetPodSpec

(Appears on:

CalicoNodeDaemonSetPodTemplateSpec)

CalicoNodeDaemonSetPodSpec is the calico-node DaemonSet’s PodSpec.

Field	Description
initContainers []CalicoNodeDaemonSetInitContainer	(Optional) InitContainers is a list of calico-node init containers. If specified, this overrides the specified calico-node DaemonSet init containers. If omitted, the calico-node DaemonSet will use its default values for its init containers.
containers []CalicoNodeDaemonSetContainer	(Optional) Containers is a list of calico-node containers. If specified, this overrides the specified calico-node DaemonSet containers. If omitted, the calico-node DaemonSet will use its default values for its containers.
affinity Kubernetes core/v1.Affinity	(Optional) Affinity is a group of affinity scheduling rules for the calico-node pods. If specified, this overrides any affinity that may be set on the calico-node DaemonSet. If omitted, the calico-node DaemonSet will use its default value for affinity. WARNING: Please note that this field will override the default calico-node DaemonSet affinity.
nodeSelector map[string]string	(Optional) NodeSelector is the calico-node pod’s scheduling constraints. If specified, each of the key/value pairs are added to the calico-node DaemonSet nodeSelector provided the key does not already exist in the object’s nodeSelector. If omitted, the calico-node DaemonSet will use its default value for nodeSelector. WARNING: Please note that this field will modify the default calico-node DaemonSet nodeSelector.
tolerations []Kubernetes core/v1.Toleration	(Optional) Tolerations is the calico-node pod’s tolerations. If specified, this overrides any tolerations that may be set on the calico-node DaemonSet. If omitted, the calico-node DaemonSet will use its default value for tolerations. WARNING: Please note that this field will override the default calico-node DaemonSet tolerations.

CalicoNodeDaemonSetPodTemplateSpec

(Appears on:

CalicoNodeDaemonSetSpec)

CalicoNodeDaemonSetPodTemplateSpec is the calico-node DaemonSet’s PodTemplateSpec

Field	Description
metadata Metadata	(Optional) Metadata is a subset of a Kubernetes object’s metadata that is added to the pod’s metadata.
spec CalicoNodeDaemonSetPodSpec	(Optional) Spec is the calico-node DaemonSet’s PodSpec.

CalicoNodeDaemonSetSpec

(Appears on:

CalicoNodeDaemonSet)

CalicoNodeDaemonSetSpec defines configuration for the calico-node DaemonSet.

Field	Description
minReadySeconds int32	(Optional) MinReadySeconds is the minimum number of seconds for which a newly created DaemonSet pod should be ready without any of its container crashing, for it to be considered available. If specified, this overrides any minReadySeconds value that may be set on the calico-node DaemonSet. If omitted, the calico-node DaemonSet will use its default value for minReadySeconds.
template CalicoNodeDaemonSetPodTemplateSpec	(Optional) Template describes the calico-node DaemonSet pod that will be created.

CalicoNodeWindowsDaemonSet

(Appears on:

InstallationSpec)

CalicoNodeWindowsDaemonSet is the configuration for the calico-node-windows DaemonSet.

Field	Description
metadata Metadata	(Optional) Metadata is a subset of a Kubernetes object’s metadata that is added to the DaemonSet.
spec CalicoNodeWindowsDaemonSetSpec	(Optional) Spec is the specification of the calico-node-windows DaemonSet.

CalicoNodeWindowsDaemonSetContainer

(Appears on:

CalicoNodeWindowsDaemonSetPodSpec)

CalicoNodeWindowsDaemonSetContainer is a calico-node-windows DaemonSet container.

Field	Description
name string	Name is an enum which identifies the calico-node-windows DaemonSet container by name. Supported values are: calico-node-windows
resources Kubernetes core/v1.ResourceRequirements	(Optional) Resources allows customization of limits and requests for compute resources such as cpu and memory. If specified, this overrides the named calico-node-windows DaemonSet container’s resources. If omitted, the calico-node-windows DaemonSet will use its default value for this container’s resources. If used in conjunction with the deprecated ComponentResources, then this value takes precedence.

CalicoNodeWindowsDaemonSetInitContainer

(Appears on:

CalicoNodeWindowsDaemonSetPodSpec)

CalicoNodeWindowsDaemonSetInitContainer is a calico-node-windows DaemonSet init container.

Field	Description
name string	Name is an enum which identifies the calico-node-windows DaemonSet init container by name. Supported values are: install-cni;hostpath-init, flexvol-driver, mount-bpffs, node-certs-key-cert-provisioner, calico-node-windows-prometheus-server-tls-key-cert-provisioner
resources Kubernetes core/v1.ResourceRequirements	(Optional) Resources allows customization of limits and requests for compute resources such as cpu and memory. If specified, this overrides the named calico-node-windows DaemonSet init container’s resources. If omitted, the calico-node-windows DaemonSet will use its default value for this container’s resources. If used in conjunction with the deprecated ComponentResources, then this value takes precedence.

CalicoNodeWindowsDaemonSetPodSpec

(Appears on:

CalicoNodeWindowsDaemonSetPodTemplateSpec)

CalicoNodeWindowsDaemonSetPodSpec is the calico-node-windows DaemonSet’s PodSpec.

Field	Description
initContainers []CalicoNodeWindowsDaemonSetInitContainer	(Optional) InitContainers is a list of calico-node-windows init containers. If specified, this overrides the specified calico-node-windows DaemonSet init containers. If omitted, the calico-node-windows DaemonSet will use its default values for its init containers.
containers []CalicoNodeWindowsDaemonSetContainer	(Optional) Containers is a list of calico-node-windows containers. If specified, this overrides the specified calico-node-windows DaemonSet containers. If omitted, the calico-node-windows DaemonSet will use its default values for its containers.
affinity Kubernetes core/v1.Affinity	(Optional) Affinity is a group of affinity scheduling rules for the calico-node-windows pods. If specified, this overrides any affinity that may be set on the calico-node-windows DaemonSet. If omitted, the calico-node-windows DaemonSet will use its default value for affinity. WARNING: Please note that this field will override the default calico-node-windows DaemonSet affinity.
nodeSelector map[string]string	(Optional) NodeSelector is the calico-node-windows pod’s scheduling constraints. If specified, each of the key/value pairs are added to the calico-node-windows DaemonSet nodeSelector provided the key does not already exist in the object’s nodeSelector. If omitted, the calico-node-windows DaemonSet will use its default value for nodeSelector. WARNING: Please note that this field will modify the default calico-node-windows DaemonSet nodeSelector.
tolerations []Kubernetes core/v1.Toleration	(Optional) Tolerations is the calico-node-windows pod’s tolerations. If specified, this overrides any tolerations that may be set on the calico-node-windows DaemonSet. If omitted, the calico-node-windows DaemonSet will use its default value for tolerations. WARNING: Please note that this field will override the default calico-node-windows DaemonSet tolerations.

CalicoNodeWindowsDaemonSetPodTemplateSpec

(Appears on:

CalicoNodeWindowsDaemonSetSpec)

CalicoNodeWindowsDaemonSetPodTemplateSpec is the calico-node-windows DaemonSet’s PodTemplateSpec

Field	Description
metadata Metadata	(Optional) Metadata is a subset of a Kubernetes object’s metadata that is added to the pod’s metadata.
spec CalicoNodeWindowsDaemonSetPodSpec	(Optional) Spec is the calico-node-windows DaemonSet’s PodSpec.

CalicoNodeWindowsDaemonSetSpec

(Appears on:

CalicoNodeWindowsDaemonSet)

CalicoNodeWindowsDaemonSetSpec defines configuration for the calico-node-windows DaemonSet.

Field	Description
minReadySeconds int32	(Optional) MinReadySeconds is the minimum number of seconds for which a newly created DaemonSet pod should be ready without any of its container crashing, for it to be considered available. If specified, this overrides any minReadySeconds value that may be set on the calico-node-windows DaemonSet. If omitted, the calico-node-windows DaemonSet will use its default value for minReadySeconds.
template CalicoNodeWindowsDaemonSetPodTemplateSpec	(Optional) Template describes the calico-node-windows DaemonSet pod that will be created.

CalicoWindowsUpgradeDaemonSet

(Appears on:

InstallationSpec)

Deprecated. The CalicoWindowsUpgradeDaemonSet is deprecated and will be removed from the API in the future. CalicoWindowsUpgradeDaemonSet is the configuration for the calico-windows-upgrade DaemonSet.

Field	Description
metadata Metadata	(Optional) Metadata is a subset of a Kubernetes object’s metadata that is added to the Deployment.
spec CalicoWindowsUpgradeDaemonSetSpec	(Optional) Spec is the specification of the calico-windows-upgrade DaemonSet.

CalicoWindowsUpgradeDaemonSetContainer

(Appears on:

CalicoWindowsUpgradeDaemonSetPodSpec)

CalicoWindowsUpgradeDaemonSetContainer is a calico-windows-upgrade DaemonSet container.

Field	Description
name string	Name is an enum which identifies the calico-windows-upgrade DaemonSet container by name.
resources Kubernetes core/v1.ResourceRequirements	(Optional) Resources allows customization of limits and requests for compute resources such as cpu and memory. If specified, this overrides the named calico-windows-upgrade DaemonSet container’s resources. If omitted, the calico-windows-upgrade DaemonSet will use its default value for this container’s resources.

CalicoWindowsUpgradeDaemonSetPodSpec

(Appears on:

CalicoWindowsUpgradeDaemonSetPodTemplateSpec)

CalicoWindowsUpgradeDaemonSetPodSpec is the calico-windows-upgrade DaemonSet’s PodSpec.

Field	Description
containers []CalicoWindowsUpgradeDaemonSetContainer	(Optional) Containers is a list of calico-windows-upgrade containers. If specified, this overrides the specified calico-windows-upgrade DaemonSet containers. If omitted, the calico-windows-upgrade DaemonSet will use its default values for its containers.
affinity Kubernetes core/v1.Affinity	(Optional) Affinity is a group of affinity scheduling rules for the calico-windows-upgrade pods. If specified, this overrides any affinity that may be set on the calico-windows-upgrade DaemonSet. If omitted, the calico-windows-upgrade DaemonSet will use its default value for affinity. WARNING: Please note that this field will override the default calico-windows-upgrade DaemonSet affinity.
nodeSelector map[string]string	(Optional) NodeSelector is the calico-windows-upgrade pod’s scheduling constraints. If specified, each of the key/value pairs are added to the calico-windows-upgrade DaemonSet nodeSelector provided the key does not already exist in the object’s nodeSelector. If omitted, the calico-windows-upgrade DaemonSet will use its default value for nodeSelector. WARNING: Please note that this field will modify the default calico-windows-upgrade DaemonSet nodeSelector.
tolerations []Kubernetes core/v1.Toleration	(Optional) Tolerations is the calico-windows-upgrade pod’s tolerations. If specified, this overrides any tolerations that may be set on the calico-windows-upgrade DaemonSet. If omitted, the calico-windows-upgrade DaemonSet will use its default value for tolerations. WARNING: Please note that this field will override the default calico-windows-upgrade DaemonSet tolerations.

CalicoWindowsUpgradeDaemonSetPodTemplateSpec

(Appears on:

CalicoWindowsUpgradeDaemonSetSpec)

CalicoWindowsUpgradeDaemonSetPodTemplateSpec is the calico-windows-upgrade DaemonSet’s PodTemplateSpec

Field	Description
metadata Metadata	(Optional) Metadata is a subset of a Kubernetes object’s metadata that is added to the pod’s metadata.
spec CalicoWindowsUpgradeDaemonSetPodSpec	(Optional) Spec is the calico-windows-upgrade DaemonSet’s PodSpec.

CalicoWindowsUpgradeDaemonSetSpec

(Appears on:

CalicoWindowsUpgradeDaemonSet)

CalicoWindowsUpgradeDaemonSetSpec defines configuration for the calico-windows-upgrade DaemonSet.

Field	Description
minReadySeconds int32	(Optional) MinReadySeconds is the minimum number of seconds for which a newly created Deployment pod should be ready without any of its container crashing, for it to be considered available. If specified, this overrides any minReadySeconds value that may be set on the calico-windows-upgrade DaemonSet. If omitted, the calico-windows-upgrade DaemonSet will use its default value for minReadySeconds.
template CalicoWindowsUpgradeDaemonSetPodTemplateSpec	(Optional) Template describes the calico-windows-upgrade DaemonSet pod that will be created.

CertificateManagement

(Appears on:

InstallationSpec)

CertificateManagement configures pods to submit a CertificateSigningRequest to the certificates.k8s.io/v1beta1 API in order to obtain TLS certificates. This feature requires that you bring your own CSR signing and approval process, otherwise pods will be stuck during initialization.

Field	Description
caCert []byte	Certificate of the authority that signs the CertificateSigningRequests in PEM format.
signerName string	When a CSR is issued to the certificates.k8s.io API, the signerName is added to the request in order to accommodate for clusters with multiple signers. Must be formatted as: <my-domain>/<my-signername>.
keyAlgorithm string	(Optional) Specify the algorithm used by pods to generate a key pair that is associated with the X.509 certificate request. Default: RSAWithSize2048
signatureAlgorithm string	(Optional) Specify the algorithm used for the signature of the X.509 certificate request. Default: SHA256WithRSA

CollectProcessPathOption (string alias)

CommonPrometheusFields

(Appears on:

PrometheusSpec)

Field	Description
containers []PrometheusContainer	(Optional) Containers is a list of Prometheus containers. If specified, this overrides the specified Prometheus Deployment containers. If omitted, the Prometheus Deployment will use its default values for its containers.
resources Kubernetes core/v1.ResourceRequirements	Define resources requests and limits for single Pods.

ComponentName (string alias)

(Appears on:

ComponentResource)

ComponentName represents a single component.

One of: Node, Typha, KubeControllers

ComponentResource

(Appears on:

InstallationSpec)

Deprecated. Please use component resource config fields in Installation.Spec instead. The ComponentResource struct associates a ResourceRequirements with a component by name

Field	Description
componentName ComponentName	ComponentName is an enum which identifies the component
resourceRequirements Kubernetes core/v1.ResourceRequirements	ResourceRequirements allows customization of limits and requests for compute resources such as cpu and memory.

ConditionStatus (string alias)

(Appears on:

TigeraStatusCondition)

ConditionStatus represents the status of a particular condition. A condition may be one of: True, False, Unknown.

ContainerIPForwardingType (string alias)

(Appears on:

CalicoNetworkSpec)

ContainerIPForwardingType specifies whether the CNI config for container ip forwarding is enabled.

DashboardsJob

(Appears on:

TenantSpec)

DashboardsJob is the configuration for the Dashboards job.

Field	Description
spec DashboardsJobSpec	(Optional) Spec is the specification of the dashboards job.

DashboardsJobContainer

(Appears on:

DashboardsJobPodSpec)

DashboardsJobContainer is the Dashboards job container.

Field	Description
name string	Name is an enum which identifies the Dashboard Job container by name. Supported values are: dashboards-installer
resources Kubernetes core/v1.ResourceRequirements	(Optional) Resources allows customization of limits and requests for compute resources such as cpu and memory. If specified, this overrides the named Dashboard Job container’s resources. If omitted, the Dashboard Job will use its default value for this container’s resources.

DashboardsJobPodSpec

(Appears on:

DashboardsJobPodTemplateSpec)

DashboardsJobPodSpec is the Dashboards job’s PodSpec.

Field	Description
containers []DashboardsJobContainer	(Optional) Containers is a list of dashboards job containers. If specified, this overrides the specified Dashboard job containers. If omitted, the Dashboard job will use its default values for its containers.

DashboardsJobPodTemplateSpec

(Appears on:

DashboardsJobSpec)

DashboardsJobPodTemplateSpec is the Dashboards job’s PodTemplateSpec

Field	Description
spec DashboardsJobPodSpec	(Optional) Spec is the Dashboard job’s PodSpec.

DashboardsJobSpec

(Appears on:

DashboardsJob)

DashboardsJobSpec defines configuration for the Dashboards job.

Field	Description
template DashboardsJobPodTemplateSpec	(Optional) Template describes the Dashboards job pod that will be created.

DataType (string alias)

(Appears on:

Index)

DataType represent the type of data stored

DexDeployment

DexDeployment is the configuration for the Dex Deployment.

Field	Description
spec DexDeploymentSpec	(Optional) Spec is the specification of the Dex Deployment.

DexDeploymentContainer

(Appears on:

DexDeploymentPodSpec)

DexDeploymentContainer is a Dex Deployment container.

Field	Description
name string	Name is an enum which identifies the Dex Deployment container by name. Supported values are: tigera-dex
resources Kubernetes core/v1.ResourceRequirements	(Optional) Resources allows customization of limits and requests for compute resources such as cpu and memory. If specified, this overrides the named Dex Deployment container’s resources. If omitted, the Dex Deployment will use its default value for this container’s resources.

DexDeploymentInitContainer

(Appears on:

DexDeploymentPodSpec)

DexDeploymentInitContainer is a Dex Deployment init container.

Field	Description
name string	Name is an enum which identifies the Dex Deployment init container by name. Supported values are: tigera-dex-tls-key-cert-provisioner
resources Kubernetes core/v1.ResourceRequirements	(Optional) Resources allows customization of limits and requests for compute resources such as cpu and memory. If specified, this overrides the named Dex Deployment init container’s resources. If omitted, the Dex Deployment will use its default value for this init container’s resources.

DexDeploymentPodSpec

(Appears on:

DexDeploymentPodTemplateSpec)

DexDeploymentPodSpec is the Dex Deployment’s PodSpec.

Field	Description
initContainers []DexDeploymentInitContainer	(Optional) InitContainers is a list of Dex init containers. If specified, this overrides the specified Dex Deployment init containers. If omitted, the Dex Deployment will use its default values for its init containers.
containers []DexDeploymentContainer	(Optional) Containers is a list of Dex containers. If specified, this overrides the specified Dex Deployment containers. If omitted, the Dex Deployment will use its default values for its containers.

DexDeploymentPodTemplateSpec

(Appears on:

DexDeploymentSpec)

DexDeploymentPodTemplateSpec is the Dex Deployment’s PodTemplateSpec

Field	Description
spec DexDeploymentPodSpec	(Optional) Spec is the Dex Deployment’s PodSpec.

DexDeploymentSpec

(Appears on:

DexDeployment)

DexDeploymentSpec defines configuration for the Dex Deployment.

Field	Description
template DexDeploymentPodTemplateSpec	(Optional) Template describes the Dex Deployment pod that will be created.

ECKOperatorStatefulSet

ECKOperatorStatefulSet is the configuration for the ECKOperator StatefulSet.

Field	Description
spec ECKOperatorStatefulSetSpec	(Optional) Spec is the specification of the ECKOperator StatefulSet.

ECKOperatorStatefulSetContainer

(Appears on:

ECKOperatorStatefulSetPodSpec)

ECKOperatorStatefulSetContainer is a ECKOperator StatefulSet container.

Field	Description
name string	Name is an enum which identifies the ECKOperator StatefulSet container by name. Supported values are: manager
resources Kubernetes core/v1.ResourceRequirements	(Optional) Resources allows customization of limits and requests for compute resources such as cpu and memory. If specified, this overrides the named ECKOperator StatefulSet container’s resources. If omitted, the ECKOperator StatefulSet will use its default value for this container’s resources.

ECKOperatorStatefulSetInitContainer

(Appears on:

ECKOperatorStatefulSetPodSpec)

ECKOperatorStatefulSetInitContainer is a ECKOperator StatefulSet init container.

Field	Description
name string	Name is an enum which identifies the ECKOperator StatefulSet init container by name.
resources Kubernetes core/v1.ResourceRequirements	(Optional) Resources allows customization of limits and requests for compute resources such as cpu and memory. If specified, this overrides the named ECKOperator StatefulSet init container’s resources. If omitted, the ECKOperator StatefulSet will use its default value for this init container’s resources.

ECKOperatorStatefulSetPodSpec

(Appears on:

ECKOperatorStatefulSetPodTemplateSpec)

ECKOperatorStatefulSetPodSpec is the ECKOperator StatefulSet’s PodSpec.

Field	Description
initContainers []ECKOperatorStatefulSetInitContainer	(Optional) InitContainers is a list of ECKOperator StatefulSet init containers. If specified, this overrides the specified ECKOperator StatefulSet init containers. If omitted, the ECKOperator StatefulSet will use its default values for its init containers.
containers []ECKOperatorStatefulSetContainer	(Optional) Containers is a list of ECKOperator StatefulSet containers. If specified, this overrides the specified ECKOperator StatefulSet containers. If omitted, the ECKOperator StatefulSet will use its default values for its containers.

ECKOperatorStatefulSetPodTemplateSpec

(Appears on:

ECKOperatorStatefulSetSpec)

ECKOperatorStatefulSetPodTemplateSpec is the ECKOperator StatefulSet’s PodTemplateSpec

Field	Description
spec ECKOperatorStatefulSetPodSpec	(Optional) Spec is the ECKOperator StatefulSet’s PodSpec.

ECKOperatorStatefulSetSpec

(Appears on:

ECKOperatorStatefulSet)

ECKOperatorStatefulSetSpec defines configuration for the ECKOperator StatefulSet.

Field	Description
template ECKOperatorStatefulSetPodTemplateSpec	(Optional) Template describes the ECKOperator StatefulSet pod that will be created.

EGWDeploymentContainer

(Appears on:

EgressGatewayDeploymentPodSpec)

EGWDeploymentContainer is a Egress Gateway Deployment container.

Field	Description
name string	Name is an enum which identifies the EGW Deployment container by name. Supported values are: calico-egw
resources Kubernetes core/v1.ResourceRequirements	(Optional) Resources allows customization of limits and requests for compute resources such as cpu and memory. If specified, this overrides the named EGW Deployment container’s resources. If omitted, the EGW Deployment will use its default value for this container’s resources. If used in conjunction with the deprecated ComponentResources, then this value takes precedence.

EGWDeploymentInitContainer

(Appears on:

EgressGatewayDeploymentPodSpec)

EGWDeploymentInitContainer is a Egress Gateway Deployment init container.

Field	Description
name string	Name is an enum which identifies the EGW Deployment init container by name. Supported values are: egress-gateway-init
resources Kubernetes core/v1.ResourceRequirements	(Optional) Resources allows customization of limits and requests for compute resources such as cpu and memory. If specified, this overrides the named EGW Deployment init container’s resources. If omitted, the EGW Deployment will use its default value for this init container’s resources. If used in conjunction with the deprecated ComponentResources, then this value takes precedence.

EKSLogForwarderDeployment

EKSLogForwarderDeployment is the configuration for the EKSLogForwarder Deployment.

Field	Description
spec EKSLogForwarderDeploymentSpec	(Optional) Spec is the specification of the EKSLogForwarder Deployment.

EKSLogForwarderDeploymentContainer

(Appears on:

EKSLogForwarderDeploymentPodSpec)

EKSLogForwarderDeploymentContainer is a EKSLogForwarder Deployment container.

Field	Description
name string	Name is an enum which identifies the EKSLogForwarder Deployment container by name. Supported values are: eks-log-forwarder
resources Kubernetes core/v1.ResourceRequirements	(Optional) Resources allows customization of limits and requests for compute resources such as cpu and memory. If specified, this overrides the named EKSLogForwarder Deployment container’s resources. If omitted, the EKSLogForwarder Deployment will use its default value for this container’s resources.

EKSLogForwarderDeploymentInitContainer

(Appears on:

EKSLogForwarderDeploymentPodSpec)

EKSLogForwarderDeploymentInitContainer is a EKSLogForwarder Deployment init container.

Field	Description
name string	Name is an enum which identifies the EKSLogForwarder Deployment init container by name. Supported values are: eks-log-forwarder-startup
resources Kubernetes core/v1.ResourceRequirements	(Optional) Resources allows customization of limits and requests for compute resources such as cpu and memory. If specified, this overrides the named EKSLogForwarder Deployment init container’s resources. If omitted, the EKSLogForwarder Deployment will use its default value for this init container’s resources.

EKSLogForwarderDeploymentPodSpec

(Appears on:

EKSLogForwarderDeploymentPodTemplateSpec)

EKSLogForwarderDeploymentPodSpec is the EKSLogForwarder Deployment’s PodSpec.

Field	Description
initContainers []EKSLogForwarderDeploymentInitContainer	(Optional) InitContainers is a list of EKSLogForwarder init containers. If specified, this overrides the specified EKSLogForwarder Deployment init containers. If omitted, the EKSLogForwarder Deployment will use its default values for its init containers.
containers []EKSLogForwarderDeploymentContainer	(Optional) Containers is a list of EKSLogForwarder containers. If specified, this overrides the specified EKSLogForwarder Deployment containers. If omitted, the EKSLogForwarder Deployment will use its default values for its containers.

EKSLogForwarderDeploymentPodTemplateSpec

(Appears on:

EKSLogForwarderDeploymentSpec)

EKSLogForwarderDeploymentPodTemplateSpec is the EKSLogForwarder Deployment’s PodTemplateSpec

Field	Description
spec EKSLogForwarderDeploymentPodSpec	(Optional) Spec is the EKSLogForwarder Deployment’s PodSpec.

EKSLogForwarderDeploymentSpec

(Appears on:

EKSLogForwarderDeployment)

EKSLogForwarderDeploymentSpec defines configuration for the EKSLogForwarder Deployment.

Field	Description
template EKSLogForwarderDeploymentPodTemplateSpec	(Optional) Template describes the EKSLogForwarder Deployment pod that will be created.

EgressGatewayDeploymentPodSpec

(Appears on:

EgressGatewayDeploymentPodTemplateSpec)

EgressGatewayDeploymentPodSpec is the Egress Gateway Deployment’s PodSpec.

Field	Description
initContainers []EGWDeploymentInitContainer	(Optional) InitContainers is a list of EGW init containers. If specified, this overrides the specified EGW Deployment init containers. If omitted, the EGW Deployment will use its default values for its init containers.
containers []EGWDeploymentContainer	(Optional) Containers is a list of EGW containers. If specified, this overrides the specified EGW Deployment containers. If omitted, the EGW Deployment will use its default values for its containers.
affinity Kubernetes core/v1.Affinity	(Optional) Affinity is a group of affinity scheduling rules for the EGW pods.
nodeSelector map[string]string	(Optional) NodeSelector gives more control over the nodes where the Egress Gateway pods will run on.
terminationGracePeriodSeconds int64	(Optional) TerminationGracePeriodSeconds defines the termination grace period of the Egress Gateway pods in seconds.
topologySpreadConstraints []Kubernetes core/v1.TopologySpreadConstraint	(Optional) TopologySpreadConstraints defines how the Egress Gateway pods should be spread across different AZs.
tolerations []Kubernetes core/v1.Toleration	(Optional) Tolerations is the egress gateway pod’s tolerations. If specified, this overrides any tolerations that may be set on the EGW Deployment. If omitted, the EGW Deployment will use its default value for tolerations.
priorityClassName string	(Optional) PriorityClassName allows to specify a PriorityClass resource to be used.

EgressGatewayDeploymentPodTemplateSpec

(Appears on:

EgressGatewaySpec)

EgressGatewayDeploymentPodTemplateSpec is the EGW Deployment’s PodTemplateSpec

Field	Description
metadata EgressGatewayMetadata	(Optional) Metadata is a subset of a Kubernetes object’s metadata that is added to the pod’s metadata.
spec EgressGatewayDeploymentPodSpec	(Optional) Spec is the EGW Deployment’s PodSpec.

EgressGatewayFailureDetection

(Appears on:

EgressGatewaySpec)

EgressGatewayFailureDetection defines the fields the needed for determining Egress Gateway readiness.

Field	Description
healthTimeoutDataStoreSeconds int32	(Optional) HealthTimeoutDataStoreSeconds defines how long Egress Gateway can fail to connect to the datastore before reporting not ready. This value must be greater than 0. Default: 90
icmpProbe ICMPProbe	(Optional) ICMPProbe define outgoing ICMP probes that Egress Gateway will use to verify its upstream connection. Egress Gateway will report not ready if all fail. Timeout must be greater than interval.
httpProbe HTTPProbe	(Optional) HTTPProbe define outgoing HTTP probes that Egress Gateway will use to verify its upsteam connection. Egress Gateway will report not ready if all fail. Timeout must be greater than interval.

EgressGatewayIPPool

(Appears on:

EgressGatewaySpec)

Field	Description
name string	(Optional) Name is the name of the IPPool that the Egress Gateways can use.
cidr string	(Optional) CIDR is the IPPool CIDR that the Egress Gateways can use.

EgressGatewayMetadata

(Appears on:

EgressGatewayDeploymentPodTemplateSpec)

EgressGatewayMetadata contains the standard Kubernetes labels and annotations fields.

Field	Description
labels map[string]string	(Optional) Labels is a map of string keys and values that may match replica set and service selectors. Each of these key/value pairs are added to the object’s labels provided the key does not already exist in the object’s labels. If not specified will default to projectcalico.org/egw:[name], where [name] is the name of the Egress Gateway resource.
annotations map[string]string	(Optional) Annotations is a map of arbitrary non-identifying metadata. Each of these key/value pairs are added to the object’s annotations provided the key does not already exist in the object’s annotations.

EgressGatewaySpec

(Appears on:

EgressGateway)

EgressGatewaySpec defines the desired state of EgressGateway

Field	Description
replicas int32	(Optional) Replicas defines how many instances of the Egress Gateway pod will run.
ipPools []EgressGatewayIPPool	IPPools defines the IP Pools that the Egress Gateway pods should be using. Either name or CIDR must be specified. IPPools must match existing IPPools.
externalNetworks []string	(Optional) ExternalNetworks defines the external network names this Egress Gateway is associated with. ExternalNetworks must match existing external networks.
logSeverity LogLevel	(Optional) LogSeverity defines the logging level of the Egress Gateway. Default: Info
template EgressGatewayDeploymentPodTemplateSpec	(Optional) Template describes the EGW Deployment pod that will be created.
egressGatewayFailureDetection EgressGatewayFailureDetection	(Optional) EgressGatewayFailureDetection is used to configure how Egress Gateway determines readiness. If both ICMP, HTTP probes are defined, one ICMP probe and one HTTP probe should succeed for Egress Gateways to become ready. Otherwise one of ICMP or HTTP probe should succeed for Egress gateways to become ready if configured.
aws AWSEgressGateway	(Optional) AWS defines the additional configuration options for Egress Gateways on AWS.

EgressGatewayStatus

(Appears on:

EgressGateway)

EgressGatewayStatus defines the observed state of EgressGateway

Field	Description
state string	State provides user-readable status.
conditions []Kubernetes meta/v1.Condition	(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.

ElasticsearchMetricsDeployment

ElasticsearchMetricsDeployment is the configuration for the tigera-elasticsearch-metric Deployment.

Field	Description
spec ElasticsearchMetricsDeploymentSpec	(Optional) Spec is the specification of the ElasticsearchMetrics Deployment.

ElasticsearchMetricsDeploymentContainer

(Appears on:

ElasticsearchMetricsDeploymentPodSpec)

ElasticsearchMetricsDeploymentContainer is a ElasticsearchMetricsDeployment container.

Field	Description
name string	Name is an enum which identifies the ElasticsearchMetricsDeployment container by name. Supported values are: tigera-elasticsearch-metrics
resources Kubernetes core/v1.ResourceRequirements	(Optional) Resources allows customization of limits and requests for compute resources such as cpu and memory. If specified, this overrides the named ElasticsearchMetricsDeployment container’s resources. If omitted, the ElasticsearchMetrics Deployment will use its default value for this container’s resources.

ElasticsearchMetricsDeploymentInitContainer

(Appears on:

ElasticsearchMetricsDeploymentPodSpec)

ElasticsearchMetricsDeploymentInitContainer is a ElasticsearchMetricsDeployment init container.

Field	Description
name string	Name is an enum which identifies the ElasticsearchMetricsDeployment init container by name. Supported values are: tigera-ee-elasticsearch-metrics-tls-key-cert-provisioner
resources Kubernetes core/v1.ResourceRequirements	(Optional) Resources allows customization of limits and requests for compute resources such as cpu and memory. If specified, this overrides the named ElasticsearchMetricsDeployment init container’s resources. If omitted, the ElasticsearchMetrics Deployment will use its default value for this init container’s resources.

ElasticsearchMetricsDeploymentPodSpec

(Appears on:

ElasticsearchMetricsDeploymentPodTemplateSpec)

ElasticsearchMetricsDeploymentPodSpec is the tElasticsearchMetricsDeployment’s PodSpec.

Field	Description
initContainers []ElasticsearchMetricsDeploymentInitContainer	(Optional) InitContainers is a list of ElasticsearchMetricsDeployment init containers. If specified, this overrides the specified ElasticsearchMetricsDeployment init containers. If omitted, the ElasticsearchMetrics Deployment will use its default values for its init containers.
containers []ElasticsearchMetricsDeploymentContainer	(Optional) Containers is a list of ElasticsearchMetricsDeployment containers. If specified, this overrides the specified ElasticsearchMetricsDeployment containers. If omitted, the ElasticsearchMetrics Deployment will use its default values for its containers.

ElasticsearchMetricsDeploymentPodTemplateSpec

(Appears on:

ElasticsearchMetricsDeploymentSpec)

ElasticsearchMetricsDeploymentPodTemplateSpec is the ElasticsearchMetricsDeployment’s PodTemplateSpec

Field	Description
spec ElasticsearchMetricsDeploymentPodSpec	(Optional) Spec is the ElasticsearchMetrics Deployment’s PodSpec.

ElasticsearchMetricsDeploymentSpec

(Appears on:

ElasticsearchMetricsDeployment)

ElasticsearchMetricsDeploymentSpec defines configuration for the ElasticsearchMetricsDeployment Deployment.

Field	Description
template ElasticsearchMetricsDeploymentPodTemplateSpec	(Optional) Template describes the ElasticsearchMetrics Deployment pod that will be created.

EncapsulationType (string alias)

(Appears on:

IPPool)

EncapsulationType is the type of encapsulation to use on an IP pool.

One of: IPIP, VXLAN, IPIPCrossSubnet, VXLANCrossSubnet, None

EncryptionOption (string alias)

EncryptionOption specifies the traffic encryption mode when connecting to a Syslog server.

One of: None, TLS

Endpoint

(Appears on:

ServiceMonitor)

Endpoint contains a subset of relevant fields from the Prometheus Endpoint struct.

Field	Description
params map[string][]string	Optional HTTP URL parameters Default: scrape all metrics.
bearerTokenSecret Kubernetes core/v1.SecretKeySelector	Secret to mount to read bearer token for scraping targets. Recommended: when unset, the operator will create a Secret, a ClusterRole and a ClusterRoleBinding.
interval github.com/prometheus-operator/prometheus-operator/pkg/apis/monitoring/v1.Duration	Interval at which metrics should be scraped. If not specified Prometheus’ global scrape interval is used.
scrapeTimeout github.com/prometheus-operator/prometheus-operator/pkg/apis/monitoring/v1.Duration	Timeout after which the scrape is ended. If not specified, the Prometheus global scrape timeout is used unless it is less than Interval in which the latter is used.
honorLabels bool	HonorLabels chooses the metric’s labels on collisions with target labels.
honorTimestamps bool	HonorTimestamps controls whether Prometheus respects the timestamps present in scraped data.
metricRelabelings []*github.com/prometheus-operator/prometheus-operator/pkg/apis/monitoring/v1.RelabelConfig	MetricRelabelConfigs to apply to samples before ingestion.
relabelings []*github.com/prometheus-operator/prometheus-operator/pkg/apis/monitoring/v1.RelabelConfig	RelabelConfigs to apply to samples before scraping. Prometheus Operator automatically adds relabelings for a few standard Kubernetes fields. The original scrape job’s name is available via the __tmp_prometheus_job_name label. More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config

EnvoySettings

(Appears on:

ApplicationLayerSpec)

Field	Description
xffNumTrustedHops int32	(Optional) The number of additional ingress proxy hops from the right side of the x-forwarded-for HTTP header to trust when determining the origin client’s IP address. 0 is permitted, but >=1 is the typical setting.
useRemoteAddress bool	(Optional) If set to true, the Envoy connection manager will use the real remote address of the client connection when determining internal versus external origin and manipulating various headers.

ExternalPrometheus

(Appears on:

MonitorSpec)

Field	Description
serviceMonitor ServiceMonitor	(Optional) ServiceMonitor when specified, the operator will create a ServiceMonitor object in the namespace. It is recommended that you configure labels if you want your prometheus instance to pick up the configuration automatically. The operator will configure 1 endpoint by default: - Params to scrape all metrics available in Calico Enterprise. - BearerTokenSecret (If not overridden, the operator will also create corresponding RBAC that allows authz to the metrics.) - TLSConfig, containing the caFile and serverName.
namespace string	Namespace is the namespace where the operator will create resources for your Prometheus instance. The namespace must be created before the operator will create Prometheus resources.

FIPSMode (string alias)

(Appears on:

InstallationSpec)

FluentdDaemonSet

FluentdDaemonSet is the configuration for the Fluentd DaemonSet.

Field	Description
spec FluentdDaemonSetSpec	(Optional) Spec is the specification of the Fluentd DaemonSet.

FluentdDaemonSetContainer

(Appears on:

FluentdDaemonSetPodSpec)

FluentdDaemonSetContainer is a Fluentd DaemonSet container.

Field	Description
name string	Name is an enum which identifies the Fluentd DaemonSet container by name. Supported values are: fluentd
resources Kubernetes core/v1.ResourceRequirements	(Optional) Resources allows customization of limits and requests for compute resources such as cpu and memory. If specified, this overrides the named Fluentd DaemonSet container’s resources. If omitted, the Fluentd DaemonSet will use its default value for this container’s resources.

FluentdDaemonSetInitContainer

(Appears on:

FluentdDaemonSetPodSpec)

FluentdDaemonSetInitContainer is a Fluentd DaemonSet init container.

Field	Description
name string	Name is an enum which identifies the Fluentd DaemonSet init container by name. Supported values are: tigera-fluentd-prometheus-tls-key-cert-provisioner
resources Kubernetes core/v1.ResourceRequirements	(Optional) Resources allows customization of limits and requests for compute resources such as cpu and memory. If specified, this overrides the named Fluentd DaemonSet init container’s resources. If omitted, the Fluentd DaemonSet will use its default value for this init container’s resources.

FluentdDaemonSetPodSpec

(Appears on:

FluentdDaemonSetPodTemplateSpec)

FluentdDaemonSetPodSpec is the Fluentd DaemonSet’s PodSpec.

Field	Description
initContainers []FluentdDaemonSetInitContainer	(Optional) InitContainers is a list of Fluentd DaemonSet init containers. If specified, this overrides the specified Fluentd DaemonSet init containers. If omitted, the Fluentd DaemonSet will use its default values for its init containers.
containers []FluentdDaemonSetContainer	(Optional) Containers is a list of Fluentd DaemonSet containers. If specified, this overrides the specified Fluentd DaemonSet containers. If omitted, the Fluentd DaemonSet will use its default values for its containers.

FluentdDaemonSetPodTemplateSpec

(Appears on:

FluentdDaemonSetSpec)

FluentdDaemonSetPodTemplateSpec is the Fluentd DaemonSet’s PodTemplateSpec

Field	Description
spec FluentdDaemonSetPodSpec	(Optional) Spec is the Fluentd DaemonSet’s PodSpec.

FluentdDaemonSetSpec

(Appears on:

FluentdDaemonSet)

FluentdDaemonSetSpec defines configuration for the Fluentd DaemonSet.

Field	Description
template FluentdDaemonSetPodTemplateSpec	(Optional) Template describes the Fluentd DaemonSet pod that will be created.

GuardianDeployment

GuardianDeployment is the configuration for the guardian Deployment.

Field	Description
spec GuardianDeploymentSpec	(Optional) Spec is the specification of the guardian Deployment.

GuardianDeploymentContainer

(Appears on:

GuardianDeploymentPodSpec)

GuardianDeploymentContainer is a guardian Deployment container.

Field	Description
name string	Name is an enum which identifies the guardian Deployment container by name. Supported values are: tigera-guardian
resources Kubernetes core/v1.ResourceRequirements	(Optional) Resources allows customization of limits and requests for compute resources such as cpu and memory. If specified, this overrides the named guardian Deployment container’s resources. If omitted, the guardian Deployment will use its default value for this container’s resources.

GuardianDeploymentInitContainer

(Appears on:

GuardianDeploymentPodSpec)

GuardianDeploymentInitContainer is a guardian Deployment init container.

Field	Description
name string	Name is an enum which identifies the guardian Deployment init container by name.
resources Kubernetes core/v1.ResourceRequirements	(Optional) Resources allows customization of limits and requests for compute resources such as cpu and memory. If specified, this overrides the named guardian Deployment init container’s resources. If omitted, the guardian Deployment will use its default value for this init container’s resources.

GuardianDeploymentPodSpec

(Appears on:

GuardianDeploymentPodTemplateSpec)

GuardianDeploymentPodSpec is the guardian Deployment’s PodSpec.

Field	Description
initContainers []GuardianDeploymentInitContainer	(Optional) InitContainers is a list of guardian init containers. If specified, this overrides the specified guardian Deployment init containers. If omitted, the guardian Deployment will use its default values for its init containers.
containers []GuardianDeploymentContainer	(Optional) Containers is a list of guardian containers. If specified, this overrides the specified guardian Deployment containers. If omitted, the guardian Deployment will use its default values for its containers.

GuardianDeploymentPodTemplateSpec

(Appears on:

GuardianDeploymentSpec)

GuardianDeploymentPodTemplateSpec is the guardian Deployment’s PodTemplateSpec

Field	Description
spec GuardianDeploymentPodSpec	(Optional) Spec is the guardian Deployment’s PodSpec.

GuardianDeploymentSpec

(Appears on:

GuardianDeployment)

GuardianDeploymentSpec defines configuration for the guardian Deployment.

Field	Description
template GuardianDeploymentPodTemplateSpec	(Optional) Template describes the guardian Deployment pod that will be created.

HTTPProbe

(Appears on:

EgressGatewayFailureDetection)

HTTPProbe defines the HTTP probe configuration for Egress Gateway.

Field	Description
urls []string	URLs define the list of HTTP probe URLs. Egress Gateway will probe each URL periodically.If all probes fail, Egress Gateway will report non-ready.
intervalSeconds int32	(Optional) IntervalSeconds defines the interval of HTTP probes. Used when URLs is non-empty. Default: 10
timeoutSeconds int32	(Optional) TimeoutSeconds defines the timeout value of HTTP probes. Used when URLs is non-empty. Default: 30

HostPortsType (string alias)

(Appears on:

CalicoNetworkSpec)

HostPortsType specifies host port support.

One of: Enabled, Disabled

ICMPProbe

(Appears on:

EgressGatewayFailureDetection)

ICMPProbe defines the ICMP probe configuration for Egress Gateway.

Field	Description
ips []string	IPs define the list of ICMP probe IPs. Egress Gateway will probe each IP periodically. If all probes fail, Egress Gateway will report non-ready.
intervalSeconds int32	(Optional) IntervalSeconds defines the interval of ICMP probes. Used when IPs is non-empty. Default: 5
timeoutSeconds int32	(Optional) TimeoutSeconds defines the timeout value of ICMP probes. Used when IPs is non-empty. Default: 15

IPAMPluginType (string alias)

(Appears on:

IPAMSpec)

IPAMSpec

(Appears on:

CNISpec)

IPAMSpec contains configuration for pod IP address management.

Field

Description

type IPAMPluginType

Specifies the IPAM plugin that will be used in the Calico or Calico Enterprise installation. * For CNI Plugin Calico, this field defaults to Calico. * For CNI Plugin GKE, this field defaults to HostLocal. * For CNI Plugin AzureVNET, this field defaults to AzureVNET. * For CNI Plugin AmazonVPC, this field defaults to AmazonVPC. The IPAM plugin is installed and configured only if the CNI plugin is set to Calico, for all other values of the CNI plugin the plugin binaries and CNI config is a dependency that is expected to be installed separately. Default: Calico

IPPool

(Appears on:

CalicoNetworkSpec)

Field	Description
name string	Name is the name of the IP pool. If omitted, this will be generated.
cidr string	CIDR contains the address range for the IP Pool in classless inter-domain routing format.
encapsulation EncapsulationType	(Optional) Encapsulation specifies the encapsulation type that will be used with the IP Pool. Default: IPIP
natOutgoing NATOutgoingType	(Optional) NATOutgoing specifies if NAT will be enabled or disabled for outgoing traffic. Default: Enabled
nodeSelector string	(Optional) NodeSelector specifies the node selector that will be set for the IP Pool. Default: ‘all()’
blockSize int32	(Optional) BlockSize specifies the CIDR prefex length to use when allocating per-node IP blocks from the main IP pool CIDR. Default: 26 (IPv4), 122 (IPv6)
disableBGPExport bool	(Optional) DisableBGPExport specifies whether routes from this IP pool’s CIDR are exported over BGP. Default: false
allowedUses []IPPoolAllowedUse	AllowedUse controls what the IP pool will be used for. If not specified or empty, defaults to [“Tunnel”, “Workload”] for back-compatibility

IPPoolAllowedUse (string alias)

(Appears on:

IPPool)

Image

(Appears on:

ImageSetSpec)

Field	Description
image string	Image is an image that the operator deploys and instead of using the built in tag the operator will use the Digest for the image identifier. The value should be the image name without registry or tag or digest. For the image docker.io/calico/node:v3.17.1 it should be represented as calico/node
digest string	Digest is the image identifier that will be used for the Image. The field should not include a leading @ and must be prefixed with sha256:.

ImageSetSpec

(Appears on:

ImageSet)

ImageSetSpec defines the desired state of ImageSet.

Field	Description
images []Image	Images is the list of images to use digests. All images that the operator will deploy must be specified.

Index

(Appears on:

TenantSpec)

Index defines how to store a tenant’s data

Field	Description
baseIndexName string	BaseIndexName defines the name of the index that will be used to store data (this name excludes the numerical identifier suffix)
dataType DataType	DataType represents the type of data stored in the defined index

InstallationSpec

(Appears on:

Installation,InstallationStatus)

InstallationSpec defines configuration for a Calico or Calico Enterprise installation.

Field	Description
variant ProductVariant	(Optional) Variant is the product to install - one of Calico or TigeraSecureEnterprise Default: Calico
registry string	(Optional) Registry is the default Docker registry used for component Docker images. If specified then the given value must end with a slash character (/) and all images will be pulled from this registry. If not specified then the default registries will be used. A special case value, UseDefault, is supported to explicitly specify the default registries will be used. Image format:<registry><imagePath>/<imagePrefix><imageName>:<image-tag> This option allows configuring the <registry> portion of the above format.
imagePath string	(Optional) ImagePath allows for the path part of an image to be specified. If specified then the specified value will be used as the image path for each image. If not specified or empty, the default for each image will be used. A special case value, UseDefault, is supported to explicitly specify the default image path will be used for each image. Image format:<registry><imagePath>/<imagePrefix><imageName>:<image-tag> This option allows configuring the <imagePath> portion of the above format.
imagePrefix string	(Optional) ImagePrefix allows for the prefix part of an image to be specified. If specified then the given value will be used as a prefix on each image. If not specified or empty, no prefix will be used. A special case value, UseDefault, is supported to explicitly specify the default image prefix will be used for each image. Image format:<registry><imagePath>/<imagePrefix><imageName>:<image-tag> This option allows configuring the <imagePrefix> portion of the above format.
imagePullSecrets []Kubernetes core/v1.LocalObjectReference	(Optional) ImagePullSecrets is an array of references to container registry pull secrets to use. These are applied to all images to be pulled.
kubernetesProvider Provider	(Optional) KubernetesProvider specifies a particular provider of the Kubernetes platform and enables provider-specific configuration. If the specified value is empty, the Operator will attempt to automatically determine the current provider. If the specified value is not empty, the Operator will still attempt auto-detection, but will additionally compare the auto-detected value to the specified value to confirm they match.
cni CNISpec	(Optional) CNI specifies the CNI that will be used by this installation.
calicoNetwork CalicoNetworkSpec	(Optional) CalicoNetwork specifies networking configuration options for Calico.
typhaAffinity TyphaAffinity	(Optional) Deprecated. Please use Installation.Spec.TyphaDeployment instead. TyphaAffinity allows configuration of node affinity characteristics for Typha pods.
controlPlaneNodeSelector map[string]string	(Optional) ControlPlaneNodeSelector is used to select control plane nodes on which to run Calico components. This is globally applied to all resources created by the operator excluding daemonsets.
controlPlaneTolerations []Kubernetes core/v1.Toleration	(Optional) ControlPlaneTolerations specify tolerations which are then globally applied to all resources created by the operator.
controlPlaneReplicas int32	(Optional) ControlPlaneReplicas defines how many replicas of the control plane core components will be deployed. This field applies to all control plane components that support High Availability. Defaults to 2.
nodeMetricsPort int32	(Optional) NodeMetricsPort specifies which port calico/node serves prometheus metrics on. By default, metrics are not enabled. If specified, this overrides any FelixConfiguration resources which may exist. If omitted, then prometheus metrics may still be configured through FelixConfiguration.
typhaMetricsPort int32	(Optional) TyphaMetricsPort specifies which port calico/typha serves prometheus metrics on. By default, metrics are not enabled.
flexVolumePath string	(Optional) FlexVolumePath optionally specifies a custom path for FlexVolume. If not specified, FlexVolume will be enabled by default. If set to ‘None’, FlexVolume will be disabled. The default is based on the kubernetesProvider.
kubeletVolumePluginPath string	(Optional) KubeletVolumePluginPath optionally specifies enablement of Calico CSI plugin. If not specified, CSI will be enabled by default. If set to ‘None’, CSI will be disabled. Default: /var/lib/kubelet
nodeUpdateStrategy Kubernetes apps/v1.DaemonSetUpdateStrategy	(Optional) NodeUpdateStrategy can be used to customize the desired update strategy, such as the MaxUnavailable field.
componentResources []ComponentResource	(Optional) Deprecated. Please use CalicoNodeDaemonSet, TyphaDeployment, and KubeControllersDeployment. ComponentResources can be used to customize the resource requirements for each component. Node, Typha, and KubeControllers are supported for installations.
certificateManagement CertificateManagement	(Optional) CertificateManagement configures pods to submit a CertificateSigningRequest to the certificates.k8s.io/v1beta1 API in order to obtain TLS certificates. This feature requires that you bring your own CSR signing and approval process, otherwise pods will be stuck during initialization.
nonPrivileged NonPrivilegedType	(Optional) NonPrivileged configures Calico to be run in non-privileged containers as non-root users where possible.
calicoNodeDaemonSet CalicoNodeDaemonSet	CalicoNodeDaemonSet configures the calico-node DaemonSet. If used in conjunction with the deprecated ComponentResources, then these overrides take precedence.
csiNodeDriverDaemonSet CSINodeDriverDaemonSet	CSINodeDriverDaemonSet configures the csi-node-driver DaemonSet.
calicoKubeControllersDeployment CalicoKubeControllersDeployment	CalicoKubeControllersDeployment configures the calico-kube-controllers Deployment. If used in conjunction with the deprecated ComponentResources, then these overrides take precedence.
typhaDeployment TyphaDeployment	TyphaDeployment configures the typha Deployment. If used in conjunction with the deprecated ComponentResources or TyphaAffinity, then these overrides take precedence.
calicoWindowsUpgradeDaemonSet CalicoWindowsUpgradeDaemonSet	Deprecated. The CalicoWindowsUpgradeDaemonSet is deprecated and will be removed from the API in the future. CalicoWindowsUpgradeDaemonSet configures the calico-windows-upgrade DaemonSet.
calicoNodeWindowsDaemonSet CalicoNodeWindowsDaemonSet	CalicoNodeWindowsDaemonSet configures the calico-node-windows DaemonSet.
fipsMode FIPSMode	(Optional) FIPSMode uses images and features only that are using FIPS 140-2 validated cryptographic modules and standards. Default: Disabled
logging Logging	(Optional) Logging Configuration for Components
windowsNodes WindowsNodeSpec	(Optional) Windows Configuration
serviceCIDRs []string	(Optional) Kubernetes Service CIDRs. Specifying this is required when using Calico for Windows.

InstallationStatus

(Appears on:

Installation)

InstallationStatus defines the observed state of the Calico or Calico Enterprise installation.

Field	Description
variant ProductVariant	Variant is the most recently observed installed variant - one of Calico or TigeraSecureEnterprise
mtu int32	MTU is the most recently observed value for pod network MTU. This may be an explicitly configured value, or based on Calico’s native auto-detetion.
imageSet string	(Optional) ImageSet is the name of the ImageSet being used, if there is an ImageSet that is being used. If an ImageSet is not being used then this will not be set.
computed InstallationSpec	(Optional) Computed is the final installation including overlaid resources.
calicoVersion string	CalicoVersion shows the current running version of calico. CalicoVersion along with Variant is needed to know the exact version deployed.
conditions []Kubernetes meta/v1.Condition	(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.

Kibana

Kibana is the configuration for the Kibana.

Field	Description
spec KibanaSpec	(Optional) Spec is the specification of the Kibana.

KibanaContainer

(Appears on:

KibanaPodSpec)

KibanaContainer is a Kibana container.

Field	Description
name string	Name is an enum which identifies the Kibana Deployment container by name. Supported values are: kibana
resources Kubernetes core/v1.ResourceRequirements	(Optional) Resources allows customization of limits and requests for compute resources such as cpu and memory. If specified, this overrides the named Kibana container’s resources. If omitted, the Kibana will use its default value for this container’s resources.

KibanaInitContainer

(Appears on:

KibanaPodSpec)

KibanaInitContainer is a Kibana init container.

Field	Description
name string	Name is an enum which identifies the Kibana init container by name. Supported values are: key-cert-provisioner
resources Kubernetes core/v1.ResourceRequirements	(Optional) Resources allows customization of limits and requests for compute resources such as cpu and memory. If specified, this overrides the named Kibana Deployment init container’s resources. If omitted, the Kibana Deployment will use its default value for this init container’s resources. If used in conjunction with the deprecated ComponentResources, then this value takes precedence.

KibanaPodSpec

(Appears on:

KibanaPodTemplateSpec)

KibanaPodSpec is the Kibana Deployment’s PodSpec.

Field	Description
initContainers []KibanaInitContainer	(Optional) InitContainers is a list of Kibana init containers. If specified, this overrides the specified Kibana Deployment init containers. If omitted, the Kibana Deployment will use its default values for its init containers.
containers []KibanaContainer	(Optional) Containers is a list of Kibana containers. If specified, this overrides the specified Kibana Deployment containers. If omitted, the Kibana Deployment will use its default values for its containers.

KibanaPodTemplateSpec

(Appears on:

KibanaSpec)

KibanaPodTemplateSpec is the Kibana’s PodTemplateSpec

Field	Description
spec KibanaPodSpec	(Optional) Spec is the Kibana’s PodSpec.

KibanaSpec

(Appears on:

Kibana)

Field	Description
template KibanaPodTemplateSpec	(Optional) Template describes the Kibana pod that will be created.

KubernetesAutodetectionMethod (string alias)

(Appears on:

NodeAddressAutodetection)

KubernetesAutodetectionMethod is a method of detecting an IP address based on the Kubernetes API.

One of: NodeInternalIP

LinseedDeployment

(Appears on:

TenantSpec)

LinseedDeployment is the configuration for the linseed Deployment.

Field	Description
spec LinseedDeploymentSpec	(Optional) Spec is the specification of the linseed Deployment.

LinseedDeploymentContainer

(Appears on:

LinseedDeploymentPodSpec)

LinseedDeploymentContainer is a linseed Deployment container.

Field	Description
name string	Name is an enum which identifies the linseed Deployment container by name. Supported values are: tigera-linseed
resources Kubernetes core/v1.ResourceRequirements	(Optional) Resources allows customization of limits and requests for compute resources such as cpu and memory. If specified, this overrides the named linseed Deployment container’s resources. If omitted, the linseed Deployment will use its default value for this container’s resources.

LinseedDeploymentInitContainer

(Appears on:

LinseedDeploymentPodSpec)

LinseedDeploymentInitContainer is a linseed Deployment init container.

Field	Description
name string	Name is an enum which identifies the linseed Deployment init container by name. Supported values are: tigera-secure-linseed-token-tls-key-cert-provisioner,tigera-secure-linseed-cert-key-cert-provisioner
resources Kubernetes core/v1.ResourceRequirements	(Optional) Resources allows customization of limits and requests for compute resources such as cpu and memory. If specified, this overrides the named linseed Deployment init container’s resources. If omitted, the linseed Deployment will use its default value for this init container’s resources.

LinseedDeploymentPodSpec

(Appears on:

LinseedDeploymentPodTemplateSpec)

LinseedDeploymentPodSpec is the linseed Deployment’s PodSpec.

Field	Description
initContainers []LinseedDeploymentInitContainer	(Optional) InitContainers is a list of linseed init containers. If specified, this overrides the specified linseed Deployment init containers. If omitted, the linseed Deployment will use its default values for its init containers.
containers []LinseedDeploymentContainer	(Optional) Containers is a list of linseed containers. If specified, this overrides the specified linseed Deployment containers. If omitted, the linseed Deployment will use its default values for its containers.

LinseedDeploymentPodTemplateSpec

(Appears on:

LinseedDeploymentSpec)

LinseedDeploymentPodTemplateSpec is the linseed Deployment’s PodTemplateSpec

Field	Description
spec LinseedDeploymentPodSpec	(Optional) Spec is the linseed Deployment’s PodSpec.

LinseedDeploymentSpec

(Appears on:

LinseedDeployment)

LinseedDeploymentSpec defines configuration for the linseed Deployment.

Field	Description
template LinseedDeploymentPodTemplateSpec	(Optional) Template describes the linseed Deployment pod that will be created.

LinuxDataplaneOption (string alias)

(Appears on:

CalicoNetworkSpec)

LinuxDataplaneOption controls which dataplane is to be used on Linux nodes.

One of: Iptables, BPF

LogCollectionSpec

(Appears on:

ApplicationLayerSpec)

Field	Description
collectLogs LogCollectionStatusType	(Optional) This setting enables or disable log collection. Allowed values are Enabled or Disabled.
logIntervalSeconds int64	(Optional) Interval in seconds for sending L7 log information for processing. Default: 5 sec
logRequestsPerInterval int64	(Optional) Maximum number of unique L7 logs that are sent LogIntervalSeconds. Adjust this to limit the number of L7 logs sent per LogIntervalSeconds to felix for further processing, use negative number to ignore limits. Default: -1

LogCollectionStatusType (string alias)

(Appears on:

LogCollectionSpec)

LogLevel (string alias)

(Appears on:

CNILogging,EgressGatewaySpec)

Logging

(Appears on:

InstallationSpec)

Field	Description
cni CNILogging	(Optional) Customized logging specification for calico-cni plugin

Metadata

(Appears on:

APIServerDeployment,APIServerDeploymentPodTemplateSpec,CSINodeDriverDaemonSet,CSINodeDriverDaemonSetPodTemplateSpec,CalicoKubeControllersDeployment,CalicoKubeControllersDeploymentPodTemplateSpec,CalicoNodeDaemonSet,CalicoNodeDaemonSetPodTemplateSpec,CalicoNodeWindowsDaemonSet,CalicoNodeWindowsDaemonSetPodTemplateSpec,CalicoWindowsUpgradeDaemonSet,CalicoWindowsUpgradeDaemonSetPodTemplateSpec,TyphaDeployment,TyphaDeploymentPodTemplateSpec)

Metadata contains the standard Kubernetes labels and annotations fields.

Field	Description
labels map[string]string	(Optional) Labels is a map of string keys and values that may match replicaset and service selectors. Each of these key/value pairs are added to the object’s labels provided the key does not already exist in the object’s labels.
annotations map[string]string	(Optional) Annotations is a map of arbitrary non-identifying metadata. Each of these key/value pairs are added to the object’s annotations provided the key does not already exist in the object’s annotations.

MonitorSpec

(Appears on:

Monitor)

MonitorSpec defines the desired state of Tigera monitor.

Field	Description
externalPrometheus ExternalPrometheus	ExternalPrometheus optionally configures integration with an external Prometheus for scraping Calico metrics. When specified, the operator will render resources in the defined namespace. This option can be useful for configuring scraping from git-ops tools without the need of post-installation steps.
prometheus Prometheus	(Optional) Prometheus is the configuration for the Prometheus.
alertManager AlertManager	(Optional) AlertManager is the configuration for the AlertManager.

MonitorStatus

(Appears on:

Monitor)

MonitorStatus defines the observed state of Tigera monitor.

Field	Description
state string	State provides user-readable status.
conditions []Kubernetes meta/v1.Condition	(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.

MultiInterfaceMode (string alias)

(Appears on:

CalicoNetworkSpec)

MultiInterfaceMode describes the method of providing multiple pod interfaces.

One of: None, Multus

NATOutgoingType (string alias)

(Appears on:

IPPool)

NATOutgoingType describe the type of outgoing NAT to use.

One of: Enabled, Disabled

NativeIP (string alias)

(Appears on:

AWSEgressGateway)

NativeIP defines if Egress Gateway pods should have AWS IPs. When NativeIP is enabled, the IPPools should be backed by AWS subnet.

NodeAddressAutodetection

(Appears on:

CalicoNetworkSpec)

NodeAddressAutodetection provides configuration options for auto-detecting node addresses. At most one option can be used. If no detection option is specified, then IP auto detection will be disabled for this address family and IPs must be specified directly on the Node resource.

Field	Description
firstFound bool	(Optional) FirstFound uses default interface matching parameters to select an interface, performing best-effort filtering based on well-known interface names.
kubernetes KubernetesAutodetectionMethod	(Optional) Kubernetes configures Calico to detect node addresses based on the Kubernetes API.
interface string	(Optional) Interface enables IP auto-detection based on interfaces that match the given regex.
skipInterface string	(Optional) SkipInterface enables IP auto-detection based on interfaces that do not match the given regex.
canReach string	(Optional) CanReach enables IP auto-detection based on which source address on the node is used to reach the specified IP or domain.
cidrs []string	CIDRS enables IP auto-detection based on which addresses on the nodes are within one of the provided CIDRs.

NodeAffinity

(Appears on:

TyphaAffinity)

NodeAffinity is similar to *v1.NodeAffinity, but allows us to limit available schedulers.

Field	Description
preferredDuringSchedulingIgnoredDuringExecution []Kubernetes core/v1.PreferredSchedulingTerm	(Optional) The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions.
requiredDuringSchedulingIgnoredDuringExecution Kubernetes core/v1.NodeSelector	(Optional) WARNING: Please note that if the affinity requirements specified by this field are not met at scheduling time, the pod will NOT be scheduled onto the node. There is no fallback to another affinity rules with this setting. This may cause networking disruption or even catastrophic failure! PreferredDuringSchedulingIgnoredDuringExecution should be used for affinity unless there is a specific well understood reason to use RequiredDuringSchedulingIgnoredDuringExecution and you can guarantee that the RequiredDuringSchedulingIgnoredDuringExecution will always have sufficient nodes to satisfy the requirement. NOTE: RequiredDuringSchedulingIgnoredDuringExecution is set by default for AKS nodes, to avoid scheduling Typhas on virtual-nodes. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to an update), the system may or may not try to eventually evict the pod from its node.

NonPrivilegedType (string alias)

(Appears on:

InstallationSpec)

NonPrivilegedType specifies whether Calico runs as permissioned or not

One of: Enabled, Disabled

OIDCType (string alias)

OIDCType defines how OIDC is configured for Tigera Enterprise. Dex should be the best option for most use-cases. The Tigera option can help in specific use-cases, for instance, when you are unable to configure a client secret. One of: Dex, Tigera

PacketCaptureAPIDeployment

(Appears on:

PacketCaptureAPISpec)

PacketCaptureAPIDeployment is the configuration for the PacketCaptureAPI Deployment.

Field	Description
spec PacketCaptureAPIDeploymentSpec	(Optional) Spec is the specification of the PacketCaptureAPI Deployment.

PacketCaptureAPIDeploymentContainer

(Appears on:

PacketCaptureAPIDeploymentPodSpec)

PacketCaptureAPIDeploymentContainer is a PacketCaptureAPI Deployment container.

Field	Description
name string	Name is an enum which identifies the PacketCaptureAPI Deployment container by name. Supported values are: tigera-packetcapture-server
resources Kubernetes core/v1.ResourceRequirements	(Optional) Resources allows customization of limits and requests for compute resources such as cpu and memory. If specified, this overrides the named PacketCaptureAPI Deployment container’s resources. If omitted, the PacketCaptureAPI Deployment will use its default value for this container’s resources.

PacketCaptureAPIDeploymentInitContainer

(Appears on:

PacketCaptureAPIDeploymentPodSpec)

PacketCaptureAPIDeploymentInitContainer is a PacketCaptureAPI Deployment init container.

Field	Description
name string	Name is an enum which identifies the PacketCaptureAPI Deployment init container by name. Supported values are: tigera-packetcapture-server-tls-key-cert-provisioner
resources Kubernetes core/v1.ResourceRequirements	(Optional) Resources allows customization of limits and requests for compute resources such as cpu and memory. If specified, this overrides the named PacketCaptureAPI Deployment init container’s resources. If omitted, the PacketCaptureAPI Deployment will use its default value for this init container’s resources.

PacketCaptureAPIDeploymentPodSpec

(Appears on:

PacketCaptureAPIDeploymentPodTemplateSpec)

PacketCaptureAPIDeploymentPodSpec is the PacketCaptureAPI Deployment’s PodSpec.

Field	Description
initContainers []PacketCaptureAPIDeploymentInitContainer	(Optional) InitContainers is a list of PacketCaptureAPI init containers. If specified, this overrides the specified PacketCaptureAPI Deployment init containers. If omitted, the PacketCaptureAPI Deployment will use its default values for its init containers.
containers []PacketCaptureAPIDeploymentContainer	(Optional) Containers is a list of PacketCaptureAPI containers. If specified, this overrides the specified PacketCaptureAPI Deployment containers. If omitted, the PacketCaptureAPI Deployment will use its default values for its containers.

PacketCaptureAPIDeploymentPodTemplateSpec

(Appears on:

PacketCaptureAPIDeploymentSpec)

PacketCaptureAPIDeploymentPodTemplateSpec is the PacketCaptureAPI Deployment’s PodTemplateSpec

Field	Description
spec PacketCaptureAPIDeploymentPodSpec	(Optional) Spec is the PacketCaptureAPI Deployment’s PodSpec.

PacketCaptureAPIDeploymentSpec

(Appears on:

PacketCaptureAPIDeployment)

PacketCaptureAPIDeploymentSpec defines configuration for the PacketCaptureAPI Deployment.

Field	Description
template PacketCaptureAPIDeploymentPodTemplateSpec	(Optional) Template describes the PacketCaptureAPI Deployment pod that will be created.

PacketCaptureAPISpec

(Appears on:

PacketCaptureAPI)

PacketCaptureAPISpec defines configuration for the Packet Capture API.

Field	Description
packetCaptureAPIDeployment PacketCaptureAPIDeployment	(Optional) PacketCaptureAPIDeployment configures the PacketCaptureAPI Deployment.

PacketCaptureAPIStatus

(Appears on:

PacketCaptureAPI)

PacketCaptureAPIStatus defines the observed state of the Packet Capture API.

Field	Description
state string	State provides user-readable status.
conditions []Kubernetes meta/v1.Condition	(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.

PathMatch

(Appears on:

TLSTerminatedRouteSpec)

Field	Description
path string	Path is the path portion of the URL based on which we proxy.
pathRegexp string	(Optional) PathRegexp, if not nil, checks if Regexp matches the path.
pathReplace string	(Optional) PathReplace if not nil will be used to replace PathRegexp matches.

PolicyRecommendationDeployment

(Appears on:

PolicyRecommendationSpec)

PolicyRecommendationDeployment is the configuration for the PolicyRecommendation Deployment.

Field	Description
spec PolicyRecommendationDeploymentSpec	(Optional) Spec is the specification of the PolicyRecommendation Deployment.

PolicyRecommendationDeploymentContainer

(Appears on:

PolicyRecommendationDeploymentPodSpec)

PolicyRecommendationDeploymentContainer is a PolicyRecommendation Deployment container.

Field	Description
name string	Name is an enum which identifies the PolicyRecommendation Deployment container by name. Supported values are: policy-recommendation-controller
resources Kubernetes core/v1.ResourceRequirements	(Optional) Resources allows customization of limits and requests for compute resources such as cpu and memory. If specified, this overrides the named PolicyRecommendation Deployment container’s resources. If omitted, the PolicyRecommendation Deployment will use its default value for this container’s resources.

PolicyRecommendationDeploymentInitContainer

(Appears on:

PolicyRecommendationDeploymentPodSpec)

PolicyRecommendationDeploymentInitContainer is a PolicyRecommendation Deployment init container.

Field	Description
name string	Name is an enum which identifies the PolicyRecommendation Deployment init container by name.
resources Kubernetes core/v1.ResourceRequirements	(Optional) Resources allows customization of limits and requests for compute resources such as cpu and memory. If specified, this overrides the named PolicyRecommendation Deployment init container’s resources. If omitted, the PolicyRecommendation Deployment will use its default value for this init container’s resources.

PolicyRecommendationDeploymentPodSpec

(Appears on:

PolicyRecommendationDeploymentPodTemplateSpec)

PolicyRecommendationDeploymentPodSpec is the PolicyRecommendation Deployment’s PodSpec.

Field	Description
initContainers []PolicyRecommendationDeploymentInitContainer	(Optional) InitContainers is a list of PolicyRecommendation init containers. If specified, this overrides the specified PolicyRecommendation Deployment init containers. If omitted, the PolicyRecommendation Deployment will use its default values for its init containers.
containers []PolicyRecommendationDeploymentContainer	(Optional) Containers is a list of PolicyRecommendation containers. If specified, this overrides the specified PolicyRecommendation Deployment containers. If omitted, the PolicyRecommendation Deployment will use its default values for its containers.

PolicyRecommendationDeploymentPodTemplateSpec

(Appears on:

PolicyRecommendationDeploymentSpec)

PolicyRecommendationDeploymentPodTemplateSpec is the PolicyRecommendation Deployment’s PodTemplateSpec

Field	Description
spec PolicyRecommendationDeploymentPodSpec	(Optional) Spec is the PolicyRecommendation Deployment’s PodSpec.

PolicyRecommendationDeploymentSpec

(Appears on:

PolicyRecommendationDeployment)

PolicyRecommendationDeploymentSpec defines configuration for the PolicyRecommendation Deployment.

Field	Description
template PolicyRecommendationDeploymentPodTemplateSpec	(Optional) Template describes the PolicyRecommendation Deployment pod that will be created.

PolicyRecommendationSpec

(Appears on:

PolicyRecommendation)

PolicyRecommendationSpec defines configuration for the Calico Enterprise Policy Recommendation service.

Field	Description
policyRecommendationDeployment PolicyRecommendationDeployment	(Optional) PolicyRecommendation configures the PolicyRecommendation Deployment.

PolicyRecommendationStatus

(Appears on:

PolicyRecommendation)

PolicyRecommendationStatus defines the observed state of Tigera policy recommendation.

Field	Description
state string	State provides user-readable status.

ProductVariant (string alias)

(Appears on:

InstallationSpec,InstallationStatus)

ProductVariant represents the variant of the product.

One of: Calico, TigeraSecureEnterprise

Prometheus

(Appears on:

MonitorSpec)

Field	Description
spec PrometheusSpec	(Optional) Spec is the specification of the Prometheus.

PrometheusContainer

(Appears on:

CommonPrometheusFields)

PrometheusContainer is a Prometheus container.

Field	Description
name string	Name is an enum which identifies the Prometheus Deployment container by name. Supported values are: authn-proxy
resources Kubernetes core/v1.ResourceRequirements	(Optional) Resources allows customization of limits and requests for compute resources such as cpu and memory. If specified, this overrides the named Prometheus container’s resources. If omitted, the Prometheus will use its default value for this container’s resources.

PrometheusSpec

(Appears on:

Prometheus)

Field	Description
commonPrometheusFields CommonPrometheusFields	CommonPrometheusFields are the options available to both the Prometheus server and agent.

PromptType (string alias)

PromptType is a value that specifies whether the identity provider prompts the end user for re-authentication and consent. One of: None, Login, Consent, SelectAccount.

Provider (string alias)

(Appears on:

InstallationSpec)

Provider represents a particular provider or flavor of Kubernetes. Valid options are: EKS, GKE, AKS, RKE2, OpenShift, DockerEnterprise, TKG.

SNIMatch

(Appears on:

TLSPassThroughRouteSpec)

Field	Description
serverName string	ServerName is used to match the server name for the request.

ServiceMonitor

(Appears on:

ExternalPrometheus)

Field	Description
labels map[string]string	Labels are the metadata.labels of the ServiceMonitor. When combined with spec.serviceMonitorSelector.matchLabels on your prometheus instance, the service monitor will automatically be picked up. Default: k8s-app=tigera-prometheus
endpoints []Endpoint	The endpoints to scrape. This struct contains a subset of the Endpoint as defined in the prometheus docs. Fields related to connecting to our Prometheus server are automatically set by the operator.

StatusConditionType (string alias)

(Appears on:

TigeraStatusCondition)

StatusConditionType is a type of condition that may apply to a particular component.

Sysctl

(Appears on:

CalicoNetworkSpec)

Field	Description
key string
value string

TLS

Field

Description

secretName string

(Optional) SecretName indicates the name of the secret in the tigera-operator namespace that contains the private key and certificate that the management cluster uses when it listens for incoming connections. When set to tigera-management-cluster-connection voltron will use the same cert bundle which Guardian client certs are signed with. When set to manager-tls, voltron will use the same cert bundle which Manager UI is served with. This cert bundle must be a publicly signed cert created by the user. Note that Tigera Operator will generate a self-signed manager-tls cert if one does not exist, and use of that cert will result in Guardian being unable to verify Voltron’s identity. If changed on a running cluster with connected managed clusters, all managed clusters will disconnect as they will no longer be able to verify Voltron’s identity. To reconnect existing managed clusters, change the tls.ca of the managed clusters’ ManagementClusterConnection resource. One of: tigera-management-cluster-connection, manager-tls Default: tigera-management-cluster-connection

TLSPassThroughRouteSpec

(Appears on:

TLSPassThroughRoute)

Field	Description
target TargetType
sniMatch SNIMatch	SNIMatch is used to match requests based on the server name for the intended destination server. Matching requests will be proxied to the Destination.
destination string	Destination is the destination url to proxy the request to.

TLSTerminatedRouteSpec

(Appears on:

TLSTerminatedRoute)

Field	Description
target TargetType
pathMatch PathMatch	PathMatch is used to match requests based on what’s in the path. Matching requests will be proxied to the Destination defined in this structure.
destination string	Destination is the destination URL where matching traffic is routed to.
caBundle Kubernetes core/v1.ConfigMapKeySelector	CABundle is where we read the CA bundle from to authenticate the destination (if non-empty)
mtlsCert Kubernetes core/v1.SecretKeySelector	(Optional) ForwardingMTLSCert is the certificate used for mTLS between voltron and the destination. Either both ForwardingMTLSCert and ForwardingMTLSKey must be specified, or neither can be specified.
mtlsKey Kubernetes core/v1.SecretKeySelector	(Optional) ForwardingMTLSKey is the key used for mTLS between voltron and the destination. Either both ForwardingMTLSCert and ForwardingMTLSKey must be specified, or neither can be specified.
unauthenticated bool	(Optional) Unauthenticated says whether the request should go through authentication. This is only applicable if the Target is UI.

TargetType (string alias)

(Appears on:

TLSPassThroughRouteSpec,TLSTerminatedRouteSpec)

TenantElasticSpec

(Appears on:

TenantSpec)

Field	Description
url string
kibanaURL string
mutualTLS bool

TenantSpec

(Appears on:

Tenant)

Field	Description
id string	ID is the unique identifier for this tenant.
name string	Name is a human readable name for this tenant.
indices []Index	Indices defines the how to store a tenant’s data
elastic TenantElasticSpec	Elastic configures per-tenant ElasticSearch and Kibana parameters. This field is required for clusters using external ES.
controlPlaneReplicas int32	(Optional) ControlPlaneReplicas defines how many replicas of the control plane core components will be deployed in the Tenant’s namespace. Defaults to the controlPlaneReplicas in Installation CR
linseedDeployment LinseedDeployment	LinseedDeployment configures the linseed Deployment.
dashboardsJob DashboardsJob	DashboardsJob configures the Dashboards job

TenantStatus

(Appears on:

Tenant)

TigeraStatusCondition

(Appears on:

TigeraStatusStatus)

TigeraStatusCondition represents a condition attached to a particular component.

Field	Description
type StatusConditionType	The type of condition. May be Available, Progressing, or Degraded.
status ConditionStatus	The status of the condition. May be True, False, or Unknown.
lastTransitionTime Kubernetes meta/v1.Time	The timestamp representing the start time for the current status.
reason string	A brief reason explaining the condition.
message string	Optionally, a detailed message providing additional context.
observedGeneration int64	(Optional) observedGeneration represents the generation that the condition was set based upon. For instance, if generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.

TigeraStatusReason (string alias)

TigeraStatusReason represents the reason for a particular condition.

TigeraStatusSpec

(Appears on:

TigeraStatus)

TigeraStatusSpec defines the desired state of TigeraStatus

TigeraStatusStatus

(Appears on:

TigeraStatus)

TigeraStatusStatus defines the observed state of TigeraStatus

Field	Description
conditions []TigeraStatusCondition	Conditions represents the latest observed set of conditions for this component. A component may be one or more of Available, Progressing, or Degraded.

TyphaAffinity

(Appears on:

InstallationSpec)

Deprecated. Please use TyphaDeployment instead. TyphaAffinity allows configuration of node affinity characteristics for Typha pods.

Field	Description
nodeAffinity NodeAffinity	(Optional) NodeAffinity describes node affinity scheduling rules for typha.

TyphaDeployment

(Appears on:

InstallationSpec)

TyphaDeployment is the configuration for the typha Deployment.

Field	Description
metadata Metadata	(Optional) Metadata is a subset of a Kubernetes object’s metadata that is added to the Deployment.
spec TyphaDeploymentSpec	(Optional) Spec is the specification of the typha Deployment.

TyphaDeploymentContainer

(Appears on:

TyphaDeploymentPodSpec)

TyphaDeploymentContainer is a typha Deployment container.

Field	Description
name string	Name is an enum which identifies the typha Deployment container by name. Supported values are: calico-typha
resources Kubernetes core/v1.ResourceRequirements	(Optional) Resources allows customization of limits and requests for compute resources such as cpu and memory. If specified, this overrides the named typha Deployment container’s resources. If omitted, the typha Deployment will use its default value for this container’s resources. If used in conjunction with the deprecated ComponentResources, then this value takes precedence.

TyphaDeploymentInitContainer

(Appears on:

TyphaDeploymentPodSpec)

TyphaDeploymentInitContainer is a typha Deployment init container.

Field	Description
name string	Name is an enum which identifies the typha Deployment init container by name. Supported values are: typha-certs-key-cert-provisioner
resources Kubernetes core/v1.ResourceRequirements	(Optional) Resources allows customization of limits and requests for compute resources such as cpu and memory. If specified, this overrides the named typha Deployment init container’s resources. If omitted, the typha Deployment will use its default value for this init container’s resources. If used in conjunction with the deprecated ComponentResources, then this value takes precedence.

TyphaDeploymentPodSpec

(Appears on:

TyphaDeploymentPodTemplateSpec)

TyphaDeploymentPodSpec is the typha Deployment’s PodSpec.

Field	Description
initContainers []TyphaDeploymentInitContainer	(Optional) InitContainers is a list of typha init containers. If specified, this overrides the specified typha Deployment init containers. If omitted, the typha Deployment will use its default values for its init containers.
containers []TyphaDeploymentContainer	(Optional) Containers is a list of typha containers. If specified, this overrides the specified typha Deployment containers. If omitted, the typha Deployment will use its default values for its containers.
affinity Kubernetes core/v1.Affinity	(Optional) Affinity is a group of affinity scheduling rules for the typha pods. If specified, this overrides any affinity that may be set on the typha Deployment. If omitted, the typha Deployment will use its default value for affinity. If used in conjunction with the deprecated TyphaAffinity, then this value takes precedence. WARNING: Please note that this field will override the default calico-typha Deployment affinity.
nodeSelector map[string]string	NodeSelector is the calico-typha pod’s scheduling constraints. If specified, each of the key/value pairs are added to the calico-typha Deployment nodeSelector provided the key does not already exist in the object’s nodeSelector. If omitted, the calico-typha Deployment will use its default value for nodeSelector. WARNING: Please note that this field will modify the default calico-typha Deployment nodeSelector.
terminationGracePeriodSeconds int64	(Optional) Optional duration in seconds the pod needs to terminate gracefully. May be decreased in delete request. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). If this value is nil, the default grace period will be used instead. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. Defaults to 30 seconds.
topologySpreadConstraints []Kubernetes core/v1.TopologySpreadConstraint	(Optional) TopologySpreadConstraints describes how a group of pods ought to spread across topology domains. Scheduler will schedule pods in a way which abides by the constraints. All topologySpreadConstraints are ANDed.
tolerations []Kubernetes core/v1.Toleration	(Optional) Tolerations is the typha pod’s tolerations. If specified, this overrides any tolerations that may be set on the typha Deployment. If omitted, the typha Deployment will use its default value for tolerations. WARNING: Please note that this field will override the default calico-typha Deployment tolerations.

TyphaDeploymentPodTemplateSpec

(Appears on:

TyphaDeploymentSpec)

TyphaDeploymentPodTemplateSpec is the typha Deployment’s PodTemplateSpec

Field	Description
metadata Metadata	(Optional) Metadata is a subset of a Kubernetes object’s metadata that is added to the pod’s metadata.
spec TyphaDeploymentPodSpec	(Optional) Spec is the typha Deployment’s PodSpec.

TyphaDeploymentSpec

(Appears on:

TyphaDeployment)

TyphaDeploymentSpec defines configuration for the typha Deployment.

Field	Description
minReadySeconds int32	(Optional) MinReadySeconds is the minimum number of seconds for which a newly created Deployment pod should be ready without any of its container crashing, for it to be considered available. If specified, this overrides any minReadySeconds value that may be set on the typha Deployment. If omitted, the typha Deployment will use its default value for minReadySeconds.
template TyphaDeploymentPodTemplateSpec	(Optional) Template describes the typha Deployment pod that will be created.
strategy TyphaDeploymentStrategy	(Optional) The deployment strategy to use to replace existing pods with new ones.

TyphaDeploymentStrategy

(Appears on:

TyphaDeploymentSpec)

TyphaDeploymentStrategy describes how to replace existing pods with new ones. Only RollingUpdate is supported at this time so the Type field is not exposed.

Field	Description
rollingUpdate Kubernetes apps/v1.RollingUpdateDeployment	(Optional) Rolling update config params. Present only if DeploymentStrategyType = RollingUpdate. to be.

WAFStatusType (string alias)

(Appears on:

ApplicationLayerSpec)

WindowsDataplaneOption (string alias)

(Appears on:

CalicoNetworkSpec)

WindowsNodeSpec

(Appears on:

InstallationSpec)

Field	Description
cniBinDir string	(Optional) CNIBinDir is the path to the CNI binaries directory on Windows, it must match what is used as ‘bin_dir’ under [plugins] [plugins.“io.containerd.grpc.v1.cri”] [plugins.“io.containerd.grpc.v1.cri”.cni] on the containerd ‘config.toml’ file on the Windows nodes.
cniConfigDir string	(Optional) CNIConfigDir is the path to the CNI configuration directory on Windows, it must match what is used as ‘conf_dir’ under [plugins] [plugins.“io.containerd.grpc.v1.cri”] [plugins.“io.containerd.grpc.v1.cri”.cni] on the containerd ‘config.toml’ file on the Windows nodes.
cniLogDir string	(Optional) CNILogDir is the path to the Calico CNI logs directory on Windows.
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

---