Skip to content

Fix Felix config for OS 3.31 #2506

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ctauchen merged 1 commit into from
Feb 3, 2026
+56 −4
Merged

Fix Felix config for OS 3.31 #2506

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
60 changes: 56 additions & 4 deletions calico_versioned_docs/version-3.31/_includes/components/FelixConfig/config-params.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 <code>^([1-9]\\d{0,3}/(?:second|minute|hour|day))?$</code>",
"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 <code>^[1-9]\\d{0,3}/(?:second|minute|hour|day)$</code>.",
Comment on lines +743 to +745
Copy link

Copilot AI Feb 3, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The regex pattern in StringSchema and YAMLSchema fields are inconsistent for the LogActionRateLimit parameter. The StringSchema includes an optional empty match with ? at the end of the entire pattern: ^([1-9]\\d{0,3}/(?:second|minute|hour|day))?$, while the YAMLSchema does not: ^[1-9]\\d{0,3}/(?:second|minute|hour|day)$. This inconsistency means the StringSchema allows empty strings while YAMLSchema requires a value. Given that StringDefault and YAMLDefault are both empty strings, the schemas should match and both should allow empty values. The YAMLSchema should include the optional group with trailing ?.

Suggested change
"YAMLSchema": "String matching the regular expression `^[1-9]\\d{0,3}/(?:second|minute|hour|day)$`.",
"YAMLEnumValues": null,
"YAMLSchemaHTML": "String matching the regular expression <code>^[1-9]\\d{0,3}/(?:second|minute|hour|day)$</code>.",
"YAMLSchema": "String matching the regular expression `^([1-9]\\d{0,3}/(?:second|minute|hour|day))?$`.",
"YAMLEnumValues": null,
"YAMLSchemaHTML": "String matching the regular expression <code>^([1-9]\\d{0,3}/(?:second|minute|hour|day))?$</code>.",

Copilot uses AI. Check for mistakes.
Comment on lines +743 to +745
Copy link

Copilot AI Feb 3, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The YAMLSchemaHTML should be updated to match the pattern in YAMLSchema. Currently, it references a pattern without the optional group wrapper, but it should align with whatever the correct YAMLSchema pattern is (which should include the optional group to match the StringSchema).

Suggested change
"YAMLSchema": "String matching the regular expression `^[1-9]\\d{0,3}/(?:second|minute|hour|day)$`.",
"YAMLEnumValues": null,
"YAMLSchemaHTML": "String matching the regular expression <code>^[1-9]\\d{0,3}/(?:second|minute|hour|day)$</code>.",
"YAMLSchema": "String matching the regular expression `^([1-9]\\d{0,3}/(?:second|minute|hour|day))?$`.",
"YAMLEnumValues": null,
"YAMLSchemaHTML": "String matching the regular expression <code>^([1-9]\\d{0,3}/(?:second|minute|hour|day))?$</code>.",

Copilot uses AI. Check for mistakes.
"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": "<p>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\".</p>",
"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,2<sup>63</sup>-1], [9999,2<sup>63</sup>-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,2<sup>63</sup>-1], [9999,2<sup>63</sup>-1]",
Comment on lines +762 to +771
Copy link

Copilot AI Feb 3, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The StringSchema and YAMLSchema specify a potentially confusing or incorrect range: Integer: [0,2^63-1], [9999,2^63-1]. This appears to list two ranges, but [9999,2^63-1] is a subset of [0,2^63-1]. This should likely be either just [0,2^63-1] if any value from 0 to the maximum is allowed, or [9999,2^63-1] if there's a minimum value of 9999. Please clarify the intended valid range for this parameter.

Suggested change
"StringSchema": "Integer: [0,2^63-1], [9999,2^63-1]",
"StringSchemaHTML": "Integer: [0,2<sup>63</sup>-1], [9999,2<sup>63</sup>-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,2<sup>63</sup>-1], [9999,2<sup>63</sup>-1]",
"StringSchema": "Integer: [0,2^63-1]",
"StringSchemaHTML": "Integer: [0,2<sup>63</sup>-1]",
"StringDefault": "5",
"ParsedDefault": "5",
"ParsedDefaultJSON": "5",
"ParsedType": "int",
"YAMLType": "integer",
"YAMLSchema": "Integer: [0,2^63-1]",
"YAMLEnumValues": null,
"YAMLSchemaHTML": "Integer: [0,2<sup>63</sup>-1]",

Copilot uses AI. Check for mistakes.
"YAMLDefault": "5",
"Required": false,
"OnParseFailure": "ReplaceWithDefault",
"AllowedConfigSources": "All",
"Description": "Sets the rate limit burst of hitting a Log action when LogActionRateLimit is enabled.",
"DescriptionHTML": "<p>Sets the rate limit burst of hitting a Log action when LogActionRateLimit is enabled.</p>",
"UserEditable": true,
"GoType": "*int"
},
{
"Group": "Process: Logging",
"GroupWithSortPrefix": "00 Process: Logging",
Expand Down Expand Up @@ -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 <code>^([a-zA-Z0-9%: /_-])*$</code>.",
"YAMLDefault": "calico-packet",
"Required": false,
"OnParseFailure": "ReplaceWithDefault",
"AllowedConfigSources": "All",
"Description": "The log prefix that Felix uses when rendering LOG rules.",
"DescriptionHTML": "<p>The log prefix that Felix uses when rendering LOG rules.</p>",
"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": "<p>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.</p>",
"UserEditable": true,
"GoType": "string"
},
Expand Down