794 lines
49 KiB
JSON
794 lines
49 KiB
JSON
{
|
|
"description": "Felix Configuration contains the configuration for Felix.",
|
|
"properties": {
|
|
"apiVersion": {
|
|
"description": "APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources",
|
|
"type": "string"
|
|
},
|
|
"kind": {
|
|
"description": "Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
|
|
"type": "string"
|
|
},
|
|
"metadata": {
|
|
"type": "object"
|
|
},
|
|
"spec": {
|
|
"description": "FelixConfigurationSpec contains the values of the Felix configuration.",
|
|
"properties": {
|
|
"allowIPIPPacketsFromWorkloads": {
|
|
"description": "AllowIPIPPacketsFromWorkloads controls whether Felix will add a rule to drop IPIP encapsulated traffic from workloads [Default: false]",
|
|
"type": "boolean"
|
|
},
|
|
"allowVXLANPacketsFromWorkloads": {
|
|
"description": "AllowVXLANPacketsFromWorkloads controls whether Felix will add a rule to drop VXLAN encapsulated traffic from workloads [Default: false]",
|
|
"type": "boolean"
|
|
},
|
|
"awsSrcDstCheck": {
|
|
"description": "Set source-destination-check on AWS EC2 instances. Accepted value must be one of \"DoNothing\", \"Enable\" or \"Disable\". [Default: DoNothing]",
|
|
"enum": [
|
|
"DoNothing",
|
|
"Enable",
|
|
"Disable"
|
|
],
|
|
"type": "string"
|
|
},
|
|
"bpfCTLBLogFilter": {
|
|
"description": "BPFCTLBLogFilter 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. [Default: unset - means logs are emitted when BPFLogLevel id debug and BPFLogFilters not set.]",
|
|
"type": "string"
|
|
},
|
|
"bpfConnectTimeLoadBalancing": {
|
|
"description": "BPFConnectTimeLoadBalancing 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. [Default: TCP]",
|
|
"enum": [
|
|
"TCP",
|
|
"Enabled",
|
|
"Disabled"
|
|
],
|
|
"type": "string"
|
|
},
|
|
"bpfConnectTimeLoadBalancingEnabled": {
|
|
"description": "BPFConnectTimeLoadBalancingEnabled 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. This will be deprecated. Use BPFConnectTimeLoadBalancing [Default: true]",
|
|
"type": "boolean"
|
|
},
|
|
"bpfDSROptoutCIDRs": {
|
|
"description": "BPFDSROptoutCIDRs is a list of CIDRs which are excluded from DSR. That is, clients in those CIDRs will accesses nodeports as if BPFExternalServiceMode was set to Tunnel.",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"bpfDataIfacePattern": {
|
|
"description": "BPFDataIfacePattern is 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...).",
|
|
"type": "string"
|
|
},
|
|
"bpfDisableGROForIfaces": {
|
|
"description": "BPFDisableGROForIfaces is 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...).",
|
|
"type": "string"
|
|
},
|
|
"bpfDisableUnprivileged": {
|
|
"description": "BPFDisableUnprivileged, 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. [Default: true]",
|
|
"type": "boolean"
|
|
},
|
|
"bpfEnabled": {
|
|
"description": "BPFEnabled, if enabled Felix will use the BPF dataplane. [Default: false]",
|
|
"type": "boolean"
|
|
},
|
|
"bpfEnforceRPF": {
|
|
"description": "BPFEnforceRPF 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. [Default: Loose]",
|
|
"pattern": "^(?i)(Disabled|Strict|Loose)?$",
|
|
"type": "string"
|
|
},
|
|
"bpfExcludeCIDRsFromNAT": {
|
|
"description": "BPFExcludeCIDRsFromNAT is 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.",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"bpfExtToServiceConnmark": {
|
|
"description": "BPFExtToServiceConnmark in BPF mode, control 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. [Default: 0]",
|
|
"type": "integer"
|
|
},
|
|
"bpfExternalServiceMode": {
|
|
"description": "BPFExternalServiceMode 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. [Default: Tunnel]",
|
|
"pattern": "^(?i)(Tunnel|DSR)?$",
|
|
"type": "string"
|
|
},
|
|
"bpfForceTrackPacketsFromIfaces": {
|
|
"description": "BPFForceTrackPacketsFromIfaces 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. [Default: docker+]",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"bpfHostConntrackBypass": {
|
|
"description": "BPFHostConntrackBypass Controls whether to bypass Linux conntrack in BPF mode for workloads and services. [Default: true - bypass Linux conntrack]",
|
|
"type": "boolean"
|
|
},
|
|
"bpfHostNetworkedNATWithoutCTLB": {
|
|
"description": "BPFHostNetworkedNATWithoutCTLB when in BPF mode, controls whether Felix does a NAT without CTLB. This along with BPFConnectTimeLoadBalancing determines the CTLB behavior. [Default: Enabled]",
|
|
"enum": [
|
|
"Enabled",
|
|
"Disabled"
|
|
],
|
|
"type": "string"
|
|
},
|
|
"bpfKubeProxyEndpointSlicesEnabled": {
|
|
"description": "BPFKubeProxyEndpointSlicesEnabled is deprecated and has no effect. BPF kube-proxy always accepts endpoint slices. This option will be removed in the next release.",
|
|
"type": "boolean"
|
|
},
|
|
"bpfKubeProxyIptablesCleanupEnabled": {
|
|
"description": "BPFKubeProxyIptablesCleanupEnabled, 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. [Default: true]",
|
|
"type": "boolean"
|
|
},
|
|
"bpfKubeProxyMinSyncPeriod": {
|
|
"description": "BPFKubeProxyMinSyncPeriod, 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. [Default: 1s]",
|
|
"pattern": "^([0-9]+(\\\\.[0-9]+)?(ms|s|m|h))*$",
|
|
"type": "string"
|
|
},
|
|
"bpfL3IfacePattern": {
|
|
"description": "BPFL3IfacePattern is 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.",
|
|
"type": "string"
|
|
},
|
|
"bpfLogFilters": {
|
|
"additionalProperties": {
|
|
"type": "string"
|
|
},
|
|
"description": "BPFLogFilters is 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. \n When specified as an env var, it accepts a comma-separated list of key=values. [Default: unset - means all debug logs are emitted]",
|
|
"type": "object"
|
|
},
|
|
"bpfLogLevel": {
|
|
"description": "BPFLogLevel 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 `tc exec bpf debug`. [Default: Off].",
|
|
"pattern": "^(?i)(Off|Info|Debug)?$",
|
|
"type": "string"
|
|
},
|
|
"bpfMapSizeConntrack": {
|
|
"description": "BPFMapSizeConntrack 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.",
|
|
"type": "integer"
|
|
},
|
|
"bpfMapSizeIPSets": {
|
|
"description": "BPFMapSizeIPSets 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).",
|
|
"type": "integer"
|
|
},
|
|
"bpfMapSizeIfState": {
|
|
"description": "BPFMapSizeIfState 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.",
|
|
"type": "integer"
|
|
},
|
|
"bpfMapSizeNATAffinity": {
|
|
"type": "integer"
|
|
},
|
|
"bpfMapSizeNATBackend": {
|
|
"description": "BPFMapSizeNATBackend 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.",
|
|
"type": "integer"
|
|
},
|
|
"bpfMapSizeNATFrontend": {
|
|
"description": "BPFMapSizeNATFrontend 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.",
|
|
"type": "integer"
|
|
},
|
|
"bpfMapSizeRoute": {
|
|
"description": "BPFMapSizeRoute 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).",
|
|
"type": "integer"
|
|
},
|
|
"bpfPSNATPorts": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "string"
|
|
}
|
|
],
|
|
"description": "BPFPSNATPorts 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\u201365535) and preferably outside the ephemeral ranges used by common operating systems. Linux uses 32768\u201360999, while others mostly use the IANA defined range 49152\u201365535. It is not necessarily a problem if this range overlaps with the operating systems. Both ends of the range are inclusive. [Default: 20000:29999]",
|
|
"pattern": "^.*",
|
|
"x-kubernetes-int-or-string": true
|
|
},
|
|
"bpfPolicyDebugEnabled": {
|
|
"description": "BPFPolicyDebugEnabled when true, Felix records detailed information about the BPF policy programs, which can be examined with the calico-bpf command-line tool.",
|
|
"type": "boolean"
|
|
},
|
|
"bpfRedirectToPeer": {
|
|
"description": "BPFRedirectToPeer 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. [Default: L2Only]",
|
|
"type": "string"
|
|
},
|
|
"chainInsertMode": {
|
|
"description": "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]",
|
|
"pattern": "^(?i)(insert|append)?$",
|
|
"type": "string"
|
|
},
|
|
"dataplaneDriver": {
|
|
"description": "DataplaneDriver filename of the external dataplane driver to use. Only used if UseInternalDataplaneDriver is set to false.",
|
|
"type": "string"
|
|
},
|
|
"dataplaneWatchdogTimeout": {
|
|
"description": "DataplaneWatchdogTimeout is the readiness/liveness timeout used for Felix's (internal) dataplane driver. Increase this value if you experience spurious non-ready or non-live events when Felix is under heavy load. Decrease the value to get felix to report non-live or non-ready more quickly. [Default: 90s] \n Deprecated: replaced by the generic HealthTimeoutOverrides.",
|
|
"type": "string"
|
|
},
|
|
"debugDisableLogDropping": {
|
|
"type": "boolean"
|
|
},
|
|
"debugHost": {
|
|
"description": "DebugHost is the host IP or hostname to bind the debug port to. Only used if DebugPort is set. [Default:localhost]",
|
|
"type": "string"
|
|
},
|
|
"debugMemoryProfilePath": {
|
|
"type": "string"
|
|
},
|
|
"debugPort": {
|
|
"description": "DebugPort 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.",
|
|
"type": "integer"
|
|
},
|
|
"debugSimulateCalcGraphHangAfter": {
|
|
"pattern": "^([0-9]+(\\\\.[0-9]+)?(ms|s|m|h))*$",
|
|
"type": "string"
|
|
},
|
|
"debugSimulateDataplaneApplyDelay": {
|
|
"pattern": "^([0-9]+(\\\\.[0-9]+)?(ms|s|m|h))*$",
|
|
"type": "string"
|
|
},
|
|
"debugSimulateDataplaneHangAfter": {
|
|
"pattern": "^([0-9]+(\\\\.[0-9]+)?(ms|s|m|h))*$",
|
|
"type": "string"
|
|
},
|
|
"defaultEndpointToHostAction": {
|
|
"description": "DefaultEndpointToHostAction 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]",
|
|
"pattern": "^(?i)(Drop|Accept|Return)?$",
|
|
"type": "string"
|
|
},
|
|
"deviceRouteProtocol": {
|
|
"description": "This defines the route protocol added to programmed device routes, by default this will be RTPROT_BOOT when left blank.",
|
|
"type": "integer"
|
|
},
|
|
"deviceRouteSourceAddress": {
|
|
"description": "This is the IPv4 source address to use on programmed device routes. By default the source address is left blank, leaving the kernel to choose the source address used.",
|
|
"type": "string"
|
|
},
|
|
"deviceRouteSourceAddressIPv6": {
|
|
"description": "This is the IPv6 source address to use on programmed device routes. By default the source address is left blank, leaving the kernel to choose the source address used.",
|
|
"type": "string"
|
|
},
|
|
"disableConntrackInvalidCheck": {
|
|
"type": "boolean"
|
|
},
|
|
"endpointReportingDelay": {
|
|
"pattern": "^([0-9]+(\\\\.[0-9]+)?(ms|s|m|h))*$",
|
|
"type": "string"
|
|
},
|
|
"endpointReportingEnabled": {
|
|
"type": "boolean"
|
|
},
|
|
"endpointStatusPathPrefix": {
|
|
"description": "EndpointStatusPathPrefix is the path to the directory where endpoint status will be written. Endpoint status file reporting is disabled if field is left empty. \n Chosen directory should match the directory used by the CNI for PodStartupDelay. [Default: \"\"]",
|
|
"type": "string"
|
|
},
|
|
"externalNodesList": {
|
|
"description": "ExternalNodesCIDRList is a list of CIDR's of external-non-calico-nodes which may source tunnel traffic and have the tunneled traffic be accepted at calico nodes.",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"failsafeInboundHostPorts": {
|
|
"description": "FailsafeInboundHostPorts is a list of PortProto 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. [Default: tcp:22, udp:68, tcp:179, tcp:2379, tcp:2380, tcp:5473, tcp:6443, tcp:6666, tcp:6667 ]",
|
|
"items": {
|
|
"description": "ProtoPort is combination of protocol, port, and CIDR. Protocol and port must be specified.",
|
|
"properties": {
|
|
"net": {
|
|
"type": "string"
|
|
},
|
|
"port": {
|
|
"type": "integer"
|
|
},
|
|
"protocol": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"port",
|
|
"protocol"
|
|
],
|
|
"type": "object",
|
|
"additionalProperties": false
|
|
},
|
|
"type": "array"
|
|
},
|
|
"failsafeOutboundHostPorts": {
|
|
"description": "FailsafeOutboundHostPorts is a list of 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. [Default: udp:53, udp:67, tcp:179, tcp:2379, tcp:2380, tcp:5473, tcp:6443, tcp:6666, tcp:6667 ]",
|
|
"items": {
|
|
"description": "ProtoPort is combination of protocol, port, and CIDR. Protocol and port must be specified.",
|
|
"properties": {
|
|
"net": {
|
|
"type": "string"
|
|
},
|
|
"port": {
|
|
"type": "integer"
|
|
},
|
|
"protocol": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"port",
|
|
"protocol"
|
|
],
|
|
"type": "object",
|
|
"additionalProperties": false
|
|
},
|
|
"type": "array"
|
|
},
|
|
"featureDetectOverride": {
|
|
"description": "FeatureDetectOverride is 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=\". \"true\" or \"false\" will force the feature, empty or omitted values are auto-detected.",
|
|
"pattern": "^([a-zA-Z0-9-_]+=(true|false|),)*([a-zA-Z0-9-_]+=(true|false|))?$",
|
|
"type": "string"
|
|
},
|
|
"featureGates": {
|
|
"description": "FeatureGates is 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.",
|
|
"pattern": "^([a-zA-Z0-9-_]+=([^=]+),)*([a-zA-Z0-9-_]+=([^=]+))?$",
|
|
"type": "string"
|
|
},
|
|
"floatingIPs": {
|
|
"description": "FloatingIPs configures whether or not Felix will program non-OpenStack floating IP addresses. (OpenStack-derived floating IPs are always programmed, regardless of this setting.)",
|
|
"enum": [
|
|
"Enabled",
|
|
"Disabled"
|
|
],
|
|
"type": "string"
|
|
},
|
|
"genericXDPEnabled": {
|
|
"description": "GenericXDPEnabled 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. [Default: false]",
|
|
"type": "boolean"
|
|
},
|
|
"goGCThreshold": {
|
|
"description": "GoGCThreshold 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. \n This setting is overridden by the GOGC environment variable. \n [Default: 40]",
|
|
"type": "integer"
|
|
},
|
|
"goMaxProcs": {
|
|
"description": "GoMaxProcs 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. \n this setting is overridden by the GOMAXPROCS environment variable. \n [Default: -1]",
|
|
"type": "integer"
|
|
},
|
|
"goMemoryLimitMB": {
|
|
"description": "GoMemoryLimitMB 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. \n 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. \n This setting is overridden by the GOMEMLIMIT environment variable. \n [Default: -1]",
|
|
"type": "integer"
|
|
},
|
|
"healthEnabled": {
|
|
"type": "boolean"
|
|
},
|
|
"healthHost": {
|
|
"type": "string"
|
|
},
|
|
"healthPort": {
|
|
"type": "integer"
|
|
},
|
|
"healthTimeoutOverrides": {
|
|
"description": "HealthTimeoutOverrides 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.",
|
|
"items": {
|
|
"properties": {
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"timeout": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"name",
|
|
"timeout"
|
|
],
|
|
"type": "object",
|
|
"additionalProperties": false
|
|
},
|
|
"type": "array"
|
|
},
|
|
"interfaceExclude": {
|
|
"description": "InterfaceExclude is a comma-separated list of interfaces that Felix should exclude when monitoring for host endpoints. The default value ensures that Felix ignores Kubernetes' IPVS dummy interface, which is used internally by kube-proxy. If you want to exclude multiple interface names using a single value, the list supports regular expressions. For regular expressions you must wrap the value with '/'. For example having values '/^kube/,veth1' will exclude all interfaces that begin with 'kube' and also the interface 'veth1'. [Default: kube-ipvs0]",
|
|
"type": "string"
|
|
},
|
|
"interfacePrefix": {
|
|
"description": "InterfacePrefix is 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. [Default: cali]",
|
|
"type": "string"
|
|
},
|
|
"interfaceRefreshInterval": {
|
|
"description": "InterfaceRefreshInterval is the period at which Felix rescans local interfaces to verify their state. The rescan can be disabled by setting the interval to 0.",
|
|
"pattern": "^([0-9]+(\\\\.[0-9]+)?(ms|s|m|h))*$",
|
|
"type": "string"
|
|
},
|
|
"ipForwarding": {
|
|
"description": "IPForwarding controls whether Felix sets the host sysctls to enable IP forwarding. IP forwarding is required when using Calico for workload networking. This should only be disabled on hosts where Calico is used for host protection. [Default: Enabled]",
|
|
"enum": [
|
|
"Enabled",
|
|
"Disabled"
|
|
],
|
|
"type": "string"
|
|
},
|
|
"ipipEnabled": {
|
|
"description": "IPIPEnabled overrides whether Felix should configure an IPIP interface on the host. Optional as Felix determines this based on the existing IP pools. [Default: nil (unset)]",
|
|
"type": "boolean"
|
|
},
|
|
"ipipMTU": {
|
|
"description": "IPIPMTU is the MTU to set on the tunnel device. See Configuring MTU [Default: 1440]",
|
|
"type": "integer"
|
|
},
|
|
"ipsetsRefreshInterval": {
|
|
"description": "IpsetsRefreshInterval is the period 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: 90s]",
|
|
"pattern": "^([0-9]+(\\\\.[0-9]+)?(ms|s|m|h))*$",
|
|
"type": "string"
|
|
},
|
|
"iptablesBackend": {
|
|
"description": "IptablesBackend specifies which backend of iptables will be used. The default is Auto.",
|
|
"pattern": "^(?i)(Auto|FelixConfiguration|FelixConfigurationList|Legacy|NFT)?$",
|
|
"type": "string"
|
|
},
|
|
"iptablesFilterAllowAction": {
|
|
"pattern": "^(?i)(Accept|Return)?$",
|
|
"type": "string"
|
|
},
|
|
"iptablesFilterDenyAction": {
|
|
"description": "IptablesFilterDenyAction 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.",
|
|
"pattern": "^(?i)(Drop|Reject)?$",
|
|
"type": "string"
|
|
},
|
|
"iptablesLockFilePath": {
|
|
"description": "IptablesLockFilePath is 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). [Default: /run/xtables.lock]",
|
|
"type": "string"
|
|
},
|
|
"iptablesLockProbeInterval": {
|
|
"description": "IptablesLockProbeInterval is 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. [Default: 50ms]",
|
|
"pattern": "^([0-9]+(\\\\.[0-9]+)?(ms|s|m|h))*$",
|
|
"type": "string"
|
|
},
|
|
"iptablesLockTimeout": {
|
|
"description": "IptablesLockTimeout is the time that Felix will wait for the iptables lock, or 0, to disable. 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 requires the /run directory of the host to be mounted into the calico/node or calico/felix container. [Default: 0s disabled]",
|
|
"pattern": "^([0-9]+(\\\\.[0-9]+)?(ms|s|m|h))*$",
|
|
"type": "string"
|
|
},
|
|
"iptablesMangleAllowAction": {
|
|
"pattern": "^(?i)(Accept|Return)?$",
|
|
"type": "string"
|
|
},
|
|
"iptablesMarkMask": {
|
|
"description": "IptablesMarkMask is 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. [Default: 0xff000000]",
|
|
"format": "int32",
|
|
"type": "integer"
|
|
},
|
|
"iptablesNATOutgoingInterfaceFilter": {
|
|
"type": "string"
|
|
},
|
|
"iptablesPostWriteCheckInterval": {
|
|
"description": "IptablesPostWriteCheckInterval is 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. [Default: 1s]",
|
|
"pattern": "^([0-9]+(\\\\.[0-9]+)?(ms|s|m|h))*$",
|
|
"type": "string"
|
|
},
|
|
"iptablesRefreshInterval": {
|
|
"description": "IptablesRefreshInterval is 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. [Default: 10s]",
|
|
"pattern": "^([0-9]+(\\\\.[0-9]+)?(ms|s|m|h))*$",
|
|
"type": "string"
|
|
},
|
|
"ipv6Support": {
|
|
"description": "IPv6Support controls whether Felix enables support for IPv6 (if supported by the in-use dataplane).",
|
|
"type": "boolean"
|
|
},
|
|
"kubeNodePortRanges": {
|
|
"description": "KubeNodePortRanges 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. [Default: 30000:32767].",
|
|
"items": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "string"
|
|
}
|
|
],
|
|
"pattern": "^.*",
|
|
"x-kubernetes-int-or-string": true
|
|
},
|
|
"type": "array"
|
|
},
|
|
"logDebugFilenameRegex": {
|
|
"description": "LogDebugFilenameRegex 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.",
|
|
"type": "string"
|
|
},
|
|
"logFilePath": {
|
|
"description": "LogFilePath is the full path to the Felix log. Set to none to disable file logging. [Default: /var/log/calico/felix.log]",
|
|
"type": "string"
|
|
},
|
|
"logPrefix": {
|
|
"description": "LogPrefix is the log prefix that Felix uses when rendering LOG rules. [Default: calico-packet]",
|
|
"type": "string"
|
|
},
|
|
"logSeverityFile": {
|
|
"description": "LogSeverityFile is the log severity above which logs are sent to the log file. [Default: Info]",
|
|
"pattern": "^(?i)(Debug|Info|Warning|Error|Fatal)?$",
|
|
"type": "string"
|
|
},
|
|
"logSeverityScreen": {
|
|
"description": "LogSeverityScreen is the log severity above which logs are sent to the stdout. [Default: Info]",
|
|
"pattern": "^(?i)(Debug|Info|Warning|Error|Fatal)?$",
|
|
"type": "string"
|
|
},
|
|
"logSeveritySys": {
|
|
"description": "LogSeveritySys is the log severity above which logs are sent to the syslog. Set to None for no logging to syslog. [Default: Info]",
|
|
"pattern": "^(?i)(Debug|Info|Warning|Error|Fatal)?$",
|
|
"type": "string"
|
|
},
|
|
"maxIpsetSize": {
|
|
"description": "MaxIpsetSize is the maximum number of IP addresses that can be stored in an IP set. Not applicable if using the nftables backend.",
|
|
"type": "integer"
|
|
},
|
|
"metadataAddr": {
|
|
"description": "MetadataAddr is 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]",
|
|
"type": "string"
|
|
},
|
|
"metadataPort": {
|
|
"description": "MetadataPort is 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].",
|
|
"type": "integer"
|
|
},
|
|
"mtuIfacePattern": {
|
|
"description": "MTUIfacePattern is 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...).",
|
|
"type": "string"
|
|
},
|
|
"natOutgoingAddress": {
|
|
"description": "NATOutgoingAddress 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 (ie it uses the iptables MASQUERADE target)",
|
|
"type": "string"
|
|
},
|
|
"natPortRange": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "string"
|
|
}
|
|
],
|
|
"description": "NATPortRange 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.",
|
|
"pattern": "^.*",
|
|
"x-kubernetes-int-or-string": true
|
|
},
|
|
"netlinkTimeout": {
|
|
"pattern": "^([0-9]+(\\\\.[0-9]+)?(ms|s|m|h))*$",
|
|
"type": "string"
|
|
},
|
|
"nftablesFilterAllowAction": {
|
|
"pattern": "^(?i)(Accept|Return)?$",
|
|
"type": "string"
|
|
},
|
|
"nftablesFilterDenyAction": {
|
|
"description": "FilterDenyAction 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.",
|
|
"pattern": "^(?i)(Drop|Reject)?$",
|
|
"type": "string"
|
|
},
|
|
"nftablesMangleAllowAction": {
|
|
"pattern": "^(?i)(Accept|Return)?$",
|
|
"type": "string"
|
|
},
|
|
"nftablesMarkMask": {
|
|
"description": "MarkMask is 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. [Default: 0xffff0000]",
|
|
"format": "int32",
|
|
"type": "integer"
|
|
},
|
|
"nftablesMode": {
|
|
"description": "NFTablesMode configures nftables support in Felix. [Default: Disabled]",
|
|
"type": "string"
|
|
},
|
|
"nftablesRefreshInterval": {
|
|
"description": "NftablesRefreshInterval controls the interval at which Felix periodically refreshes the nftables rules. [Default: 90s]",
|
|
"type": "string"
|
|
},
|
|
"openstackRegion": {
|
|
"description": "OpenstackRegion is 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. [Default: Empty]",
|
|
"type": "string"
|
|
},
|
|
"policySyncPathPrefix": {
|
|
"description": "PolicySyncPathPrefix is used to by Felix to communicate policy changes to external services, like Application layer policy. [Default: Empty]",
|
|
"type": "string"
|
|
},
|
|
"prometheusGoMetricsEnabled": {
|
|
"description": "PrometheusGoMetricsEnabled 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. [Default: true]",
|
|
"type": "boolean"
|
|
},
|
|
"prometheusMetricsEnabled": {
|
|
"description": "PrometheusMetricsEnabled enables the Prometheus metrics server in Felix if set to true. [Default: false]",
|
|
"type": "boolean"
|
|
},
|
|
"prometheusMetricsHost": {
|
|
"description": "PrometheusMetricsHost is the host that the Prometheus metrics server should bind to. [Default: empty]",
|
|
"type": "string"
|
|
},
|
|
"prometheusMetricsPort": {
|
|
"description": "PrometheusMetricsPort is the TCP port that the Prometheus metrics server should bind to. [Default: 9091]",
|
|
"type": "integer"
|
|
},
|
|
"prometheusProcessMetricsEnabled": {
|
|
"description": "PrometheusProcessMetricsEnabled 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. [Default: true]",
|
|
"type": "boolean"
|
|
},
|
|
"prometheusWireGuardMetricsEnabled": {
|
|
"description": "PrometheusWireGuardMetricsEnabled 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. [Default: true]",
|
|
"type": "boolean"
|
|
},
|
|
"removeExternalRoutes": {
|
|
"description": "Whether or not to remove device routes that have not been programmed by Felix. Disabling this will allow external applications to also add device routes. This is enabled by default which means we will remove externally added routes.",
|
|
"type": "boolean"
|
|
},
|
|
"reportingInterval": {
|
|
"description": "ReportingInterval is the interval at which Felix reports its status into the datastore or 0 to disable. Must be non-zero in OpenStack deployments. [Default: 30s]",
|
|
"pattern": "^([0-9]+(\\\\.[0-9]+)?(ms|s|m|h))*$",
|
|
"type": "string"
|
|
},
|
|
"reportingTTL": {
|
|
"description": "ReportingTTL is the time-to-live setting for process-wide status reports. [Default: 90s]",
|
|
"pattern": "^([0-9]+(\\\\.[0-9]+)?(ms|s|m|h))*$",
|
|
"type": "string"
|
|
},
|
|
"routeRefreshInterval": {
|
|
"description": "RouteRefreshInterval is 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. [Default: 90s]",
|
|
"pattern": "^([0-9]+(\\\\.[0-9]+)?(ms|s|m|h))*$",
|
|
"type": "string"
|
|
},
|
|
"routeSource": {
|
|
"description": "RouteSource configures where Felix gets its routing information. - WorkloadIPs: use workload endpoints to construct routes. - CalicoIPAM: the default - use IPAM data to construct routes.",
|
|
"pattern": "^(?i)(WorkloadIPs|CalicoIPAM)?$",
|
|
"type": "string"
|
|
},
|
|
"routeSyncDisabled": {
|
|
"description": "RouteSyncDisabled will disable all operations performed on the route table. Set to true to run in network-policy mode only.",
|
|
"type": "boolean"
|
|
},
|
|
"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.",
|
|
"properties": {
|
|
"max": {
|
|
"type": "integer"
|
|
},
|
|
"min": {
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"required": [
|
|
"max",
|
|
"min"
|
|
],
|
|
"type": "object",
|
|
"additionalProperties": false
|
|
},
|
|
"routeTableRanges": {
|
|
"description": "Calico programs additional Linux route tables for various purposes. RouteTableRanges specifies a set of table index ranges that Calico should use. Deprecates`RouteTableRange`, overrides `RouteTableRange`.",
|
|
"items": {
|
|
"properties": {
|
|
"max": {
|
|
"type": "integer"
|
|
},
|
|
"min": {
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"required": [
|
|
"max",
|
|
"min"
|
|
],
|
|
"type": "object",
|
|
"additionalProperties": false
|
|
},
|
|
"type": "array"
|
|
},
|
|
"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. [Default: Drop]",
|
|
"pattern": "^(?i)(Drop|Reject|Disabled)?$",
|
|
"type": "string"
|
|
},
|
|
"sidecarAccelerationEnabled": {
|
|
"description": "SidecarAccelerationEnabled enables experimental sidecar acceleration [Default: false]",
|
|
"type": "boolean"
|
|
},
|
|
"usageReportingEnabled": {
|
|
"description": "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]",
|
|
"type": "boolean"
|
|
},
|
|
"usageReportingInitialDelay": {
|
|
"description": "UsageReportingInitialDelay controls the minimum delay before Felix makes a report. [Default: 300s]",
|
|
"pattern": "^([0-9]+(\\\\.[0-9]+)?(ms|s|m|h))*$",
|
|
"type": "string"
|
|
},
|
|
"usageReportingInterval": {
|
|
"description": "UsageReportingInterval controls the interval at which Felix makes reports. [Default: 86400s]",
|
|
"pattern": "^([0-9]+(\\\\.[0-9]+)?(ms|s|m|h))*$",
|
|
"type": "string"
|
|
},
|
|
"useInternalDataplaneDriver": {
|
|
"description": "UseInternalDataplaneDriver, 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.",
|
|
"type": "boolean"
|
|
},
|
|
"vxlanEnabled": {
|
|
"description": "VXLANEnabled overrides whether Felix should create the VXLAN tunnel device for IPv4 VXLAN networking. Optional as Felix determines this based on the existing IP pools. [Default: nil (unset)]",
|
|
"type": "boolean"
|
|
},
|
|
"vxlanMTU": {
|
|
"description": "VXLANMTU is the MTU to set on the IPv4 VXLAN tunnel device. See Configuring MTU [Default: 1410]",
|
|
"type": "integer"
|
|
},
|
|
"vxlanMTUV6": {
|
|
"description": "VXLANMTUV6 is the MTU to set on the IPv6 VXLAN tunnel device. See Configuring MTU [Default: 1390]",
|
|
"type": "integer"
|
|
},
|
|
"vxlanPort": {
|
|
"type": "integer"
|
|
},
|
|
"vxlanVNI": {
|
|
"type": "integer"
|
|
},
|
|
"windowsManageFirewallRules": {
|
|
"description": "WindowsManageFirewallRules configures whether or not Felix will program Windows Firewall rules. (to allow inbound access to its own metrics ports) [Default: Disabled]",
|
|
"enum": [
|
|
"Enabled",
|
|
"Disabled"
|
|
],
|
|
"type": "string"
|
|
},
|
|
"wireguardEnabled": {
|
|
"description": "WireguardEnabled controls whether Wireguard is enabled for IPv4 (encapsulating IPv4 traffic over an IPv4 underlay network). [Default: false]",
|
|
"type": "boolean"
|
|
},
|
|
"wireguardEnabledV6": {
|
|
"description": "WireguardEnabledV6 controls whether Wireguard is enabled for IPv6 (encapsulating IPv6 traffic over an IPv6 underlay network). [Default: false]",
|
|
"type": "boolean"
|
|
},
|
|
"wireguardHostEncryptionEnabled": {
|
|
"description": "WireguardHostEncryptionEnabled controls whether Wireguard host-to-host encryption is enabled. [Default: false]",
|
|
"type": "boolean"
|
|
},
|
|
"wireguardInterfaceName": {
|
|
"description": "WireguardInterfaceName specifies the name to use for the IPv4 Wireguard interface. [Default: wireguard.cali]",
|
|
"type": "string"
|
|
},
|
|
"wireguardInterfaceNameV6": {
|
|
"description": "WireguardInterfaceNameV6 specifies the name to use for the IPv6 Wireguard interface. [Default: wg-v6.cali]",
|
|
"type": "string"
|
|
},
|
|
"wireguardKeepAlive": {
|
|
"description": "WireguardKeepAlive controls Wireguard PersistentKeepalive option. Set 0 to disable. [Default: 0]",
|
|
"pattern": "^([0-9]+(\\\\.[0-9]+)?(ms|s|m|h))*$",
|
|
"type": "string"
|
|
},
|
|
"wireguardListeningPort": {
|
|
"description": "WireguardListeningPort controls the listening port used by IPv4 Wireguard. [Default: 51820]",
|
|
"type": "integer"
|
|
},
|
|
"wireguardListeningPortV6": {
|
|
"description": "WireguardListeningPortV6 controls the listening port used by IPv6 Wireguard. [Default: 51821]",
|
|
"type": "integer"
|
|
},
|
|
"wireguardMTU": {
|
|
"description": "WireguardMTU controls the MTU on the IPv4 Wireguard interface. See Configuring MTU [Default: 1440]",
|
|
"type": "integer"
|
|
},
|
|
"wireguardMTUV6": {
|
|
"description": "WireguardMTUV6 controls the MTU on the IPv6 Wireguard interface. See Configuring MTU [Default: 1420]",
|
|
"type": "integer"
|
|
},
|
|
"wireguardRoutingRulePriority": {
|
|
"description": "WireguardRoutingRulePriority controls the priority value to use for the Wireguard routing rule. [Default: 99]",
|
|
"type": "integer"
|
|
},
|
|
"wireguardThreadingEnabled": {
|
|
"description": "WireguardThreadingEnabled controls whether Wireguard has NAPI threading enabled. [Default: false]",
|
|
"type": "boolean"
|
|
},
|
|
"workloadSourceSpoofing": {
|
|
"description": "WorkloadSourceSpoofing 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.",
|
|
"pattern": "^(?i)(Disabled|Any)?$",
|
|
"type": "string"
|
|
},
|
|
"xdpEnabled": {
|
|
"description": "XDPEnabled enables XDP acceleration for suitable untracked incoming deny rules. [Default: true]",
|
|
"type": "boolean"
|
|
},
|
|
"xdpRefreshInterval": {
|
|
"description": "XDPRefreshInterval is 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. [Default: 90s]",
|
|
"pattern": "^([0-9]+(\\\\.[0-9]+)?(ms|s|m|h))*$",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"additionalProperties": false
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|