Felix configuration
A Felix configuration resource (FelixConfiguration
) represents Felix configuration options for the cluster.
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 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
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 |
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 , 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 , 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 , 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 |
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 |
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 |
Dataplane: Common
allowIPIPPacketsFromWorkloads
Attribute | Value |
---|---|
Key | allowIPIPPacketsFromWorkloads |
Description | Controls whether Felix will add a rule to drop IPIP encapsulated traffic from workloads. |
Schema | Boolean. |
Default | false |
allowVXLANPacketsFromWorkloads
Attribute | Value |
---|---|
Key | allowVXLANPacketsFromWorkloads |
Description | Controls whether Felix will add a rule to drop VXLAN encapsulated traffic from workloads. |
Schema | Boolean. |
Default | false |
chainInsertMode
Attribute | Value |
---|---|
Key | chainInsertMode |
Description | Controls whether Felix hooks the kernel's top-level iptables chains by inserting a rule at the top of the chain or by appending a rule at the bottom. insert is the safe default since it prevents Calico's rules from being bypassed. If you switch to append mode, be sure that the other rules in the chains signal acceptance by falling through to the Calico rules, otherwise the Calico policy will be bypassed. |
Schema | One of: Append , Insert . |
Default | Insert |
dataplaneDriver
Attribute | Value |
---|---|
Key | dataplaneDriver |
Description | Filename of the external dataplane driver to use. Only used if UseInternalDataplaneDriver is set to false. |
Schema | String. |
Default | calico-iptables-plugin |
dataplaneWatchdogTimeout
Attribute | Value |
---|---|
Key | dataplaneWatchdogTimeout |
Description | The readiness/liveness timeout used for Felix's (internal) dataplane driver. Deprecated: replaced by the generic HealthTimeoutOverrides. |
Schema | Duration string, for example 1m30s123ms or 1h5m . |
Default | 1m30s |
defaultEndpointToHostAction
Attribute | Value |
---|---|
Key | defaultEndpointToHostAction |
Description | Controls what happens to traffic that goes from a workload endpoint to the host itself (after the endpoint's egress policy is applied). By default, Calico blocks traffic from workload endpoints to the host itself with an iptables "DROP" action. If you want to allow some or all traffic from endpoint to host, set this parameter to RETURN or ACCEPT. Use RETURN if you have your own rules in the iptables "INPUT" chain; Calico will insert its rules at the top of that chain, then "RETURN" packets to the "INPUT" chain once it has completed processing workload endpoint egress policy. Use ACCEPT to unconditionally accept packets from workloads after processing workload endpoint egress policy. |
Schema | One of: Accept , Drop , Return . |
Default | Drop |
deviceRouteProtocol
Attribute | Value |
---|---|
Key | deviceRouteProtocol |
Description | Controls the protocol to set on routes programmed by Felix. The protocol is an 8-bit label used to identify the owner of the route. |
Schema | Integer |
Default | 3 |
deviceRouteSourceAddress
Attribute | Value |
---|---|
Key | deviceRouteSourceAddress |
Description | IPv4 address to set as the source hint for routes programmed by Felix. When not set the source address for local traffic from host to workload will be determined by the kernel. |
Schema | String. |
Default | none |
deviceRouteSourceAddressIPv6
Attribute | Value |
---|---|
Key | deviceRouteSourceAddressIPv6 |
Description | IPv6 address to set as the source hint for routes programmed by Felix. When not set the source address for local traffic from host to workload will be determined by the kernel. |
Schema | String. |
Default | none |
disableConntrackInvalidCheck
Attribute | Value |
---|---|
Key | disableConntrackInvalidCheck |
Description | Disables the check for invalid connections in conntrack. While the conntrack invalid check helps to detect malicious traffic, it can also cause issues with certain multi-NIC scenarios. |
Schema | Boolean. |
Default | false |
endpointStatusPathPrefix
Attribute | Value |
---|---|
Key | endpointStatusPathPrefix |
Description | The path to the directory where endpoint status will be written. Endpoint status file reporting is disabled if field is left empty. Chosen directory should match the directory used by the CNI plugin for PodStartupDelay. |
Schema | String. |
Default | none |
externalNodesList
Attribute | Value |
---|---|
Key | externalNodesList |
Description | A list of CIDR's of external, non-Calico nodes from which VXLAN/IPIP overlay traffic will be allowed. By default, external tunneled traffic is blocked to reduce attack surface. |
Schema | List of strings: ["<string>", ...] . |
Default | none |
failsafeInboundHostPorts
Attribute | Value |
---|---|
Key | failsafeInboundHostPorts |
Description | A list of ProtoPort struct objects including UDP/TCP/SCTP ports and CIDRs that Felix will allow incoming traffic to host endpoints on irrespective of the security policy. This is useful to avoid accidentally cutting off a host with incorrect configuration. For backwards compatibility, if the protocol is not specified, it defaults to "tcp". If a CIDR is not specified, it will allow traffic from all addresses. To disable all inbound host ports, use the value "[]". The default value allows ssh access, DHCP, BGP, etcd and the Kubernetes API. |
Schema | List of protocol/port objects with optional CIDR match: [{protocol: "TCP|UDP", port: <port>, net: "<cidr>"}, ...] . |
Default | [{"protocol":"tcp","port":22},{"protocol":"udp","port":68},{"protocol":"tcp","port":179},{"protocol":"tcp","port":2379},{"protocol":"tcp","port":2380},{"protocol":"tcp","port":5473},{"protocol":"tcp","port":6443},{"protocol":"tcp","port":6666},{"protocol":"tcp","port":6667}] |
failsafeOutboundHostPorts
Attribute | Value |
---|---|
Key | failsafeOutboundHostPorts |
Description | A list of PortProto struct objects including UDP/TCP/SCTP ports and CIDRs that Felix will allow outgoing traffic from host endpoints to irrespective of the security policy. This is useful to avoid accidentally cutting off a host with incorrect configuration. For backwards compatibility, if the protocol is not specified, it defaults to "tcp". If a CIDR is not specified, it will allow traffic from all addresses. To disable all outbound host ports, use the value "[]". The default value opens etcd's standard ports to ensure that Felix does not get cut off from etcd as well as allowing DHCP, DNS, BGP and the Kubernetes API. |
Schema | List of protocol/port objects with optional CIDR match: [{protocol: "TCP|UDP", port: <port>, net: "<cidr>"}, ...] . |
Default | [{"protocol":"udp","port":53},{"protocol":"udp","port":67},{"protocol":"tcp","port":179},{"protocol":"tcp","port":2379},{"protocol":"tcp","port":2380},{"protocol":"tcp","port":5473},{"protocol":"tcp","port":6443},{"protocol":"tcp","port":6666},{"protocol":"tcp","port":6667}] |
floatingIPs
Attribute | Value |
---|---|
Key | floatingIPs |
Description | Configures whether or not Felix will program non-OpenStack floating IP addresses. (OpenStack-derived floating IPs are always programmed, regardless of this setting.) |
Schema | One of: Disabled , Enabled . |
Default | Disabled |
ipForwarding
Attribute | Value |
---|---|
Key | ipForwarding |
Description | Controls whether Felix sets the host sysctls to enable IP forwarding. IP forwarding is required when using Calico for workload networking. This should be disabled only on hosts where Calico is used solely for host protection. |
Schema | One of: Disabled , Enabled . |
Default | Enabled |
interfaceExclude
Attribute | Value |
---|---|
Key | interfaceExclude |
Description | A comma-separated list of interface names that should be excluded when Felix is resolving host endpoints. The default value ensures that Felix ignores Kubernetes' internal |
Schema | String. |
Default | kube-ipvs0 |
interfacePrefix
Attribute | Value |
---|---|
Key | interfacePrefix |
Description | The interface name prefix that identifies workload endpoints and so distinguishes them from host endpoint interfaces. Note: in environments other than bare metal, the orchestrators configure this appropriately. For example our Kubernetes and Docker integrations set the 'cali' value, and our OpenStack integration sets the 'tap' value. |
Schema | String. |
Default | cali |
interfaceRefreshInterval
Attribute | Value |
---|---|
Key | interfaceRefreshInterval |
Description | The period at which Felix rescans local interfaces to verify their state. The rescan can be disabled by setting the interval to 0. |
Schema | Duration string, for example 1m30s123ms or 1h5m . |
Default | 1m30s |
ipv6Support
Attribute | Value |
---|---|
Key | ipv6Support |
Description | Controls whether Felix enables support for IPv6 (if supported by the in-use dataplane). |
Schema | Boolean. |
Default | true |
mtuIfacePattern
Attribute | Value |
---|---|
Key | mtuIfacePattern |
Description | A regular expression that controls which interfaces Felix should scan in order to calculate the host's MTU. This should not match workload interfaces (usually named cali...). |
Schema | String. |
Default | ^((en|wl|ww|sl|ib)[Pcopsvx].*|(eth|wlan|wwan).*) |
natOutgoingAddress
Attribute | Value |
---|---|
Key | natOutgoingAddress |
Description | Specifies an address to use when performing source NAT for traffic in a natOutgoing pool that is leaving the network. By default the address used is an address on the interface the traffic is leaving on (i.e. it uses the iptables MASQUERADE target). |
Schema | String. |
Default | none |
natPortRange
Attribute | Value |
---|---|
Key | natPortRange |
Description | Specifies the range of ports that is used for port mapping when doing outgoing NAT. When unset the default behavior of the network stack is used. |
Schema | String. |
Default | 0 |
nftablesMode
Attribute | Value |
---|---|
Key | nftablesMode |
Description | Configures nftables support in Felix. |
Schema | One of: Auto , Disabled , Enabled . |
Default | Disabled |
netlinkTimeout
Attribute | Value |
---|---|
Key | netlinkTimeout |
Description | The timeout when talking to the kernel over the netlink protocol, used for programming routes, rules, and other kernel objects. |
Schema | Duration string, for example 1m30s123ms or 1h5m . |
Default | 10s |
policySyncPathPrefix
Attribute | Value |
---|---|
Key | policySyncPathPrefix |
Description | Used to by Felix to communicate policy changes to external services, like Application layer policy. |
Schema | String. |
Default | none |
removeExternalRoutes
Attribute | Value |
---|---|
Key | removeExternalRoutes |
Description | Controls whether Felix will remove unexpected routes to workload interfaces. Felix will always clean up expected routes that use the configured DeviceRouteProtocol. To add your own routes, you must use a distinct protocol (in addition to setting this field to false). |
Schema | Boolean. |
Default | true |
routeRefreshInterval
Attribute | Value |
---|---|
Key | routeRefreshInterval |
Description | The period at which Felix re-checks the routes in the dataplane to ensure that no other process has accidentally broken Calico's rules. Set to 0 to disable route refresh. |
Schema | Duration string, for example 1m30s123ms or 1h5m . |
Default | 1m30s |
routeSource
Attribute | Value |
---|---|
Key | routeSource |
Description | Configures where Felix gets its routing information. - WorkloadIPs: use workload endpoints to construct routes. - CalicoIPAM: the default - use IPAM data to construct routes. |
Schema | One of: CalicoIPAM , WorkloadIPs . |
Default | CalicoIPAM |
routeSyncDisabled
Attribute | Value |
---|---|
Key | routeSyncDisabled |
Description | Will disable all operations performed on the route table. Set to true to run in network-policy mode only. |
Schema | Boolean. |
Default | false |
routeTableRange
Attribute | Value |
---|---|
Key | routeTableRange |
Description | Deprecated in favor of RouteTableRanges. Calico programs additional Linux route tables for various purposes. RouteTableRange specifies the indices of the route tables that Calico should use. |
Schema | Route table range: {min:<n>, max<m>} . |
Default | none |
routeTableRanges
Attribute | Value |
---|---|
Key | routeTableRanges |
Description | Calico programs additional Linux route tables for various purposes. RouteTableRanges specifies a set of table index ranges that Calico should use. Deprecates |
Schema | List of route table ranges: [{min:<n>, max<m>}, ...] . |
Default | none |
serviceLoopPrevention
Attribute | Value |
---|---|
Key | serviceLoopPrevention |
Description | When service IP advertisement is enabled, prevent routing loops to service IPs that are not in use, by dropping or rejecting packets that do not get DNAT'd by kube-proxy. Unless set to "Disabled", in which case such routing loops continue to be allowed. |
Schema | One of: Disabled , Drop , Reject . |
Default | Drop |
sidecarAccelerationEnabled
Attribute | Value |
---|---|
Key | sidecarAccelerationEnabled |
Description | Enables experimental sidecar acceleration. |
Schema | Boolean. |
Default | false |
useInternalDataplaneDriver
Attribute | Value |
---|---|
Key | useInternalDataplaneDriver |
Description | If true, Felix will use its internal dataplane programming logic. If false, it will launch an external dataplane driver and communicate with it over protobuf. |
Schema | Boolean. |
Default | true |
workloadSourceSpoofing
Attribute | Value |
---|---|
Key | workloadSourceSpoofing |
Description | Controls whether pods can use the allowedSourcePrefixes annotation to send traffic with a source IP address that is not theirs. This is disabled by default. When set to "Any", pods can request any prefix. |
Schema | One of: Any , Disabled . |
Default | Disabled |
Dataplane: iptables
ipsetsRefreshInterval
Attribute | Value |
---|---|
Key | ipsetsRefreshInterval |
Description | Controls the period at which Felix re-checks all IP sets to look for discrepancies. Set to 0 to disable the periodic refresh. |
Schema | Duration string, for example 1m30s123ms or 1h5m . |
Default | 1m30s |
iptablesBackend
Attribute | Value |
---|---|
Key | iptablesBackend |
Description | Controls which backend of iptables will be used. The default is Warning: changing this on a running system can leave "orphaned" rules in the "other" backend. These should be cleaned up to avoid confusing interactions. |
Schema | One of: Auto , Legacy , NFT . |
Default | Auto |
iptablesFilterAllowAction
Attribute | Value |
---|---|
Key | iptablesFilterAllowAction |
Description | Controls what happens to traffic that is accepted by a Felix policy chain in the iptables filter table (which is used for "normal" policy). The default will immediately |
Schema | One of: Accept , Return . |
Default | Accept |
iptablesFilterDenyAction
Attribute | Value |
---|---|
Key | iptablesFilterDenyAction |
Description | Controls what happens to traffic that is denied by network policy. By default Calico blocks traffic with an iptables "DROP" action. If you want to use "REJECT" action instead you can configure it in here. |
Schema | One of: Drop , Reject . |
Default | Drop |
iptablesLockFilePath
Attribute | Value |
---|---|
Key | iptablesLockFilePath |
Description | The location of the iptables lock file. You may need to change this if the lock file is not in its standard location (for example if you have mapped it into Felix's container at a different path). |
Schema | String. |
Default | /run/xtables.lock |
iptablesLockProbeInterval
Attribute | Value |
---|---|
Key | iptablesLockProbeInterval |
Description | When IptablesLockTimeout is enabled: the time that Felix will wait between attempts to acquire the iptables lock if it is not available. Lower values make Felix more responsive when the lock is contended, but use more CPU. |
Schema | Duration string, for example 1m30s123ms or 1h5m . |
Default | 50ms |
iptablesLockTimeout
Attribute | Value |
---|---|
Key | iptablesLockTimeout |
Description | The time that Felix itself will wait for the iptables lock (rather than delegating the lock handling to the Deprecated: |
Schema | Duration string, for example 1m30s123ms or 1h5m . |
Default | 0s |
iptablesMangleAllowAction
Attribute | Value |
---|---|
Key | iptablesMangleAllowAction |
Description | Controls what happens to traffic that is accepted by a Felix policy chain in the iptables mangle table (which is used for "pre-DNAT" policy). The default will immediately |
Schema | One of: Accept , Return . |
Default | Accept |
iptablesMarkMask
Attribute | Value |
---|---|
Key | iptablesMarkMask |
Description | The mask that Felix selects its IPTables Mark bits from. Should be a 32 bit hexadecimal number with at least 8 bits set, none of which clash with any other mark bits in use on the system. |
Schema | Unsigned 32-bit integer. |
Default | 0xffff0000 |
iptablesNATOutgoingInterfaceFilter
Attribute | Value |
---|---|
Key | iptablesNATOutgoingInterfaceFilter |
Description | This parameter can be used to limit the host interfaces on which Calico will apply SNAT to traffic leaving a Calico IPAM pool with "NAT outgoing" enabled. This can be useful if you have a main data interface, where traffic should be SNATted and a secondary device (such as the docker bridge) which is local to the host and doesn't require SNAT. This parameter uses the iptables interface matching syntax, which allows + as a wildcard. Most users will not need to set this. Example: if your data interfaces are eth0 and eth1 and you want to exclude the docker bridge, you could set this to eth+. |
Schema | String. |
Default | none |
iptablesPostWriteCheckInterval
Attribute | Value |
---|---|
Key | iptablesPostWriteCheckInterval |
Description | The period after Felix has done a write to the dataplane that it schedules an extra read back in order to check the write was not clobbered by another process. This should only occur if another application on the system doesn't respect the iptables lock. |
Schema | Duration string, for example 1m30s123ms or 1h5m . |
Default | 5s |
iptablesRefreshInterval
Attribute | Value |
---|---|
Key | iptablesRefreshInterval |
Description | The period at which Felix re-checks the IP sets in the dataplane to ensure that no other process has accidentally broken Calico's rules. Set to 0 to disable IP sets refresh. Note: the default for this value is lower than the other refresh intervals as a workaround for a Linux kernel bug that was fixed in kernel version 4.11. If you are using v4.11 or greater you may want to set this to, a higher value to reduce Felix CPU usage. |
Schema | Duration string, for example 1m30s123ms or 1h5m . |
Default | 3m0s |
kubeNodePortRanges
Attribute | Value |
---|---|
Key | kubeNodePortRanges |
Description | Holds list of port ranges used for service node ports. Only used if felix detects kube-proxy running in ipvs mode. Felix uses these ranges to separate host and workload traffic. . |
Schema | List of ports: [<port>, ...] where <port> is a port number (integer) or range (string), for example 80 , 8080:8089 . |
Default | ["30000:32767"] |
maxIpsetSize
Attribute | Value |
---|---|
Key | maxIpsetSize |
Description | The maximum number of IP addresses that can be stored in an IP set. Not applicable if using the nftables backend. |
Schema | Integer |
Default | 1048576 |
Dataplane: nftables
nftablesFilterAllowAction
Attribute | Value |
---|---|
Key | nftablesFilterAllowAction |
Description | Controls the nftables action that Felix uses to represent the "allow" policy verdict in the filter table. The default is to |
Schema | One of: Accept , Return . |
Default | Accept |
nftablesFilterDenyAction
Attribute | Value |
---|---|
Key | nftablesFilterDenyAction |
Description | Controls what happens to traffic that is denied by network policy. By default, Calico blocks traffic with a "drop" action. If you want to use a "reject" action instead you can configure it here. |
Schema | One of: Drop , Reject . |
Default | Drop |
nftablesMangleAllowAction
Attribute | Value |
---|---|
Key | nftablesMangleAllowAction |
Description | Controls the nftables action that Felix uses to represent the "allow" policy verdict in the mangle table. The default is to |
Schema | One of: Accept , Return . |
Default | Accept |
nftablesMarkMask
Attribute | Value |
---|---|
Key | nftablesMarkMask |
Description | The mask that Felix selects its nftables Mark bits from. Should be a 32 bit hexadecimal number with at least 8 bits set, none of which clash with any other mark bits in use on the system. |
Schema | Unsigned 32-bit integer. |
Default | 0xffff0000 |
nftablesRefreshInterval
Attribute | Value |
---|---|
Key | nftablesRefreshInterval |
Description | Controls the interval at which Felix periodically refreshes the nftables rules. |
Schema | Duration string, for example 1m30s123ms or 1h5m . |
Default | 3m0s |
Dataplane: eBPF
bpfCTLBLogFilter
Attribute | Value |
---|---|
Key | bpfCTLBLogFilter |
Description | Specifies, what is logged by connect time load balancer when BPFLogLevel is debug. Currently has to be specified as 'all' when BPFLogFilters is set to see CTLB logs. |
Schema | String. |
Default | none |
bpfConnectTimeLoadBalancing
Attribute | Value |
---|---|
Key | bpfConnectTimeLoadBalancing |
Description | When in BPF mode, controls whether Felix installs the connect-time load balancer. The connect-time load balancer is required for the host to be able to reach Kubernetes services and it improves the performance of pod-to-service connections.When set to TCP, connect time load balancing is available only for services with TCP ports. |
Schema | One of: Disabled , Enabled , TCP . |
Default | TCP |
bpfConnectTimeLoadBalancingEnabled
Attribute | Value |
---|---|
Key | bpfConnectTimeLoadBalancingEnabled |
Description | When in BPF mode, controls whether Felix installs the connection-time load balancer. The connect-time load balancer is required for the host to be able to reach Kubernetes services and it improves the performance of pod-to-service connections. The only reason to disable it is for debugging purposes. Deprecated: Use BPFConnectTimeLoadBalancing. |
Schema | Boolean. |
Default | none |
bpfDSROptoutCIDRs
Attribute | Value |
---|---|
Key | bpfDSROptoutCIDRs |
Description | A list of CIDRs which are excluded from DSR. That is, clients in those CIDRs will access service node ports as if BPFExternalServiceMode was set to Tunnel. |
Schema | List of CIDRs: ["<cidr>", ...] . |
Default | none |
bpfDataIfacePattern
Attribute | Value |
---|---|
Key | bpfDataIfacePattern |
Description | A regular expression that controls which interfaces Felix should attach BPF programs to in order to catch traffic to/from the network. This needs to match the interfaces that Calico workload traffic flows over as well as any interfaces that handle incoming traffic to nodeports and services from outside the cluster. It should not match the workload interfaces (usually named cali...). |
Schema | String. |
Default | ^((en|wl|ww|sl|ib)[Popsx].*|(eth|wlan|wwan|bond).*|tunl0$|vxlan.calico$|vxlan-v6.calico$|wireguard.cali$|wg-v6.cali$|egress.calico$) |
bpfDisableGROForIfaces
Attribute | Value |
---|---|
Key | bpfDisableGROForIfaces |
Description | A regular expression that controls which interfaces Felix should disable the Generic Receive Offload [GRO] option. It should not match the workload interfaces (usually named cali...). |
Schema | String. |
Default | none |
bpfDisableUnprivileged
Attribute | Value |
---|---|
Key | bpfDisableUnprivileged |
Description | If enabled, Felix sets the kernel.unprivileged_bpf_disabled sysctl to disable unprivileged use of BPF. This ensures that unprivileged users cannot access Calico's BPF maps and cannot insert their own BPF programs to interfere with Calico's. |
Schema | Boolean. |
Default | true |
bpfEnabled
Attribute | Value |
---|---|
Key | bpfEnabled |
Description | If enabled Felix will use the BPF dataplane. |
Schema | Boolean. |
Default | false |
bpfEnforceRPF
Attribute | Value |
---|---|
Key | bpfEnforceRPF |
Description | Enforce strict RPF on all host interfaces with BPF programs regardless of what is the per-interfaces or global setting. Possible values are Disabled, Strict or Loose. |
Schema | One of: Disabled , Loose , Strict . |
Default | Loose |
bpfExcludeCIDRsFromNAT
Attribute | Value |
---|---|
Key | bpfExcludeCIDRsFromNAT |
Description | A list of CIDRs that are to be excluded from NAT resolution so that host can handle them. A typical usecase is node local DNS cache. |
Schema | List of CIDRs: ["<cidr>", ...] . |
Default | none |
bpfExtToServiceConnmark
Attribute | Value |
---|---|
Key | bpfExtToServiceConnmark |
Description | In BPF mode, controls a 32bit mark that is set on connections from an external client to a local service. This mark allows us to control how packets of that connection are routed within the host and how is routing interpreted by RPF check. |
Schema | Integer |
Default | 0 |
bpfExternalServiceMode
Attribute | Value |
---|---|
Key | bpfExternalServiceMode |
Description | In BPF mode, controls how connections from outside the cluster to services (node ports and cluster IPs) are forwarded to remote workloads. If set to "Tunnel" then both request and response traffic is tunneled to the remote node. If set to "DSR", the request traffic is tunneled but the response traffic is sent directly from the remote node. In "DSR" mode, the remote node appears to use the IP of the ingress node; this requires a permissive L2 network. |
Schema | One of: DSR , Tunnel . |
Default | Tunnel |
bpfForceTrackPacketsFromIfaces
Attribute | Value |
---|---|
Key | bpfForceTrackPacketsFromIfaces |
Description | In BPF mode, forces traffic from these interfaces to skip Calico's iptables NOTRACK rule, allowing traffic from those interfaces to be tracked by Linux conntrack. Should only be used for interfaces that are not used for the Calico fabric. For example, a docker bridge device for non-Calico-networked containers. |
Schema | List of interface names (may use + as a wildcard: ["<name>", ...] . |
Default | ["docker+"] |
bpfHostConntrackBypass
Attribute | Value |
---|---|
Key | bpfHostConntrackBypass |
Description | Controls whether to bypass Linux conntrack in BPF mode for workloads and services. |
Schema | Boolean. |
Default | true |
bpfHostNetworkedNATWithoutCTLB
Attribute | Value |
---|---|
Key | bpfHostNetworkedNATWithoutCTLB |
Description | When in BPF mode, controls whether Felix does a NAT without CTLB. This along with BPFConnectTimeLoadBalancing determines the CTLB behavior. |
Schema | One of: Disabled , Enabled . |
Default | Enabled |
bpfKubeProxyEndpointSlicesEnabled
Attribute | Value |
---|---|
Key | bpfKubeProxyEndpointSlicesEnabled |
Description | Deprecated and has no effect. BPF kube-proxy always accepts endpoint slices. This option will be removed in the next release. |
Schema | Boolean. |
Default | true |
bpfKubeProxyIptablesCleanupEnabled
Attribute | Value |
---|---|
Key | bpfKubeProxyIptablesCleanupEnabled |
Description | If enabled in BPF mode, Felix will proactively clean up the upstream Kubernetes kube-proxy's iptables chains. Should only be enabled if kube-proxy is not running. |
Schema | Boolean. |
Default | true |
bpfKubeProxyMinSyncPeriod
Attribute | Value |
---|---|
Key | bpfKubeProxyMinSyncPeriod |
Description | In BPF mode, controls the minimum time between updates to the dataplane for Felix's embedded kube-proxy. Lower values give reduced set-up latency. Higher values reduce Felix CPU usage by batching up more work. |
Schema | Duration string, for example 1m30s123ms or 1h5m . |
Default | 1s |
bpfL3IfacePattern
Attribute | Value |
---|---|
Key | bpfL3IfacePattern |
Description | A regular expression that allows to list tunnel devices like wireguard or vxlan (i.e., L3 devices) in addition to BPFDataIfacePattern. That is, tunnel interfaces not created by Calico, that Calico workload traffic flows over as well as any interfaces that handle incoming traffic to nodeports and services from outside the cluster. |
Schema | String. |
Default | none |
bpfLogFilters
Attribute | Value |
---|---|
Key | bpfLogFilters |
Description | A map of key=values where the value is a pcap filter expression and the key is an interface name with 'all' denoting all interfaces, 'weps' all workload endpoints and 'heps' all host endpoints. When specified as an env var, it accepts a comma-separated list of key=values. |
Schema | |
Default | none |
bpfLogLevel
Attribute | Value |
---|---|
Key | bpfLogLevel |
Description | Controls the log level of the BPF programs when in BPF dataplane mode. One of "Off", "Info", or "Debug". The logs are emitted to the BPF trace pipe, accessible with the command |
Schema | One of: Debug , Info , Off . |
Default | Off |
bpfMapSizeConntrack
Attribute | Value |
---|---|
Key | bpfMapSizeConntrack |
Description | Sets the size for the conntrack map. This map must be large enough to hold an entry for each active connection. Warning: changing the size of the conntrack map can cause disruption. |
Schema | Integer |
Default | 512000 |
bpfMapSizeIPSets
Attribute | Value |
---|---|
Key | bpfMapSizeIPSets |
Description | Sets the size for ipsets map. The IP sets map must be large enough to hold an entry for each endpoint matched by every selector in the source/destination matches in network policy. Selectors such as "all()" can result in large numbers of entries (one entry per endpoint in that case). |
Schema | Integer |
Default | 1048576 |
bpfMapSizeIfState
Attribute | Value |
---|---|
Key | bpfMapSizeIfState |
Description | Sets the size for ifstate map. The ifstate map must be large enough to hold an entry for each device (host + workloads) on a host. |
Schema | Integer |
Default | 1000 |
bpfMapSizeNATAffinity
Attribute | Value |
---|---|
Key | bpfMapSizeNATAffinity |
Description | Sets the size of the BPF map that stores the affinity of a connection (for services that enable that feature. |
Schema | Integer |
Default | 65536 |
bpfMapSizeNATBackend
Attribute | Value |
---|---|
Key | bpfMapSizeNATBackend |
Description | Sets the size for NAT back end map. This is the total number of endpoints. This is mostly more than the size of the number of services. |
Schema | Integer |
Default | 262144 |
bpfMapSizeNATFrontend
Attribute | Value |
---|---|
Key | bpfMapSizeNATFrontend |
Description | Sets the size for NAT front end map. FrontendMap should be large enough to hold an entry for each nodeport, external IP and each port in each service. |
Schema | Integer |
Default | 65536 |
bpfMapSizeRoute
Attribute | Value |
---|---|
Key | bpfMapSizeRoute |
Description | Sets the size for the routes map. The routes map should be large enough to hold one entry per workload and a handful of entries per host (enough to cover its own IPs and tunnel IPs). |
Schema | Integer |
Default | 262144 |
bpfPSNATPorts
Attribute | Value |
---|---|
Key | bpfPSNATPorts |
Description | Sets the range from which we randomly pick a port if there is a source port collision. This should be within the ephemeral range as defined by RFC 6056 (1024–65535) and preferably outside the ephemeral ranges used by common operating systems. Linux uses 32768–60999, while others mostly use the IANA defined range 49152–65535. It is not necessarily a problem if this range overlaps with the operating systems. Both ends of the range are inclusive. |
Schema | String. |
Default | 20000:29999 |
bpfPolicyDebugEnabled
Attribute | Value |
---|---|
Key | bpfPolicyDebugEnabled |
Description | When true, Felix records detailed information about the BPF policy programs, which can be examined with the calico-bpf command-line tool. |
Schema | Boolean. |
Default | true |
bpfRedirectToPeer
Attribute | Value |
---|---|
Key | bpfRedirectToPeer |
Description | Controls which whether it is allowed to forward straight to the peer side of the workload devices. It is allowed for any host L2 devices by default (L2Only), but it breaks TCP dump on the host side of workload device as it bypasses it on ingress. Value of Enabled also allows redirection from L3 host devices like IPIP tunnel or Wireguard directly to the peer side of the workload's device. This makes redirection faster, however, it breaks tools like tcpdump on the peer side. Use Enabled with caution. |
Schema | String. |
Default | L2Only |
Dataplane: Windows
windowsManageFirewallRules
Attribute | Value |
---|---|
Key | windowsManageFirewallRules |
Description | Configures whether or not Felix will program Windows Firewall rules (to allow inbound access to its own metrics ports). |
Schema | One of: Disabled , Enabled . |
Default | Disabled |
Dataplane: OpenStack support
endpointReportingDelay
Attribute | Value |
---|---|
Key | endpointReportingDelay |
Description | The delay before Felix reports endpoint status to the datastore. This is only used by the OpenStack integration. |
Schema | Duration string, for example 1m30s123ms or 1h5m . |
Default | 1s |
endpointReportingEnabled
Attribute | Value |
---|---|
Key | endpointReportingEnabled |
Description | Controls whether Felix reports endpoint status to the datastore. This is only used by the OpenStack integration. |
Schema | Boolean. |
Default | false |
metadataAddr
Attribute | Value |
---|---|
Key | metadataAddr |
Description | The IP address or domain name of the server that can answer VM queries for cloud-init metadata. In OpenStack, this corresponds to the machine running nova-api (or in Ubuntu, nova-api-metadata). A value of none (case-insensitive) means that Felix should not set up any NAT rule for the metadata path. |
Schema | String. |
Default | 127.0.0.1 |
metadataPort
Attribute | Value |
---|---|
Key | metadataPort |
Description | The port of the metadata server. This, combined with global.MetadataAddr (if not 'None'), is used to set up a NAT rule, from 169.254.169.254:80 to MetadataAddr:MetadataPort. In most cases this should not need to be changed . |
Schema | Integer: [0,65535] |
Default | 8775 |
openstackRegion
Attribute | Value |
---|---|
Key | openstackRegion |
Description | The name of the region that a particular Felix belongs to. In a multi-region Calico/OpenStack deployment, this must be configured somehow for each Felix (here in the datamodel, or in felix.cfg or the environment on each compute node), and must match the [calico] openstack_region value configured in neutron.conf on each node. |
Schema | String. |
Default | none |
reportingInterval
Attribute | Value |
---|---|
Key | reportingInterval |
Description | The interval at which Felix reports its status into the datastore or 0 to disable. Must be non-zero in OpenStack deployments. |
Schema | Duration string, for example 1m30s123ms or 1h5m . |
Default | 30s |
reportingTTL
Attribute | Value |
---|---|
Key | reportingTTL |
Description | The time-to-live setting for process-wide status reports. |
Schema | Duration string, for example 1m30s123ms or 1h5m . |
Default | 1m30s |
Dataplane: XDP acceleration for iptables dataplane
genericXDPEnabled
Attribute | Value |
---|---|
Key | genericXDPEnabled |
Description | Enables Generic XDP so network cards that don't support XDP offload or driver modes can use XDP. This is not recommended since it doesn't provide better performance than iptables. |
Schema | Boolean. |
Default | false |
xdpEnabled
Attribute | Value |
---|---|
Key | xdpEnabled |
Description | Enables XDP acceleration for suitable untracked incoming deny rules. |
Schema | Boolean. |
Default | true |
xdpRefreshInterval
Attribute | Value |
---|---|
Key | xdpRefreshInterval |
Description | The period at which Felix re-checks all XDP state to ensure that no other process has accidentally broken Calico's BPF maps or attached programs. Set to 0 to disable XDP refresh. |
Schema | Duration string, for example 1m30s123ms or 1h5m . |
Default | 1m30s |
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
wireguardEnabled
Attribute | Value |
---|---|
Key | wireguardEnabled |
Description | Controls whether Wireguard is enabled for IPv4 (encapsulating IPv4 traffic over an IPv4 underlay network). |
Schema | Boolean. |
Default | false |
wireguardEnabledV6
Attribute | Value |
---|---|
Key | wireguardEnabledV6 |
Description | Controls whether Wireguard is enabled for IPv6 (encapsulating IPv6 traffic over an IPv6 underlay network). |
Schema | Boolean. |
Default | false |
wireguardHostEncryptionEnabled
Attribute | Value |
---|---|
Key | wireguardHostEncryptionEnabled |
Description | Controls whether Wireguard host-to-host encryption is enabled. |
Schema | Boolean. |
Default | false |
wireguardInterfaceName
Attribute | Value |
---|---|
Key | wireguardInterfaceName |
Description | Specifies the name to use for the IPv4 Wireguard interface. |
Schema | String. |
Default | wireguard.cali |
wireguardInterfaceNameV6
Attribute | Value |
---|---|
Key | wireguardInterfaceNameV6 |
Description | Specifies the name to use for the IPv6 Wireguard interface. |
Schema | String. |
Default | wg-v6.cali |
wireguardListeningPort
Attribute | Value |
---|---|
Key | wireguardListeningPort |
Description | Controls the listening port used by IPv4 Wireguard. |
Schema | Integer |
Default | 51820 |
wireguardListeningPortV6
Attribute | Value |
---|---|
Key | wireguardListeningPortV6 |
Description | Controls the listening port used by IPv6 Wireguard. |
Schema | Integer |
Default | 51821 |
wireguardMTU
Attribute | Value |
---|---|
Key | wireguardMTU |
Description | Controls the MTU on the IPv4 Wireguard interface. See Configuring MTU. |
Schema | Integer |
Default | 0 |
wireguardMTUV6
Attribute | Value |
---|---|
Key | wireguardMTUV6 |
Description | Controls the MTU on the IPv6 Wireguard interface. See Configuring MTU. |
Schema | Integer |
Default | 0 |
wireguardKeepAlive
Attribute | Value |
---|---|
Key | wireguardKeepAlive |
Description | Controls Wireguard PersistentKeepalive option. Set 0 to disable. |
Schema | Duration string, for example 1m30s123ms or 1h5m . |
Default | 0s |
wireguardRoutingRulePriority
Attribute | Value |
---|---|
Key | wireguardRoutingRulePriority |
Description | Controls the priority value to use for the Wireguard routing rule. |
Schema | Integer |
Default | 99 |
AWS integration
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 |
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 |
Usage reporting
usageReportingEnabled
Attribute | Value |
---|---|
Key | usageReportingEnabled |
Description | Reports anonymous Calico version number and cluster size to projectcalico.org. Logs warnings returned by the usage server. For example, if a significant security vulnerability has been discovered in the version of Calico being used. |
Schema | Boolean. |
Default | true |
usageReportingInitialDelay
Attribute | Value |
---|---|
Key | usageReportingInitialDelay |
Description | Controls the minimum delay before Felix makes a report. |
Schema | Duration string, for example 1m30s123ms or 1h5m . |
Default | 5m0s |
usageReportingInterval
Attribute | Value |
---|---|
Key | usageReportingInterval |
Description | Controls the interval at which Felix makes reports. |
Schema | Duration string, for example 1m30s123ms or 1h5m . |
Default | 24h0m0s |
Metadata
Field | Description | Accepted Values | Schema |
---|---|---|---|
name | Unique name to describe this resource instance. Required. | Alphanumeric string with optional . , _ , or - . | string |
- Calico 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.
genericXDPEnabled
and xdpRefreshInterval
are only relevant when bpfEnabled
is false
and
xdpEnabled
is true
; in other words when XDP is being used to accelerate denial-of-service
prevention policies in the iptables dataplane.
When bpfEnabled
is true
the "xdp" settings all have no effect; in BPF mode the implementation of
policy is always accelerated, using the best available BPF technology.
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
...
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 |
---|---|---|---|---|---|---|
etcdv3 | Yes | Yes | No | Yes | Yes | |
Kubernetes API server | Yes | Yes | No | Yes | Yes |