DOCS-2970: Fix FelixConfiguration reference dropping iptables/dataplane fields#2819
Merged
Merged
Conversation
…ne fields The felixconfig.mdx pages render field groups via the FelixConfig component, which matches a group by exact string: `jsonData.Groups.find((group) => group.Name === name)`. The group names come from config-params.json, which is auto-synced from the Felix source repos and must not be hand-edited. A prose/casing style sweep (573e3bb) rewrote the functional `name=` lookup keys as if they were prose (`Dataplane:` -> `Data plane:`, `...iptables dataplane` -> `...iptables data plane`, `Wireguard` -> `WireGuard`), so 8 groups -- including "Dataplane: iptables" and with it `iptablesRefreshInterval` -- no longer matched any generated group name and rendered "No matching group found", dropping their fields. Correct the `name=` lookup keys in the affected calico and calico-enterprise felixconfig.mdx files (current + versioned_docs) to exactly match each file's own config-params.json. Visible `####` headings are left as the restyled prose; only the lookup keys change. version-3.29's JSON already uses `Data plane:`, so only the WireGuard fix applies there. calico-cloud was untouched by the sweep. Surfaced during the Visa RCA (CI-2011). Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
✅ Deploy Preview for calico-docs-preview-next ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
✅ Deploy Preview succeeded!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
There was a problem hiding this comment.
Pull request overview
Fixes FelixConfiguration reference pages that were dropping entire field groups (notably the iptables/dataplane sections, including iptablesRefreshInterval) due to <FelixConfig name='...'> lookup keys no longer matching the generated config-params.json group Name values.
Changes:
- Restores exact-match
<FelixConfig name='...'>keys fromData plane:back toDataplane:where required. - Restores exact-match key for
Overlay: Wireguard(fromWireGuard) to match generated group names. - Applies the corrections consistently across Calico OSS, Calico Enterprise, and selected versioned docs (with
version-3.29only needing the Wireguard key change).
Reviewed changes
Copilot reviewed 9 out of 9 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| calico/reference/resources/felixconfig.mdx | Fixes <FelixConfig name> keys to match Dataplane:* and Overlay: Wireguard group names so field groups render again. |
| calico-enterprise/reference/resources/felixconfig.mdx | Same key corrections for the Enterprise “current” docs. |
| calico-enterprise_versioned_docs/version-3.23-2/reference/resources/felixconfig.mdx | Same key corrections for Enterprise v3.23-2 versioned docs. |
| calico-enterprise_versioned_docs/version-3.22-2/reference/resources/felixconfig.mdx | Same key corrections for Enterprise v3.22-2 versioned docs. |
| calico-enterprise_versioned_docs/version-3.21-2/reference/resources/felixconfig.mdx | Same key corrections for Enterprise v3.21-2 versioned docs. |
| calico_versioned_docs/version-3.32/reference/resources/felixconfig.mdx | Same key corrections for OSS v3.32 versioned docs. |
| calico_versioned_docs/version-3.31/reference/resources/felixconfig.mdx | Same key corrections for OSS v3.31 versioned docs. |
| calico_versioned_docs/version-3.30/reference/resources/felixconfig.mdx | Same key corrections for OSS v3.30 versioned docs. |
| calico_versioned_docs/version-3.29/reference/resources/felixconfig.mdx | Fixes only the Overlay: Wireguard lookup key (this version’s JSON uses Data plane:* group names). |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.

Problem
The FelixConfiguration reference page silently drops 8 field groups — including the entire Dataplane: iptables group and with it
iptablesRefreshInterval— on both Calico Enterprise and open-source Calico. The fields still render correctly in the REST API reference.Jira: DOCS-2970.
Root cause
felixconfig.mdxrenders field groups via theFelixConfigcomponent (_includes/components/FelixConfig/index.js), which matches a group by exact string:The group names come from
config-params.json, which is auto-synced from the Felix source repos (source of truth, not hand-edited). The prose/casing style sweep573e3bb3("Fix prose terminology and casing across all docs") rewrote the functionalname=lookup keys as if they were prose:Dataplane:→Data plane:...iptables dataplane→...iptables data planeWireguard→WireGuardThose keys no longer matched any generated group name, so the groups rendered "No matching group found" and their fields disappeared.
Fix
Correct the
name=lookup keys in the affectedfelixconfig.mdxfiles (current +versioned_docs) to exactly match each file's ownconfig-params.json. Only the lookup keys change — the visible####headings keep the restyled prose spelling.calico_versioned_docs/version-3.29already usesData plane:in its own JSON, so only theOverlay: WireGuard→Overlay: Wireguardfix applies there.calico-cloudwas untouched by the sweep and is unaffected.Verified: after the change, every
name=value in each file resolves to a groupNamein its siblingconfig-params.json, and the diff touches onlyname=lines.Follow-up (not in this PR): harden the
FelixConfigcomponent matching so a future prose sweep cannot silently break lookups again.🤖 Generated with Claude Code