Installation reference

Specification of the desired state for the Calico or Calico Enterprise installation.

Most recently observed state for the Calico or Calico Enterprise installation.

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 AKE, this field defaults to AzureVNET. For KubernetesProvider EKS, this field defaults to AmazonVPC. For all other KubernetesProviders 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

BGP configures whether or not to enable Calico’s BGP capabilities.

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 specifies the maximum transmission unit to use on the pod network. Default: 1410

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 specifies an approach to automatically detect node IPv6 addresses. If not specified, IPv6 addresses will not be auto-detected.

HostPorts configures whether or not Calico will support Kubernetes HostPorts. Valid only when using the Calico CNI plugin. Default: Enabled

MultiInterfaceMode configures what will configure multiple interface per pod. Only valid for Calico Enterprise installations using the Calico CNI plugin. Default: None

ContainerIPForwarding configures whether ip forwarding will be enabled for containers in the CNI configuration. Default: Disabled

ComponentName is an enum which identifies the component

ResourceRequirements allows customization of limits and requests for compute resources such as cpu and memory.

CIDR contains the address range for the IP Pool in classless inter-domain routing format.

Encapsulation specifies the encapsulation type that will be used with the IP Pool. Default: IPIP

NATOutgoing specifies if NAT will be enabled or disabled for outgoing traffic. Default: Enabled

NodeSelector specifies the node selector that will be set for the IP Pool. Default: ‘all()’

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)

Variant is the product to install - one of Calico or TigeraSecureEnterprise Default: Calico

Registry is the default Docker registry used for component Docker images. If specified, all images will be pulled from this registry. If not specified then the default registries will be used.

Image format: <registry>/<imagePath>/<imageName>:<image-tag>

This option allows configuring the <registry> portion of the above format.

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.

Image format: <registry>/<imagePath>/<imageName>:<image-tag>

This option allows configuring the <imagePath> portion of the above format.

ImagePullSecrets is an array of references to container registry pull secrets to use. These are applied to all images to be pulled.

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 specifies the CNI that will be used by this installation.

CalicoNetwork specifies networking configuration options for Calico.

ControlPlaneNodeSelector is used to select control plane nodes on which to run specific Calico components. This currently only applies to kube-controllers and the apiserver.

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.

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.

NodeUpdateStrategy can be used to customize the desired update strategy, such as the MaxUnavailable field.

ComponentResources can be used to customize the resource requirements for each component.

Variant is the most recently observed installed variant - one of Calico or TigeraSecureEnterprise

FirstFound uses default interface matching parameters to select an interface, performing best-effort filtering based on well-known interface names.

Interface enables IP auto-detection based on interfaces that match the given regex.

SkipInterface enables IP auto-detection based on interfaces that do not match the given regex.

CanReach enables IP auto-detection based on which source address on the node is used to reach the specified IP or domain.

The type of condition. May be Available, Progressing, or Degraded.

The status of the condition. May be True, False, or Unknown.

The timestamp representing the start time for the current status.

A brief reason explaining the condition.

Optionally, a detailed message providing additional context.

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