Felix configuration

A Felix configuration resource (FelixConfiguration) represents Felix configuration options for the cluster.

For kubectl commands, the following case-insensitive aliases may be used to specify the resource type on the CLI: felixconfiguration.projectcalico.org, felixconfigurations.projectcalico.org as well as abbreviations such as felixconfiguration.p and felixconfigurations.p.

See Configuring Felix for more details.

Sample YAML

apiVersion: projectcalico.org/v3
kind: FelixConfiguration
metadata:
  name: default
spec:
  ipv6Support: false
  ipipMTU: 1400
  chainInsertMode: Append

Felix configuration definition

Metadata

Field	Description	Accepted Values	Schema
name	Unique name to describe this resource instance. Required.	Alphanumeric string with optional ., _, or -.	string

• Calico Enterprise automatically creates a resource named default containing the global default configuration settings for Felix. You can use calicoctl to view and edit these settings
• The resources with the name node.<nodename> contain the node-specific overrides, and will be applied to the node <nodename>. When deleting a node the FelixConfiguration resource associated with the node will also be deleted.

Spec

Datastore connection

Process: Feature detection/overrides

featureDetectOverride

Attribute	Value
Key	featureDetectOverride
Description	Used to override feature detection based on auto-detected platform capabilities. Values are specified in a comma separated list with no spaces, example; "SNATFullyRandom=true,MASQFullyRandom=false,RestoreSupportsLock=". A value of "true" or "false" will force enable/disable feature, empty or omitted values fall back to auto-detection.
Schema	String matching the regular expression ^([a-zA-Z0-9-_]+=(true|false|),)*([a-zA-Z0-9-_]+=(true|false|))?$.
Default	none

featureGates

Attribute	Value
Key	featureGates
Description	Used to enable or disable tech-preview Calico features. Values are specified in a comma separated list with no spaces, example; "BPFConnectTimeLoadBalancingWorkaround=enabled,XyZ=false". This is used to enable features that are not fully production ready.
Schema	String matching the regular expression ^([a-zA-Z0-9-_]+=([^=]+),)*([a-zA-Z0-9-_]+=([^=]+))?$.
Default	none

Process: Go runtime

goGCThreshold

Attribute	Value
Key	goGCThreshold
Description	Sets the Go runtime's garbage collection threshold. I.e. the percentage that the heap is allowed to grow before garbage collection is triggered. In general, doubling the value halves the CPU time spent doing GC, but it also doubles peak GC memory overhead. A special value of -1 can be used to disable GC entirely; this should only be used in conjunction with the GoMemoryLimitMB setting. This setting is overridden by the GOGC environment variable.
Schema	Integer: [-1,263-1]
Default	40

goMaxProcs

Attribute	Value
Key	goMaxProcs
Description	Sets the maximum number of CPUs that the Go runtime will use concurrently. A value of -1 means "use the system default"; typically the number of real CPUs on the system. this setting is overridden by the GOMAXPROCS environment variable.
Schema	Integer: [-1,263-1]
Default	-1

goMemoryLimitMB

Attribute	Value
Key	goMemoryLimitMB
Description	Sets a (soft) memory limit for the Go runtime in MB. The Go runtime will try to keep its memory usage under the limit by triggering GC as needed. To avoid thrashing, it will exceed the limit if GC starts to take more than 50% of the process's CPU time. A value of -1 disables the memory limit. Note that the memory limit, if used, must be considerably less than any hard resource limit set at the container or pod level. This is because felix is not the only process that must run in the container or pod. This setting is overridden by the GOMEMLIMIT environment variable.
Schema	Integer: [-1,263-1]
Default	-1

Process: Health port and timeouts

healthEnabled

Attribute	Value
Key	healthEnabled
Description	If set to true, enables Felix's health port, which provides readiness and liveness endpoints.
Schema	Boolean.
Default	false

healthHost

Attribute	Value
Key	healthHost
Description	The host that the health server should bind to.
Schema	String.
Default	localhost

healthPort

Attribute	Value
Key	healthPort
Description	The TCP port that the health server should bind to.
Schema	Integer: [0,65535]
Default	9099

healthTimeoutOverrides

Attribute	Value
Key	healthTimeoutOverrides
Description	Allows the internal watchdog timeouts of individual subcomponents to be overridden. This is useful for working around "false positive" liveness timeouts that can occur in particularly stressful workloads or if CPU is constrained. For a list of active subcomponents, see Felix's logs.
Schema	List of health timeout overrides: [{name: "<name>", timeout: "<duration>"}, ...] where <duration> is in the Go duration format, for example 1m30s.
Default	none

Process: Logging

logDebugFilenameRegex

Attribute	Value
Key	logDebugFilenameRegex
Description	Controls which source code files have their Debug log output included in the logs. Only logs from files with names that match the given regular expression are included. The filter only applies to Debug level logs.
Schema	String.
Default	none

logDropActionOverride

Attribute	Value
Key	logDropActionOverride
Description	Specifies whether or not to include the DropActionOverride in the logs when it is triggered.
Schema	Boolean.
Default	false

logFilePath

Attribute	Value
Key	logFilePath
Description	The full path to the Felix log. Set to none to disable file logging.
Schema	String.
Default	/var/log/calico/felix.log

logPrefix

Attribute	Value
Key	logPrefix
Description	The log prefix that Felix uses when rendering LOG rules.
Schema	String.
Default	calico-packet

logSeverityFile

Attribute	Value
Key	logSeverityFile
Description	The log severity above which logs are sent to the log file.
Schema	One of: Debug, Error, Fatal, Info, Trace, Warning.
Default	Info

logSeverityScreen

Attribute	Value
Key	logSeverityScreen
Description	The log severity above which logs are sent to the stdout.
Schema	One of: Debug, Error, Fatal, Info, Trace, Warning.
Default	Info

logSeveritySys

Attribute	Value
Key	logSeveritySys
Description	The log severity above which logs are sent to the syslog. Set to None for no logging to syslog.
Schema	One of: Debug, Error, Fatal, Info, Trace, Warning.
Default	Info

Process: Prometheus metrics

prometheusGoMetricsEnabled

Attribute	Value
Key	prometheusGoMetricsEnabled
Description	Disables Go runtime metrics collection, which the Prometheus client does by default, when set to false. This reduces the number of metrics reported, reducing Prometheus load.
Schema	Boolean.
Default	true

prometheusMetricsCAFile

Attribute	Value
Key	prometheusMetricsCAFile
Description	The path to the TLS CA file for the Prometheus metrics server.
Schema	String.
Default	none

prometheusMetricsCertFile

Attribute	Value
Key	prometheusMetricsCertFile
Description	The path to the TLS certificate file for the Prometheus metrics server.
Schema	String.
Default	none

prometheusMetricsEnabled

Attribute	Value
Key	prometheusMetricsEnabled
Description	Enables the Prometheus metrics server in Felix if set to true.
Schema	Boolean.
Default	false

prometheusMetricsHost

Attribute	Value
Key	prometheusMetricsHost
Description	The host that the Prometheus metrics server should bind to.
Schema	String.
Default	none

prometheusMetricsKeyFile

Attribute	Value
Key	prometheusMetricsKeyFile
Description	The path to the TLS private key file for the Prometheus metrics server.
Schema	String.
Default	none

prometheusMetricsPort

Attribute	Value
Key	prometheusMetricsPort
Description	The TCP port that the Prometheus metrics server should bind to.
Schema	Integer: [0,65535]
Default	9091

prometheusProcessMetricsEnabled

Attribute	Value
Key	prometheusProcessMetricsEnabled
Description	Disables process metrics collection, which the Prometheus client does by default, when set to false. This reduces the number of metrics reported, reducing Prometheus load.
Schema	Boolean.
Default	true

prometheusWireGuardMetricsEnabled

Attribute	Value
Key	prometheusWireGuardMetricsEnabled
Description	Disables wireguard metrics collection, which the Prometheus client does by default, when set to false. This reduces the number of metrics reported, reducing Prometheus load.
Schema	Boolean.
Default	true

Data plane: Common

No matching group found for 'Data plane: Common'.

Data plane: iptables

No matching group found for 'Data plane: iptables'.

Data plane: nftables

No matching group found for 'Data plane: nftables'.

Data plane: eBPF

No matching group found for 'Data plane: eBPF'.

Data plane: Windows

No matching group found for 'Data plane: Windows'.

Data plane: OpenStack support

No matching group found for 'Data plane: OpenStack support'.

Data plane: XDP acceleration for iptables data plane

No matching group found for 'Data plane: XDP acceleration for iptables data plane'.

Overlay: VXLAN overlay

vxlanEnabled

Attribute	Value
Key	vxlanEnabled
Description	Overrides whether Felix should create the VXLAN tunnel device for IPv4 VXLAN networking. Optional as Felix determines this based on the existing IP pools.
Schema	Boolean.
Default	none

vxlanMTU

Attribute	Value
Key	vxlanMTU
Description	The MTU to set on the IPv4 VXLAN tunnel device. Optional as Felix auto-detects the MTU based on the MTU of the host's interfaces.
Schema	Integer
Default	0

vxlanMTUV6

Attribute	Value
Key	vxlanMTUV6
Description	The MTU to set on the IPv6 VXLAN tunnel device. Optional as Felix auto-detects the MTU based on the MTU of the host's interfaces.
Schema	Integer
Default	0

vxlanPort

Attribute	Value
Key	vxlanPort
Description	The UDP port number to use for VXLAN traffic.
Schema	Integer
Default	4789

vxlanVNI

Attribute	Value
Key	vxlanVNI
Description	The VXLAN VNI to use for VXLAN traffic. You may need to change this if the default value is in use on your system.
Schema	Integer
Default	4096

Overlay: IP-in-IP

ipipEnabled

Attribute	Value
Key	ipipEnabled
Description	Overrides whether Felix should configure an IPIP interface on the host. Optional as Felix determines this based on the existing IP pools.
Schema	Boolean.
Default	none

ipipMTU

Attribute	Value
Key	ipipMTU
Description	Controls the MTU to set on the IPIP tunnel device. Optional as Felix auto-detects the MTU based on the MTU of the host's interfaces.
Schema	Integer
Default	0

Overlay: WireGuard

No matching group found for 'Overlay: WireGuard'.

Overlay: IPSec

ipsecAllowUnsecuredTraffic

Attribute	Value
Key	ipsecAllowUnsecuredTraffic
Description	Controls whether non-IPsec traffic is allowed in addition to IPsec traffic. Enabling this negates the anti-spoofing protections of IPsec but it is useful when migrating to/from IPsec.
Schema	Boolean.
Default	false

ipsecESPAlgorithm

Attribute	Value
Key	ipsecESPAlgorithm
Description	IPSecESAlgorithm sets IPSec ESP algorithm. Default is NIST suite B recommendation.
Schema	String.
Default	aes128gcm16-ecp256

ipsecIKEAlgorithm

Attribute	Value
Key	ipsecIKEAlgorithm
Description	Sets IPSec IKE algorithm. Default is NIST suite B recommendation.
Schema	String.
Default	aes128gcm16-prfsha256-ecp256

ipsecLogLevel

Attribute	Value
Key	ipsecLogLevel
Description	Controls log level for IPSec components. Set to None for no logging. A generic log level terminology is used [None, Notice, Info, Debug, Verbose].
Schema	One of: Debug, Info, None, Notice, Verbose.
Default	Info

ipsecMode

Attribute	Value
Key	ipsecMode
Description	Controls which mode IPSec is operating on. Default value means IPSec is not enabled.
Schema	String.
Default	none

ipsecPolicyRefreshInterval

Attribute	Value
Key	ipsecPolicyRefreshInterval
Description	The interval at which Felix will check the kernel's IPsec policy tables and repair any inconsistencies.
Schema	Duration string, for example 1m30s123ms or 1h5m.
Default	10m0s

Flow logs: Prometheus reports

deletedMetricsRetentionSecs

Attribute	Value
Key	deletedMetricsRetentionSecs
Description	Controls how long metrics are retianed after the flow is gone.
Schema	Integer.
Default	30s

prometheusReporterCAFile

Attribute	Value
Key	prometheusReporterCAFile
Description	The path to the TLS CA file for the Prometheus per-flow metrics reporter.
Schema	String.
Default	none

prometheusReporterCertFile

Attribute	Value
Key	prometheusReporterCertFile
Description	The path to the TLS certificate file for the Prometheus per-flow metrics reporter.
Schema	String.
Default	none

prometheusReporterEnabled

Attribute	Value
Key	prometheusReporterEnabled
Description	Controls whether the Prometheus per-flow metrics reporter is enabled. This is used to show real-time flow metrics in the UI.
Schema	Boolean.
Default	false

prometheusReporterKeyFile

Attribute	Value
Key	prometheusReporterKeyFile
Description	The path to the TLS private key file for the Prometheus per-flow metrics reporter.
Schema	String.
Default	none

prometheusReporterPort

Attribute	Value
Key	prometheusReporterPort
Description	The port that the Prometheus per-flow metrics reporter should bind to.
Schema	Integer: [0,65535]
Default	9092

Flow logs: Syslog reports

syslogReporterAddress

Attribute	Value
Key	syslogReporterAddress
Description	The address to dial to when writing to Syslog. For TCP and UDP networks, the address has the form "host:port". The host must be a literal IP address, or a host name that can be resolved to IP addresses. The port must be a literal port number or a service name. For more, see: https://pkg.go.dev/net#Dial.
Schema	String.
Default	none

syslogReporterEnabled

Attribute	Value
Key	syslogReporterEnabled
Description	Turns on the feature to write logs to Syslog. Please note that this can incur significant disk space usage when running felix on non-cluster hosts.
Schema	Boolean.
Default	false

syslogReporterNetwork

Attribute	Value
Key	syslogReporterNetwork
Description	The network to dial to when writing to Syslog. Known networks are "tcp", "tcp4" (IPv4-only), "tcp6" (IPv6-only), "udp", "udp4" (IPv4-only), "udp6" (IPv6-only), "ip", "ip4" (IPv4-only), "ip6" (IPv6-only), "unix", "unixgram" and "unixpacket". For more, see: https://pkg.go.dev/net#Dial.
Schema	String.
Default	none

Flow logs: file reports

flowLogsAggregationThresholdBytes

Attribute	Value
Key	flowLogsAggregationThresholdBytes
Description	Used specify how far behind the external pipeline that reads flow logs can be. Default is 8192 bytes. This parameter only takes effect when FlowLogsDynamicAggregationEnabled is set to true.
Schema	Integer
Default	8192

flowLogsCollectProcessInfo

Attribute	Value
Key	flowLogsCollectProcessInfo
Description	If enabled Felix will load the kprobe BPF programs to collect process info.
Schema	Boolean.
Default	false

flowLogsCollectProcessPath

Attribute	Value
Key	flowLogsCollectProcessPath
Description	When FlowLogsCollectProcessPath and FlowLogsCollectProcessInfo are both enabled, each flow log will include information about the process that is sending or receiving the packets in that flow: the process_name field will contain the full path of the process executable, and the process_args field will have the arguments with which the executable was invoked. Process information will not be reported for connections which use raw sockets.
Schema	Boolean.
Default	false

flowLogsCollectTcpStats

Attribute	Value
Key	flowLogsCollectTcpStats
Description	Enables flow logs reporting TCP socket stats.
Schema	Boolean.
Default	false

flowLogsCollectorDebugTrace

Attribute	Value
Key	flowLogsCollectorDebugTrace
Description	When FlowLogsCollectorDebugTrace is set to true, enables the logs in the collector to be printed in their entirety.
Schema	Boolean.
Default	false

flowLogsDestDomainsByClient

Attribute	Value
Key	flowLogsDestDomainsByClient
Description	Used to configure if the source IP is used in the mapping of top level destination domains.
Schema	Boolean.
Default	true

flowLogsDynamicAggregationEnabled

Attribute	Value
Key	flowLogsDynamicAggregationEnabled
Description	Used to enable/disable dynamically changing aggregation levels. Default is true.
Schema	Boolean.
Default	false

flowLogsEnableHostEndpoint

Attribute	Value
Key	flowLogsEnableHostEndpoint
Description	Enables Flow logs reporting for HostEndpoints.
Schema	Boolean.
Default	false

flowLogsEnableNetworkSets

Attribute	Value
Key	flowLogsEnableNetworkSets
Description	Enables Flow logs reporting for GlobalNetworkSets.
Schema	Boolean.
Default	false

flowLogsFileAggregationKindForAllowed

Attribute	Value
Key	flowLogsFileAggregationKindForAllowed
Description	Used to choose the type of aggregation for flow log entries created for allowed connections. . Accepted values are 0, 1 and 2. 0 - No aggregation. 1 - Source port based aggregation. 2 - Pod prefix name based aggreagation.
Schema	One of: 0, 1, 2.
Default	2

flowLogsFileAggregationKindForDenied

Attribute	Value
Key	flowLogsFileAggregationKindForDenied
Description	Used to choose the type of aggregation for flow log entries created for denied connections. . Accepted values are 0, 1 and 2. 0 - No aggregation. 1 - Source port based aggregation. 2 - Pod prefix name based aggregation. 3 - No destination ports based aggregation.
Schema	One of: 0, 1, 2, 3.
Default	1

flowLogsFileDirectory

Attribute	Value
Key	flowLogsFileDirectory
Description	Sets the directory where flow logs files are stored.
Schema	String.
Default	/var/log/calico/flowlogs

flowLogsFileDomainsLimit

Attribute	Value
Key	flowLogsFileDomainsLimit
Description	Used to configure the number of (destination) domains to include in the flow log. These are not included for workload or host endpoint destinations.
Schema	Integer
Default	5

flowLogsFileEnabled

Attribute	Value
Key	flowLogsFileEnabled
Description	When set to true, enables logging flow logs to a file. If false no flow logging to file will occur.
Schema	Boolean.
Default	false

flowLogsFileEnabledForAllowed

Attribute	Value
Key	flowLogsFileEnabledForAllowed
Description	Used to enable/disable flow logs entries created for allowed connections. Default is true. This parameter only takes effect when FlowLogsFileReporterEnabled is set to true.
Schema	Boolean.
Default	true

flowLogsFileEnabledForDenied

Attribute	Value
Key	flowLogsFileEnabledForDenied
Description	Used to enable/disable flow logs entries created for denied flows. Default is true. This parameter only takes effect when FlowLogsFileReporterEnabled is set to true.
Schema	Boolean.
Default	true

flowLogsFileIncludeLabels

Attribute	Value
Key	flowLogsFileIncludeLabels
Description	Used to configure if endpoint labels are included in a Flow log entry written to file.
Schema	Boolean.
Default	false

flowLogsFileIncludePolicies

Attribute	Value
Key	flowLogsFileIncludePolicies
Description	Used to configure if policy information are included in a Flow log entry written to file.
Schema	Boolean.
Default	false

flowLogsFileIncludeService

Attribute	Value
Key	flowLogsFileIncludeService
Description	Used to configure if the destination service is included in a Flow log entry written to file. The service information can only be included if the flow was explicitly determined to be directed at the service (e.g. when the pre-DNAT destination corresponds to the service ClusterIP and port).
Schema	Boolean.
Default	false

flowLogsFileMaxFileSizeMB

Attribute	Value
Key	flowLogsFileMaxFileSizeMB
Description	Sets the max size in MB of flow logs files before rotation.
Schema	Integer
Default	100

flowLogsFileMaxFiles

Attribute	Value
Key	flowLogsFileMaxFiles
Description	Sets the number of log files to keep.
Schema	Integer
Default	5

flowLogsFileNatOutgoingPortLimit

Attribute	Value
Key	flowLogsFileNatOutgoingPortLimit
Description	Used to specify the maximum number of distinct post SNAT ports that will appear in the flowLogs. Default value is 3.
Schema	Integer
Default	3

flowLogsFilePerFlowProcessArgsLimit

Attribute	Value
Key	flowLogsFilePerFlowProcessArgsLimit
Description	Used to specify the maximum number of distinct process args that will appear in the flowLogs. Default value is 5.
Schema	Integer
Default	5

flowLogsFilePerFlowProcessLimit

Attribute	Value
Key	flowLogsFilePerFlowProcessLimit
Description	Used to specify the maximum number of flow log entries with distinct process information beyond which process information will be aggregated.
Schema	Integer
Default	2

flowLogsFlushInterval

Attribute	Value
Key	flowLogsFlushInterval
Description	Configures the interval at which Felix exports flow logs.
Schema	Duration string, for example 1m30s123ms or 1h5m.
Default	5m0s

flowLogsGoldmaneServer

Attribute	Value
Key	flowLogsGoldmaneServer
Description	FlowLogGoldmaneServer is the flow server endpoint to which flow data should be published.
Schema	String.
Default	none

flowLogsLocalReporter

Attribute	Value
Key	flowLogsLocalReporter
Description	Configures local unix socket for reporting flow data from each node.
Schema	One of: "Disabled", "Enabled".
Default	Disabled

flowLogsMaxOriginalIPsIncluded

Attribute	Value
Key	flowLogsMaxOriginalIPsIncluded
Description	Specifies the number of unique IP addresses (if relevant) that should be included in Flow logs.
Schema	Integer
Default	50

flowLogsPolicyEvaluationMode

Attribute	Value
Key	flowLogsPolicyEvaluationMode
Description	Defines how policies are evaluated and reflected in flow logs. OnNewConnection - In this mode, staged policies are only evaluated when new connections are made in the dataplane. Staged/active policy changes will not be reflected in the pending_policies field of flow logs for long lived connections. Continuous - Felix evaluates active flows on a regular basis to determine the rule traces in the flow logs. Any policy updates that impact a flow will be reflected in the pending_policies field, offering a near-real-time view of policy changes across flows.
Schema	String.
Default	Continuous

flowLogsPolicyScope

Attribute	Value
Key	flowLogsPolicyScope
Description	Controls which policies are included in flow logs. AllPolicies - Processes both transit policies for the local node and endpoint policies derived from packet source/destination IPs. Provides comprehensive visibility into all policy evaluations but increases log volume. EndpointPolicies - Processes only policies for endpoints identified as the source or destination of the packet (whether workload or host endpoints).
Schema	String.
Default	EndpointPolicies

flowLogsPositionFilePath

Attribute	Value
Key	flowLogsPositionFilePath
Description	Used specify the position of the external pipeline that reads flow logs. Default is /var/log/calico/flows.log.pos. This parameter only takes effect when FlowLogsDynamicAggregationEnabled is set to true.
Schema	String.
Default	/var/log/calico/flows.log.pos

DNS logs / policy

dnsCacheEpoch

Attribute	Value
Key	dnsCacheEpoch
Description	An arbitrary number that can be changed, at runtime, to tell Felix to discard all its learnt DNS information. .
Schema	Integer
Default	0

dnsCacheFile

Attribute	Value
Key	dnsCacheFile
Description	The name of the file that Felix uses to preserve learnt DNS information when restarting. .
Schema	String.
Default	/var/run/calico/felix-dns-cache.txt

dnsCacheSaveInterval

Attribute	Value
Key	dnsCacheSaveInterval
Description	The periodic interval at which Felix saves learnt DNS information to the cache file. .
Schema	Duration string, for example 1m30s123ms or 1h5m.
Default	1m0s

dnsExtraTTL

Attribute	Value
Key	dnsExtraTTL
Description	Extra time to keep IPs and alias names that are learnt from DNS, in addition to each name or IP's advertised TTL. .
Schema	Duration string, for example 1m30s123ms or 1h5m.
Default	0s

dnsLogsFileAggregationKind

Attribute	Value
Key	dnsLogsFileAggregationKind
Description	Used to choose the type of aggregation for DNS log entries. . Accepted values are 0 and 1. 0 - No aggregation. 1 - Aggregate over clients with the same name prefix.
Schema	One of: 0, 1.
Default	1

dnsLogsFileDirectory

Attribute	Value
Key	dnsLogsFileDirectory
Description	Sets the directory where DNS log files are stored.
Schema	String.
Default	/var/log/calico/dnslogs

dnsLogsFileEnabled

Attribute	Value
Key	dnsLogsFileEnabled
Description	Controls logging DNS logs to a file. If false no DNS logging to file will occur.
Schema	Boolean.
Default	false

dnsLogsFileIncludeLabels

Attribute	Value
Key	dnsLogsFileIncludeLabels
Description	Used to configure if endpoint labels are included in a DNS log entry written to file.
Schema	Boolean.
Default	true

dnsLogsFileMaxFileSizeMB

Attribute	Value
Key	dnsLogsFileMaxFileSizeMB
Description	Sets the max size in MB of DNS log files before rotation.
Schema	Integer
Default	100

dnsLogsFileMaxFiles

Attribute	Value
Key	dnsLogsFileMaxFiles
Description	Sets the number of DNS log files to keep.
Schema	Integer
Default	5

dnsLogsFilePerNodeLimit

Attribute	Value
Key	dnsLogsFilePerNodeLimit
Description	Limit on the number of DNS logs that can be emitted within each flush interval. When this limit has been reached, Felix counts the number of unloggable DNS responses within the flush interval, and emits a WARNING log with that count at the same time as it flushes the buffered DNS logs.
Schema	Integer
Default	0

dnsLogsFlushInterval

Attribute	Value
Key	dnsLogsFlushInterval
Description	Configures the interval at which Felix exports DNS logs.
Schema	Duration string, for example 1m30s123ms or 1h5m.
Default	5m0s

dnsLogsLatency

Attribute	Value
Key	dnsLogsLatency
Description	Indicates to include measurements of DNS request/response latency in each DNS log.
Schema	Boolean.
Default	true

dnsPacketsNfqueueID

Attribute	Value
Key	dnsPacketsNfqueueID
Description	The NFQUEUE ID to use for capturing DNS packets to ensure programming IPSets occurs before the response is released. Used when DNSPolicyMode is DelayDNSResponse.
Schema	Integer
Default	101

dnsPacketsNfqueueMaxHoldDuration

Attribute	Value
Key	dnsPacketsNfqueueMaxHoldDuration
Description	The max length of time to hold on to a DNS response while waiting for the the dataplane to be programmed. Used when DNSPolicyMode is DelayDNSResponse.
Schema	Duration string, for example 1m30s123ms or 1h5m.
Default	3s

dnsPacketsNfqueueSize

Attribute	Value
Key	dnsPacketsNfqueueSize
Description	The size of the NFQUEUE for captured DNS packets. This is the maximum number of DNS packets that may be queued awaiting programming in the dataplane. Used when DNSPolicyMode is DelayDNSResponse.
Schema	Integer
Default	100

dnsPolicyMode

Attribute	Value
Key	dnsPolicyMode
Description	Specifies how DNS policy programming will be handled. DelayDeniedPacket - Felix delays any denied packet that traversed a policy that included egress domain matches, but did not match. The packet is released after a fixed time, or after the destination IP address was programmed. DelayDNSResponse - Felix delays any DNS response until related IPSets are programmed. This introduces some latency to all DNS packets (even when no IPSet programming is required), but it ensures policy hit statistics are accurate. This is the recommended setting when you are making use of staged policies or policy rule hit statistics. NoDelay - Felix does not introduce any delay to the packets. DNS rules may not have been programmed by the time the first packet traverses the policy rules. Client applications need to handle reconnection attempts if initial connection attempts fail. This may be problematic for some applications or for very low DNS TTLs. Inline - Parses DNS response inline with DNS response packet processing within IPTables. This guarantees the DNS rules reflect any change immediately. This mode works for iptables only and matches the same mode for BPFDNSPolicyMode. This setting is ignored on Windows and "NoDelay" is always used. This setting is ignored by eBPF and BPFDNSPolicyMode is used instead. This field has no effect in NFTables mode. Please use NFTablesDNSPolicyMode instead.
Schema	One of: "DelayDNSResponse", "DelayDeniedPacket", "Inline", "NoDelay".
Default	DelayDeniedPacket

dnsPolicyNfqueueID

Attribute	Value
Key	dnsPolicyNfqueueID
Description	The NFQUEUE ID to use for DNS Policy re-evaluation when the domains IP hasn't been programmed to ipsets yet. Used when DNSPolicyMode is DelayDeniedPacket.
Schema	Integer
Default	100

dnsPolicyNfqueueSize

Attribute	Value
Key	dnsPolicyNfqueueSize
Description	DNSPolicyNfqueueID is the size of the NFQUEUE for DNS policy re-evaluation. This is the maximum number of denied packets that may be queued up pending re-evaluation. Used when DNSPolicyMode is DelayDeniedPacket.
Schema	Integer
Default	255

dnsTrustedServers

Attribute	Value
Key	dnsTrustedServers
Description	The DNS servers that Felix should trust. Each entry here must be <ip>[:<port>] - indicating an explicit DNS server IP - or k8s-service:[<namespace>/]<name>[:port] - indicating a Kubernetes DNS service. <port> defaults to the first service port, or 53 for an IP, and <namespace> to kube-system. An IPv6 address with a port must use the square brackets convention, for example [fd00:83a6::12]:5353.Note that Felix (calico-node) will need RBAC permission to read the details of each service specified by a k8s-service:... form. .
Schema	List of strings: ["<string>", ...].
Default	none

L7 logs

l7LogsFileAggregationDestinationInfo

Attribute	Value
Key	l7LogsFileAggregationDestinationInfo
Description	Used to choose the type of aggregation for the destination metadata on L7 log entries. . Accepted values are IncludeL7DestinationInfo and ExcludeL7DestinationInfo. IncludeL7DestinationInfo - Include destination metadata in the logs. ExcludeL7DestinationInfo - Aggregate over all other fields ignoring the destination aggregated name, namespace, and type.
Schema	One of: ExcludeL7DestinationInfo, IncludeL7DestinationInfo.
Default	IncludeL7DestinationInfo

l7LogsFileAggregationHTTPHeaderInfo

Attribute	Value
Key	l7LogsFileAggregationHTTPHeaderInfo
Description	Used to choose the type of aggregation for HTTP header data on L7 log entries. . Accepted values are IncludeL7HTTPHeaderInfo and ExcludeL7HTTPHeaderInfo. IncludeL7HTTPHeaderInfo - Include HTTP header data in the logs. ExcludeL7HTTPHeaderInfo - Aggregate over all other fields ignoring the user agent and log type.
Schema	One of: ExcludeL7HTTPHeaderInfo, IncludeL7HTTPHeaderInfo.
Default	ExcludeL7HTTPHeaderInfo

l7LogsFileAggregationHTTPMethod

Attribute	Value
Key	l7LogsFileAggregationHTTPMethod
Description	Used to choose the type of aggregation for the HTTP request method on L7 log entries. . Accepted values are IncludeL7HTTPMethod and ExcludeL7HTTPMethod. IncludeL7HTTPMethod - Include HTTP method in the logs. ExcludeL7HTTPMethod - Aggregate over all other fields ignoring the HTTP method.
Schema	One of: ExcludeL7HTTPMethod, IncludeL7HTTPMethod.
Default	IncludeL7HTTPMethod

l7LogsFileAggregationNumURLPath

Attribute	Value
Key	l7LogsFileAggregationNumURLPath
Description	Used to choose the number of components in the url path to display. This allows for the url to be truncated in case parts of the path provide no value. Setting this value to negative will allow all parts of the path to be displayed. .
Schema	Integer
Default	5

l7LogsFileAggregationResponseCode

Attribute	Value
Key	l7LogsFileAggregationResponseCode
Description	Used to choose the type of aggregation for the response code on L7 log entries. . Accepted values are IncludeL7ResponseCode and ExcludeL7ResponseCode. IncludeL7ResponseCode - Include the response code in the logs. ExcludeL7ResponseCode - Aggregate over all other fields ignoring the response code.
Schema	One of: ExcludeL7ResponseCode, IncludeL7ResponseCode.
Default	IncludeL7ResponseCode

l7LogsFileAggregationServiceInfo

Attribute	Value
Key	l7LogsFileAggregationServiceInfo
Description	Used to choose the type of aggregation for the service data on L7 log entries. . Accepted values are IncludeL7ServiceInfo and ExcludeL7ServiceInfo. IncludeL7ServiceInfo - Include service data in the logs. ExcludeL7ServiceInfo - Aggregate over all other fields ignoring the service name, namespace, and port.
Schema	One of: ExcludeL7ServiceInfo, IncludeL7ServiceInfo.
Default	IncludeL7ServiceInfo

l7LogsFileAggregationSourceInfo

Attribute	Value
Key	l7LogsFileAggregationSourceInfo
Description	L7LogsFileAggregationExcludeSourceInfo is used to choose the type of aggregation for the source metadata on L7 log entries. . Accepted values are IncludeL7SourceInfo, IncludeL7SourceInfoNoPort, and ExcludeL7SourceInfo. IncludeL7SourceInfo - Include source metadata in the logs. IncludeL7SourceInfoNoPort - Include source metadata in the logs excluding the source port. ExcludeL7SourceInfo - Aggregate over all other fields ignoring the source aggregated name, namespace, and type.
Schema	One of: ExcludeL7SourceInfo, IncludeL7SourceInfo, IncludeL7SourceInfoNoPort.
Default	IncludeL7SourceInfoNoPort

l7LogsFileAggregationTrimURL

Attribute	Value
Key	l7LogsFileAggregationTrimURL
Description	Used to choose the type of aggregation for the url on L7 log entries. . Accepted values: IncludeL7FullURL - Include the full URL up to however many path components are allowed by L7LogsFileAggregationNumURLPath. TrimURLQuery - Aggregate over all other fields ignoring the query parameters on the URL. TrimURLQueryAndPath - Aggregate over all other fields and the base URL only. ExcludeL7URL - Aggregate over all other fields ignoring the URL entirely.
Schema	One of: ExcludeL7URL, IncludeL7FullURL, TrimURLQuery, TrimURLQueryAndPath.
Default	IncludeL7FullURL

l7LogsFileAggregationURLCharLimit

Attribute	Value
Key	l7LogsFileAggregationURLCharLimit
Description	Limit on the length of the URL collected in L7 logs. When a URL length reaches this limit it is sliced off, and the sliced URL is sent to log storage.
Schema	Integer
Default	250

l7LogsFileDirectory

Attribute	Value
Key	l7LogsFileDirectory
Description	Sets the directory where L7 log files are stored.
Schema	String.
Default	/var/log/calico/l7logs

l7LogsFileEnabled

Attribute	Value
Key	l7LogsFileEnabled
Description	Controls logging L7 logs to a file. If false no L7 logging to file will occur.
Schema	Boolean.
Default	true

l7LogsFileMaxFileSizeMB

Attribute	Value
Key	l7LogsFileMaxFileSizeMB
Description	Sets the max size in MB of L7 log files before rotation.
Schema	Integer
Default	100

l7LogsFileMaxFiles

Attribute	Value
Key	l7LogsFileMaxFiles
Description	Sets the number of L7 log files to keep.
Schema	Integer
Default	5

l7LogsFilePerNodeLimit

Attribute	Value
Key	l7LogsFilePerNodeLimit
Description	Limit on the number of L7 logs that can be emitted within each flush interval. When this limit has been reached, Felix counts the number of unloggable L7 responses within the flush interval, and emits a WARNING log with that count at the same time as it flushes the buffered L7 logs. A value of 0 means no limit.
Schema	Integer
Default	1500

l7LogsFlushInterval

Attribute	Value
Key	l7LogsFlushInterval
Description	Configures the interval at which Felix exports L7 logs.
Schema	Duration string, for example 1m30s123ms or 1h5m.
Default	5m0s

AWS integration

awsRequestTimeout

Attribute	Value
Key	awsRequestTimeout
Description	The timeout on AWS API requests.
Schema	Duration string, for example 1m30s123ms or 1h5m.
Default	30s

awsSecondaryIPRoutingRulePriority

Attribute	Value
Key	awsSecondaryIPRoutingRulePriority
Description	Controls the priority that Felix will use for routing rules when programming them for AWS Secondary IP support.
Schema	Integer: [0,4294967295]
Default	101

awsSecondaryIPSupport

Attribute	Value
Key	awsSecondaryIPSupport
Description	Controls whether Felix will try to provision AWS secondary ENIs for workloads that have IPs from IP pools that are configured with an AWS subnet ID. If the field is set to "EnabledENIPerWorkload" then each workload with an AWS-backed IP will be assigned its own secondary ENI. If set to "Enabled" then each workload with an AWS-backed IP pool will be allocated a secondary IP address on a secondary ENI; this mode requires additional IP pools to be provisioned for the host to claim IPs for the primary IP of the secondary ENIs. Accepted value must be one of "Enabled", "EnabledENIPerWorkload" or "Disabled".
Schema	One of: Disabled, Enabled, EnabledENIPerWorkload.
Default	Disabled

awsSrcDstCheck

Attribute	Value
Key	awsSrcDstCheck
Description	Controls whether Felix will try to change the "source/dest check" setting on the EC2 instance on which it is running. A value of "Disable" will try to disable the source/dest check. Disabling the check allows for sending workload traffic without encapsulation within the same AWS subnet.
Schema	One of: "Disable", "DoNothing", "Enable".
Default	DoNothing

Egress gateway

egressGatewayPollFailureCount

Attribute	Value
Key	egressGatewayPollFailureCount
Description	The minimum number of poll failures before a remote Egress Gateway is considered to have failed.
Schema	Integer
Default	3

egressGatewayPollInterval

Attribute	Value
Key	egressGatewayPollInterval
Description	The interval at which Felix will poll remote egress gateways to check their health. Only Egress Gateways with a named "health" port will be polled in this way. Egress Gateways that fail the health check will be taken our of use as if they have been deleted.
Schema	Duration string, for example 1m30s123ms or 1h5m.
Default	10s

egressIPHostIfacePattern

Attribute	Value
Key	egressIPHostIfacePattern
Description	A comma-separated list of interface names which might send and receive egress traffic across the cluster boundary, after it has left an Egress Gateway pod. Felix will ensure src_valid_mark sysctl flags are set correctly for matching interfaces. To target multiple interfaces with a single string, the list supports regular expressions. For regular expressions, wrap the value with /. Example: /^bond/,eth0 will match all interfaces that begin with bond and also the interface eth0.
Schema	String.
Default	none

egressIPRoutingRulePriority

Attribute	Value
Key	egressIPRoutingRulePriority
Description	Controls the priority value to use for the egress IP routing rule.
Schema	Integer
Default	100

egressIPSupport

Attribute	Value
Key	egressIPSupport
Description	Defines three different support modes for egress IP function. - Disabled: Egress IP function is disabled. - EnabledPerNamespace: Egress IP function is enabled and can be configured on a per-namespace basis; per-pod egress annotations are ignored. - EnabledPerNamespaceOrPerPod: Egress IP function is enabled and can be configured per-namespace or per-pod, with per-pod egress annotations overriding namespace annotations.
Schema	One of: Disabled, EnabledPerNamespace, EnabledPerNamespaceOrPerPod.
Default	Disabled

egressIPVXLANPort

Attribute	Value
Key	egressIPVXLANPort
Description	The port number of vxlan tunnel device for egress traffic.
Schema	Integer
Default	4790

egressIPVXLANVNI

Attribute	Value
Key	egressIPVXLANVNI
Description	The VNI ID of vxlan tunnel device for egress traffic.
Schema	Integer
Default	4097

External network support

externalNetworkRoutingRulePriority

Attribute	Value
Key	externalNetworkRoutingRulePriority
Description	Controls the priority value to use for the external network routing rule.
Schema	Integer
Default	102

externalNetworkSupport

Attribute	Value
Key	externalNetworkSupport
Description	Defines two different support modes for external network function. - Disabled: External network function is disabled. - Enabled: External network function is enabled.
Schema	One of: Disabled, Enabled.
Default	Disabled

Packet capture

captureDir

Attribute	Value
Key	captureDir
Description	Controls directory to store file capture.
Schema	String.
Default	/var/log/calico/pcap

captureMaxFiles

Attribute	Value
Key	captureMaxFiles
Description	Controls number of rotated capture file to keep.
Schema	Integer
Default	2

captureMaxSizeBytes

Attribute	Value
Key	captureMaxSizeBytes
Description	Controls the max size of a file capture.
Schema	Integer
Default	10000000

captureRotationSeconds

Attribute	Value
Key	captureRotationSeconds
Description	Controls the time rotation of a packet capture.
Schema	Integer
Default	3600

L7 proxy

tproxyMode

Attribute	Value
Key	tproxyMode
Description	Sets whether traffic is directed through a transparent proxy for further processing or not and how is the proxying done.
Schema	One of: Disabled, Enabled, EnabledAllServices.
Default	Disabled

tproxyPort

Attribute	Value
Key	tproxyPort
Description	Sets to which port proxied traffic should be redirected.
Schema	Integer
Default	16001

tproxyUpstreamConnMark

Attribute	Value
Key	tproxyUpstreamConnMark
Description	Tells Felix which mark is used by the proxy for its upstream connections so that Felix can program the dataplane correctly.
Schema	Unsigned 32-bit integer.
Default	0x17

Debug/test-only (generally unsupported)

debugDisableLogDropping

Attribute	Value
Key	debugDisableLogDropping
Description	Disables the dropping of log messages when the log buffer is full. This can significantly impact performance if log write-out is a bottleneck.
Schema	Boolean.
Default	false

debugHost

Attribute	Value
Key	debugHost
Description	The host IP or hostname to bind the debug port to. Only used if DebugPort is set.
Schema	String.
Default	localhost

debugMemoryProfilePath

Attribute	Value
Key	debugMemoryProfilePath
Description	The path to write the memory profile to when triggered by signal.
Schema	String.
Default	none

debugPort

Attribute	Value
Key	debugPort
Description	If set, enables Felix's debug HTTP port, which allows memory and CPU profiles to be retrieved. The debug port is not secure, it should not be exposed to the internet.
Schema	Integer: [0,65535]
Default	none

debugSimulateCalcGraphHangAfter

Attribute	Value
Key	debugSimulateCalcGraphHangAfter
Description	Used to simulate a hang in the calculation graph after the specified duration. This is useful in tests of the watchdog system only!
Schema	Duration string, for example 1m30s123ms or 1h5m.
Default	0s

debugSimulateDataplaneApplyDelay

Attribute	Value
Key	debugSimulateDataplaneApplyDelay
Description	Adds an artificial delay to every dataplane operation. This is useful for simulating a heavily loaded system for test purposes only.
Schema	Duration string, for example 1m30s123ms or 1h5m.
Default	0s

debugSimulateDataplaneHangAfter

Attribute	Value
Key	debugSimulateDataplaneHangAfter
Description	Used to simulate a hang in the dataplane after the specified duration. This is useful in tests of the watchdog system only!
Schema	Duration string, for example 1m30s123ms or 1h5m.
Default	0s

statsDumpFilePath

Attribute	Value
Key	statsDumpFilePath
Description	The path to write a diagnostic flow logs statistics dump to when triggered by signal.
Schema	String.
Default	/var/log/calico/stats/dump

Usage reporting

usageReportingEnabled

Attribute	Value
Key	usageReportingEnabled
Description	Unused in Calico Enterprise, usage reporting is permanently disabled.
Schema	Boolean.
Default	true

usageReportingInitialDelay

Attribute	Value
Key	usageReportingInitialDelay
Description	Unused in Calico Enterprise, usage reporting is permanently disabled.
Schema	Duration string, for example 1m30s123ms or 1h5m.
Default	5m0s

usageReportingInterval

Attribute	Value
Key	usageReportingInterval
Description	Unused in Calico Enterprise, usage reporting is permanently disabled.
Schema	Duration string, for example 1m30s123ms or 1h5m.
Default	24h0m0s

Health Timeout Overrides

Felix has internal liveness and readiness watchdog timers that monitor its various loops. If a loop fails to "check in" within the allotted timeout then Felix will report non-Ready or non-Live on its health port (which is monitored by kubelet in a Kubernetes system). If Felix reports non-Live, this can result in the Pod being restarted.

In Kubernetes, if you see the calico-node Pod readiness or liveness checks fail intermittently, check the calico-node Pod log for a log from Felix that gives the overall health status (the list of components will depend on which features are enabled):

+---------------------------+---------+----------------+-----------------+--------+
|         COMPONENT         | TIMEOUT |    LIVENESS    |    READINESS    | DETAIL |
+---------------------------+---------+----------------+-----------------+--------+
| CalculationGraph          | 30s     | reporting live | reporting ready |        |
| FelixStartup              | 0s      | reporting live | reporting ready |        |
| InternalDataplaneMainLoop | 1m30s   | reporting live | reporting ready |        |
+---------------------------+---------+----------------+-----------------+--------+

If some health timeouts show as "timed out" it may help to apply an override using the healthTimeoutOverrides field:

...
spec:
  healthTimeoutOverrides:
  - name: InternalDataplaneMainLoop
    timeout: "5m"
  - name: CalculationGraph
    timeout: "1m30s"
  ...

A timeout value of 0 disables the timeout.

ProtoPort

Field	Description	Accepted Values	Schema
port	The exact port match	0-65535	int
protocol	The protocol match	tcp, udp, sctp	string
net	The CIDR match	any valid CIDR (e.g. 192.168.0.0/16)	string

Keep in mind that in the following example, net: "" and net: "0.0.0.0/0" are processed as the same in the policy enforcement.

  ...
spec:
  failsafeInboundHostPorts:
  - net: "192.168.1.1/32"
    port: 22
    protocol: tcp
  - net: ""
    port: 67
    protocol: udp
failsafeOutboundHostPorts:
  - net: "0.0.0.0/0"
    port: 67
    protocol: udp
  ...

AggregationKind

Value	Description
0	No aggregation
1	Aggregate all flows that share a source port on each node
2	Aggregate all flows that share source ports or are from the same ReplicaSet on each node

DNSPolicyMode

Value	Description
DelayDeniedPacket (default)	Felix delays any denied packet that traversed a policy that included egress domain matches, but did not match. The packet is released after a fixed time, or after the destination IP address was programmed.
DelayDNSResponse	Felix delays any DNS response until related IPSets are programmed. This introduces some latency to all DNS packets (even when no IPSet programming is required), but it ensures policy hit statistics are accurate. This is the recommended setting when you are making use of staged policies or policy rule hit statistics. A Linux kernel version of 3.13 or greater is required to use DelayDNSResponse. For earlier kernel versions, this value is modified to DelayDeniedPacket.
Inline	Parses DNS response inline with DNS response packet processing within iptables. This guarantees the DNS rules reflect any change immediately. This mode works for iptables only and matches the same mode for BPFDNSPolicyMode. This setting is ignored on Windows and NoDelay is always used.
NoDelay	Felix does not introduce any delay to the packets. DNS rules may not have been programmed by the time the first packet traverses the policy rules. Client applications need to handle reconnection attempts if initial connection attempts fail. This may be problematic for some applications or for very low DNS TTLs.

On Windows, or when using the eBPF data plane, this setting is ignored. Windows always uses NoDelay while eBPF has its own BPFDNSPolicyMode option.

BPFDNSPolicyMode

Value	Description
Inline	Felix does not introduce any delay to any packets. Felix's eBPF programs parse DNS responses and program policy rules immediately, before the DNS response is passed to the application. This only applies to wildcard prefixes: *.x.y.z will be processed in this manner, but wildcards such as x.*.y.z will not match. A Linux kernel version of 5.17 or greater is required.
NoDelay	Felix does not introduce any delay to the packets. DNS rules may not have been programmed by the time the first packet traverses the policy rules. Client applications need to handle reconnection attempts if initial connection attempts fail. This may be problematic for some applications or for very low DNS TTLs.

RouteTableRange

The RouteTableRange option is now deprecated in favor of RouteTableRanges.

Field	Description	Accepted Values	Schema
min	Minimum index to use	1-250	int
max	Maximum index to use	1-250	int

RouteTableRanges

RouteTableRanges is a list of RouteTableRange objects:

Field	Description	Accepted Values	Schema
min	Minimum index to use	1 - 4294967295	int
max	Maximum index to use	1 - 4294967295	int

Each item in the RouteTableRanges list designates a range of routing tables available to Calico. By default, Calico will use a single range of 1-250. If a range spans Linux's reserved table range (253-255) then those tables are automatically excluded from the list. It's possible that other table ranges may also be reserved by third-party systems unknown to Calico. In that case, multiple ranges can be defined to target tables below and above the sensitive ranges:

 target tables 65-99, and 256-1000, skipping 100-255
calicoctl patch felixconfig default --type=merge -p '{"spec":{"routeTableRanges": [{"min": 65, "max": 99}, {"min": 256, "max": 1000}] }}

Note, for performance reasons, the maximum total number of routing tables that Felix will accept is 65535 (or 2*16).

Specifying both the RouteTableRange and RouteTableRanges arguments is not supported and will result in an error from the api.

AWS IAM Role/Policy for source-destination-check configuration

Setting awsSrcDstCheck to Disable will automatically disable source-destination-check on EC2 instances in a cluster, provided necessary IAM roles and policies are set. One of the policies assigned to IAM role of cluster nodes must contain a statement similar to the following:

{
    "Effect": "Allow",
        "Action": [
            "ec2:DescribeInstances",
            "ec2:ModifyNetworkInterfaceAttribute"
        ],
    "Resource": "*"
}

If there are no policies attached to node roles containing the above statement, attach a new policy. For example, if a node role is test-cluster-nodeinstance-role, click on the IAM role in AWS console. In the Permission policies list, add a new inline policy with the above statement to the new policy JSON definition. For detailed information, see AWS documentation.

For an EKS cluster, the necessary IAM role and policy is available by default. No further actions are needed.

Supported operations

Datastore type	Create	Delete	Delete (Global default)	Update	Get/List	Notes
Kubernetes API server	Yes	Yes	No	Yes	Yes