From f336a231209133f035642ea08aa754ba15ece196 Mon Sep 17 00:00:00 2001 From: Christopher Tauchen Date: Tue, 3 Feb 2026 12:06:03 +0000 Subject: [PATCH] Update Felix configuration files --- .../components/FelixConfig/config-params.json | 1284 ++++++++++++----- .../components/FelixConfig/config-params.json | 170 ++- 2 files changed, 1056 insertions(+), 398 deletions(-) diff --git a/calico/_includes/components/FelixConfig/config-params.json b/calico/_includes/components/FelixConfig/config-params.json index 66bb6655a5..2a8b2d9baa 100644 --- a/calico/_includes/components/FelixConfig/config-params.json +++ b/calico/_includes/components/FelixConfig/config-params.json @@ -479,7 +479,7 @@ "Fields": [ { "Group": "Process: Feature detection/overrides", - "GroupWithSortPrefix": "01 Process: Feature detection/overrides", + "GroupWithSortPrefix": "00 Process: Feature detection/overrides", "NameConfigFile": "FeatureDetectOverride", "NameEnvVar": "FELIX_FeatureDetectOverride", "NameYAML": "featureDetectOverride", @@ -498,14 +498,14 @@ "Required": false, "OnParseFailure": "ReplaceWithDefault", "AllowedConfigSources": "All", - "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.", - "DescriptionHTML": "

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.

", + "Description": "Used to override feature detection based on auto-detected platform\ncapabilities. Values are specified in a comma separated list with no spaces, example;\n\"SNATFullyRandom=true,MASQFullyRandom=false,RestoreSupportsLock=\". A value of \"true\" or \"false\" will\nforce enable/disable feature, empty or omitted values fall back to auto-detection.", + "DescriptionHTML": "

Used to override feature detection based on auto-detected platform\ncapabilities. Values are specified in a comma separated list with no spaces, example;\n\"SNATFullyRandom=true,MASQFullyRandom=false,RestoreSupportsLock=\". A value of \"true\" or \"false\" will\nforce enable/disable feature, empty or omitted values fall back to auto-detection.

", "UserEditable": true, "GoType": "string" }, { "Group": "Process: Feature detection/overrides", - "GroupWithSortPrefix": "01 Process: Feature detection/overrides", + "GroupWithSortPrefix": "00 Process: Feature detection/overrides", "NameConfigFile": "FeatureGates", "NameEnvVar": "FELIX_FeatureGates", "NameYAML": "featureGates", @@ -524,8 +524,8 @@ "Required": false, "OnParseFailure": "ReplaceWithDefault", "AllowedConfigSources": "All", - "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.", - "DescriptionHTML": "

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.

", + "Description": "Used to enable or disable tech-preview Calico features.\nValues are specified in a comma separated list with no spaces, example;\n\"BPFConnectTimeLoadBalancingWorkaround=enabled,XyZ=false\". This is\nused to enable features that are not fully production ready.", + "DescriptionHTML": "

Used to enable or disable tech-preview Calico features.\nValues are specified in a comma separated list with no spaces, example;\n\"BPFConnectTimeLoadBalancingWorkaround=enabled,XyZ=false\". This is\nused to enable features that are not fully production ready.

", "UserEditable": true, "GoType": "string" } @@ -536,7 +536,7 @@ "Fields": [ { "Group": "Process: Go runtime", - "GroupWithSortPrefix": "01 Process: Go runtime", + "GroupWithSortPrefix": "00 Process: Go runtime", "NameConfigFile": "GoGCThreshold", "NameEnvVar": "FELIX_GoGCThreshold", "NameYAML": "goGCThreshold", @@ -555,14 +555,14 @@ "Required": false, "OnParseFailure": "ReplaceWithDefault", "AllowedConfigSources": "All", - "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.\n\nThis setting is overridden by the GOGC environment variable.", - "DescriptionHTML": "

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.

", + "Description": "Sets the Go runtime's garbage collection threshold. I.e. the percentage that the heap is\nallowed to grow before garbage collection is triggered. In general, doubling the value halves the CPU time\nspent doing GC, but it also doubles peak GC memory overhead. A special value of -1 can be used\nto disable GC entirely; this should only be used in conjunction with the GoMemoryLimitMB setting.\n\nThis setting is overridden by the GOGC environment variable.", + "DescriptionHTML": "

Sets the Go runtime's garbage collection threshold. I.e. the percentage that the heap is\nallowed to grow before garbage collection is triggered. In general, doubling the value halves the CPU time\nspent doing GC, but it also doubles peak GC memory overhead. A special value of -1 can be used\nto disable GC entirely; this should only be used in conjunction with the GoMemoryLimitMB setting.

\n

This setting is overridden by the GOGC environment variable.

", "UserEditable": true, "GoType": "*int" }, { "Group": "Process: Go runtime", - "GroupWithSortPrefix": "01 Process: Go runtime", + "GroupWithSortPrefix": "00 Process: Go runtime", "NameConfigFile": "GoMaxProcs", "NameEnvVar": "FELIX_GoMaxProcs", "NameYAML": "goMaxProcs", @@ -581,14 +581,14 @@ "Required": false, "OnParseFailure": "ReplaceWithDefault", "AllowedConfigSources": "All", - "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.\n\nthis setting is overridden by the GOMAXPROCS environment variable.", - "DescriptionHTML": "

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.

", + "Description": "Sets the maximum number of CPUs that the Go runtime will use concurrently. A value of -1 means\n\"use the system default\"; typically the number of real CPUs on the system.\n\nthis setting is overridden by the GOMAXPROCS environment variable.", + "DescriptionHTML": "

Sets the maximum number of CPUs that the Go runtime will use concurrently. A value of -1 means\n\"use the system default\"; typically the number of real CPUs on the system.

\n

this setting is overridden by the GOMAXPROCS environment variable.

", "UserEditable": true, "GoType": "*int" }, { "Group": "Process: Go runtime", - "GroupWithSortPrefix": "01 Process: Go runtime", + "GroupWithSortPrefix": "00 Process: Go runtime", "NameConfigFile": "GoMemoryLimitMB", "NameEnvVar": "FELIX_GoMemoryLimitMB", "NameYAML": "goMemoryLimitMB", @@ -607,8 +607,8 @@ "Required": false, "OnParseFailure": "ReplaceWithDefault", "AllowedConfigSources": "All", - "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.\n\nNote 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\nThis setting is overridden by the GOMEMLIMIT environment variable.", - "DescriptionHTML": "

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.

", + "Description": "Sets a (soft) memory limit for the Go runtime in MB. The Go runtime will try to keep its memory\nusage under the limit by triggering GC as needed. To avoid thrashing, it will exceed the limit if GC starts to\ntake more than 50% of the process's CPU time. A value of -1 disables the memory limit.\n\nNote that the memory limit, if used, must be considerably less than any hard resource limit set at the container\nor pod level. This is because felix is not the only process that must run in the container or pod.\n\nThis setting is overridden by the GOMEMLIMIT environment variable.", + "DescriptionHTML": "

Sets a (soft) memory limit for the Go runtime in MB. The Go runtime will try to keep its memory\nusage under the limit by triggering GC as needed. To avoid thrashing, it will exceed the limit if GC starts to\ntake 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\nor 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.

", "UserEditable": true, "GoType": "*int" } @@ -619,7 +619,7 @@ "Fields": [ { "Group": "Process: Health port and timeouts", - "GroupWithSortPrefix": "01 Process: Health port and timeouts", + "GroupWithSortPrefix": "00 Process: Health port and timeouts", "NameConfigFile": "HealthEnabled", "NameEnvVar": "FELIX_HealthEnabled", "NameYAML": "healthEnabled", @@ -645,7 +645,7 @@ }, { "Group": "Process: Health port and timeouts", - "GroupWithSortPrefix": "01 Process: Health port and timeouts", + "GroupWithSortPrefix": "00 Process: Health port and timeouts", "NameConfigFile": "HealthHost", "NameEnvVar": "FELIX_HealthHost", "NameYAML": "healthHost", @@ -671,7 +671,7 @@ }, { "Group": "Process: Health port and timeouts", - "GroupWithSortPrefix": "01 Process: Health port and timeouts", + "GroupWithSortPrefix": "00 Process: Health port and timeouts", "NameConfigFile": "HealthPort", "NameEnvVar": "FELIX_HealthPort", "NameYAML": "healthPort", @@ -697,7 +697,7 @@ }, { "Group": "Process: Health port and timeouts", - "GroupWithSortPrefix": "01 Process: Health port and timeouts", + "GroupWithSortPrefix": "00 Process: Health port and timeouts", "NameConfigFile": "HealthTimeoutOverrides", "NameEnvVar": "FELIX_HealthTimeoutOverrides", "NameYAML": "healthTimeoutOverrides", @@ -716,8 +716,8 @@ "Required": false, "OnParseFailure": "ReplaceWithDefault", "AllowedConfigSources": "All", - "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.", - "DescriptionHTML": "

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.

", + "Description": "Allows the internal watchdog timeouts of individual subcomponents to be\noverridden. This is useful for working around \"false positive\" liveness timeouts that can occur\nin particularly stressful workloads or if CPU is constrained. For a list of active\nsubcomponents, see Felix's logs.", + "DescriptionHTML": "

Allows the internal watchdog timeouts of individual subcomponents to be\noverridden. This is useful for working around \"false positive\" liveness timeouts that can occur\nin particularly stressful workloads or if CPU is constrained. For a list of active\nsubcomponents, see Felix's logs.

", "UserEditable": true, "GoType": "[]v3.HealthTimeoutOverride" } @@ -728,7 +728,59 @@ "Fields": [ { "Group": "Process: Logging", - "GroupWithSortPrefix": "01 Process: Logging", + "GroupWithSortPrefix": "00 Process: Logging", + "NameConfigFile": "LogActionRateLimit", + "NameEnvVar": "FELIX_LogActionRateLimit", + "NameYAML": "logActionRateLimit", + "NameGoAPI": "LogActionRateLimit", + "StringSchema": "String matching regex `^([1-9]\\d{0,3}/(?:second|minute|hour|day))?$`", + "StringSchemaHTML": "String matching regex ^([1-9]\\d{0,3}/(?:second|minute|hour|day))?$", + "StringDefault": "", + "ParsedDefault": "", + "ParsedDefaultJSON": "\"\"", + "ParsedType": "string", + "YAMLType": "string", + "YAMLSchema": "String matching the regular expression `^[1-9]\\d{0,3}/(?:second|minute|hour|day)$`.", + "YAMLEnumValues": null, + "YAMLSchemaHTML": "String matching the regular expression ^[1-9]\\d{0,3}/(?:second|minute|hour|day)$.", + "YAMLDefault": "", + "Required": false, + "OnParseFailure": "ReplaceWithDefault", + "AllowedConfigSources": "All", + "Description": "Sets the rate of hitting a Log action. The value must be in the format \"N/unit\",\nwhere N is a number and unit is one of: second, minute, hour, or day. For example: \"10/second\" or \"100/hour\".", + "DescriptionHTML": "

Sets the rate of hitting a Log action. The value must be in the format \"N/unit\",\nwhere N is a number and unit is one of: second, minute, hour, or day. For example: \"10/second\" or \"100/hour\".

", + "UserEditable": true, + "GoType": "*string" + }, + { + "Group": "Process: Logging", + "GroupWithSortPrefix": "00 Process: Logging", + "NameConfigFile": "LogActionRateLimitBurst", + "NameEnvVar": "FELIX_LogActionRateLimitBurst", + "NameYAML": "logActionRateLimitBurst", + "NameGoAPI": "LogActionRateLimitBurst", + "StringSchema": "Integer: [0,2^63-1], [9999,2^63-1]", + "StringSchemaHTML": "Integer: [0,263-1], [9999,263-1]", + "StringDefault": "5", + "ParsedDefault": "5", + "ParsedDefaultJSON": "5", + "ParsedType": "int", + "YAMLType": "integer", + "YAMLSchema": "Integer: [0,2^63-1], [9999,2^63-1]", + "YAMLEnumValues": null, + "YAMLSchemaHTML": "Integer: [0,263-1], [9999,263-1]", + "YAMLDefault": "5", + "Required": false, + "OnParseFailure": "ReplaceWithDefault", + "AllowedConfigSources": "All", + "Description": "Sets the rate limit burst of hitting a Log action when LogActionRateLimit is enabled.", + "DescriptionHTML": "

Sets the rate limit burst of hitting a Log action when LogActionRateLimit is enabled.

", + "UserEditable": true, + "GoType": "*int" + }, + { + "Group": "Process: Logging", + "GroupWithSortPrefix": "00 Process: Logging", "NameConfigFile": "LogDebugFilenameRegex", "NameEnvVar": "FELIX_LogDebugFilenameRegex", "NameYAML": "logDebugFilenameRegex", @@ -747,14 +799,14 @@ "Required": false, "OnParseFailure": "ReplaceWithDefault", "AllowedConfigSources": "All", - "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.", - "DescriptionHTML": "

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.

", + "Description": "Controls which source code files have their Debug log output included in the logs.\nOnly logs from files with names that match the given regular expression are included. The filter only applies\nto Debug level logs.", + "DescriptionHTML": "

Controls which source code files have their Debug log output included in the logs.\nOnly logs from files with names that match the given regular expression are included. The filter only applies\nto Debug level logs.

", "UserEditable": true, "GoType": "string" }, { "Group": "Process: Logging", - "GroupWithSortPrefix": "01 Process: Logging", + "GroupWithSortPrefix": "00 Process: Logging", "NameConfigFile": "LogFilePath", "NameEnvVar": "FELIX_LogFilePath", "NameYAML": "logFilePath", @@ -780,7 +832,7 @@ }, { "Group": "Process: Logging", - "GroupWithSortPrefix": "01 Process: Logging", + "GroupWithSortPrefix": "00 Process: Logging", "NameConfigFile": "LogPrefix", "NameEnvVar": "FELIX_LogPrefix", "NameYAML": "logPrefix", @@ -792,41 +844,42 @@ "ParsedDefaultJSON": "\"calico-packet\"", "ParsedType": "string", "YAMLType": "string", - "YAMLSchema": "String.", + "YAMLSchema": "String matching the regular expression `^([a-zA-Z0-9%: /_-])*$`.", "YAMLEnumValues": null, - "YAMLSchemaHTML": "String.", + "YAMLSchemaHTML": "String matching the regular expression ^([a-zA-Z0-9%: /_-])*$.", "YAMLDefault": "calico-packet", "Required": false, "OnParseFailure": "ReplaceWithDefault", "AllowedConfigSources": "All", - "Description": "The log prefix that Felix uses when rendering LOG rules.", - "DescriptionHTML": "

The log prefix that Felix uses when rendering LOG rules.

", + "Description": "The log prefix that Felix uses when rendering LOG rules. It is possible to use the following specifiers\nto include extra information in the log prefix.\n- %t: Tier name.\n- %k: Kind (short names).\n- %n: Policy or profile name.\n- %p: Policy or profile name (namespace/name for namespaced kinds or just name for non namespaced kinds).\nCalico includes \": \" characters at the end of the generated log prefix.\nNote that iptables shows up to 29 characters for the log prefix and nftables up to 127 characters. Extra characters are truncated.", + "DescriptionHTML": "

The log prefix that Felix uses when rendering LOG rules. It is possible to use the following specifiers\nto include extra information in the log prefix.\n- %t: Tier name.\n- %k: Kind (short names).\n- %n: Policy or profile name.\n- %p: Policy or profile name (namespace/name for namespaced kinds or just name for non namespaced kinds).\nCalico includes \": \" characters at the end of the generated log prefix.\nNote that iptables shows up to 29 characters for the log prefix and nftables up to 127 characters. Extra characters are truncated.

", "UserEditable": true, "GoType": "string" }, { "Group": "Process: Logging", - "GroupWithSortPrefix": "01 Process: Logging", + "GroupWithSortPrefix": "00 Process: Logging", "NameConfigFile": "LogSeverityFile", "NameEnvVar": "FELIX_LogSeverityFile", "NameYAML": "logSeverityFile", "NameGoAPI": "LogSeverityFile", - "StringSchema": "One of: `DEBUG`, `ERROR`, `FATAL`, `INFO`, `WARNING` (case insensitive)", - "StringSchemaHTML": "One of: DEBUG, ERROR, FATAL, INFO, WARNING (case insensitive)", + "StringSchema": "One of: `DEBUG`, `ERROR`, `FATAL`, `INFO`, `TRACE`, `WARNING` (case insensitive)", + "StringSchemaHTML": "One of: DEBUG, ERROR, FATAL, INFO, TRACE, WARNING (case insensitive)", "StringDefault": "INFO", "ParsedDefault": "INFO", "ParsedDefaultJSON": "\"INFO\"", "ParsedType": "string", "YAMLType": "string", - "YAMLSchema": "One of: `Debug`, `Error`, `Fatal`, `Info`, `Warning`.", + "YAMLSchema": "One of: `Debug`, `Error`, `Fatal`, `Info`, `Trace`, `Warning`.", "YAMLEnumValues": [ "Debug", "Error", "Fatal", "Info", + "Trace", "Warning" ], - "YAMLSchemaHTML": "One of: Debug, Error, Fatal, Info, Warning.", + "YAMLSchemaHTML": "One of: Debug, Error, Fatal, Info, Trace, Warning.", "YAMLDefault": "Info", "Required": false, "OnParseFailure": "ReplaceWithDefault", @@ -838,27 +891,28 @@ }, { "Group": "Process: Logging", - "GroupWithSortPrefix": "01 Process: Logging", + "GroupWithSortPrefix": "00 Process: Logging", "NameConfigFile": "LogSeverityScreen", "NameEnvVar": "FELIX_LogSeverityScreen", "NameYAML": "logSeverityScreen", "NameGoAPI": "LogSeverityScreen", - "StringSchema": "One of: `DEBUG`, `ERROR`, `FATAL`, `INFO`, `WARNING` (case insensitive)", - "StringSchemaHTML": "One of: DEBUG, ERROR, FATAL, INFO, WARNING (case insensitive)", + "StringSchema": "One of: `DEBUG`, `ERROR`, `FATAL`, `INFO`, `TRACE`, `WARNING` (case insensitive)", + "StringSchemaHTML": "One of: DEBUG, ERROR, FATAL, INFO, TRACE, WARNING (case insensitive)", "StringDefault": "INFO", "ParsedDefault": "INFO", "ParsedDefaultJSON": "\"INFO\"", "ParsedType": "string", "YAMLType": "string", - "YAMLSchema": "One of: `Debug`, `Error`, `Fatal`, `Info`, `Warning`.", + "YAMLSchema": "One of: `Debug`, `Error`, `Fatal`, `Info`, `Trace`, `Warning`.", "YAMLEnumValues": [ "Debug", "Error", "Fatal", "Info", + "Trace", "Warning" ], - "YAMLSchemaHTML": "One of: Debug, Error, Fatal, Info, Warning.", + "YAMLSchemaHTML": "One of: Debug, Error, Fatal, Info, Trace, Warning.", "YAMLDefault": "Info", "Required": false, "OnParseFailure": "ReplaceWithDefault", @@ -870,27 +924,28 @@ }, { "Group": "Process: Logging", - "GroupWithSortPrefix": "01 Process: Logging", + "GroupWithSortPrefix": "00 Process: Logging", "NameConfigFile": "LogSeveritySys", "NameEnvVar": "FELIX_LogSeveritySys", "NameYAML": "logSeveritySys", "NameGoAPI": "LogSeveritySys", - "StringSchema": "One of: `DEBUG`, `ERROR`, `FATAL`, `INFO`, `WARNING` (case insensitive)", - "StringSchemaHTML": "One of: DEBUG, ERROR, FATAL, INFO, WARNING (case insensitive)", + "StringSchema": "One of: `DEBUG`, `ERROR`, `FATAL`, `INFO`, `TRACE`, `WARNING` (case insensitive)", + "StringSchemaHTML": "One of: DEBUG, ERROR, FATAL, INFO, TRACE, WARNING (case insensitive)", "StringDefault": "INFO", "ParsedDefault": "INFO", "ParsedDefaultJSON": "\"INFO\"", "ParsedType": "string", "YAMLType": "string", - "YAMLSchema": "One of: `Debug`, `Error`, `Fatal`, `Info`, `Warning`.", + "YAMLSchema": "One of: `Debug`, `Error`, `Fatal`, `Info`, `Trace`, `Warning`.", "YAMLEnumValues": [ "Debug", "Error", "Fatal", "Info", + "Trace", "Warning" ], - "YAMLSchemaHTML": "One of: Debug, Error, Fatal, Info, Warning.", + "YAMLSchemaHTML": "One of: Debug, Error, Fatal, Info, Trace, Warning.", "YAMLDefault": "Info", "Required": false, "OnParseFailure": "ReplaceWithDefault", @@ -907,7 +962,7 @@ "Fields": [ { "Group": "Process: Prometheus metrics", - "GroupWithSortPrefix": "01 Process: Prometheus metrics", + "GroupWithSortPrefix": "00 Process: Prometheus metrics", "NameConfigFile": "PrometheusGoMetricsEnabled", "NameEnvVar": "FELIX_PrometheusGoMetricsEnabled", "NameYAML": "prometheusGoMetricsEnabled", @@ -926,14 +981,14 @@ "Required": false, "OnParseFailure": "ReplaceWithDefault", "AllowedConfigSources": "All", - "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.", - "DescriptionHTML": "

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.

", + "Description": "Disables Go runtime metrics collection, which the Prometheus client does by default, when\nset to false. This reduces the number of metrics reported, reducing Prometheus load.", + "DescriptionHTML": "

Disables Go runtime metrics collection, which the Prometheus client does by default, when\nset to false. This reduces the number of metrics reported, reducing Prometheus load.

", "UserEditable": true, "GoType": "*bool" }, { "Group": "Process: Prometheus metrics", - "GroupWithSortPrefix": "01 Process: Prometheus metrics", + "GroupWithSortPrefix": "00 Process: Prometheus metrics", "NameConfigFile": "PrometheusMetricsEnabled", "NameEnvVar": "FELIX_PrometheusMetricsEnabled", "NameYAML": "prometheusMetricsEnabled", @@ -959,7 +1014,7 @@ }, { "Group": "Process: Prometheus metrics", - "GroupWithSortPrefix": "01 Process: Prometheus metrics", + "GroupWithSortPrefix": "00 Process: Prometheus metrics", "NameConfigFile": "PrometheusMetricsHost", "NameEnvVar": "FELIX_PrometheusMetricsHost", "NameYAML": "prometheusMetricsHost", @@ -985,7 +1040,7 @@ }, { "Group": "Process: Prometheus metrics", - "GroupWithSortPrefix": "01 Process: Prometheus metrics", + "GroupWithSortPrefix": "00 Process: Prometheus metrics", "NameConfigFile": "PrometheusMetricsPort", "NameEnvVar": "FELIX_PrometheusMetricsPort", "NameYAML": "prometheusMetricsPort", @@ -1011,7 +1066,7 @@ }, { "Group": "Process: Prometheus metrics", - "GroupWithSortPrefix": "01 Process: Prometheus metrics", + "GroupWithSortPrefix": "00 Process: Prometheus metrics", "NameConfigFile": "PrometheusProcessMetricsEnabled", "NameEnvVar": "FELIX_PrometheusProcessMetricsEnabled", "NameYAML": "prometheusProcessMetricsEnabled", @@ -1030,14 +1085,14 @@ "Required": false, "OnParseFailure": "ReplaceWithDefault", "AllowedConfigSources": "All", - "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.", - "DescriptionHTML": "

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.

", + "Description": "Disables process metrics collection, which the Prometheus client does by default, when\nset to false. This reduces the number of metrics reported, reducing Prometheus load.", + "DescriptionHTML": "

Disables process metrics collection, which the Prometheus client does by default, when\nset to false. This reduces the number of metrics reported, reducing Prometheus load.

", "UserEditable": true, "GoType": "*bool" }, { "Group": "Process: Prometheus metrics", - "GroupWithSortPrefix": "01 Process: Prometheus metrics", + "GroupWithSortPrefix": "00 Process: Prometheus metrics", "NameConfigFile": "PrometheusWireGuardMetricsEnabled", "NameEnvVar": "FELIX_PrometheusWireGuardMetricsEnabled", "NameYAML": "prometheusWireGuardMetricsEnabled", @@ -1056,8 +1111,8 @@ "Required": false, "OnParseFailure": "ReplaceWithDefault", "AllowedConfigSources": "All", - "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.", - "DescriptionHTML": "

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.

", + "Description": "Disables wireguard metrics collection, which the Prometheus client does by default, when\nset to false. This reduces the number of metrics reported, reducing Prometheus load.", + "DescriptionHTML": "

Disables wireguard metrics collection, which the Prometheus client does by default, when\nset to false. This reduces the number of metrics reported, reducing Prometheus load.

", "UserEditable": true, "GoType": "*bool" } @@ -1087,8 +1142,8 @@ "Required": false, "OnParseFailure": "ReplaceWithDefault", "AllowedConfigSources": "All", - "Description": "Controls whether Felix will add a rule to drop IPIP encapsulated traffic from workloads.", - "DescriptionHTML": "

Controls whether Felix will add a rule to drop IPIP encapsulated traffic from workloads.

", + "Description": "Controls whether Felix will add a rule to drop IPIP encapsulated traffic\nfrom workloads.", + "DescriptionHTML": "

Controls whether Felix will add a rule to drop IPIP encapsulated traffic\nfrom workloads.

", "UserEditable": true, "GoType": "*bool" }, @@ -1113,11 +1168,37 @@ "Required": false, "OnParseFailure": "ReplaceWithDefault", "AllowedConfigSources": "All", - "Description": "Controls whether Felix will add a rule to drop VXLAN encapsulated traffic from workloads.", - "DescriptionHTML": "

Controls whether Felix will add a rule to drop VXLAN encapsulated traffic from workloads.

", + "Description": "Controls whether Felix will add a rule to drop VXLAN encapsulated traffic\nfrom workloads.", + "DescriptionHTML": "

Controls whether Felix will add a rule to drop VXLAN encapsulated traffic\nfrom workloads.

", "UserEditable": true, "GoType": "*bool" }, + { + "Group": "Dataplane: Common", + "GroupWithSortPrefix": "10 Dataplane: Common", + "NameConfigFile": "CgroupV2Path", + "NameEnvVar": "FELIX_CgroupV2Path", + "NameYAML": "cgroupV2Path", + "NameGoAPI": "CgroupV2Path", + "StringSchema": "String", + "StringSchemaHTML": "String", + "StringDefault": "", + "ParsedDefault": "", + "ParsedDefaultJSON": "\"\"", + "ParsedType": "string", + "YAMLType": "string", + "YAMLSchema": "String.", + "YAMLEnumValues": null, + "YAMLSchemaHTML": "String.", + "YAMLDefault": "", + "Required": false, + "OnParseFailure": "ReplaceWithDefault", + "AllowedConfigSources": "All", + "Description": "Overrides the default location where to find the cgroup hierarchy.", + "DescriptionHTML": "

Overrides the default location where to find the cgroup hierarchy.

", + "UserEditable": true, + "GoType": "string" + }, { "Group": "Dataplane: Common", "GroupWithSortPrefix": "10 Dataplane: Common", @@ -1142,8 +1223,8 @@ "Required": true, "OnParseFailure": "Exit", "AllowedConfigSources": "All", - "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.", - "DescriptionHTML": "

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.

", + "Description": "Controls whether Felix hooks the kernel's top-level iptables chains by inserting a rule\nat the top of the chain or by appending a rule at the bottom. insert is the safe default since it prevents\nCalico's rules from being bypassed. If you switch to append mode, be sure that the other rules in the chains\nsignal acceptance by falling through to the Calico rules, otherwise the Calico policy will be bypassed.", + "DescriptionHTML": "

Controls whether Felix hooks the kernel's top-level iptables chains by inserting a rule\nat the top of the chain or by appending a rule at the bottom. insert is the safe default since it prevents\nCalico's rules from being bypassed. If you switch to append mode, be sure that the other rules in the chains\nsignal acceptance by falling through to the Calico rules, otherwise the Calico policy will be bypassed.

", "UserEditable": true, "GoType": "string" }, @@ -1168,8 +1249,8 @@ "Required": true, "OnParseFailure": "Exit", "AllowedConfigSources": "All", - "Description": "Filename of the external dataplane driver to use. Only used if UseInternalDataplaneDriver is set to false.", - "DescriptionHTML": "

Filename of the external dataplane driver to use. Only used if UseInternalDataplaneDriver is set to false.

", + "Description": "Filename of the external dataplane driver to use. Only used if UseInternalDataplaneDriver\nis set to false.", + "DescriptionHTML": "

Filename of the external dataplane driver to use. Only used if UseInternalDataplaneDriver\nis set to false.

", "UserEditable": true, "GoType": "string" }, @@ -1194,8 +1275,8 @@ "Required": false, "OnParseFailure": "ReplaceWithDefault", "AllowedConfigSources": "All", - "Description": "The readiness/liveness timeout used for Felix's (internal) dataplane driver. Deprecated: replaced by the generic HealthTimeoutOverrides.", - "DescriptionHTML": "

The readiness/liveness timeout used for Felix's (internal) dataplane driver. Deprecated: replaced by the generic HealthTimeoutOverrides.

", + "Description": "The readiness/liveness timeout used for Felix's (internal) dataplane driver.\nDeprecated: replaced by the generic HealthTimeoutOverrides.", + "DescriptionHTML": "

The readiness/liveness timeout used for Felix's (internal) dataplane driver.\nDeprecated: replaced by the generic HealthTimeoutOverrides.

", "UserEditable": true, "GoType": "*v1.Duration" }, @@ -1224,8 +1305,8 @@ "Required": true, "OnParseFailure": "Exit", "AllowedConfigSources": "All", - "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.", - "DescriptionHTML": "

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.

", + "Description": "Controls what happens to traffic that goes from a workload endpoint to the host\nitself (after the endpoint's egress policy is applied). By default, Calico blocks traffic from workload\nendpoints to the host itself with an iptables \"DROP\" action. If you want to allow some or all traffic from\nendpoint to host, set this parameter to RETURN or ACCEPT. Use RETURN if you have your own rules in the iptables\n\"INPUT\" chain; Calico will insert its rules at the top of that chain, then \"RETURN\" packets to the \"INPUT\" chain\nonce it has completed processing workload endpoint egress policy. Use ACCEPT to unconditionally accept packets\nfrom workloads after processing workload endpoint egress policy.", + "DescriptionHTML": "

Controls what happens to traffic that goes from a workload endpoint to the host\nitself (after the endpoint's egress policy is applied). By default, Calico blocks traffic from workload\nendpoints to the host itself with an iptables \"DROP\" action. If you want to allow some or all traffic from\nendpoint to host, set this parameter to RETURN or ACCEPT. Use RETURN if you have your own rules in the iptables\n\"INPUT\" chain; Calico will insert its rules at the top of that chain, then \"RETURN\" packets to the \"INPUT\" chain\nonce it has completed processing workload endpoint egress policy. Use ACCEPT to unconditionally accept packets\nfrom workloads after processing workload endpoint egress policy.

", "UserEditable": true, "GoType": "string" }, @@ -1250,8 +1331,8 @@ "Required": false, "OnParseFailure": "ReplaceWithDefault", "AllowedConfigSources": "All", - "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.", - "DescriptionHTML": "

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.

", + "Description": "Controls the protocol to set on routes programmed by Felix. The protocol is an 8-bit label\nused to identify the owner of the route.", + "DescriptionHTML": "

Controls the protocol to set on routes programmed by Felix. The protocol is an 8-bit label\nused to identify the owner of the route.

", "UserEditable": true, "GoType": "*int" }, @@ -1276,8 +1357,8 @@ "Required": false, "OnParseFailure": "ReplaceWithDefault", "AllowedConfigSources": "All", - "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.", - "DescriptionHTML": "

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.

", + "Description": "IPv4 address to set as the source hint for routes programmed by Felix. When not set\nthe source address for local traffic from host to workload will be determined by the kernel.", + "DescriptionHTML": "

IPv4 address to set as the source hint for routes programmed by Felix. When not set\nthe source address for local traffic from host to workload will be determined by the kernel.

", "UserEditable": true, "GoType": "string" }, @@ -1302,8 +1383,8 @@ "Required": false, "OnParseFailure": "ReplaceWithDefault", "AllowedConfigSources": "All", - "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.", - "DescriptionHTML": "

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.

", + "Description": "IPv6 address to set as the source hint for routes programmed by Felix. When not set\nthe source address for local traffic from host to workload will be determined by the kernel.", + "DescriptionHTML": "

IPv6 address to set as the source hint for routes programmed by Felix. When not set\nthe source address for local traffic from host to workload will be determined by the kernel.

", "UserEditable": true, "GoType": "string" }, @@ -1328,8 +1409,8 @@ "Required": false, "OnParseFailure": "ReplaceWithDefault", "AllowedConfigSources": "All", - "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.", - "DescriptionHTML": "

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.

", + "Description": "Disables the check for invalid connections in conntrack. While the conntrack\ninvalid check helps to detect malicious traffic, it can also cause issues with certain multi-NIC scenarios.", + "DescriptionHTML": "

Disables the check for invalid connections in conntrack. While the conntrack\ninvalid check helps to detect malicious traffic, it can also cause issues with certain multi-NIC scenarios.

", "UserEditable": true, "GoType": "*bool" }, @@ -1342,20 +1423,20 @@ "NameGoAPI": "EndpointStatusPathPrefix", "StringSchema": "Path to file", "StringSchemaHTML": "Path to file", - "StringDefault": "", - "ParsedDefault": "", - "ParsedDefaultJSON": "\"\"", + "StringDefault": "/var/run/calico", + "ParsedDefault": "/var/run/calico", + "ParsedDefaultJSON": "\"/var/run/calico\"", "ParsedType": "string", "YAMLType": "string", "YAMLSchema": "String.", "YAMLEnumValues": null, "YAMLSchemaHTML": "String.", - "YAMLDefault": "", + "YAMLDefault": "/var/run/calico", "Required": false, "OnParseFailure": "ReplaceWithDefault", "AllowedConfigSources": "All", - "Description": "The path to the directory where endpoint status will be written. Endpoint status file reporting is disabled if field is left empty.\n\nChosen directory should match the directory used by the CNI plugin for PodStartupDelay.", - "DescriptionHTML": "

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 plugin for PodStartupDelay.

", + "Description": "The path to the directory where endpoint status will be written. Endpoint status\nfile reporting is disabled if field is left empty.\n\nChosen directory should match the directory used by the CNI plugin for PodStartupDelay.", + "DescriptionHTML": "

The path to the directory where endpoint status will be written. Endpoint status\nfile reporting is disabled if field is left empty.

\n

Chosen directory should match the directory used by the CNI plugin for PodStartupDelay.

", "UserEditable": true, "GoType": "string" }, @@ -1380,8 +1461,8 @@ "Required": false, "OnParseFailure": "Exit", "AllowedConfigSources": "All", - "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.", - "DescriptionHTML": "

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.

", + "Description": "A list of CIDR's of external, non-Calico nodes from which VXLAN/IPIP overlay traffic\nwill be allowed. By default, external tunneled traffic is blocked to reduce attack surface.", + "DescriptionHTML": "

A list of CIDR's of external, non-Calico nodes from which VXLAN/IPIP overlay traffic\nwill be allowed. By default, external tunneled traffic is blocked to reduce attack surface.

", "UserEditable": true, "GoType": "*[]string" }, @@ -1406,8 +1487,8 @@ "Required": false, "OnParseFailure": "Exit", "AllowedConfigSources": "All", - "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.", - "DescriptionHTML": "

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.

", + "Description": "A list of ProtoPort struct objects including UDP/TCP/SCTP ports and CIDRs that Felix will\nallow incoming traffic to host endpoints on irrespective of the security policy. This is useful to avoid accidentally\ncutting off a host with incorrect configuration. For backwards compatibility, if the protocol is not specified,\nit defaults to \"tcp\". If a CIDR is not specified, it will allow traffic from all addresses. To disable all inbound host ports,\nuse the value \"[]\". The default value allows ssh access, DHCP, BGP, etcd and the Kubernetes API.", + "DescriptionHTML": "

A list of ProtoPort struct objects including UDP/TCP/SCTP ports and CIDRs that Felix will\nallow incoming traffic to host endpoints on irrespective of the security policy. This is useful to avoid accidentally\ncutting off a host with incorrect configuration. For backwards compatibility, if the protocol is not specified,\nit defaults to \"tcp\". If a CIDR is not specified, it will allow traffic from all addresses. To disable all inbound host ports,\nuse the value \"[]\". The default value allows ssh access, DHCP, BGP, etcd and the Kubernetes API.

", "UserEditable": true, "GoType": "*[]v3.ProtoPort" }, @@ -1432,8 +1513,8 @@ "Required": false, "OnParseFailure": "Exit", "AllowedConfigSources": "All", - "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.", - "DescriptionHTML": "

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.

", + "Description": "A list of PortProto struct objects including UDP/TCP/SCTP ports and CIDRs that Felix\nwill allow outgoing traffic from host endpoints to irrespective of the security policy. This is useful to avoid accidentally\ncutting off a host with incorrect configuration. For backwards compatibility, if the protocol is not specified, it defaults\nto \"tcp\". If a CIDR is not specified, it will allow traffic from all addresses. To disable all outbound host ports,\nuse the value \"[]\". The default value opens etcd's standard ports to ensure that Felix does not get cut off from etcd\nas well as allowing DHCP, DNS, BGP and the Kubernetes API.", + "DescriptionHTML": "

A list of PortProto struct objects including UDP/TCP/SCTP ports and CIDRs that Felix\nwill allow outgoing traffic from host endpoints to irrespective of the security policy. This is useful to avoid accidentally\ncutting off a host with incorrect configuration. For backwards compatibility, if the protocol is not specified, it defaults\nto \"tcp\". If a CIDR is not specified, it will allow traffic from all addresses. To disable all outbound host ports,\nuse the value \"[]\". The default value opens etcd's standard ports to ensure that Felix does not get cut off from etcd\nas well as allowing DHCP, DNS, BGP and the Kubernetes API.

", "UserEditable": true, "GoType": "*[]v3.ProtoPort" }, @@ -1451,18 +1532,18 @@ "ParsedDefaultJSON": "\"Disabled\"", "ParsedType": "string", "YAMLType": "string", - "YAMLSchema": "One of: `Disabled`, `Enabled`.", + "YAMLSchema": "One of: `\"Disabled\"`, `\"Enabled\"`.", "YAMLEnumValues": [ - "`Disabled`", - "`Enabled`" + "`\"Disabled\"`", + "`\"Enabled\"`" ], - "YAMLSchemaHTML": "One of: Disabled, Enabled.", + "YAMLSchemaHTML": "One of: \"Disabled\", \"Enabled\".", "YAMLDefault": "Disabled", "Required": false, "OnParseFailure": "ReplaceWithDefault", "AllowedConfigSources": "All", - "Description": "Configures whether or not Felix will program non-OpenStack floating IP addresses. (OpenStack-derived floating IPs are always programmed, regardless of this setting.)", - "DescriptionHTML": "

Configures whether or not Felix will program non-OpenStack floating IP addresses. (OpenStack-derived floating IPs are always programmed, regardless of this setting.)

", + "Description": "Configures whether or not Felix will program non-OpenStack floating IP addresses. (OpenStack-derived\nfloating IPs are always programmed, regardless of this setting.)", + "DescriptionHTML": "

Configures whether or not Felix will program non-OpenStack floating IP addresses. (OpenStack-derived\nfloating IPs are always programmed, regardless of this setting.)

", "UserEditable": true, "GoType": "*v3.FloatingIPType" }, @@ -1480,18 +1561,18 @@ "ParsedDefaultJSON": "\"Enabled\"", "ParsedType": "string", "YAMLType": "string", - "YAMLSchema": "One of: `Disabled`, `Enabled`.", + "YAMLSchema": "One of: `\"Disabled\"`, `\"Enabled\"`.", "YAMLEnumValues": [ - "`Disabled`", - "`Enabled`" + "`\"Disabled\"`", + "`\"Enabled\"`" ], - "YAMLSchemaHTML": "One of: Disabled, Enabled.", + "YAMLSchemaHTML": "One of: \"Disabled\", \"Enabled\".", "YAMLDefault": "Enabled", "Required": false, "OnParseFailure": "ReplaceWithDefault", "AllowedConfigSources": "All", - "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.", - "DescriptionHTML": "

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.

", + "Description": "Controls whether Felix sets the host sysctls to enable IP forwarding. IP forwarding is required\nwhen using Calico for workload networking. This should be disabled only on hosts where Calico is used solely for\nhost protection. In BPF mode, due to a kernel interaction, either IPForwarding must be enabled or BPFEnforceRPF\nmust be disabled.", + "DescriptionHTML": "

Controls whether Felix sets the host sysctls to enable IP forwarding. IP forwarding is required\nwhen using Calico for workload networking. This should be disabled only on hosts where Calico is used solely for\nhost protection. In BPF mode, due to a kernel interaction, either IPForwarding must be enabled or BPFEnforceRPF\nmust be disabled.

", "UserEditable": true, "GoType": "string" }, @@ -1516,8 +1597,8 @@ "Required": false, "OnParseFailure": "ReplaceWithDefault", "AllowedConfigSources": "All", - "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 `kube-ipvs0` device. 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`.", - "DescriptionHTML": "

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. 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.

", + "Description": "A comma-separated list of interface names that should be excluded when Felix is resolving\nhost endpoints. The default value ensures that Felix ignores Kubernetes' internal `kube-ipvs0` device. If you\nwant to exclude multiple interface names using a single value, the list supports regular expressions. For\nregular expressions you must wrap the value with `/`. For example having values `/^kube/,veth1` will exclude\nall interfaces that begin with `kube` and also the interface `veth1`.", + "DescriptionHTML": "

A comma-separated list of interface names that should be excluded when Felix is resolving\nhost endpoints. The default value ensures that Felix ignores Kubernetes' internal kube-ipvs0 device. If you\nwant to exclude multiple interface names using a single value, the list supports regular expressions. For\nregular expressions you must wrap the value with /. For example having values /^kube/,veth1 will exclude\nall interfaces that begin with kube and also the interface veth1.

", "UserEditable": true, "GoType": "string" }, @@ -1542,8 +1623,8 @@ "Required": true, "OnParseFailure": "Exit", "AllowedConfigSources": "All", - "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.", - "DescriptionHTML": "

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.

", + "Description": "The interface name prefix that identifies workload endpoints and so distinguishes\nthem from host endpoint interfaces. Note: in environments other than bare metal, the orchestrators\nconfigure this appropriately. For example our Kubernetes and Docker integrations set the 'cali' value,\nand our OpenStack integration sets the 'tap' value.", + "DescriptionHTML": "

The interface name prefix that identifies workload endpoints and so distinguishes\nthem from host endpoint interfaces. Note: in environments other than bare metal, the orchestrators\nconfigure this appropriately. For example our Kubernetes and Docker integrations set the 'cali' value,\nand our OpenStack integration sets the 'tap' value.

", "UserEditable": true, "GoType": "string" }, @@ -1568,8 +1649,8 @@ "Required": false, "OnParseFailure": "ReplaceWithDefault", "AllowedConfigSources": "All", - "Description": "The period at which Felix rescans local interfaces to verify their state. The rescan can be disabled by setting the interval to 0.", - "DescriptionHTML": "

The period at which Felix rescans local interfaces to verify their state. The rescan can be disabled by setting the interval to 0.

", + "Description": "The period at which Felix rescans local interfaces to verify their state.\nThe rescan can be disabled by setting the interval to 0.", + "DescriptionHTML": "

The period at which Felix rescans local interfaces to verify their state.\nThe rescan can be disabled by setting the interval to 0.

", "UserEditable": true, "GoType": "*v1.Duration" }, @@ -1620,8 +1701,8 @@ "Required": false, "OnParseFailure": "ReplaceWithDefault", "AllowedConfigSources": "All", - "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...).", - "DescriptionHTML": "

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...).

", + "Description": "A regular expression that controls which interfaces Felix should scan in order\nto calculate the host's MTU.\nThis should not match workload interfaces (usually named cali...).", + "DescriptionHTML": "

A regular expression that controls which interfaces Felix should scan in order\nto calculate the host's MTU.\nThis should not match workload interfaces (usually named cali...).

", "UserEditable": true, "GoType": "string" }, @@ -1646,11 +1727,40 @@ "Required": false, "OnParseFailure": "ReplaceWithDefault", "AllowedConfigSources": "All", - "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).", - "DescriptionHTML": "

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).

", + "Description": "Specifies an address to use when performing source NAT for traffic in a natOutgoing pool that\nis leaving the network. By default the address used is an address on the interface the traffic is leaving on\n(i.e. it uses the iptables MASQUERADE target).", + "DescriptionHTML": "

Specifies an address to use when performing source NAT for traffic in a natOutgoing pool that\nis leaving the network. By default the address used is an address on the interface the traffic is leaving on\n(i.e. it uses the iptables MASQUERADE target).

", "UserEditable": true, "GoType": "string" }, + { + "Group": "Dataplane: Common", + "GroupWithSortPrefix": "10 Dataplane: Common", + "NameConfigFile": "NATOutgoingExclusions", + "NameEnvVar": "FELIX_NATOutgoingExclusions", + "NameYAML": "natOutgoingExclusions", + "NameGoAPI": "NATOutgoingExclusions", + "StringSchema": "One of: `IPPoolsAndHostIPs`, `IPPoolsOnly` (case insensitive)", + "StringSchemaHTML": "One of: IPPoolsAndHostIPs, IPPoolsOnly (case insensitive)", + "StringDefault": "IPPoolsOnly", + "ParsedDefault": "IPPoolsOnly", + "ParsedDefaultJSON": "\"IPPoolsOnly\"", + "ParsedType": "string", + "YAMLType": "string", + "YAMLSchema": "One of: `\"IPPoolsAndHostIPs\"`, `\"IPPoolsOnly\"`.", + "YAMLEnumValues": [ + "`\"IPPoolsAndHostIPs\"`", + "`\"IPPoolsOnly\"`" + ], + "YAMLSchemaHTML": "One of: \"IPPoolsAndHostIPs\", \"IPPoolsOnly\".", + "YAMLDefault": "IPPoolsOnly", + "Required": false, + "OnParseFailure": "ReplaceWithDefault", + "AllowedConfigSources": "All", + "Description": "When a IP pool setting `natOutgoing` is true, packets sent from Calico networked containers in this IP pool to destinations will be masqueraded.\nConfigure which type of destinations is excluded from being masqueraded.\n- IPPoolsOnly: destinations outside of this IP pool will be masqueraded.\n- IPPoolsAndHostIPs: destinations outside of this IP pool and all hosts will be masqueraded.", + "DescriptionHTML": "

When a IP pool setting natOutgoing is true, packets sent from Calico networked containers in this IP pool to destinations will be masqueraded.\nConfigure which type of destinations is excluded from being masqueraded.\n- IPPoolsOnly: destinations outside of this IP pool will be masqueraded.\n- IPPoolsAndHostIPs: destinations outside of this IP pool and all hosts will be masqueraded.

", + "UserEditable": true, + "GoType": "*v3.NATOutgoingExclusionsType" + }, { "Group": "Dataplane: Common", "GroupWithSortPrefix": "10 Dataplane: Common", @@ -1672,8 +1782,8 @@ "Required": false, "OnParseFailure": "ReplaceWithDefault", "AllowedConfigSources": "All", - "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.", - "DescriptionHTML": "

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.

", + "Description": "Specifies the range of ports that is used for port mapping when doing outgoing NAT. When unset the default behavior of the\nnetwork stack is used.", + "DescriptionHTML": "

Specifies the range of ports that is used for port mapping when doing outgoing NAT. When unset the default behavior of the\nnetwork stack is used.

", "UserEditable": true, "GoType": "*numorstring.Port" }, @@ -1691,13 +1801,13 @@ "ParsedDefaultJSON": "\"Disabled\"", "ParsedType": "string", "YAMLType": "string", - "YAMLSchema": "One of: `Auto`, `Disabled`, `Enabled`.", + "YAMLSchema": "One of: `\"Auto\"`, `\"Disabled\"`, `\"Enabled\"`.", "YAMLEnumValues": [ - "`Auto`", - "`Disabled`", - "`Enabled`" + "`\"Auto\"`", + "`\"Disabled\"`", + "`\"Enabled\"`" ], - "YAMLSchemaHTML": "One of: Auto, Disabled, Enabled.", + "YAMLSchemaHTML": "One of: \"Auto\", \"Disabled\", \"Enabled\".", "YAMLDefault": "Disabled", "Required": false, "OnParseFailure": "ReplaceWithDefault", @@ -1728,8 +1838,8 @@ "Required": false, "OnParseFailure": "ReplaceWithDefault", "AllowedConfigSources": "All", - "Description": "The timeout when talking to the kernel over the netlink protocol, used for programming routes, rules, and other kernel objects.", - "DescriptionHTML": "

The timeout when talking to the kernel over the netlink protocol, used for programming routes, rules, and other kernel objects.

", + "Description": "The timeout when talking to the kernel over the netlink protocol, used for programming\nroutes, rules, and other kernel objects.", + "DescriptionHTML": "

The timeout when talking to the kernel over the netlink protocol, used for programming\nroutes, rules, and other kernel objects.

", "UserEditable": true, "GoType": "*v1.Duration" }, @@ -1754,11 +1864,40 @@ "Required": false, "OnParseFailure": "ReplaceWithDefault", "AllowedConfigSources": "All", - "Description": "Used to by Felix to communicate policy changes to external services, like Application layer policy.", - "DescriptionHTML": "

Used to by Felix to communicate policy changes to external services, like Application layer policy.

", + "Description": "Used to by Felix to communicate policy changes to external services,\nlike Application layer policy.", + "DescriptionHTML": "

Used to by Felix to communicate policy changes to external services,\nlike Application layer policy.

", "UserEditable": true, "GoType": "string" }, + { + "Group": "Dataplane: Common", + "GroupWithSortPrefix": "10 Dataplane: Common", + "NameConfigFile": "ProgramClusterRoutes", + "NameEnvVar": "FELIX_ProgramClusterRoutes", + "NameYAML": "programClusterRoutes", + "NameGoAPI": "ProgramClusterRoutes", + "StringSchema": "One of: `Disabled`, `Enabled` (case insensitive)", + "StringSchemaHTML": "One of: Disabled, Enabled (case insensitive)", + "StringDefault": "Disabled", + "ParsedDefault": "Disabled", + "ParsedDefaultJSON": "\"Disabled\"", + "ParsedType": "string", + "YAMLType": "string", + "YAMLSchema": "One of: `\"Disabled\"`, `\"Enabled\"`.", + "YAMLEnumValues": [ + "`\"Disabled\"`", + "`\"Enabled\"`" + ], + "YAMLSchemaHTML": "One of: \"Disabled\", \"Enabled\".", + "YAMLDefault": "Disabled", + "Required": false, + "OnParseFailure": "ReplaceWithDefault", + "AllowedConfigSources": "All", + "Description": "Specifies whether Felix should program IPIP routes instead of BIRD.\nFelix always programs VXLAN routes.", + "DescriptionHTML": "

Specifies whether Felix should program IPIP routes instead of BIRD.\nFelix always programs VXLAN routes.

", + "UserEditable": true, + "GoType": "*string" + }, { "Group": "Dataplane: Common", "GroupWithSortPrefix": "10 Dataplane: Common", @@ -1780,8 +1919,34 @@ "Required": false, "OnParseFailure": "ReplaceWithDefault", "AllowedConfigSources": "All", - "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).", - "DescriptionHTML": "

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).

", + "Description": "Controls whether Felix will remove unexpected routes to workload interfaces. Felix will\nalways clean up expected routes that use the configured DeviceRouteProtocol. To add your own routes, you must\nuse a distinct protocol (in addition to setting this field to false).", + "DescriptionHTML": "

Controls whether Felix will remove unexpected routes to workload interfaces. Felix will\nalways clean up expected routes that use the configured DeviceRouteProtocol. To add your own routes, you must\nuse a distinct protocol (in addition to setting this field to false).

", + "UserEditable": true, + "GoType": "*bool" + }, + { + "Group": "Dataplane: Common", + "GroupWithSortPrefix": "10 Dataplane: Common", + "NameConfigFile": "RequireMTUFile", + "NameEnvVar": "FELIX_RequireMTUFile", + "NameYAML": "requireMTUFile", + "NameGoAPI": "RequireMTUFile", + "StringSchema": "Boolean: `true`, `1`, `yes`, `y`, `t` accepted as True; `false`, `0`, `no`, `n`, `f` accepted (case insensitively) as False.", + "StringSchemaHTML": "Boolean: true, 1, yes, y, t accepted as True; false, 0, no, n, f accepted (case insensitively) as False.", + "StringDefault": "false", + "ParsedDefault": "false", + "ParsedDefaultJSON": "false", + "ParsedType": "bool", + "YAMLType": "boolean", + "YAMLSchema": "Boolean.", + "YAMLEnumValues": null, + "YAMLSchemaHTML": "Boolean.", + "YAMLDefault": "false", + "Required": false, + "OnParseFailure": "ReplaceWithDefault", + "AllowedConfigSources": "All", + "Description": "Specifies whether mtu file is required to start the felix.\nOptional as to keep the same as previous behavior.", + "DescriptionHTML": "

Specifies whether mtu file is required to start the felix.\nOptional as to keep the same as previous behavior.

", "UserEditable": true, "GoType": "*bool" }, @@ -1806,8 +1971,8 @@ "Required": false, "OnParseFailure": "ReplaceWithDefault", "AllowedConfigSources": "All", - "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.", - "DescriptionHTML": "

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.

", + "Description": "The period at which Felix re-checks the routes\nin the dataplane to ensure that no other process has accidentally broken Calico's rules.\nSet to 0 to disable route refresh.", + "DescriptionHTML": "

The period at which Felix re-checks the routes\nin the dataplane to ensure that no other process has accidentally broken Calico's rules.\nSet to 0 to disable route refresh.

", "UserEditable": true, "GoType": "*v1.Duration" }, @@ -1835,8 +2000,8 @@ "Required": false, "OnParseFailure": "ReplaceWithDefault", "AllowedConfigSources": "All", - "Description": "Configures where Felix gets its routing information. - WorkloadIPs: use workload endpoints to construct routes. - CalicoIPAM: the default - use IPAM data to construct routes.", - "DescriptionHTML": "

Configures where Felix gets its routing information. - WorkloadIPs: use workload endpoints to construct routes. - CalicoIPAM: the default - use IPAM data to construct routes.

", + "Description": "Configures where Felix gets its routing information.\n- WorkloadIPs: use workload endpoints to construct routes.\n- CalicoIPAM: the default - use IPAM data to construct routes.", + "DescriptionHTML": "

Configures where Felix gets its routing information.\n- WorkloadIPs: use workload endpoints to construct routes.\n- CalicoIPAM: the default - use IPAM data to construct routes.

", "UserEditable": true, "GoType": "string" }, @@ -1861,8 +2026,8 @@ "Required": false, "OnParseFailure": "ReplaceWithDefault", "AllowedConfigSources": "All", - "Description": "Will disable all operations performed on the route table. Set to true to run in network-policy mode only.", - "DescriptionHTML": "

Will disable all operations performed on the route table. Set to true to run in network-policy mode only.

", + "Description": "Will disable all operations performed on the route table. Set to true to\nrun in network-policy mode only.", + "DescriptionHTML": "

Will disable all operations performed on the route table. Set to true to\nrun in network-policy mode only.

", "UserEditable": true, "GoType": "*bool" }, @@ -1887,8 +2052,8 @@ "Required": false, "OnParseFailure": "Exit", "AllowedConfigSources": "All", - "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.", - "DescriptionHTML": "

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.

", + "Description": "Deprecated in favor of RouteTableRanges.\nCalico programs additional Linux route tables for various purposes.\nRouteTableRange specifies the indices of the route tables that Calico should use.", + "DescriptionHTML": "

Deprecated in favor of RouteTableRanges.\nCalico programs additional Linux route tables for various purposes.\nRouteTableRange specifies the indices of the route tables that Calico should use.

", "UserEditable": true, "GoType": "*v3.RouteTableRange" }, @@ -1913,8 +2078,8 @@ "Required": false, "OnParseFailure": "Exit", "AllowedConfigSources": "All", - "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`.", - "DescriptionHTML": "

Calico programs additional Linux route tables for various purposes. RouteTableRanges specifies a set of table index ranges that Calico should use. DeprecatesRouteTableRange, overrides RouteTableRange.

", + "Description": "Calico programs additional Linux route tables for various purposes.\nRouteTableRanges specifies a set of table index ranges that Calico should use.\nDeprecates`RouteTableRange`, overrides `RouteTableRange`.", + "DescriptionHTML": "

Calico programs additional Linux route tables for various purposes.\nRouteTableRanges specifies a set of table index ranges that Calico should use.\nDeprecatesRouteTableRange, overrides RouteTableRange.

", "UserEditable": true, "GoType": "*v3.RouteTableRanges" }, @@ -1943,8 +2108,8 @@ "Required": false, "OnParseFailure": "ReplaceWithDefault", "AllowedConfigSources": "All", - "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.", - "DescriptionHTML": "

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.

", + "Description": "When service IP advertisement is enabled, prevent routing loops to service IPs that are\nnot in use, by dropping or rejecting packets that do not get DNAT'd by kube-proxy.\nUnless set to \"Disabled\", in which case such routing loops continue to be allowed.", + "DescriptionHTML": "

When service IP advertisement is enabled, prevent routing loops to service IPs that are\nnot in use, by dropping or rejecting packets that do not get DNAT'd by kube-proxy.\nUnless set to \"Disabled\", in which case such routing loops continue to be allowed.

", "UserEditable": true, "GoType": "string" }, @@ -1995,8 +2160,8 @@ "Required": false, "OnParseFailure": "ReplaceWithDefault", "AllowedConfigSources": "All", - "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.", - "DescriptionHTML": "

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.

", + "Description": "If true, Felix will use its internal dataplane programming logic. If false, it\nwill launch an external dataplane driver and communicate with it over protobuf.", + "DescriptionHTML": "

If true, Felix will use its internal dataplane programming logic. If false, it\nwill launch an external dataplane driver and communicate with it over protobuf.

", "UserEditable": true, "GoType": "*bool" }, @@ -2024,8 +2189,8 @@ "Required": false, "OnParseFailure": "ReplaceWithDefault", "AllowedConfigSources": "All", - "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.", - "DescriptionHTML": "

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.

", + "Description": "Controls whether pods can use the allowedSourcePrefixes annotation to send traffic with a source IP\naddress that is not theirs. This is disabled by default. When set to \"Any\", pods can request any prefix.", + "DescriptionHTML": "

Controls whether pods can use the allowedSourcePrefixes annotation to send traffic with a source IP\naddress that is not theirs. This is disabled by default. When set to \"Any\", pods can request any prefix.

", "UserEditable": true, "GoType": "string" } @@ -2055,8 +2220,8 @@ "Required": false, "OnParseFailure": "ReplaceWithDefault", "AllowedConfigSources": "All", - "Description": "Controls the period at which Felix re-checks all IP sets to look for discrepancies. Set to 0 to disable the periodic refresh.", - "DescriptionHTML": "

Controls the period at which Felix re-checks all IP sets to look for discrepancies. Set to 0 to disable the periodic refresh.

", + "Description": "Controls the period at which Felix re-checks all IP sets to look for discrepancies.\nSet to 0 to disable the periodic refresh.", + "DescriptionHTML": "

Controls the period at which Felix re-checks all IP sets to look for discrepancies.\nSet to 0 to disable the periodic refresh.

", "UserEditable": true, "GoType": "*v1.Duration" }, @@ -2085,8 +2250,8 @@ "Required": false, "OnParseFailure": "ReplaceWithDefault", "AllowedConfigSources": "All", - "Description": "Controls which backend of iptables will be used. The default is `Auto`.\n\nWarning: changing this on a running system can leave \"orphaned\" rules in the \"other\" backend. These should be cleaned up to avoid confusing interactions.", - "DescriptionHTML": "

Controls which backend of iptables will be used. The default is Auto.

\n

Warning: changing this on a running system can leave \"orphaned\" rules in the \"other\" backend. These should be cleaned up to avoid confusing interactions.

", + "Description": "Controls which backend of iptables will be used. The default is `Auto`.\n\nWarning: changing this on a running system can leave \"orphaned\" rules in the \"other\" backend. These\nshould be cleaned up to avoid confusing interactions.", + "DescriptionHTML": "

Controls which backend of iptables will be used. The default is Auto.

\n

Warning: changing this on a running system can leave \"orphaned\" rules in the \"other\" backend. These\nshould be cleaned up to avoid confusing interactions.

", "UserEditable": true, "GoType": "*v3.IptablesBackend" }, @@ -2114,8 +2279,8 @@ "Required": true, "OnParseFailure": "Exit", "AllowedConfigSources": "All", - "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 `Accept` the traffic. Use `Return` to send the traffic back up to the system chains for further processing.", - "DescriptionHTML": "

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 Accept the traffic. Use Return to send the traffic back up to the system chains for further processing.

", + "Description": "Controls what happens to traffic that is accepted by a Felix policy chain in the\niptables filter table (which is used for \"normal\" policy). The default will immediately `Accept` the traffic. Use\n`Return` to send the traffic back up to the system chains for further processing.", + "DescriptionHTML": "

Controls what happens to traffic that is accepted by a Felix policy chain in the\niptables filter table (which is used for \"normal\" policy). The default will immediately Accept the traffic. Use\nReturn to send the traffic back up to the system chains for further processing.

", "UserEditable": true, "GoType": "string" }, @@ -2143,8 +2308,8 @@ "Required": true, "OnParseFailure": "Exit", "AllowedConfigSources": "All", - "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.", - "DescriptionHTML": "

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.

", + "Description": "Controls what happens to traffic that is denied by network policy. By default Calico blocks traffic\nwith an iptables \"DROP\" action. If you want to use \"REJECT\" action instead you can configure it in here.", + "DescriptionHTML": "

Controls what happens to traffic that is denied by network policy. By default Calico blocks traffic\nwith an iptables \"DROP\" action. If you want to use \"REJECT\" action instead you can configure it in here.

", "UserEditable": true, "GoType": "string" }, @@ -2169,8 +2334,8 @@ "Required": false, "OnParseFailure": "ReplaceWithDefault", "AllowedConfigSources": "All", - "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).", - "DescriptionHTML": "

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).

", + "Description": "The location of the iptables lock file. You may need to change this\nif the lock file is not in its standard location (for example if you have mapped it into Felix's\ncontainer at a different path).", + "DescriptionHTML": "

The location of the iptables lock file. You may need to change this\nif the lock file is not in its standard location (for example if you have mapped it into Felix's\ncontainer at a different path).

", "UserEditable": true, "GoType": "string" }, @@ -2195,8 +2360,8 @@ "Required": false, "OnParseFailure": "ReplaceWithDefault", "AllowedConfigSources": "All", - "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.", - "DescriptionHTML": "

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.

", + "Description": "When IptablesLockTimeout is enabled: the time that Felix will wait between\nattempts to acquire the iptables lock if it is not available. Lower values make Felix more\nresponsive when the lock is contended, but use more CPU.", + "DescriptionHTML": "

When IptablesLockTimeout is enabled: the time that Felix will wait between\nattempts to acquire the iptables lock if it is not available. Lower values make Felix more\nresponsive when the lock is contended, but use more CPU.

", "UserEditable": true, "GoType": "*v1.Duration" }, @@ -2221,8 +2386,8 @@ "Required": false, "OnParseFailure": "ReplaceWithDefault", "AllowedConfigSources": "All", - "Description": "The time that Felix itself will wait for the iptables lock (rather than delegating the lock handling to the `iptables` command).\n\nDeprecated: `iptables-restore` v1.8+ always takes the lock, so enabling this feature results in deadlock.", - "DescriptionHTML": "

The time that Felix itself will wait for the iptables lock (rather than delegating the lock handling to the iptables command).

\n

Deprecated: iptables-restore v1.8+ always takes the lock, so enabling this feature results in deadlock.

", + "Description": "The time that Felix itself will wait for the iptables lock (rather than delegating the\nlock handling to the `iptables` command).\n\nDeprecated: `iptables-restore` v1.8+ always takes the lock, so enabling this feature results in deadlock.", + "DescriptionHTML": "

The time that Felix itself will wait for the iptables lock (rather than delegating the\nlock handling to the iptables command).

\n

Deprecated: iptables-restore v1.8+ always takes the lock, so enabling this feature results in deadlock.

", "UserEditable": true, "GoType": "*v1.Duration" }, @@ -2250,8 +2415,8 @@ "Required": true, "OnParseFailure": "Exit", "AllowedConfigSources": "All", - "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 `Accept` the traffic. Use `Return` to send the traffic back up to the system chains for further processing.", - "DescriptionHTML": "

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 Accept the traffic. Use Return to send the traffic back up to the system chains for further processing.

", + "Description": "Controls what happens to traffic that is accepted by a Felix policy chain in the\niptables mangle table (which is used for \"pre-DNAT\" policy). The default will immediately `Accept` the traffic.\nUse `Return` to send the traffic back up to the system chains for further processing.", + "DescriptionHTML": "

Controls what happens to traffic that is accepted by a Felix policy chain in the\niptables mangle table (which is used for \"pre-DNAT\" policy). The default will immediately Accept the traffic.\nUse Return to send the traffic back up to the system chains for further processing.

", "UserEditable": true, "GoType": "string" }, @@ -2276,8 +2441,8 @@ "Required": true, "OnParseFailure": "Exit", "AllowedConfigSources": "All", - "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.", - "DescriptionHTML": "

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.

", + "Description": "The mask that Felix selects its IPTables Mark bits from. Should be a 32 bit hexadecimal\nnumber with at least 8 bits set, none of which clash with any other mark bits in use on the system.", + "DescriptionHTML": "

The mask that Felix selects its IPTables Mark bits from. Should be a 32 bit hexadecimal\nnumber with at least 8 bits set, none of which clash with any other mark bits in use on the system.

", "UserEditable": true, "GoType": "*uint32" }, @@ -2302,8 +2467,8 @@ "Required": false, "OnParseFailure": "ReplaceWithDefault", "AllowedConfigSources": "All", - "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+.", - "DescriptionHTML": "

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+.

", + "Description": "This parameter can be used to limit the host interfaces on which Calico will apply SNAT to traffic leaving a\nCalico IPAM pool with \"NAT outgoing\" enabled. This can be useful if you have a main data interface, where\ntraffic should be SNATted and a secondary device (such as the docker bridge) which is local to the host and\ndoesn't require SNAT. This parameter uses the iptables interface matching syntax, which allows + as a\nwildcard. Most users will not need to set this. Example: if your data interfaces are eth0 and eth1 and you\nwant to exclude the docker bridge, you could set this to eth+.", + "DescriptionHTML": "

This parameter can be used to limit the host interfaces on which Calico will apply SNAT to traffic leaving a\nCalico IPAM pool with \"NAT outgoing\" enabled. This can be useful if you have a main data interface, where\ntraffic should be SNATted and a secondary device (such as the docker bridge) which is local to the host and\ndoesn't require SNAT. This parameter uses the iptables interface matching syntax, which allows + as a\nwildcard. Most users will not need to set this. Example: if your data interfaces are eth0 and eth1 and you\nwant to exclude the docker bridge, you could set this to eth+.

", "UserEditable": true, "GoType": "string" }, @@ -2328,8 +2493,8 @@ "Required": false, "OnParseFailure": "ReplaceWithDefault", "AllowedConfigSources": "All", - "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.", - "DescriptionHTML": "

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.

", + "Description": "The period after Felix has done a write\nto the dataplane that it schedules an extra read back in order to check the write was not\nclobbered by another process. This should only occur if another application on the system\ndoesn't respect the iptables lock.", + "DescriptionHTML": "

The period after Felix has done a write\nto the dataplane that it schedules an extra read back in order to check the write was not\nclobbered by another process. This should only occur if another application on the system\ndoesn't respect the iptables lock.

", "UserEditable": true, "GoType": "*v1.Duration" }, @@ -2354,8 +2519,8 @@ "Required": false, "OnParseFailure": "ReplaceWithDefault", "AllowedConfigSources": "All", - "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.", - "DescriptionHTML": "

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.

", + "Description": "The period at which Felix re-checks the IP sets\nin the dataplane to ensure that no other process has accidentally broken Calico's rules.\nSet to 0 to disable IP sets refresh. Note: the default for this value is lower than the\nother refresh intervals as a workaround for a Linux kernel bug that was fixed in kernel\nversion 4.11. If you are using v4.11 or greater you may want to set this to, a higher value\nto reduce Felix CPU usage.", + "DescriptionHTML": "

The period at which Felix re-checks the IP sets\nin the dataplane to ensure that no other process has accidentally broken Calico's rules.\nSet to 0 to disable IP sets refresh. Note: the default for this value is lower than the\nother refresh intervals as a workaround for a Linux kernel bug that was fixed in kernel\nversion 4.11. If you are using v4.11 or greater you may want to set this to, a higher value\nto reduce Felix CPU usage.

", "UserEditable": true, "GoType": "*v1.Duration" }, @@ -2380,8 +2545,8 @@ "Required": false, "OnParseFailure": "ReplaceWithDefault", "AllowedConfigSources": "All", - "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. .", - "DescriptionHTML": "

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. .

", + "Description": "Holds list of port ranges used for service node ports. Only used if felix detects kube-proxy running in ipvs mode.\nFelix uses these ranges to separate host and workload traffic. .", + "DescriptionHTML": "

Holds list of port ranges used for service node ports. Only used if felix detects kube-proxy running in ipvs mode.\nFelix uses these ranges to separate host and workload traffic. .

", "UserEditable": true, "GoType": "*[]numorstring.Port" }, @@ -2406,8 +2571,8 @@ "Required": true, "OnParseFailure": "ReplaceWithDefault", "AllowedConfigSources": "All", - "Description": "The maximum number of IP addresses that can be stored in an IP set. Not applicable if using the nftables backend.", - "DescriptionHTML": "

The maximum number of IP addresses that can be stored in an IP set. Not applicable if using the nftables backend.

", + "Description": "The maximum number of IP addresses that can be stored in an IP set. Not applicable\nif using the nftables backend.", + "DescriptionHTML": "

The maximum number of IP addresses that can be stored in an IP set. Not applicable\nif using the nftables backend.

", "UserEditable": true, "GoType": "*int" } @@ -2440,8 +2605,8 @@ "Required": true, "OnParseFailure": "Exit", "AllowedConfigSources": "All", - "Description": "Controls the nftables action that Felix uses to represent the \"allow\" policy verdict in the filter table. The default is to `ACCEPT` the traffic, which is a terminal action. Alternatively, `RETURN` can be used to return the traffic back to the top-level chain for further processing by your rules.", - "DescriptionHTML": "

Controls the nftables action that Felix uses to represent the \"allow\" policy verdict in the filter table. The default is to ACCEPT the traffic, which is a terminal action. Alternatively, RETURN can be used to return the traffic back to the top-level chain for further processing by your rules.

", + "Description": "Controls the nftables action that Felix uses to represent the \"allow\" policy verdict\nin the filter table. The default is to `ACCEPT` the traffic, which is a terminal action. Alternatively,\n`RETURN` can be used to return the traffic back to the top-level chain for further processing by your rules.", + "DescriptionHTML": "

Controls the nftables action that Felix uses to represent the \"allow\" policy verdict\nin the filter table. The default is to ACCEPT the traffic, which is a terminal action. Alternatively,\nRETURN can be used to return the traffic back to the top-level chain for further processing by your rules.

", "UserEditable": true, "GoType": "string" }, @@ -2469,8 +2634,8 @@ "Required": true, "OnParseFailure": "Exit", "AllowedConfigSources": "All", - "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.", - "DescriptionHTML": "

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.

", + "Description": "Controls what happens to traffic that is denied by network policy. By default, Calico\nblocks traffic with a \"drop\" action. If you want to use a \"reject\" action instead you can configure it here.", + "DescriptionHTML": "

Controls what happens to traffic that is denied by network policy. By default, Calico\nblocks traffic with a \"drop\" action. If you want to use a \"reject\" action instead you can configure it here.

", "UserEditable": true, "GoType": "string" }, @@ -2498,8 +2663,8 @@ "Required": true, "OnParseFailure": "Exit", "AllowedConfigSources": "All", - "Description": "Controls the nftables action that Felix uses to represent the \"allow\" policy verdict in the mangle table. The default is to `ACCEPT` the traffic, which is a terminal action. Alternatively, `RETURN` can be used to return the traffic back to the top-level chain for further processing by your rules.", - "DescriptionHTML": "

Controls the nftables action that Felix uses to represent the \"allow\" policy verdict in the mangle table. The default is to ACCEPT the traffic, which is a terminal action. Alternatively, RETURN can be used to return the traffic back to the top-level chain for further processing by your rules.

", + "Description": "Controls the nftables action that Felix uses to represent the \"allow\" policy verdict\nin the mangle table. The default is to `ACCEPT` the traffic, which is a terminal action. Alternatively,\n`RETURN` can be used to return the traffic back to the top-level chain for further processing by your rules.", + "DescriptionHTML": "

Controls the nftables action that Felix uses to represent the \"allow\" policy verdict\nin the mangle table. The default is to ACCEPT the traffic, which is a terminal action. Alternatively,\nRETURN can be used to return the traffic back to the top-level chain for further processing by your rules.

", "UserEditable": true, "GoType": "string" }, @@ -2524,8 +2689,8 @@ "Required": true, "OnParseFailure": "Exit", "AllowedConfigSources": "All", - "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.", - "DescriptionHTML": "

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.

", + "Description": "The mask that Felix selects its nftables Mark bits from. Should be a 32 bit hexadecimal\nnumber with at least 8 bits set, none of which clash with any other mark bits in use on the system.", + "DescriptionHTML": "

The mask that Felix selects its nftables Mark bits from. Should be a 32 bit hexadecimal\nnumber with at least 8 bits set, none of which clash with any other mark bits in use on the system.

", "UserEditable": true, "GoType": "*uint32" }, @@ -2560,6 +2725,35 @@ { "Name": "Dataplane: eBPF", "Fields": [ + { + "Group": "Dataplane: eBPF", + "GroupWithSortPrefix": "22 Dataplane: eBPF", + "NameConfigFile": "BPFAttachType", + "NameEnvVar": "FELIX_BPFAttachType", + "NameYAML": "bpfAttachType", + "NameGoAPI": "BPFAttachType", + "StringSchema": "One of: `TCX`, `TC` (case insensitive)", + "StringSchemaHTML": "One of: TCX, TC (case insensitive)", + "StringDefault": "TCX", + "ParsedDefault": "TCX", + "ParsedDefaultJSON": "\"TCX\"", + "ParsedType": "string", + "YAMLType": "string", + "YAMLSchema": "One of: `\"TC\"`, `\"TCX\"`.", + "YAMLEnumValues": [ + "`\"TC\"`", + "`\"TCX\"`" + ], + "YAMLSchemaHTML": "One of: \"TC\", \"TCX\".", + "YAMLDefault": "TCX", + "Required": true, + "OnParseFailure": "ReplaceWithDefault", + "AllowedConfigSources": "All", + "Description": "Controls how are the BPF programs at the network interfaces attached.\nBy default `TCX` is used where available to enable easier coexistence with 3rd party programs.\n`TC` can force the legacy method of attaching via a qdisc. `TCX` falls back to `TC` if `TCX` is not available.", + "DescriptionHTML": "

Controls how are the BPF programs at the network interfaces attached.\nBy default TCX is used where available to enable easier coexistence with 3rd party programs.\nTC can force the legacy method of attaching via a qdisc. TCX falls back to TC if TCX is not available.

", + "UserEditable": true, + "GoType": "*v3.BPFAttachOption" + }, { "Group": "Dataplane: eBPF", "GroupWithSortPrefix": "22 Dataplane: eBPF", @@ -2581,8 +2775,8 @@ "Required": false, "OnParseFailure": "ReplaceWithDefault", "AllowedConfigSources": "All", - "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.", - "DescriptionHTML": "

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.

", + "Description": "Specifies, what is logged by connect time load balancer when BPFLogLevel is\ndebug. Currently has to be specified as 'all' when BPFLogFilters is set\nto see CTLB logs.", + "DescriptionHTML": "

Specifies, what is logged by connect time load balancer when BPFLogLevel is\ndebug. Currently has to be specified as 'all' when BPFLogFilters is set\nto see CTLB logs.

", "UserEditable": true, "GoType": "string" }, @@ -2600,19 +2794,19 @@ "ParsedDefaultJSON": "\"TCP\"", "ParsedType": "string", "YAMLType": "string", - "YAMLSchema": "One of: `Disabled`, `Enabled`, `TCP`.", + "YAMLSchema": "One of: `\"Disabled\"`, `\"Enabled\"`, `\"TCP\"`.", "YAMLEnumValues": [ - "`Disabled`", - "`Enabled`", - "`TCP`" + "`\"Disabled\"`", + "`\"Enabled\"`", + "`\"TCP\"`" ], - "YAMLSchemaHTML": "One of: Disabled, Enabled, TCP.", + "YAMLSchemaHTML": "One of: \"Disabled\", \"Enabled\", \"TCP\".", "YAMLDefault": "TCP", "Required": true, "OnParseFailure": "ReplaceWithDefault", "AllowedConfigSources": "All", - "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.", - "DescriptionHTML": "

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.

", + "Description": "When in BPF mode, controls whether Felix installs the connect-time load\nbalancer. The connect-time load balancer is required for the host to be able to reach Kubernetes services\nand it improves the performance of pod-to-service connections.When set to TCP, connect time load balancing\nis available only for services with TCP ports.", + "DescriptionHTML": "

When in BPF mode, controls whether Felix installs the connect-time load\nbalancer. The connect-time load balancer is required for the host to be able to reach Kubernetes services\nand it improves the performance of pod-to-service connections.When set to TCP, connect time load balancing\nis available only for services with TCP ports.

", "UserEditable": true, "GoType": "*v3.BPFConnectTimeLBType" }, @@ -2637,11 +2831,96 @@ "Required": false, "OnParseFailure": "ReplaceWithDefault", "AllowedConfigSources": "All", - "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.\n\nDeprecated: Use BPFConnectTimeLoadBalancing.", - "DescriptionHTML": "

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.

\n

Deprecated: Use BPFConnectTimeLoadBalancing.

", + "Description": "When in BPF mode, controls whether Felix installs the connection-time load\nbalancer. The connect-time load balancer is required for the host to be able to reach Kubernetes services\nand it improves the performance of pod-to-service connections. The only reason to disable it is for debugging\npurposes.\n\nDeprecated: Use BPFConnectTimeLoadBalancing.", + "DescriptionHTML": "

When in BPF mode, controls whether Felix installs the connection-time load\nbalancer. The connect-time load balancer is required for the host to be able to reach Kubernetes services\nand it improves the performance of pod-to-service connections. The only reason to disable it is for debugging\npurposes.

\n

Deprecated: Use BPFConnectTimeLoadBalancing.

", "UserEditable": true, "GoType": "*bool" }, + { + "Group": "Dataplane: eBPF", + "GroupWithSortPrefix": "22 Dataplane: eBPF", + "NameConfigFile": "BPFConntrackCleanupMode", + "NameEnvVar": "FELIX_BPFConntrackCleanupMode", + "NameYAML": "bpfConntrackMode", + "NameGoAPI": "BPFConntrackCleanupMode", + "StringSchema": "One of: `Auto`, `BPFProgram`, `Userspace` (case insensitive)", + "StringSchemaHTML": "One of: Auto, BPFProgram, Userspace (case insensitive)", + "StringDefault": "Auto", + "ParsedDefault": "Auto", + "ParsedDefaultJSON": "\"Auto\"", + "ParsedType": "string", + "YAMLType": "string", + "YAMLSchema": "One of: `\"Auto\"`, `\"BPFProgram\"`, `\"Userspace\"`.", + "YAMLEnumValues": [ + "`\"Auto\"`", + "`\"BPFProgram\"`", + "`\"Userspace\"`" + ], + "YAMLSchemaHTML": "One of: \"Auto\", \"BPFProgram\", \"Userspace\".", + "YAMLDefault": "Auto", + "Required": false, + "OnParseFailure": "ReplaceWithDefault", + "AllowedConfigSources": "All", + "Description": "Controls how BPF conntrack entries are cleaned up. `Auto` will use a BPF program if supported,\nfalling back to userspace if not. `Userspace` will always use the userspace cleanup code. `BPFProgram` will\nalways use the BPF program (failing if not supported).\n\n/To be deprecated in future versions as conntrack map type changed to\nlru_hash and userspace cleanup is the only mode that is supported.", + "DescriptionHTML": "

Controls how BPF conntrack entries are cleaned up. Auto will use a BPF program if supported,\nfalling back to userspace if not. Userspace will always use the userspace cleanup code. BPFProgram will\nalways use the BPF program (failing if not supported).

\n

/To be deprecated in future versions as conntrack map type changed to\nlru_hash and userspace cleanup is the only mode that is supported.

", + "UserEditable": true, + "GoType": "*v3.BPFConntrackMode" + }, + { + "Group": "Dataplane: eBPF", + "GroupWithSortPrefix": "22 Dataplane: eBPF", + "NameConfigFile": "BPFConntrackLogLevel", + "NameEnvVar": "FELIX_BPFConntrackLogLevel", + "NameYAML": "bpfConntrackLogLevel", + "NameGoAPI": "BPFConntrackLogLevel", + "StringSchema": "One of: `debug`, `off` (case insensitive)", + "StringSchemaHTML": "One of: debug, off (case insensitive)", + "StringDefault": "off", + "ParsedDefault": "off", + "ParsedDefaultJSON": "\"off\"", + "ParsedType": "string", + "YAMLType": "string", + "YAMLSchema": "One of: `\"Debug\"`, `\"Off\"`.", + "YAMLEnumValues": [ + "`\"Debug\"`", + "`\"Off\"`" + ], + "YAMLSchemaHTML": "One of: \"Debug\", \"Off\".", + "YAMLDefault": "off", + "Required": true, + "OnParseFailure": "ReplaceWithDefault", + "AllowedConfigSources": "All", + "Description": "Controls the log level of the BPF conntrack cleanup program, which runs periodically\nto clean up expired BPF conntrack entries.\n.", + "DescriptionHTML": "

Controls the log level of the BPF conntrack cleanup program, which runs periodically\nto clean up expired BPF conntrack entries.\n.

", + "UserEditable": true, + "GoType": "string" + }, + { + "Group": "Dataplane: eBPF", + "GroupWithSortPrefix": "22 Dataplane: eBPF", + "NameConfigFile": "BPFConntrackTimeouts", + "NameEnvVar": "FELIX_BPFConntrackTimeouts", + "NameYAML": "bpfConntrackTimeouts", + "NameGoAPI": "BPFConntrackTimeouts", + "StringSchema": "Comma-delimited list of key=value pairs", + "StringSchemaHTML": "Comma-delimited list of key=value pairs", + "StringDefault": "CreationGracePeriod=10s,TCPSynSent=20s,TCPEstablished=1h,TCPFinsSeen=Auto,TCPResetSeen=40s,UDPTimeout=60s,GenericTimeout=10m,ICMPTimeout=5s", + "ParsedDefault": "map[CreationGracePeriod:10s GenericTimeout:10m ICMPTimeout:5s TCPEstablished:1h TCPFinsSeen:Auto TCPResetSeen:40s TCPSynSent:20s UDPTimeout:60s]", + "ParsedDefaultJSON": "{\"CreationGracePeriod\":\"10s\",\"GenericTimeout\":\"10m\",\"ICMPTimeout\":\"5s\",\"TCPEstablished\":\"1h\",\"TCPFinsSeen\":\"Auto\",\"TCPResetSeen\":\"40s\",\"TCPSynSent\":\"20s\",\"UDPTimeout\":\"60s\"}", + "ParsedType": "map[string]string", + "YAMLType": "object", + "YAMLSchema": "", + "YAMLEnumValues": null, + "YAMLSchemaHTML": "", + "YAMLDefault": "", + "Required": false, + "OnParseFailure": "ReplaceWithDefault", + "AllowedConfigSources": "All", + "Description": "BPFConntrackTimers overrides the default values for the specified conntrack timer if\nset. Each value can be either a duration or `Auto` to pick the value from\na Linux conntrack timeout.\n\nConfigurable timers are: CreationGracePeriod, TCPSynSent,\nTCPEstablished, TCPFinsSeen, TCPResetSeen, UDPTimeout, GenericTimeout,\nICMPTimeout.\n\nUnset values are replaced by the default values with a warning log for\nincorrect values.", + "DescriptionHTML": "

BPFConntrackTimers overrides the default values for the specified conntrack timer if\nset. Each value can be either a duration or Auto to pick the value from\na Linux conntrack timeout.

\n

Configurable timers are: CreationGracePeriod, TCPSynSent,\nTCPEstablished, TCPFinsSeen, TCPResetSeen, UDPTimeout, GenericTimeout,\nICMPTimeout.

\n

Unset values are replaced by the default values with a warning log for\nincorrect values.

", + "UserEditable": true, + "GoType": "*v3.BPFConntrackTimeouts" + }, { "Group": "Dataplane: eBPF", "GroupWithSortPrefix": "22 Dataplane: eBPF", @@ -2663,8 +2942,8 @@ "Required": false, "OnParseFailure": "ReplaceWithDefault", "AllowedConfigSources": "All", - "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.", - "DescriptionHTML": "

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.

", + "Description": "A list of CIDRs which are excluded from DSR. That is, clients\nin those CIDRs will access service node ports as if BPFExternalServiceMode was set to\nTunnel.", + "DescriptionHTML": "

A list of CIDRs which are excluded from DSR. That is, clients\nin those CIDRs will access service node ports as if BPFExternalServiceMode was set to\nTunnel.

", "UserEditable": true, "GoType": "*[]string" }, @@ -2677,20 +2956,20 @@ "NameGoAPI": "BPFDataIfacePattern", "StringSchema": "Regular expression", "StringSchemaHTML": "Regular expression", - "StringDefault": "^((en|wl|ww|sl|ib)[Popsx].*|(eth|wlan|wwan|bond).*|tunl0$|vxlan.calico$|vxlan-v6.calico$|wireguard.cali$|wg-v6.cali$|egress.calico$)", - "ParsedDefault": "^((en|wl|ww|sl|ib)[Popsx].*|(eth|wlan|wwan|bond).*|tunl0$|vxlan.calico$|vxlan-v6.calico$|wireguard.cali$|wg-v6.cali$|egress.calico$)", - "ParsedDefaultJSON": "\"^((en|wl|ww|sl|ib)[Popsx].*|(eth|wlan|wwan|bond).*|tunl0$|vxlan.calico$|vxlan-v6.calico$|wireguard.cali$|wg-v6.cali$|egress.calico$)\"", + "StringDefault": "^((en|wl|ww|sl|ib)[Popsx].*|(eth|wlan|wwan|bond).*)", + "ParsedDefault": "^((en|wl|ww|sl|ib)[Popsx].*|(eth|wlan|wwan|bond).*)", + "ParsedDefaultJSON": "\"^((en|wl|ww|sl|ib)[Popsx].*|(eth|wlan|wwan|bond).*)\"", "ParsedType": "*regexp.Regexp", "YAMLType": "string", "YAMLSchema": "String.", "YAMLEnumValues": null, "YAMLSchemaHTML": "String.", - "YAMLDefault": "^((en|wl|ww|sl|ib)[Popsx].*|(eth|wlan|wwan|bond).*|tunl0$|vxlan.calico$|vxlan-v6.calico$|wireguard.cali$|wg-v6.cali$|egress.calico$)", + "YAMLDefault": "^((en|wl|ww|sl|ib)[Popsx].*|(eth|wlan|wwan|bond).*)", "Required": false, "OnParseFailure": "ReplaceWithDefault", "AllowedConfigSources": "All", - "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...).", - "DescriptionHTML": "

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...).

", + "Description": "A regular expression that controls which interfaces Felix should attach BPF programs to\nin order to catch traffic to/from the network. This needs to match the interfaces that Calico workload traffic\nflows over as well as any interfaces that handle incoming traffic to nodeports and services from outside the\ncluster. It should not match the workload interfaces (usually named cali...) or any other special device managed\nby Calico itself (e.g., tunnels).", + "DescriptionHTML": "

A regular expression that controls which interfaces Felix should attach BPF programs to\nin order to catch traffic to/from the network. This needs to match the interfaces that Calico workload traffic\nflows over as well as any interfaces that handle incoming traffic to nodeports and services from outside the\ncluster. It should not match the workload interfaces (usually named cali...) or any other special device managed\nby Calico itself (e.g., tunnels).

", "UserEditable": true, "GoType": "string" }, @@ -2715,8 +2994,8 @@ "Required": false, "OnParseFailure": "ReplaceWithDefault", "AllowedConfigSources": "All", - "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...).", - "DescriptionHTML": "

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...).

", + "Description": "A regular expression that controls which interfaces Felix should disable the\nGeneric Receive Offload [GRO] option. It should not match the workload interfaces (usually named cali...).", + "DescriptionHTML": "

A regular expression that controls which interfaces Felix should disable the\nGeneric Receive Offload [GRO] option. It should not match the workload interfaces (usually named cali...).

", "UserEditable": true, "GoType": "string" }, @@ -2741,8 +3020,8 @@ "Required": false, "OnParseFailure": "ReplaceWithDefault", "AllowedConfigSources": "All", - "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.", - "DescriptionHTML": "

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.

", + "Description": "If enabled, Felix sets the kernel.unprivileged_bpf_disabled sysctl to disable\nunprivileged use of BPF. This ensures that unprivileged users cannot access Calico's BPF maps and\ncannot insert their own BPF programs to interfere with Calico's.", + "DescriptionHTML": "

If enabled, Felix sets the kernel.unprivileged_bpf_disabled sysctl to disable\nunprivileged use of BPF. This ensures that unprivileged users cannot access Calico's BPF maps and\ncannot insert their own BPF programs to interfere with Calico's.

", "UserEditable": true, "GoType": "*bool" }, @@ -2797,8 +3076,8 @@ "Required": true, "OnParseFailure": "ReplaceWithDefault", "AllowedConfigSources": "All", - "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.", - "DescriptionHTML": "

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.

", + "Description": "Enforce strict RPF on all host interfaces with BPF programs regardless of\nwhat is the per-interfaces or global setting. Possible values are Disabled, Strict\nor Loose.", + "DescriptionHTML": "

Enforce strict RPF on all host interfaces with BPF programs regardless of\nwhat is the per-interfaces or global setting. Possible values are Disabled, Strict\nor Loose.

", "UserEditable": true, "GoType": "string" }, @@ -2823,11 +3102,37 @@ "Required": false, "OnParseFailure": "ReplaceWithDefault", "AllowedConfigSources": "All", - "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.", - "DescriptionHTML": "

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.

", + "Description": "A list of CIDRs that are to be excluded from NAT\nresolution so that host can handle them. A typical usecase is node local\nDNS cache.", + "DescriptionHTML": "

A list of CIDRs that are to be excluded from NAT\nresolution so that host can handle them. A typical usecase is node local\nDNS cache.

", "UserEditable": true, "GoType": "*[]string" }, + { + "Group": "Dataplane: eBPF", + "GroupWithSortPrefix": "22 Dataplane: eBPF", + "NameConfigFile": "BPFExportBufferSizeMB", + "NameEnvVar": "FELIX_BPFExportBufferSizeMB", + "NameYAML": "bpfExportBufferSizeMB", + "NameGoAPI": "BPFExportBufferSizeMB", + "StringSchema": "Integer", + "StringSchemaHTML": "Integer", + "StringDefault": "1", + "ParsedDefault": "1", + "ParsedDefaultJSON": "1", + "ParsedType": "int", + "YAMLType": "integer", + "YAMLSchema": "Integer", + "YAMLEnumValues": null, + "YAMLSchemaHTML": "Integer", + "YAMLDefault": "1", + "Required": true, + "OnParseFailure": "ReplaceWithDefault", + "AllowedConfigSources": "All", + "Description": "In BPF mode, controls the buffer size used for sending BPF events to felix.", + "DescriptionHTML": "

In BPF mode, controls the buffer size used for sending BPF events to felix.

", + "UserEditable": true, + "GoType": "*int" + }, { "Group": "Dataplane: eBPF", "GroupWithSortPrefix": "22 Dataplane: eBPF", @@ -2849,8 +3154,8 @@ "Required": false, "OnParseFailure": "ReplaceWithDefault", "AllowedConfigSources": "All", - "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.", - "DescriptionHTML": "

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.

", + "Description": "In BPF mode, controls a 32bit mark that is set on connections from an\nexternal client to a local service. This mark allows us to control how packets of that\nconnection are routed within the host and how is routing interpreted by RPF check.", + "DescriptionHTML": "

In BPF mode, controls a 32bit mark that is set on connections from an\nexternal client to a local service. This mark allows us to control how packets of that\nconnection are routed within the host and how is routing interpreted by RPF check.

", "UserEditable": true, "GoType": "*int" }, @@ -2878,8 +3183,8 @@ "Required": true, "OnParseFailure": "ReplaceWithDefault", "AllowedConfigSources": "All", - "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.", - "DescriptionHTML": "

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.

", + "Description": "In BPF mode, controls how connections from outside the cluster to services (node ports\nand cluster IPs) are forwarded to remote workloads. If set to \"Tunnel\" then both request and response traffic\nis tunneled to the remote node. If set to \"DSR\", the request traffic is tunneled but the response traffic\nis sent directly from the remote node. In \"DSR\" mode, the remote node appears to use the IP of the ingress\nnode; this requires a permissive L2 network.", + "DescriptionHTML": "

In BPF mode, controls how connections from outside the cluster to services (node ports\nand cluster IPs) are forwarded to remote workloads. If set to \"Tunnel\" then both request and response traffic\nis tunneled to the remote node. If set to \"DSR\", the request traffic is tunneled but the response traffic\nis sent directly from the remote node. In \"DSR\" mode, the remote node appears to use the IP of the ingress\nnode; this requires a permissive L2 network.

", "UserEditable": true, "GoType": "string" }, @@ -2904,8 +3209,8 @@ "Required": false, "OnParseFailure": "ReplaceWithDefault", "AllowedConfigSources": "All", - "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.", - "DescriptionHTML": "

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.

", + "Description": "In BPF mode, forces traffic from these interfaces\nto skip Calico's iptables NOTRACK rule, allowing traffic from those interfaces to be\ntracked by Linux conntrack. Should only be used for interfaces that are not used for\nthe Calico fabric. For example, a docker bridge device for non-Calico-networked\ncontainers.", + "DescriptionHTML": "

In BPF mode, forces traffic from these interfaces\nto skip Calico's iptables NOTRACK rule, allowing traffic from those interfaces to be\ntracked by Linux conntrack. Should only be used for interfaces that are not used for\nthe Calico fabric. For example, a docker bridge device for non-Calico-networked\ncontainers.

", "UserEditable": true, "GoType": "*[]string" }, @@ -2918,20 +3223,20 @@ "NameGoAPI": "BPFHostConntrackBypass", "StringSchema": "Boolean: `true`, `1`, `yes`, `y`, `t` accepted as True; `false`, `0`, `no`, `n`, `f` accepted (case insensitively) as False.", "StringSchemaHTML": "Boolean: true, 1, yes, y, t accepted as True; false, 0, no, n, f accepted (case insensitively) as False.", - "StringDefault": "true", - "ParsedDefault": "true", - "ParsedDefaultJSON": "true", + "StringDefault": "false", + "ParsedDefault": "false", + "ParsedDefaultJSON": "false", "ParsedType": "bool", "YAMLType": "boolean", "YAMLSchema": "Boolean.", "YAMLEnumValues": null, "YAMLSchemaHTML": "Boolean.", - "YAMLDefault": "true", + "YAMLDefault": "false", "Required": false, "OnParseFailure": "ReplaceWithDefault", "AllowedConfigSources": "All", - "Description": "Controls whether to bypass Linux conntrack in BPF mode for workloads and services.", - "DescriptionHTML": "

Controls whether to bypass Linux conntrack in BPF mode for workloads and services.

", + "Description": "Controls whether to bypass Linux conntrack in BPF mode for\nworkloads and services.", + "DescriptionHTML": "

Controls whether to bypass Linux conntrack in BPF mode for\nworkloads and services.

", "UserEditable": true, "GoType": "*bool" }, @@ -2949,21 +3254,47 @@ "ParsedDefaultJSON": "\"Enabled\"", "ParsedType": "string", "YAMLType": "string", - "YAMLSchema": "One of: `Disabled`, `Enabled`.", + "YAMLSchema": "One of: `\"Disabled\"`, `\"Enabled\"`.", "YAMLEnumValues": [ - "`Disabled`", - "`Enabled`" + "`\"Disabled\"`", + "`\"Enabled\"`" ], - "YAMLSchemaHTML": "One of: Disabled, Enabled.", + "YAMLSchemaHTML": "One of: \"Disabled\", \"Enabled\".", "YAMLDefault": "Enabled", "Required": true, "OnParseFailure": "ReplaceWithDefault", "AllowedConfigSources": "All", - "Description": "When in BPF mode, controls whether Felix does a NAT without CTLB. This along with BPFConnectTimeLoadBalancing determines the CTLB behavior.", - "DescriptionHTML": "

When in BPF mode, controls whether Felix does a NAT without CTLB. This along with BPFConnectTimeLoadBalancing determines the CTLB behavior.

", + "Description": "When in BPF mode, controls whether Felix does a NAT without CTLB. This along with BPFConnectTimeLoadBalancing\ndetermines the CTLB behavior.", + "DescriptionHTML": "

When in BPF mode, controls whether Felix does a NAT without CTLB. This along with BPFConnectTimeLoadBalancing\ndetermines the CTLB behavior.

", "UserEditable": true, "GoType": "*v3.BPFHostNetworkedNATType" }, + { + "Group": "Dataplane: eBPF", + "GroupWithSortPrefix": "22 Dataplane: eBPF", + "NameConfigFile": "BPFJITHardening", + "NameEnvVar": "FELIX_BPFJITHardening", + "NameYAML": "bpfJITHardening", + "NameGoAPI": "BPFJITHardening", + "StringSchema": "One of: `Auto`, `Strict` (case insensitive)", + "StringSchemaHTML": "One of: Auto, Strict (case insensitive)", + "StringDefault": "Auto", + "ParsedDefault": "Auto", + "ParsedDefaultJSON": "\"Auto\"", + "ParsedType": "string", + "YAMLType": "string", + "YAMLSchema": "", + "YAMLEnumValues": null, + "YAMLSchemaHTML": "", + "YAMLDefault": "Auto", + "Required": true, + "OnParseFailure": "ReplaceWithDefault", + "AllowedConfigSources": "All", + "Description": "Controls BPF JIT hardening. When set to \"Auto\", Felix will set JIT hardening to 1\nif it detects the current value is 2 (strict mode that hurts performance). When set to \"Strict\",\nFelix will not modify the JIT hardening setting.", + "DescriptionHTML": "

Controls BPF JIT hardening. When set to \"Auto\", Felix will set JIT hardening to 1\nif it detects the current value is 2 (strict mode that hurts performance). When set to \"Strict\",\nFelix will not modify the JIT hardening setting.

", + "UserEditable": true, + "GoType": "*v3.BPFJITHardeningType" + }, { "Group": "Dataplane: eBPF", "GroupWithSortPrefix": "22 Dataplane: eBPF", @@ -2985,11 +3316,37 @@ "Required": false, "OnParseFailure": "ReplaceWithDefault", "AllowedConfigSources": "All", - "Description": "Deprecated and has no effect. BPF kube-proxy always accepts endpoint slices. This option will be removed in the next release.", - "DescriptionHTML": "

Deprecated and has no effect. BPF kube-proxy always accepts endpoint slices. This option will be removed in the next release.

", + "Description": "Deprecated and has no effect. BPF\nkube-proxy always accepts endpoint slices. This option will be removed in\nthe next release.", + "DescriptionHTML": "

Deprecated and has no effect. BPF\nkube-proxy always accepts endpoint slices. This option will be removed in\nthe next release.

", "UserEditable": true, "GoType": "*bool" }, + { + "Group": "Dataplane: eBPF", + "GroupWithSortPrefix": "22 Dataplane: eBPF", + "NameConfigFile": "BPFKubeProxyHealthzPort", + "NameEnvVar": "FELIX_BPFKubeProxyHealthzPort", + "NameYAML": "bpfKubeProxyHealthzPort", + "NameGoAPI": "BPFKubeProxyHealthzPort", + "StringSchema": "Integer", + "StringSchemaHTML": "Integer", + "StringDefault": "10256", + "ParsedDefault": "10256", + "ParsedDefaultJSON": "10256", + "ParsedType": "int", + "YAMLType": "integer", + "YAMLSchema": "Integer", + "YAMLEnumValues": null, + "YAMLSchemaHTML": "Integer", + "YAMLDefault": "10256", + "Required": true, + "OnParseFailure": "ReplaceWithDefault", + "AllowedConfigSources": "All", + "Description": "In BPF mode, controls the port that Felix's embedded kube-proxy health check server binds to.\nThe health check server is used by external load balancers to determine if this node should receive traffic.", + "DescriptionHTML": "

In BPF mode, controls the port that Felix's embedded kube-proxy health check server binds to.\nThe health check server is used by external load balancers to determine if this node should receive traffic.

", + "UserEditable": true, + "GoType": "*int" + }, { "Group": "Dataplane: eBPF", "GroupWithSortPrefix": "22 Dataplane: eBPF", @@ -3011,8 +3368,8 @@ "Required": false, "OnParseFailure": "ReplaceWithDefault", "AllowedConfigSources": "All", - "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.", - "DescriptionHTML": "

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.

", + "Description": "If enabled in BPF mode, Felix will proactively clean up the upstream\nKubernetes kube-proxy's iptables chains. Should only be enabled if kube-proxy is not running.", + "DescriptionHTML": "

If enabled in BPF mode, Felix will proactively clean up the upstream\nKubernetes kube-proxy's iptables chains. Should only be enabled if kube-proxy is not running.

", "UserEditable": true, "GoType": "*bool" }, @@ -3037,8 +3394,8 @@ "Required": false, "OnParseFailure": "ReplaceWithDefault", "AllowedConfigSources": "All", - "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.", - "DescriptionHTML": "

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.

", + "Description": "In BPF mode, controls the minimum time between updates to the dataplane for Felix's\nembedded kube-proxy. Lower values give reduced set-up latency. Higher values reduce Felix CPU usage by\nbatching up more work.", + "DescriptionHTML": "

In BPF mode, controls the minimum time between updates to the dataplane for Felix's\nembedded kube-proxy. Lower values give reduced set-up latency. Higher values reduce Felix CPU usage by\nbatching up more work.

", "UserEditable": true, "GoType": "*v1.Duration" }, @@ -3063,8 +3420,8 @@ "Required": false, "OnParseFailure": "ReplaceWithDefault", "AllowedConfigSources": "All", - "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.", - "DescriptionHTML": "

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.

", + "Description": "A regular expression that allows to list tunnel devices like wireguard or vxlan (i.e., L3 devices)\nin addition to BPFDataIfacePattern. That is, tunnel interfaces not created by Calico, that Calico workload traffic flows\nover as well as any interfaces that handle incoming traffic to nodeports and services from outside the cluster.", + "DescriptionHTML": "

A regular expression that allows to list tunnel devices like wireguard or vxlan (i.e., L3 devices)\nin addition to BPFDataIfacePattern. That is, tunnel interfaces not created by Calico, that Calico workload traffic flows\nover as well as any interfaces that handle incoming traffic to nodeports and services from outside the cluster.

", "UserEditable": true, "GoType": "string" }, @@ -3089,8 +3446,8 @@ "Required": false, "OnParseFailure": "ReplaceWithDefault", "AllowedConfigSources": "All", - "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.\n\nWhen specified as an env var, it accepts a comma-separated list of key=values.", - "DescriptionHTML": "

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.

", + "Description": "A map of key=values where the value is\na pcap filter expression and the key is an interface name with 'all'\ndenoting all interfaces, 'weps' all workload endpoints and 'heps' all host\nendpoints.\n\nWhen specified as an env var, it accepts a comma-separated list of\nkey=values.", + "DescriptionHTML": "

A map of key=values where the value is\na pcap filter expression and the key is an interface name with 'all'\ndenoting all interfaces, 'weps' all workload endpoints and 'heps' all host\nendpoints.

\n

When specified as an env var, it accepts a comma-separated list of\nkey=values.

", "UserEditable": true, "GoType": "*map[string]string" }, @@ -3119,8 +3476,8 @@ "Required": true, "OnParseFailure": "ReplaceWithDefault", "AllowedConfigSources": "All", - "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 `tc exec bpf debug`. .", - "DescriptionHTML": "

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. .

", + "Description": "Controls the log level of the BPF programs when in BPF dataplane mode. One of \"Off\", \"Info\", or\n\"Debug\". The logs are emitted to the BPF trace pipe, accessible with the command `tc exec bpf debug`.\n.", + "DescriptionHTML": "

Controls the log level of the BPF programs when in BPF dataplane mode. One of \"Off\", \"Info\", or\n\"Debug\". The logs are emitted to the BPF trace pipe, accessible with the command tc exec bpf debug.\n.

", "UserEditable": true, "GoType": "string" }, @@ -3145,11 +3502,66 @@ "Required": true, "OnParseFailure": "ReplaceWithDefault", "AllowedConfigSources": "All", - "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.", - "DescriptionHTML": "

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.

", + "Description": "Sets the size for the conntrack map. This map must be large enough to hold\nan entry for each active connection. Warning: changing the size of the conntrack map can cause disruption.", + "DescriptionHTML": "

Sets the size for the conntrack map. This map must be large enough to hold\nan entry for each active connection. Warning: changing the size of the conntrack map can cause disruption.

", + "UserEditable": true, + "GoType": "*int" + }, + { + "Group": "Dataplane: eBPF", + "GroupWithSortPrefix": "22 Dataplane: eBPF", + "NameConfigFile": "BPFMapSizeConntrackCleanupQueue", + "NameEnvVar": "FELIX_BPFMapSizeConntrackCleanupQueue", + "NameYAML": "bpfMapSizeConntrackCleanupQueue", + "NameGoAPI": "BPFMapSizeConntrackCleanupQueue", + "StringSchema": "Integer", + "StringSchemaHTML": "Integer", + "StringDefault": "100000", + "ParsedDefault": "100000", + "ParsedDefaultJSON": "100000", + "ParsedType": "int", + "YAMLType": "integer", + "YAMLSchema": "Integer", + "YAMLEnumValues": null, + "YAMLSchemaHTML": "Integer", + "YAMLDefault": "100000", + "Required": true, + "OnParseFailure": "ReplaceWithDefault", + "AllowedConfigSources": "All", + "Description": "Sets the size for the map used to hold NAT conntrack entries that are queued\nfor cleanup. This should be big enough to hold all the NAT entries that expire within one cleanup interval.", + "DescriptionHTML": "

Sets the size for the map used to hold NAT conntrack entries that are queued\nfor cleanup. This should be big enough to hold all the NAT entries that expire within one cleanup interval.

", "UserEditable": true, "GoType": "*int" }, + { + "Group": "Dataplane: eBPF", + "GroupWithSortPrefix": "22 Dataplane: eBPF", + "NameConfigFile": "BPFMapSizeConntrackScaling", + "NameEnvVar": "FELIX_BPFMapSizeConntrackScaling", + "NameYAML": "bpfMapSizeConntrackScaling", + "NameGoAPI": "BPFMapSizeConntrackScaling", + "StringSchema": "One of: `Disabled`, `DoubleIfFull` (case insensitive)", + "StringSchemaHTML": "One of: Disabled, DoubleIfFull (case insensitive)", + "StringDefault": "DoubleIfFull", + "ParsedDefault": "DoubleIfFull", + "ParsedDefaultJSON": "\"DoubleIfFull\"", + "ParsedType": "string", + "YAMLType": "string", + "YAMLSchema": "One of: `Disabled`, `DoubleIfFull`.", + "YAMLEnumValues": [ + "Disabled", + "DoubleIfFull" + ], + "YAMLSchemaHTML": "One of: Disabled, DoubleIfFull.", + "YAMLDefault": "DoubleIfFull", + "Required": true, + "OnParseFailure": "ReplaceWithDefault", + "AllowedConfigSources": "All", + "Description": "Controls whether and how we scale the conntrack map size depending\non its usage. 'Disabled' make the size stay at the default or whatever is set by\nBPFMapSizeConntrack*. 'DoubleIfFull' doubles the size when the map is pretty much full even\nafter cleanups.", + "DescriptionHTML": "

Controls whether and how we scale the conntrack map size depending\non its usage. 'Disabled' make the size stay at the default or whatever is set by\nBPFMapSizeConntrack*. 'DoubleIfFull' doubles the size when the map is pretty much full even\nafter cleanups.

", + "UserEditable": true, + "GoType": "string" + }, { "Group": "Dataplane: eBPF", "GroupWithSortPrefix": "22 Dataplane: eBPF", @@ -3171,8 +3583,8 @@ "Required": true, "OnParseFailure": "ReplaceWithDefault", "AllowedConfigSources": "All", - "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).", - "DescriptionHTML": "

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).

", + "Description": "Sets the size for ipsets map. The IP sets map must be large enough to hold an entry\nfor each endpoint matched by every selector in the source/destination matches in network policy. Selectors\nsuch as \"all()\" can result in large numbers of entries (one entry per endpoint in that case).", + "DescriptionHTML": "

Sets the size for ipsets map. The IP sets map must be large enough to hold an entry\nfor each endpoint matched by every selector in the source/destination matches in network policy. Selectors\nsuch as \"all()\" can result in large numbers of entries (one entry per endpoint in that case).

", "UserEditable": true, "GoType": "*int" }, @@ -3197,8 +3609,8 @@ "Required": true, "OnParseFailure": "ReplaceWithDefault", "AllowedConfigSources": "All", - "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.", - "DescriptionHTML": "

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.

", + "Description": "Sets the size for ifstate map. The ifstate map must be large enough to hold an entry\nfor each device (host + workloads) on a host.", + "DescriptionHTML": "

Sets the size for ifstate map. The ifstate map must be large enough to hold an entry\nfor each device (host + workloads) on a host.

", "UserEditable": true, "GoType": "*int" }, @@ -3223,8 +3635,8 @@ "Required": true, "OnParseFailure": "ReplaceWithDefault", "AllowedConfigSources": "All", - "Description": "Sets the size of the BPF map that stores the affinity of a connection (for services that enable that feature.", - "DescriptionHTML": "

Sets the size of the BPF map that stores the affinity of a connection (for services that enable that feature.

", + "Description": "Sets the size of the BPF map that stores the affinity of a connection (for services that\nenable that feature.", + "DescriptionHTML": "

Sets the size of the BPF map that stores the affinity of a connection (for services that\nenable that feature.

", "UserEditable": true, "GoType": "*int" }, @@ -3249,8 +3661,8 @@ "Required": true, "OnParseFailure": "ReplaceWithDefault", "AllowedConfigSources": "All", - "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.", - "DescriptionHTML": "

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.

", + "Description": "Sets the size for NAT back end map.\nThis is the total number of endpoints. This is mostly\nmore than the size of the number of services.", + "DescriptionHTML": "

Sets the size for NAT back end map.\nThis is the total number of endpoints. This is mostly\nmore than the size of the number of services.

", "UserEditable": true, "GoType": "*int" }, @@ -3275,8 +3687,34 @@ "Required": true, "OnParseFailure": "ReplaceWithDefault", "AllowedConfigSources": "All", - "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.", - "DescriptionHTML": "

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.

", + "Description": "Sets the size for NAT front end map.\nFrontendMap should be large enough to hold an entry for each nodeport,\nexternal IP and each port in each service.", + "DescriptionHTML": "

Sets the size for NAT front end map.\nFrontendMap should be large enough to hold an entry for each nodeport,\nexternal IP and each port in each service.

", + "UserEditable": true, + "GoType": "*int" + }, + { + "Group": "Dataplane: eBPF", + "GroupWithSortPrefix": "22 Dataplane: eBPF", + "NameConfigFile": "BPFMapSizePerCPUConntrack", + "NameEnvVar": "FELIX_BPFMapSizePerCPUConntrack", + "NameYAML": "bpfMapSizePerCpuConntrack", + "NameGoAPI": "BPFMapSizePerCPUConntrack", + "StringSchema": "Integer", + "StringSchemaHTML": "Integer", + "StringDefault": "0", + "ParsedDefault": "0", + "ParsedDefaultJSON": "0", + "ParsedType": "int", + "YAMLType": "integer", + "YAMLSchema": "Integer", + "YAMLEnumValues": null, + "YAMLSchemaHTML": "Integer", + "YAMLDefault": "0", + "Required": false, + "OnParseFailure": "ReplaceWithDefault", + "AllowedConfigSources": "All", + "Description": "Determines the size of conntrack map based on the number of CPUs. If set to a\nnon-zero value, overrides BPFMapSizeConntrack with `BPFMapSizePerCPUConntrack * (Number of CPUs)`.\nThis map must be large enough to hold an entry for each active connection. Warning: changing the size of the\nconntrack map can cause disruption.", + "DescriptionHTML": "

Determines the size of conntrack map based on the number of CPUs. If set to a\nnon-zero value, overrides BPFMapSizeConntrack with BPFMapSizePerCPUConntrack * (Number of CPUs).\nThis map must be large enough to hold an entry for each active connection. Warning: changing the size of the\nconntrack map can cause disruption.

", "UserEditable": true, "GoType": "*int" }, @@ -3301,8 +3739,8 @@ "Required": true, "OnParseFailure": "ReplaceWithDefault", "AllowedConfigSources": "All", - "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).", - "DescriptionHTML": "

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).

", + "Description": "Sets the size for the routes map. The routes map should be large enough\nto hold one entry per workload and a handful of entries per host (enough to cover its own IPs and\ntunnel IPs).", + "DescriptionHTML": "

Sets the size for the routes map. The routes map should be large enough\nto hold one entry per workload and a handful of entries per host (enough to cover its own IPs and\ntunnel IPs).

", "UserEditable": true, "GoType": "*int" }, @@ -3327,8 +3765,8 @@ "Required": false, "OnParseFailure": "ReplaceWithDefault", "AllowedConfigSources": "All", - "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.", - "DescriptionHTML": "

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.

", + "Description": "Sets the range from which we randomly pick a port if there is a source port\ncollision. This should be within the ephemeral range as defined by RFC 6056 (1024–65535) and\npreferably outside the ephemeral ranges used by common operating systems. Linux uses\n32768–60999, while others mostly use the IANA defined range 49152–65535. It is not necessarily\na problem if this range overlaps with the operating systems. Both ends of the range are\ninclusive.", + "DescriptionHTML": "

Sets the range from which we randomly pick a port if there is a source port\ncollision. This should be within the ephemeral range as defined by RFC 6056 (1024–65535) and\npreferably outside the ephemeral ranges used by common operating systems. Linux uses\n32768–60999, while others mostly use the IANA defined range 49152–65535. It is not necessarily\na problem if this range overlaps with the operating systems. Both ends of the range are\ninclusive.

", "UserEditable": true, "GoType": "*numorstring.Port" }, @@ -3353,11 +3791,40 @@ "Required": false, "OnParseFailure": "ReplaceWithDefault", "AllowedConfigSources": "All", - "Description": "When true, Felix records detailed information about the BPF policy programs, which can be examined with the calico-bpf command-line tool.", - "DescriptionHTML": "

When true, Felix records detailed information about the BPF policy programs, which can be examined with the calico-bpf command-line tool.

", + "Description": "When true, Felix records detailed information\nabout the BPF policy programs, which can be examined with the calico-bpf command-line tool.", + "DescriptionHTML": "

When true, Felix records detailed information\nabout the BPF policy programs, which can be examined with the calico-bpf command-line tool.

", "UserEditable": true, "GoType": "*bool" }, + { + "Group": "Dataplane: eBPF", + "GroupWithSortPrefix": "22 Dataplane: eBPF", + "NameConfigFile": "BPFProfiling", + "NameEnvVar": "FELIX_BPFProfiling", + "NameYAML": "bpfProfiling", + "NameGoAPI": "BPFProfiling", + "StringSchema": "One of: `Disabled`, `Enabled` (case insensitive)", + "StringSchemaHTML": "One of: Disabled, Enabled (case insensitive)", + "StringDefault": "Disabled", + "ParsedDefault": "Disabled", + "ParsedDefaultJSON": "\"Disabled\"", + "ParsedType": "string", + "YAMLType": "string", + "YAMLSchema": "One of: `\"Disabled\"`, `\"Enabled\"`.", + "YAMLEnumValues": [ + "`\"Disabled\"`", + "`\"Enabled\"`" + ], + "YAMLSchemaHTML": "One of: \"Disabled\", \"Enabled\".", + "YAMLDefault": "Disabled", + "Required": true, + "OnParseFailure": "ReplaceWithDefault", + "AllowedConfigSources": "All", + "Description": "Controls profiling of BPF programs. At the monent, it can be\nDisabled or Enabled.", + "DescriptionHTML": "

Controls profiling of BPF programs. At the monent, it can be\nDisabled or Enabled.

", + "UserEditable": true, + "GoType": "string" + }, { "Group": "Dataplane: eBPF", "GroupWithSortPrefix": "22 Dataplane: eBPF", @@ -3372,15 +3839,19 @@ "ParsedDefaultJSON": "\"L2Only\"", "ParsedType": "string", "YAMLType": "string", - "YAMLSchema": "String.", - "YAMLEnumValues": null, - "YAMLSchemaHTML": "String.", + "YAMLSchema": "One of: `\"Disabled\"`, `\"Enabled\"`, `\"L2Only\"`.", + "YAMLEnumValues": [ + "`\"Disabled\"`", + "`\"Enabled\"`", + "`\"L2Only\"`" + ], + "YAMLSchemaHTML": "One of: \"Disabled\", \"Enabled\", \"L2Only\".", "YAMLDefault": "L2Only", "Required": true, "OnParseFailure": "ReplaceWithDefault", "AllowedConfigSources": "All", - "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.", - "DescriptionHTML": "

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.

", + "Description": "Controls which whether it is allowed to forward straight to the\npeer side of the workload devices. It is allowed for any host L2 devices by default\n(L2Only), but it breaks TCP dump on the host side of workload device as it bypasses\nit on ingress. Value of Enabled also allows redirection from L3 host devices like\nIPIP tunnel or Wireguard directly to the peer side of the workload's device. This\nmakes redirection faster, however, it breaks tools like tcpdump on the peer side.\nUse Enabled with caution.", + "DescriptionHTML": "

Controls which whether it is allowed to forward straight to the\npeer side of the workload devices. It is allowed for any host L2 devices by default\n(L2Only), but it breaks TCP dump on the host side of workload device as it bypasses\nit on ingress. Value of Enabled also allows redirection from L3 host devices like\nIPIP tunnel or Wireguard directly to the peer side of the workload's device. This\nmakes redirection faster, however, it breaks tools like tcpdump on the peer side.\nUse Enabled with caution.

", "UserEditable": true, "GoType": "string" } @@ -3403,12 +3874,12 @@ "ParsedDefaultJSON": "\"Disabled\"", "ParsedType": "string", "YAMLType": "string", - "YAMLSchema": "One of: `Disabled`, `Enabled`.", + "YAMLSchema": "One of: `\"Disabled\"`, `\"Enabled\"`.", "YAMLEnumValues": [ - "`Disabled`", - "`Enabled`" + "`\"Disabled\"`", + "`\"Enabled\"`" ], - "YAMLSchemaHTML": "One of: Disabled, Enabled.", + "YAMLSchemaHTML": "One of: \"Disabled\", \"Enabled\".", "YAMLDefault": "Disabled", "Required": false, "OnParseFailure": "ReplaceWithDefault", @@ -3444,8 +3915,8 @@ "Required": false, "OnParseFailure": "ReplaceWithDefault", "AllowedConfigSources": "All", - "Description": "The delay before Felix reports endpoint status to the datastore. This is only used by the OpenStack integration.", - "DescriptionHTML": "

The delay before Felix reports endpoint status to the datastore. This is only used by the OpenStack integration.

", + "Description": "The delay before Felix reports endpoint status to the datastore. This is only used\nby the OpenStack integration.", + "DescriptionHTML": "

The delay before Felix reports endpoint status to the datastore. This is only used\nby the OpenStack integration.

", "UserEditable": true, "GoType": "*v1.Duration" }, @@ -3470,8 +3941,8 @@ "Required": false, "OnParseFailure": "ReplaceWithDefault", "AllowedConfigSources": "All", - "Description": "Controls whether Felix reports endpoint status to the datastore. This is only used by the OpenStack integration.", - "DescriptionHTML": "

Controls whether Felix reports endpoint status to the datastore. This is only used by the OpenStack integration.

", + "Description": "Controls whether Felix reports endpoint status to the datastore. This is only used\nby the OpenStack integration.", + "DescriptionHTML": "

Controls whether Felix reports endpoint status to the datastore. This is only used\nby the OpenStack integration.

", "UserEditable": true, "GoType": "*bool" }, @@ -3496,8 +3967,8 @@ "Required": false, "OnParseFailure": "Exit", "AllowedConfigSources": "All", - "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.", - "DescriptionHTML": "

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.

", + "Description": "The IP address or domain name of the server that can answer VM queries for\ncloud-init metadata. In OpenStack, this corresponds to the machine running nova-api (or in\nUbuntu, nova-api-metadata). A value of none (case-insensitive) means that Felix should not\nset up any NAT rule for the metadata path.", + "DescriptionHTML": "

The IP address or domain name of the server that can answer VM queries for\ncloud-init metadata. In OpenStack, this corresponds to the machine running nova-api (or in\nUbuntu, nova-api-metadata). A value of none (case-insensitive) means that Felix should not\nset up any NAT rule for the metadata path.

", "UserEditable": true, "GoType": "string" }, @@ -3522,8 +3993,8 @@ "Required": false, "OnParseFailure": "Exit", "AllowedConfigSources": "All", - "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 .", - "DescriptionHTML": "

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 .

", + "Description": "The port of the metadata server. This, combined with global.MetadataAddr (if\nnot 'None'), is used to set up a NAT rule, from 169.254.169.254:80 to MetadataAddr:MetadataPort.\nIn most cases this should not need to be changed .", + "DescriptionHTML": "

The port of the metadata server. This, combined with global.MetadataAddr (if\nnot 'None'), is used to set up a NAT rule, from 169.254.169.254:80 to MetadataAddr:MetadataPort.\nIn most cases this should not need to be changed .

", "UserEditable": true, "GoType": "*int" }, @@ -3548,8 +4019,8 @@ "Required": false, "OnParseFailure": "Exit", "AllowedConfigSources": "All", - "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.", - "DescriptionHTML": "

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.

", + "Description": "The name of the region that a particular Felix belongs to. In a multi-region\nCalico/OpenStack deployment, this must be configured somehow for each Felix (here in the datamodel,\nor in felix.cfg or the environment on each compute node), and must match the [calico]\nopenstack_region value configured in neutron.conf on each node.", + "DescriptionHTML": "

The name of the region that a particular Felix belongs to. In a multi-region\nCalico/OpenStack deployment, this must be configured somehow for each Felix (here in the datamodel,\nor in felix.cfg or the environment on each compute node), and must match the [calico]\nopenstack_region value configured in neutron.conf on each node.

", "UserEditable": true, "GoType": "string" }, @@ -3574,8 +4045,8 @@ "Required": false, "OnParseFailure": "ReplaceWithDefault", "AllowedConfigSources": "All", - "Description": "The interval at which Felix reports its status into the datastore or 0 to disable. Must be non-zero in OpenStack deployments.", - "DescriptionHTML": "

The interval at which Felix reports its status into the datastore or 0 to disable. Must be non-zero in OpenStack deployments.

", + "Description": "The interval at which Felix reports its status into the datastore or 0 to disable.\nMust be non-zero in OpenStack deployments.", + "DescriptionHTML": "

The interval at which Felix reports its status into the datastore or 0 to disable.\nMust be non-zero in OpenStack deployments.

", "UserEditable": true, "GoType": "*v1.Duration" }, @@ -3631,8 +4102,8 @@ "Required": false, "OnParseFailure": "ReplaceWithDefault", "AllowedConfigSources": "All", - "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.", - "DescriptionHTML": "

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.

", + "Description": "Enables Generic XDP so network cards that don't support XDP offload or driver\nmodes can use XDP. This is not recommended since it doesn't provide better performance than\niptables.", + "DescriptionHTML": "

Enables Generic XDP so network cards that don't support XDP offload or driver\nmodes can use XDP. This is not recommended since it doesn't provide better performance than\niptables.

", "UserEditable": true, "GoType": "*bool" }, @@ -3683,8 +4154,8 @@ "Required": false, "OnParseFailure": "ReplaceWithDefault", "AllowedConfigSources": "All", - "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.", - "DescriptionHTML": "

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.

", + "Description": "The period at which Felix re-checks all XDP state to ensure that no\nother process has accidentally broken Calico's BPF maps or attached programs. Set to 0 to\ndisable XDP refresh.", + "DescriptionHTML": "

The period at which Felix re-checks all XDP state to ensure that no\nother process has accidentally broken Calico's BPF maps or attached programs. Set to 0 to\ndisable XDP refresh.

", "UserEditable": true, "GoType": "*v1.Duration" } @@ -3714,8 +4185,8 @@ "Required": false, "OnParseFailure": "ReplaceWithDefault", "AllowedConfigSources": "All", - "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.", - "DescriptionHTML": "

Overrides whether Felix should create the VXLAN tunnel device for IPv4 VXLAN networking. Optional as Felix determines this based on the existing IP pools.

", + "Description": "Overrides whether Felix should create the VXLAN tunnel device for IPv4 VXLAN networking.\nOptional as Felix determines this based on the existing IP pools.", + "DescriptionHTML": "

Overrides whether Felix should create the VXLAN tunnel device for IPv4 VXLAN networking.\nOptional as Felix determines this based on the existing IP pools.

", "UserEditable": true, "GoType": "*bool" }, @@ -3740,8 +4211,8 @@ "Required": false, "OnParseFailure": "ReplaceWithDefault", "AllowedConfigSources": "All", - "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.", - "DescriptionHTML": "

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.

", + "Description": "The MTU to set on the IPv4 VXLAN tunnel device. Optional as Felix auto-detects the MTU based on the\nMTU of the host's interfaces.", + "DescriptionHTML": "

The MTU to set on the IPv4 VXLAN tunnel device. Optional as Felix auto-detects the MTU based on the\nMTU of the host's interfaces.

", "UserEditable": true, "GoType": "*int" }, @@ -3766,8 +4237,8 @@ "Required": false, "OnParseFailure": "ReplaceWithDefault", "AllowedConfigSources": "All", - "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.", - "DescriptionHTML": "

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.

", + "Description": "The MTU to set on the IPv6 VXLAN tunnel device. Optional as Felix auto-detects the MTU based on the\nMTU of the host's interfaces.", + "DescriptionHTML": "

The MTU to set on the IPv6 VXLAN tunnel device. Optional as Felix auto-detects the MTU based on the\nMTU of the host's interfaces.

", "UserEditable": true, "GoType": "*int" }, @@ -3818,8 +4289,8 @@ "Required": false, "OnParseFailure": "ReplaceWithDefault", "AllowedConfigSources": "All", - "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.", - "DescriptionHTML": "

The VXLAN VNI to use for VXLAN traffic. You may need to change this if the default value is in use on your system.

", + "Description": "The VXLAN VNI to use for VXLAN traffic. You may need to change this if the default value is\nin use on your system.", + "DescriptionHTML": "

The VXLAN VNI to use for VXLAN traffic. You may need to change this if the default value is\nin use on your system.

", "UserEditable": true, "GoType": "*int" } @@ -3849,8 +4320,8 @@ "Required": false, "OnParseFailure": "ReplaceWithDefault", "AllowedConfigSources": "All", - "Description": "Overrides whether Felix should configure an IPIP interface on the host. Optional as Felix determines this based on the existing IP pools.", - "DescriptionHTML": "

Overrides whether Felix should configure an IPIP interface on the host. Optional as Felix determines this based on the existing IP pools.

", + "Description": "Overrides whether Felix should configure an IPIP interface on the host. Optional as Felix\ndetermines this based on the existing IP pools.", + "DescriptionHTML": "

Overrides whether Felix should configure an IPIP interface on the host. Optional as Felix\ndetermines this based on the existing IP pools.

", "UserEditable": true, "GoType": "*bool" }, @@ -3875,8 +4346,8 @@ "Required": false, "OnParseFailure": "ReplaceWithDefault", "AllowedConfigSources": "All", - "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.", - "DescriptionHTML": "

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.

", + "Description": "Controls the MTU to set on the IPIP tunnel device. Optional as Felix auto-detects the MTU based on the\nMTU of the host's interfaces.", + "DescriptionHTML": "

Controls the MTU to set on the IPIP tunnel device. Optional as Felix auto-detects the MTU based on the\nMTU of the host's interfaces.

", "UserEditable": true, "GoType": "*int" } @@ -4170,6 +4641,173 @@ "DescriptionHTML": "

Controls the priority value to use for the Wireguard routing rule.

", "UserEditable": true, "GoType": "*int" + }, + { + "Group": "Overlay: Wireguard", + "GroupWithSortPrefix": "33 Overlay: Wireguard", + "NameConfigFile": "WireguardThreadingEnabled", + "NameEnvVar": "FELIX_WireguardThreadingEnabled", + "NameYAML": "wireguardThreadingEnabled", + "NameGoAPI": "WireguardThreadingEnabled", + "StringSchema": "Boolean: `true`, `1`, `yes`, `y`, `t` accepted as True; `false`, `0`, `no`, `n`, `f` accepted (case insensitively) as False.", + "StringSchemaHTML": "Boolean: true, 1, yes, y, t accepted as True; false, 0, no, n, f accepted (case insensitively) as False.", + "StringDefault": "false", + "ParsedDefault": "false", + "ParsedDefaultJSON": "false", + "ParsedType": "bool", + "YAMLType": "boolean", + "YAMLSchema": "Boolean.", + "YAMLEnumValues": null, + "YAMLSchemaHTML": "Boolean.", + "YAMLDefault": "false", + "Required": false, + "OnParseFailure": "ReplaceWithDefault", + "AllowedConfigSources": "All", + "Description": "Controls whether Wireguard has Threaded NAPI enabled. \nThis increases the maximum number of packets a Wireguard interface can process.\nConsider threaded NAPI only if you have high packets per second workloads that are causing dropping packets due to a saturated `softirq` CPU core.\nThere is a [known issue](https://lore.kernel.org/netdev/CALrw=nEoT2emQ0OAYCjM1d_6Xe_kNLSZ6dhjb5FxrLFYh4kozA@mail.gmail.com/T/) with this setting\nthat may cause NAPI to get stuck holding the global `rtnl_mutex` when a peer is removed.\nWorkaround: Make sure your Linux kernel [includes this patch](https://github.com/torvalds/linux/commit/56364c910691f6d10ba88c964c9041b9ab777bd6) to unwedge NAPI.", + "DescriptionHTML": "

Controls whether Wireguard has Threaded NAPI enabled. \nThis increases the maximum number of packets a Wireguard interface can process.\nConsider threaded NAPI only if you have high packets per second workloads that are causing dropping packets due to a saturated softirq CPU core.\nThere is a [known issue](https://lore.kernel.org/netdev/CALrw=nEoT2emQ0OAYCjM1d_6Xe_kNLSZ6dhjb5FxrLFYh4kozA@mail.gmail.com/T/) with this setting\nthat may cause NAPI to get stuck holding the global rtnl_mutex when a peer is removed.\nWorkaround: Make sure your Linux kernel [includes this patch](https://github.com/torvalds/linux/commit/56364c910691f6d10ba88c964c9041b9ab777bd6) to unwedge NAPI.

", + "UserEditable": true, + "GoType": "*bool" + } + ] + }, + { + "Name": "Flow logs: file reports", + "Fields": [ + { + "Group": "Flow logs: file reports", + "GroupWithSortPrefix": "40 Flow logs: file reports", + "NameConfigFile": "FlowLogsCollectorDebugTrace", + "NameEnvVar": "FELIX_FlowLogsCollectorDebugTrace", + "NameYAML": "flowLogsCollectorDebugTrace", + "NameGoAPI": "FlowLogsCollectorDebugTrace", + "StringSchema": "Boolean: `true`, `1`, `yes`, `y`, `t` accepted as True; `false`, `0`, `no`, `n`, `f` accepted (case insensitively) as False.", + "StringSchemaHTML": "Boolean: true, 1, yes, y, t accepted as True; false, 0, no, n, f accepted (case insensitively) as False.", + "StringDefault": "false", + "ParsedDefault": "false", + "ParsedDefaultJSON": "false", + "ParsedType": "bool", + "YAMLType": "boolean", + "YAMLSchema": "Boolean.", + "YAMLEnumValues": null, + "YAMLSchemaHTML": "Boolean.", + "YAMLDefault": "false", + "Required": false, + "OnParseFailure": "ReplaceWithDefault", + "AllowedConfigSources": "All", + "Description": "When FlowLogsCollectorDebugTrace is set to true, enables the logs in the collector to be\nprinted in their entirety.", + "DescriptionHTML": "

When FlowLogsCollectorDebugTrace is set to true, enables the logs in the collector to be\nprinted in their entirety.

", + "UserEditable": true, + "GoType": "*bool" + }, + { + "Group": "Flow logs: file reports", + "GroupWithSortPrefix": "40 Flow logs: file reports", + "NameConfigFile": "FlowLogsFlushInterval", + "NameEnvVar": "FELIX_FlowLogsFlushInterval", + "NameYAML": "flowLogsFlushInterval", + "NameGoAPI": "FlowLogsFlushInterval", + "StringSchema": "Seconds (floating point)", + "StringSchemaHTML": "Seconds (floating point)", + "StringDefault": "300", + "ParsedDefault": "5m0s", + "ParsedDefaultJSON": "300000000000", + "ParsedType": "time.Duration", + "YAMLType": "string", + "YAMLSchema": "Duration string, for example `1m30s123ms` or `1h5m`.", + "YAMLEnumValues": null, + "YAMLSchemaHTML": "Duration string, for example 1m30s123ms or 1h5m.", + "YAMLDefault": "5m0s", + "Required": false, + "OnParseFailure": "ReplaceWithDefault", + "AllowedConfigSources": "All", + "Description": "Configures the interval at which Felix exports flow logs.", + "DescriptionHTML": "

Configures the interval at which Felix exports flow logs.

", + "UserEditable": true, + "GoType": "*v1.Duration" + }, + { + "Group": "Flow logs: file reports", + "GroupWithSortPrefix": "40 Flow logs: file reports", + "NameConfigFile": "FlowLogsGoldmaneServer", + "NameEnvVar": "FELIX_FlowLogsGoldmaneServer", + "NameYAML": "flowLogsGoldmaneServer", + "NameGoAPI": "FlowLogsGoldmaneServer", + "StringSchema": "String", + "StringSchemaHTML": "String", + "StringDefault": "", + "ParsedDefault": "", + "ParsedDefaultJSON": "\"\"", + "ParsedType": "string", + "YAMLType": "string", + "YAMLSchema": "String.", + "YAMLEnumValues": null, + "YAMLSchemaHTML": "String.", + "YAMLDefault": "", + "Required": false, + "OnParseFailure": "ReplaceWithDefault", + "AllowedConfigSources": "All", + "Description": "FlowLogGoldmaneServer is the flow server endpoint to which flow data should be published.", + "DescriptionHTML": "

FlowLogGoldmaneServer is the flow server endpoint to which flow data should be published.

", + "UserEditable": true, + "GoType": "*string" + }, + { + "Group": "Flow logs: file reports", + "GroupWithSortPrefix": "40 Flow logs: file reports", + "NameConfigFile": "FlowLogsLocalReporter", + "NameEnvVar": "FELIX_FlowLogsLocalReporter", + "NameYAML": "flowLogsLocalReporter", + "NameGoAPI": "FlowLogsLocalReporter", + "StringSchema": "One of: `Disabled`, `Enabled` (case insensitive)", + "StringSchemaHTML": "One of: Disabled, Enabled (case insensitive)", + "StringDefault": "Disabled", + "ParsedDefault": "Disabled", + "ParsedDefaultJSON": "\"Disabled\"", + "ParsedType": "string", + "YAMLType": "string", + "YAMLSchema": "One of: `\"Disabled\"`, `\"Enabled\"`.", + "YAMLEnumValues": [ + "`\"Disabled\"`", + "`\"Enabled\"`" + ], + "YAMLSchemaHTML": "One of: \"Disabled\", \"Enabled\".", + "YAMLDefault": "Disabled", + "Required": false, + "OnParseFailure": "ReplaceWithDefault", + "AllowedConfigSources": "All", + "Description": "Configures local unix socket for reporting flow data from each node.", + "DescriptionHTML": "

Configures local unix socket for reporting flow data from each node.

", + "UserEditable": true, + "GoType": "*string" + }, + { + "Group": "Flow logs: file reports", + "GroupWithSortPrefix": "40 Flow logs: file reports", + "NameConfigFile": "FlowLogsPolicyEvaluationMode", + "NameEnvVar": "FELIX_FlowLogsPolicyEvaluationMode", + "NameYAML": "flowLogsPolicyEvaluationMode", + "NameGoAPI": "FlowLogsPolicyEvaluationMode", + "StringSchema": "One of: `Continuous`, `None` (case insensitive)", + "StringSchemaHTML": "One of: Continuous, None (case insensitive)", + "StringDefault": "Continuous", + "ParsedDefault": "Continuous", + "ParsedDefaultJSON": "\"Continuous\"", + "ParsedType": "string", + "YAMLType": "string", + "YAMLSchema": "One of: `\"Continuous\"`, `\"None\"`.", + "YAMLEnumValues": [ + "`\"Continuous\"`", + "`\"None\"`" + ], + "YAMLSchemaHTML": "One of: \"Continuous\", \"None\".", + "YAMLDefault": "Continuous", + "Required": false, + "OnParseFailure": "ReplaceWithDefault", + "AllowedConfigSources": "All", + "Description": "Continuous - Felix evaluates active flows on a regular basis to determine the rule\ntraces in the flow logs. Any policy updates that impact a flow will be reflected in the\npending_policies field, offering a near-real-time view of policy changes across flows.\nNone - Felix stops evaluating pending traces.", + "DescriptionHTML": "

Continuous - Felix evaluates active flows on a regular basis to determine the rule\ntraces in the flow logs. Any policy updates that impact a flow will be reflected in the\npending_policies field, offering a near-real-time view of policy changes across flows.\nNone - Felix stops evaluating pending traces.

", + "UserEditable": true, + "GoType": "*v3.FlowLogsPolicyEvaluationModeType" } ] }, @@ -4190,19 +4828,19 @@ "ParsedDefaultJSON": "\"DoNothing\"", "ParsedType": "string", "YAMLType": "string", - "YAMLSchema": "One of: `Disable`, `DoNothing`, `Enable`.", + "YAMLSchema": "One of: `\"Disable\"`, `\"DoNothing\"`, `\"Enable\"`.", "YAMLEnumValues": [ - "`Disable`", - "`DoNothing`", - "`Enable`" + "`\"Disable\"`", + "`\"DoNothing\"`", + "`\"Enable\"`" ], - "YAMLSchemaHTML": "One of: Disable, DoNothing, Enable.", + "YAMLSchemaHTML": "One of: \"Disable\", \"DoNothing\", \"Enable\".", "YAMLDefault": "DoNothing", "Required": true, "OnParseFailure": "ReplaceWithDefault", "AllowedConfigSources": "All", - "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.", - "DescriptionHTML": "

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.

", + "Description": "Controls whether Felix will try to change the \"source/dest check\" setting on the EC2 instance\non which it is running. A value of \"Disable\" will try to disable the source/dest check. Disabling the check\nallows for sending workload traffic without encapsulation within the same AWS subnet.", + "DescriptionHTML": "

Controls whether Felix will try to change the \"source/dest check\" setting on the EC2 instance\non which it is running. A value of \"Disable\" will try to disable the source/dest check. Disabling the check\nallows for sending workload traffic without encapsulation within the same AWS subnet.

", "UserEditable": true, "GoType": "*v3.AWSSrcDstCheckOption" } @@ -4237,32 +4875,6 @@ "UserEditable": true, "GoType": "" }, - { - "Group": "Debug/test-only (generally unsupported)", - "GroupWithSortPrefix": "97 Debug/test-only (generally unsupported)", - "NameConfigFile": "DebugBPFMapRepinEnabled", - "NameEnvVar": "FELIX_DebugBPFMapRepinEnabled", - "NameYAML": "", - "NameGoAPI": "", - "StringSchema": "Boolean: `true`, `1`, `yes`, `y`, `t` accepted as True; `false`, `0`, `no`, `n`, `f` accepted (case insensitively) as False.", - "StringSchemaHTML": "Boolean: true, 1, yes, y, t accepted as True; false, 0, no, n, f accepted (case insensitively) as False.", - "StringDefault": "false", - "ParsedDefault": "false", - "ParsedDefaultJSON": "false", - "ParsedType": "bool", - "YAMLType": "", - "YAMLSchema": "", - "YAMLEnumValues": null, - "YAMLSchemaHTML": "", - "YAMLDefault": "", - "Required": false, - "OnParseFailure": "ReplaceWithDefault", - "AllowedConfigSources": "LocalOnly", - "Description": "Can be used to prevent Felix from repinning its BPF maps at startup. This is useful for\ntesting with multiple Felix instances running on one host.", - "DescriptionHTML": "

Can be used to prevent Felix from repinning its BPF maps at startup. This is useful for\ntesting with multiple Felix instances running on one host.

", - "UserEditable": true, - "GoType": "" - }, { "Group": "Debug/test-only (generally unsupported)", "GroupWithSortPrefix": "97 Debug/test-only (generally unsupported)", @@ -4310,8 +4922,8 @@ "Required": false, "OnParseFailure": "ReplaceWithDefault", "AllowedConfigSources": "All", - "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.", - "DescriptionHTML": "

Disables the dropping of log messages when the log buffer is full. This can significantly impact performance if log write-out is a bottleneck.

", + "Description": "Disables the dropping of log messages when the log buffer is full. This can\nsignificantly impact performance if log write-out is a bottleneck.", + "DescriptionHTML": "

Disables the dropping of log messages when the log buffer is full. This can\nsignificantly impact performance if log write-out is a bottleneck.

", "UserEditable": true, "GoType": "*bool" }, @@ -4336,8 +4948,8 @@ "Required": false, "OnParseFailure": "ReplaceWithDefault", "AllowedConfigSources": "All", - "Description": "The host IP or hostname to bind the debug port to. Only used if DebugPort is set.", - "DescriptionHTML": "

The host IP or hostname to bind the debug port to. Only used if DebugPort is set.

", + "Description": "The host IP or hostname to bind the debug port to. Only used\nif DebugPort is set.", + "DescriptionHTML": "

The host IP or hostname to bind the debug port to. Only used\nif DebugPort is set.

", "UserEditable": true, "GoType": "*string" }, @@ -4414,8 +5026,8 @@ "Required": false, "OnParseFailure": "ReplaceWithDefault", "AllowedConfigSources": "All", - "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.", - "DescriptionHTML": "

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.

", + "Description": "If set, enables Felix's debug HTTP port, which allows memory and CPU profiles\nto be retrieved. The debug port is not secure, it should not be exposed to the internet.", + "DescriptionHTML": "

If set, enables Felix's debug HTTP port, which allows memory and CPU profiles\nto be retrieved. The debug port is not secure, it should not be exposed to the internet.

", "UserEditable": true, "GoType": "*int" }, @@ -4440,8 +5052,8 @@ "Required": false, "OnParseFailure": "ReplaceWithDefault", "AllowedConfigSources": "All", - "Description": "Used to simulate a hang in the calculation graph after the specified duration. This is useful in tests of the watchdog system only!", - "DescriptionHTML": "

Used to simulate a hang in the calculation graph after the specified duration. This is useful in tests of the watchdog system only!

", + "Description": "Used to simulate a hang in the calculation graph after the specified duration.\nThis is useful in tests of the watchdog system only!", + "DescriptionHTML": "

Used to simulate a hang in the calculation graph after the specified duration.\nThis is useful in tests of the watchdog system only!

", "UserEditable": true, "GoType": "*v1.Duration" }, @@ -4492,8 +5104,8 @@ "Required": false, "OnParseFailure": "ReplaceWithDefault", "AllowedConfigSources": "All", - "Description": "Adds an artificial delay to every dataplane operation. This is useful for simulating a heavily loaded system for test purposes only.", - "DescriptionHTML": "

Adds an artificial delay to every dataplane operation. This is useful for simulating a heavily loaded system for test purposes only.

", + "Description": "Adds an artificial delay to every dataplane operation. This is useful for\nsimulating a heavily loaded system for test purposes only.", + "DescriptionHTML": "

Adds an artificial delay to every dataplane operation. This is useful for\nsimulating a heavily loaded system for test purposes only.

", "UserEditable": true, "GoType": "*v1.Duration" }, @@ -4518,8 +5130,8 @@ "Required": false, "OnParseFailure": "ReplaceWithDefault", "AllowedConfigSources": "All", - "Description": "Used to simulate a hang in the dataplane after the specified duration. This is useful in tests of the watchdog system only!", - "DescriptionHTML": "

Used to simulate a hang in the dataplane after the specified duration. This is useful in tests of the watchdog system only!

", + "Description": "Used to simulate a hang in the dataplane after the specified duration.\nThis is useful in tests of the watchdog system only!", + "DescriptionHTML": "

Used to simulate a hang in the dataplane after the specified duration.\nThis is useful in tests of the watchdog system only!

", "UserEditable": true, "GoType": "*v1.Duration" } @@ -4549,8 +5161,8 @@ "Required": false, "OnParseFailure": "ReplaceWithDefault", "AllowedConfigSources": "All", - "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.", - "DescriptionHTML": "

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.

", + "Description": "Reports anonymous Calico version number and cluster size to projectcalico.org. Logs warnings returned by the usage\nserver. For example, if a significant security vulnerability has been discovered in the version of Calico being used.", + "DescriptionHTML": "

Reports anonymous Calico version number and cluster size to projectcalico.org. Logs warnings returned by the usage\nserver. For example, if a significant security vulnerability has been discovered in the version of Calico being used.

", "UserEditable": true, "GoType": "*bool" }, @@ -4609,4 +5221,4 @@ ] } ] -} \ No newline at end of file +} diff --git a/calico_versioned_docs/version-3.30/_includes/components/FelixConfig/config-params.json b/calico_versioned_docs/version-3.30/_includes/components/FelixConfig/config-params.json index d7c35321ee..44598f5a52 100644 --- a/calico_versioned_docs/version-3.30/_includes/components/FelixConfig/config-params.json +++ b/calico_versioned_docs/version-3.30/_includes/components/FelixConfig/config-params.json @@ -726,6 +726,58 @@ { "Name": "Process: Logging", "Fields": [ + { + "Group": "Process: Logging", + "GroupWithSortPrefix": "00 Process: Logging", + "NameConfigFile": "LogActionRateLimit", + "NameEnvVar": "FELIX_LogActionRateLimit", + "NameYAML": "logActionRateLimit", + "NameGoAPI": "LogActionRateLimit", + "StringSchema": "String matching regex `^([1-9]\\d{0,3}/(?:second|minute|hour|day))?$`", + "StringSchemaHTML": "String matching regex ^([1-9]\\d{0,3}/(?:second|minute|hour|day))?$", + "StringDefault": "", + "ParsedDefault": "", + "ParsedDefaultJSON": "\"\"", + "ParsedType": "string", + "YAMLType": "string", + "YAMLSchema": "String matching the regular expression `^[1-9]\\d{0,3}/(?:second|minute|hour|day)$`.", + "YAMLEnumValues": null, + "YAMLSchemaHTML": "String matching the regular expression ^[1-9]\\d{0,3}/(?:second|minute|hour|day)$.", + "YAMLDefault": "", + "Required": false, + "OnParseFailure": "ReplaceWithDefault", + "AllowedConfigSources": "All", + "Description": "Sets the rate of hitting a Log action. The value must be in the format \"N/unit\",\nwhere N is a number and unit is one of: second, minute, hour, or day. For example: \"10/second\" or \"100/hour\".", + "DescriptionHTML": "

Sets the rate of hitting a Log action. The value must be in the format \"N/unit\",\nwhere N is a number and unit is one of: second, minute, hour, or day. For example: \"10/second\" or \"100/hour\".

", + "UserEditable": true, + "GoType": "*string" + }, + { + "Group": "Process: Logging", + "GroupWithSortPrefix": "00 Process: Logging", + "NameConfigFile": "LogActionRateLimitBurst", + "NameEnvVar": "FELIX_LogActionRateLimitBurst", + "NameYAML": "logActionRateLimitBurst", + "NameGoAPI": "LogActionRateLimitBurst", + "StringSchema": "Integer: [0,2^63-1], [9999,2^63-1]", + "StringSchemaHTML": "Integer: [0,263-1], [9999,263-1]", + "StringDefault": "5", + "ParsedDefault": "5", + "ParsedDefaultJSON": "5", + "ParsedType": "int", + "YAMLType": "integer", + "YAMLSchema": "Integer: [0,2^63-1], [9999,2^63-1]", + "YAMLEnumValues": null, + "YAMLSchemaHTML": "Integer: [0,263-1], [9999,263-1]", + "YAMLDefault": "5", + "Required": false, + "OnParseFailure": "ReplaceWithDefault", + "AllowedConfigSources": "All", + "Description": "Sets the rate limit burst of hitting a Log action when LogActionRateLimit is enabled.", + "DescriptionHTML": "

Sets the rate limit burst of hitting a Log action when LogActionRateLimit is enabled.

", + "UserEditable": true, + "GoType": "*int" + }, { "Group": "Process: Logging", "GroupWithSortPrefix": "00 Process: Logging", @@ -792,15 +844,15 @@ "ParsedDefaultJSON": "\"calico-packet\"", "ParsedType": "string", "YAMLType": "string", - "YAMLSchema": "String.", + "YAMLSchema": "String matching the regular expression `^([a-zA-Z0-9%: /_-])*$`.", "YAMLEnumValues": null, - "YAMLSchemaHTML": "String.", + "YAMLSchemaHTML": "String matching the regular expression ^([a-zA-Z0-9%: /_-])*$.", "YAMLDefault": "calico-packet", "Required": false, "OnParseFailure": "ReplaceWithDefault", "AllowedConfigSources": "All", - "Description": "The log prefix that Felix uses when rendering LOG rules.", - "DescriptionHTML": "

The log prefix that Felix uses when rendering LOG rules.

", + "Description": "The log prefix that Felix uses when rendering LOG rules. It is possible to use the following specifiers\nto include extra information in the log prefix.\n- %t: Tier name.\n- %k: Kind (short names).\n- %n: Policy or profile name.\n- %p: Policy or profile name (namespace/name for namespaced kinds or just name for non namespaced kinds).\nCalico includes \": \" characters at the end of the generated log prefix.\nNote that iptables shows up to 29 characters for the log prefix and nftables up to 127 characters. Extra characters are truncated.", + "DescriptionHTML": "

The log prefix that Felix uses when rendering LOG rules. It is possible to use the following specifiers\nto include extra information in the log prefix.\n- %t: Tier name.\n- %k: Kind (short names).\n- %n: Policy or profile name.\n- %p: Policy or profile name (namespace/name for namespaced kinds or just name for non namespaced kinds).\nCalico includes \": \" characters at the end of the generated log prefix.\nNote that iptables shows up to 29 characters for the log prefix and nftables up to 127 characters. Extra characters are truncated.

", "UserEditable": true, "GoType": "string" }, @@ -1121,6 +1173,32 @@ "UserEditable": true, "GoType": "*bool" }, + { + "Group": "Dataplane: Common", + "GroupWithSortPrefix": "10 Dataplane: Common", + "NameConfigFile": "CgroupV2Path", + "NameEnvVar": "FELIX_CgroupV2Path", + "NameYAML": "cgroupV2Path", + "NameGoAPI": "CgroupV2Path", + "StringSchema": "String", + "StringSchemaHTML": "String", + "StringDefault": "", + "ParsedDefault": "", + "ParsedDefaultJSON": "\"\"", + "ParsedType": "string", + "YAMLType": "string", + "YAMLSchema": "String.", + "YAMLEnumValues": null, + "YAMLSchemaHTML": "String.", + "YAMLDefault": "", + "Required": false, + "OnParseFailure": "ReplaceWithDefault", + "AllowedConfigSources": "All", + "Description": "Overrides the default location where to find the cgroup hierarchy.", + "DescriptionHTML": "

Overrides the default location where to find the cgroup hierarchy.

", + "UserEditable": true, + "GoType": "string" + }, { "Group": "Dataplane: Common", "GroupWithSortPrefix": "10 Dataplane: Common", @@ -1654,35 +1732,6 @@ "UserEditable": true, "GoType": "string" }, - { - "Group": "Dataplane: Common", - "GroupWithSortPrefix": "10 Dataplane: Common", - "NameConfigFile": "NATOutgoingExclusions", - "NameEnvVar": "FELIX_NATOutgoingExclusions", - "NameYAML": "natOutgoingExclusions", - "NameGoAPI": "NATOutgoingExclusions", - "StringSchema": "One of: `IPPoolsAndHostIPs`, `IPPoolsOnly` (case insensitive)", - "StringSchemaHTML": "One of: IPPoolsAndHostIPs, IPPoolsOnly (case insensitive)", - "StringDefault": "IPPoolsOnly", - "ParsedDefault": "IPPoolsOnly", - "ParsedDefaultJSON": "\"IPPoolsOnly\"", - "ParsedType": "string", - "YAMLType": "string", - "YAMLSchema": "One of: `\"IPPoolsAndHostIPs\"`, `\"IPPoolsOnly\"`.", - "YAMLEnumValues": [ - "`\"IPPoolsAndHostIPs\"`", - "`\"IPPoolsOnly\"`" - ], - "YAMLSchemaHTML": "One of: \"IPPoolsAndHostIPs\", \"IPPoolsOnly\".", - "YAMLDefault": "IPPoolsOnly", - "Required": false, - "OnParseFailure": "ReplaceWithDefault", - "AllowedConfigSources": "All", - "Description": "When a IP pool setting `natOutgoing` is true, packets sent from Calico networked containers in this IP pool to destinations will be masqueraded.\nConfigure which type of destinations is excluded from being masqueraded.\n- IPPoolsOnly: destinations outside of this IP pool will be masqueraded.\n- IPPoolsAndHostIPs: destinations outside of this IP pool and all hosts will be masqueraded.", - "DescriptionHTML": "

When a IP pool setting natOutgoing is true, packets sent from Calico networked containers in this IP pool to destinations will be masqueraded.\nConfigure which type of destinations is excluded from being masqueraded.\n- IPPoolsOnly: destinations outside of this IP pool will be masqueraded.\n- IPPoolsAndHostIPs: destinations outside of this IP pool and all hosts will be masqueraded.

", - "UserEditable": true, - "GoType": "*v3.NATOutgoingExclusionsType" - }, { "Group": "Dataplane: Common", "GroupWithSortPrefix": "10 Dataplane: Common", @@ -1791,35 +1840,6 @@ "UserEditable": true, "GoType": "string" }, - { - "Group": "Dataplane: Common", - "GroupWithSortPrefix": "10 Dataplane: Common", - "NameConfigFile": "ProgramClusterRoutes", - "NameEnvVar": "FELIX_ProgramClusterRoutes", - "NameYAML": "programClusterRoutes", - "NameGoAPI": "ProgramClusterRoutes", - "StringSchema": "One of: `Disabled`, `Enabled` (case insensitive)", - "StringSchemaHTML": "One of: Disabled, Enabled (case insensitive)", - "StringDefault": "Disabled", - "ParsedDefault": "Disabled", - "ParsedDefaultJSON": "\"Disabled\"", - "ParsedType": "string", - "YAMLType": "string", - "YAMLSchema": "One of: `\"Disabled\"`, `\"Enabled\"`.", - "YAMLEnumValues": [ - "`\"Disabled\"`", - "`\"Enabled\"`" - ], - "YAMLSchemaHTML": "One of: \"Disabled\", \"Enabled\".", - "YAMLDefault": "Disabled", - "Required": false, - "OnParseFailure": "ReplaceWithDefault", - "AllowedConfigSources": "All", - "Description": "Specifies whether Felix should program IPIP routes instead of BIRD.\nFelix always programs VXLAN routes.", - "DescriptionHTML": "

Specifies whether Felix should program IPIP routes instead of BIRD.\nFelix always programs VXLAN routes.

", - "UserEditable": true, - "GoType": "*string" - }, { "Group": "Dataplane: Common", "GroupWithSortPrefix": "10 Dataplane: Common", @@ -3162,6 +3182,32 @@ "UserEditable": true, "GoType": "*bool" }, + { + "Group": "Dataplane: eBPF", + "GroupWithSortPrefix": "22 Dataplane: eBPF", + "NameConfigFile": "BPFKubeProxyHealthzPort", + "NameEnvVar": "FELIX_BPFKubeProxyHealthzPort", + "NameYAML": "bpfKubeProxyHealthzPort", + "NameGoAPI": "BPFKubeProxyHealthzPort", + "StringSchema": "Integer", + "StringSchemaHTML": "Integer", + "StringDefault": "10256", + "ParsedDefault": "10256", + "ParsedDefaultJSON": "10256", + "ParsedType": "int", + "YAMLType": "integer", + "YAMLSchema": "Integer", + "YAMLEnumValues": null, + "YAMLSchemaHTML": "Integer", + "YAMLDefault": "10256", + "Required": true, + "OnParseFailure": "ReplaceWithDefault", + "AllowedConfigSources": "All", + "Description": "In BPF mode, controls the port that Felix's embedded kube-proxy health check server binds to.\nThe health check server is used by external load balancers to determine if this node should receive traffic.", + "DescriptionHTML": "

In BPF mode, controls the port that Felix's embedded kube-proxy health check server binds to.\nThe health check server is used by external load balancers to determine if this node should receive traffic.

", + "UserEditable": true, + "GoType": "*int" + }, { "Group": "Dataplane: eBPF", "GroupWithSortPrefix": "22 Dataplane: eBPF",