Configuring Felix

Configuration for Felix is read from one of four possible locations, in order, as follows.

  1. Environment variables.
  2. The Felix configuration file.
  3. Host-specific FelixConfiguration resources.
  4. The global FelixConfiguration resource (default).

The value of any configuration parameter is the value read from the first location containing a value. For example, if an environment variable contains a value, it takes top precedence.

If not set in any of these locations, most configuration parameters have defaults, and it should be rare to have to explicitly set them.

The full list of parameters which can be set is as follows.

Note: The following tables detail the configuration file and environment variable parameters. For FelixConfiguration resource settings, refer to Felix Configuration Resource.

General configuration

Configuration parameter Environment variable Description Schema
DatastoreType FELIX_DATASTORETYPE The datastore that Felix should read endpoints and policy information from. [Default: etcdv3] etcdv3, kubernetes
ExternalNodesCIDRList FELIX_EXTERNALNODESCIDRLIST Comma-delimited list of IPv4 or CIDR of external-non-calico-nodes from which IPIP traffic is accepted by calico-nodes. [Default: “”] string
FailsafeInboundHostPorts FELIX_FAILSAFEINBOUNDHOSTPORTS Comma-delimited list of UDP/TCP ports 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. Each port should be specified as tcp:<port-number> or udp:<port-number>. For backwards compatibility, if the protocol is not specified, it defaults to “tcp”. To disable all inbound host ports, use the value none. The default value allows ssh access, DHCP, BGP and etcd. [Default: tcp:22, udp:68, tcp:179, tcp:2379, tcp:2380, tcp:6666, tcp:6667] string
FailsafeOutboundHostPorts FELIX_FAILSAFEOUTBOUNDHOSTPORTS Comma-delimited list of UDP/TCP ports that Felix will allow outgoing traffic from host endpoints to irrespective of the security policy. This is useful to avoid accidently cutting off a host with incorrect configuration. Each port should be specified as tcp:<port-number> or udp:<port-number>. For backwards compatibility, if the protocol is not specified, it defaults to “tcp”. To disable all outbound host ports, use the value none. 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. [Default: udp:53, udp:67, tcp:179, tcp:2379, tcp:2380, tcp:6666, tcp:6667] string
FelixHostname FELIX_FELIXHOSTNAME The hostname Felix reports to the plugin. Should be used if the hostname Felix autodetects is incorrect or does not match what the plugin will expect. [Default: socket.gethostname()] string
HealthEnabled FELIX_HEALTHENABLED When enabled, exposes felix health information via an http endpoint. boolean
HealthHost FELIX_HEALTHHOST The address on which Felix will respond to health requests. [Default: localhost] string
IpInIpMtu FELIX_IPINIPMTU The MTU to set on the tunnel device. See Configuring MTU [Default: 1440] int
LogFilePath FELIX_LOGFILEPATH The full path to the Felix log. Set to none to disable file logging. [Default: /var/log/calico/felix.log] string
LogSeverityFile FELIX_LOGSEVERITYFILE The log severity above which logs are sent to the log file. [Default: Info] Debug, Info, Warning, Error, Fatal
LogSeverityScreen FELIX_LOGSEVERITYSCREEN The log severity above which logs are sent to the stdout. [Default: Info] Debug, Info, Warning, Error, Fatal
LogSeveritySys FELIX_LOGSEVERITYSYS The log severity above which logs are sent to the syslog. Set to "" for no logging to syslog. [Default: Info] Debug, Info, Warning, Error, Fatal
PolicySyncPathPrefix FELIX_POLICYSYNCPATHPREFIX File system path where Felix notifies services of policy changes over Unix domain sockets. This is only required if you’re configuring application layer policy. Set to "" to disable. [Default: ""] string
PrometheusGoMetricsEnabled FELIX_PROMETHEUSGOMETRICSENABLED Set to false to disable Go runtime metrics collection, which the Prometheus client does by default. This reduces the number of metrics reported, reducing Prometheus load. [Default: true] boolean
PrometheusMetricsEnabled FELIX_PROMETHEUSMETRICSENABLED Set to true to enable the Prometheus metrics server in Felix. [Default: false] boolean
PrometheusMetricsPort FELIX_PROMETHEUSMETRICSPORT Experimental: TCP port that the Prometheus metrics server should bind to. [Default: 9091] int
PrometheusProcessMetricsEnabled FELIX_PROMETHEUSPROCESSMETRICSENABLED Set to false to disable process metrics collection, which the Prometheus client does by default. This reduces the number of metrics reported, reducing Prometheus load. [Default: true] boolean
ReportingIntervalSecs FELIX_REPORTINGINTERVALSECS Interval at which Felix reports its status into the datastore or 0 to disable. Must be non-zero in OpenStack deployments. [Default: 30] int
ReportingTTLSecs FELIX_REPORTINGTTLSECS Time-to-live setting for process-wide status reports. [Default: 90] int
UsageReportingEnabled FELIX_USAGEREPORTINGENABLED 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. [Default: true] boolean
UsageReportingInitialDelaySecs FELIX_USAGEREPORTINGINITIALDELAYSECS Minimum delay before first usage report, in seconds. [Default: 300] int
UsageReportingIntervalSecs FELIX_USAGEREPORTINGINTERVALSECS Interval at which to make usage reports, in seconds. [Default: 86400] int

etcd datastore configuration

Configuration parameter Environment variable Description Schema
EtcdCaFile FELIX_ETCDCAFILE Path to the file containing the root certificate of the certificate authority (CA) that issued the etcd server certificate. Configures Felix to trust the CA that signed the root certificate. The file may contain multiple root certificates, causing Felix to trust each of the CAs included. To disable authentication of the server by Felix, set the value to none. [Default: /etc/ssl/certs/ca-certificates.crt] string
EtcdCertFile FELIX_ETCDCERTFILE Path to the file containing the client certificate issued to Felix. Enables Felix to participate in mutual TLS authentication and identify itself to the etcd server. Example: /etc/felix/cert.pem (optional) string
EtcdEndpoints FELIX_ETCDENDPOINTS Comma-delimited list of etcd endpoints to connect to. Example: http://127.0.0.1:2379,http://127.0.0.2:2379. <scheme>://<ip-or-fqdn>:<port>
EtcdKeyFile FELIX_ETCDKEYFILE Path to the file containing the private key matching Felix’s client certificate. Enables Felix to participate in mutual TLS authentication and identify itself to the etcd server. Example: /etc/felix/key.pem (optional) string

Kubernetes API datastore configuration

The Kubernetes API datastore driver reads its configuration from Kubernetes-provided environment variables.

iptables dataplane configuration

Configuration parameter Environment variable Description Schema
ChainInsertMode FELIX_CHAININSERTMODE 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. [Default: Insert] Insert, Append
DefaultEndpointToHostAction FELIX_DEFAULTENDPOINTTOHOSTACTION This parameter controls what happens to traffic that goes from a workload endpoint to the host itself (after the traffic hits the endpoint egress policy). 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. [Default: Drop] Drop, Return, Accept
IgnoreLooseRPF FELIX_IGNORELOOSERPF Set to true to allow Felix to run on systems with loose reverse path forwarding (RPF). Warning: Calico relies on “strict” RPF checking being enabled to prevent workloads, such as VMs and privileged containers, from spoofing their IP addresses and impersonating other workloads (or hosts). Only enable this flag if you need to run with “loose” RPF and you either trust your workloads or have another mechanism in place to prevent spoofing. true,false
InterfaceExclude FELIX_INTERFACEEXCLUDE 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 kube-ipvs0 device. [Default: kube-ipvs0] string
IpInIpEnabled FELIX_IPINIPENABLED Whether Felix should configure an IPinIP interface on the host. Set automatically to true by calico/node or calicoctl when you create an IPIP-enabled pool. [Default: false] boolean
IpsetsRefreshIntervalSecs FELIX_IPSETSREFRESHINTERVAL Period, in seconds, 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. [Default: 10] int
IptablesFilterAllowAction FELIX_IPTABLESFILTERALLOWACTION This parameter controls what happens to traffic that is allowed by a Felix policy chain in the iptables filter table (i.e., a normal policy chain). The default will immediately Accept the traffic. Use Return to send the traffic back up to the system chains for further processing. [Default: Accept] Accept, Return
IptablesLockFilePath FELIX_IPTABLESLOCKFILEPATH Deprecated: For iptables versions prior to v1.6.2, location of the iptables lock file (later versions of iptables always use value “/run/xtables.lock”). 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). [Default: /run/xtables.lock] string
IptablesLockProbeIntervalMillis FELIX_IPTABLESLOCKPROBEINTERVALMILLIS Time, in milliseconds, 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. [Default: 50] int
IptablesLockTimeoutSecs FELIX_IPTABLESLOCKTIMEOUTSECS Time, in seconds, that Felix will wait for the iptables lock. Versions of iptables prior to v1.6.2 support disabling the iptables lock by setting this value to 0; v1.6.2 and above do not so Felix will default to 10s if a non-positive number is used. To use this feature, Felix must share the iptables lock file with all other processes that also take the lock. When running Felix inside a container, this typically requires the file /run/xtables.lock on the host to be mounted into the calico/node or calico/felix container. [Default: 0 disabled for iptables <v1.6.2 or 10s for later versions] int
IptablesMangleAllowAction FELIX_IPTABLESMANGLEALLOWACTION This parameter controls what happens to traffic that is allowed by a Felix policy chain in the iptables mangle table (i.e., a pre-DNAT policy chain). The default will immediately Accept the traffic. Use Return to send the traffic back up to the system chains for further processing. [Default: Accept] Accept, Return
IptablesMarkMask FELIX_IPTABLESMARKMASK 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. When using Calico with Kubernetes’ kube-proxy in IPVS mode, we recommend allowing at least 16 bits. [Default: 0xffff0000] netmask
IptablesPostWriteCheckIntervalSecs FELIX_IPTABLESPOSTWRITECHECKINTERVALSECS Period, in seconds, 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. [Default: 1] int
IptablesRefreshInterval FELIX_IPTABLESREFRESHINTERVAL Period, in seconds, at which Felix re-checks all iptables state to ensure that no other process has accidentally broken Calico’s rules. Set to 0 to disable iptables refresh. [Default: 90] int
LogPrefix FELIX_LOGPREFIX The log prefix that Felix uses when rendering LOG rules. [Default: calico-packet] string
MaxIpsetSize FELIX_MAXIPSETSIZE Maximum size for the ipsets used by Felix to implement tags. Should be set to a number that is greater than the maximum number of IP addresses that are ever expected in a tag. [Default: 1048576] int
NATPortRange FELIX_NATPORTRANGE Port range used by iptables for port mapping when doing outgoing NAT. (Example: 32768:65000). [Default: iptables maps source ports below 512 to other ports below 512: those between 512 and 1023 inclusive will be mapped to ports below 1024, and other ports will be mapped to 1024 or above. Where possible, no port alteration will occur.] string
NetlinkTimeoutSecs FELIX_NETLINKTIMEOUTSECS Time, in seconds, that Felix will wait for netlink (i.e. routing table list/update) operations to complete before giving up and retrying. [Default: 10] float
RouteRefreshIntervalSecs FELIX_ROUTEREFRESHINTERVAL Period, in seconds, 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. [Default: 90] int

Kubernetes-specific configuration

Configuration parameter Environment variable Description Schema
KubeNodePortRanges FELIX_KUBENODEPORTRANGES A list of port ranges that Felix should treat as Kubernetes node ports. Only when kube-proxy is configured to use IPVS mode: Felix assumes that traffic arriving at the host one one of these ports will ultimately be forwarded instead of being terminated by a host process. [Default: 30000:32767] Comma-delimited list of <min>:<max> port ranges or single ports.

Note: When using Calico with Kubernetes’ kube-proxy in IPVS mode, Calico uses additional iptables mark bits to store an ID for each local Calico endpoint. For example, the default IptablesMarkMask value, 0xffff0000 gives Calico 16 bits, up to 6 of which are used for internal purposes, leaving 10 bits for endpoint IDs. 10 bits is enough for 1024 different values and Calico uses 2 of those for internal purposes, leaving enough for 1022 endpoints on the host.

OpenStack-specific configuration

Configuration parameter Environment variable Description Schema
MetadataAddr FELIX_METADATAADDR 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. [Default: 127.0.0.1] <IPv4-address>, <hostname>, none
MetadataPort FELIX_METADATAPORT 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 [Default: 8775]. int

Bare metal specific configuration

Configuration parameter Environment variable Description Schema
InterfacePrefix FELIX_INTERFACEPREFIX The interface name prefix that identifies workload endpoints and so distinguishes them from host endpoint interfaces. Accepts more than one interface name prefix in comma-delimited format, e.g., tap,cali. 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. [Default: cali] string

Felix-Typha TLS configuration

Configuration parameter Environment variable Description Schema
TyphaCAFile FELIX_TYPHACAFILE Path to the file containing the root certificate of the CA that issued the Typha server certificate. Configures Felix to trust the CA that signed the root certificate. The file may contain multiple root certificates, causing Felix to trust each of the CAs included. Example: /etc/felix/ca.pem string
TyphaCertFile FELIX_TYPHACERTFILE Path to the file containing the client certificate issued to Felix. Enables Felix to participate in mutual TLS authentication and identify itself to the Typha server. Example: /etc/felix/cert.pem string
TyphaCN FELIX_TYPHACN If set, the Common Name that Typha’s certificate must have. If you have enabled TLS on the communications from Felix to Typha, you must set a value here or in TyphaURISAN. You can set values in both, as well, such as to facilitate a migration from using one to the other. If either matches, the communication succeeds. [Default: none] string
TyphaKeyFile FELIX_TYPHAKEYFILE Path to the file containing the private key matching the Felix client certificate. Enables Felix to participate in mutual TLS authentication and identify itself to the Typha server. Example: /etc/felix/key.pem (optional) string
TyphaURISAN FELIX_TYPHAURISAN If set, a URI SAN that Typha’s certificate must have. We recommend populating this with a SPIFFE string that identifies Typha. All Typha instances should use the same SPIFFE ID. If you have enabled TLS on the communications from Felix to Typha, you must set a value here or in TyphaCN. You can set values in both, as well, such as to facilitate a migration from using one to the other. If either matches, the communication succeeds. [Default: none] string

For more information on how to use and set these variables, refer to Connections from Felix to Typha (Kubernetes).

Environment variables

The highest priority of configuration is that read from environment variables. To set a configuration parameter via an environment variable, set the environment variable formed by taking FELIX_ and appending the uppercase form of the variable name. For example, to set the etcd address, set the environment variable FELIX_ETCDADDR. Other examples include FELIX_ETCDSCHEME, FELIX_ETCDKEYFILE, FELIX_ETCDCERTFILE, FELIX_ETCDCAFILE, FELIX_FELIXHOSTNAME, FELIX_LOGFILEPATH and FELIX_METADATAADDR.

Configuration file

On startup, Felix reads an ini-style configuration file. The path to this file defaults to /etc/calico/felix.cfg but can be overridden using the -c or --config-file options on the command line. If the file exists, then it is read (ignoring section names) and all parameters are set from it.

In OpenStack, we recommend putting all configuration into configuration files, since the etcd database is transient (and may be recreated by the OpenStack plugin in certain error cases). However, in a Docker environment the use of environment variables or etcd is often more convenient.

Datastore

Felix also reads configuration parameters from the datastore. It supports a global setting and a per-host override.

# Get the current felixconfig settings
$ calicoctl get felixconfig -o yaml > felix.yaml

# Modify logFilePath to your intended path, e.g. "/tmp/felix.log"
#   Global change: set name to "default"
#   Node-specific change: set name to the node name, e.g. "Calico-Node-1"
$ vim felix.yaml

# Replace the current felixconfig settings
$ calicoctl replace -f felix.yaml

For more information, see Felix Configuration Resource.