calico/node container is primarily configured through environment variables.
|NODENAME||A unique identifier for this host. See node name determination for more details.||lowercase string|
|NO_DEFAULT_POOLS||Prevents Calico from creating a default pool if one does not exist. [Default:
|IP||The IPv4 address to assign this host or detection behavior at startup. Refer to IP setting for the details of the behavior possible with this field.||IPv4|
|IP6||The IPv6 address to assign this host or detection behavior at startup. Refer to IP setting for the details of the behavior possible with this field.||IPv6|
|IP_AUTODETECTION_METHOD||The method to use to autodetect the IPv4 address for this host. This is only used when the IPv4 address is being autodetected. See IP Autodetection methods for details of the valid methods. [Default:
|IP6_AUTODETECTION_METHOD||The method to use to autodetect the IPv6 address for this host. This is only used when the IPv6 address is being autodetected. See IP Autodetection methods for details of the valid methods. [Default:
|DISABLE_NODE_IP_CHECK||Skips checks for duplicate Node IPs. This can reduce the load on the cluster when a large number of Nodes are restarting. [Default:
|AS||The AS number for this node. When specified, the value is saved in the node resource configuration for this host, overriding any previously configured value. When omitted, if an AS number has been previously configured in the node resource, that AS number is used for the peering. When omitted, if an AS number has not yet been configured in the node resource, the node will use the global value (see example modifying Global BGP settings for details.)||int|
|CALICO_DISABLE_FILE_LOGGING||Disables logging to file. [Default: “false”]||string|
|DATASTORE_TYPE||Type of datastore. [Default:
|WAIT_FOR_DATASTORE||Wait for connection to datastore before starting. If a successful connection is not made, node will shutdown. [Default:
|CALICO_LIBNETWORK_CREATE_PROFILES||Enables creating a Calico profile resource for each Docker network. When disabled, no profiles will be processed even if manually created. [Default:
|CALICO_LIBNETWORK_LABEL_ENDPOINTS||Enables copying a subset of the Docker container labels for use as Calico labels on workloadendpoints. [Default:
|CALICO_LIBNETWORK_ENABLED||Enables running the docker-libnetwork plugin directly in the
|CALICO_LIBNETWORK_IFPREFIX||Interface prefix to use for the network interface within the Docker containers that have been networked by the Calico driver. [Default:
|CALICO_NETWORKING_BACKEND||Describes which BGP networking backend to use [Default:
||gobgp, bird, none|
|CALICO_IPV4POOL_CIDR||The IPv4 Pool to create if none exists at start up. It is invalid to define this variable and NO_DEFAULT_POOLS. [Default:
|CALICO_IPV6POOL_CIDR||The IPv6 Pool to create if none exists at start up. It is invalid to define this variable and NO_DEFAULT_POOLS. [Default:
|CALICO_IPV4POOL_IPIP||IPIP Mode to use for the IPv4 POOL created at start up. [Default:
||Off, Always, CrossSubnet|
|CALICO_IPV4POOL_NAT_OUTGOING||Controls NAT Outgoing for the IPv4 Pool created at start up. [Default:
|CALICO_IPV6POOL_NAT_OUTGOING||Controls NAT Outgoing for the IPv6 Pool created at start up. [Default:
|CALICO_STARTUP_LOGLEVEL||The log severity above which startup
||DEBUG, INFO, WARNING, ERROR, CRITICAL, or NONE (case-insensitive)|
|CLUSTER_TYPE||Contains comma delimited list of indicators about this cluster. e.g. k8s, mesos, kubeadm, canal, bgp||string|
|ETCD_ENDPOINTS||A comma separated list of etcd endpoints [Example:
|ETCD_KEY_FILE||Path to the file containing the private key matching the
|ETCD_CERT_FILE||Path to the file containing the client certificate issued to
|ETCD_CA_CERT_FILE||Path to the file containing the root certificate of the certificate authority (CA) that issued the etcd server certificate. Configures
|KUBECONFIG||When using the Kubernetes datastore, the location of a kubeconfig file to use.||string|
|K8S_API_ENDPOINT||Location of the Kubernetes API. Not required if using kubeconfig.||string|
|K8S_CERT_FILE||Location of a client certificate for accessing the Kubernetes API.||string|
|K8S_KEY_FILE||Location of a client key for accessing the Kubernetes API.||string|
|K8S_CA_FILE||Location of a CA for accessing the Kubernetes API.||string|
|K8S_TOKEN||Token to be used for accessing the Kubernetes API.||string|
In addition to the above,
calico/node also supports the standard Felix configuration environment variables.
Note: When Calico is configured to use the Kubernetes API as the datastore, the environments used for BGP configuration are ignored—this includes selection of the node AS number (AS) and all of the IP selection options (IP, IP6, IP_AUTODETECTION_METHOD, IP6_AUTODETECTION_METHOD).
Node name determination
calico/node must know the name of the node on which it is running. The node name is used to
retrieve the Node resource configured for this node if it exists, or to create a new node resource representing the node if it does not. It is
also used to associate the node with per-node BGP configuration, felix configuration, and endpoints.
When launched, the `` container sets the node name according to the following order of precedence:
- The value specified in the
NODENAMEenvironment variable, if set.
- The value specified in
/var/lib/calico/nodename, if it exists.
- The value specified in the
HOSTNAMEenvironment variable, if set.
- The hostname as returned by the operating system, converted to lowercase.
Once the node has determined its name, the value will be cached in
/var/lib/calico/nodename for future use.
For example, if given the following conditions:
/var/lib/calico/nodenamedoes not exist
- The operating system returns “host-A.internal.myorg.com” for the hostname
calico/node will use “host-a” for its name and will write the value in
/var/lib/calico/nodename. If calico/node
is then restarted, it will use the cached value of “host-a” read from the file on disk.
The IP (for IPv4) and IP6 (for IPv6) environment variables are used to set, force autodetection, or disable auto detection of the address for the appropriate IP version for the node. When the environment variable is set, the address is saved in the node resource configuration for this host, overriding any previously configured value.
IP setting special case values
There are several special case values that can be set in the IP(6) environemnt variables, they are:
- Not set or empty string: Any previously set address on the node
resource will be used. If no previous address is set on the node resource
the two versions behave differently:
- IP will do autodetection of the IPv4 address and set it on the node resource.
- IP6 will not do autodetection.
autodetect: Autodetection will always be performed for the IP address and the detected address will overwrite any value configured in the node resource.
none: Autodetection will not be performed (this is useful to disable IPv4).
IP Autodetection methods
When Calico is used for routing, each node must be configured with an IPv4
address and/or an IPv6 address that will be used to route between
nodes. To eliminate node specific IP address configuration, the
container can be configured to autodetect these IP addresses. In many systems,
there might be multiple physical interfaces on a host, or possibly multiple IP
addresses configured on a physical interface. In these cases, there are
multiple addresses to choose from and so autodetection of the correct address
can be tricky.
The IP autodetection methods are provided to improve the selection of the correct address, by limiting the selection based on suitable criteria for your deployment.
The following sections describe the available IP autodetection methods.
first-found option enumerates all interface IP addresses and returns the
first valid IP address (based on IP version and type of address) on
the first valid interface. Certain known “local” interfaces
are omitted, such as the docker bridge. The order that both the interfaces
and the IP addresses are listed is system dependent.
This is the default detection method. However, since this method only makes a very simplified guess, it is recommended to either configure the node with a specific IP address, or to use one of the other detection methods.
can-reach method uses your local routing to determine which IP address
will be used to reach the supplied destination. Both IP addresses and domain
names may be used.
# Using IP addresses IP_AUTODETECTION_METHOD=can-reach=220.127.116.11 IP6_AUTODETECTION_METHOD=can-reach=2001:4860:4860::8888 # Using domain names IP_AUTODETECTION_METHOD=can-reach=www.google.com IP6_AUTODETECTION_METHOD=can-reach=www.google.com
interface method uses the supplied interface regular expression (golang
syntax) to enumerate matching interfaces and to return the first IP address on
the first matching interface. The order that both the interfaces
and the IP addresses are listed is system dependent.
# Valid IP address on interface eth0, eth1, eth2 etc. IP_AUTODETECTION_METHOD=interface=eth.* IP6_AUTODETECTION_METHOD=interface=eth.*
calico/node container supports an exec readiness endpoint.
Here is the help text:
$ docker exec calico-node /bin/readiness -h Usage of dist/readiness: -bird Specify to enable BIRD readiness checks -bird6 Specify to enable BIRD6 readiness checks -felix Specify to enable felix readiness checks
The BIRD readiness endpoint ensures that the BGP mesh is healthy by verifiying that all BGP peers are established and no graceful restart is in progress. If the BIRD readiness check is failing due to unreachable peers that are no longer in the cluster, see decomissioning a node.