Skip to content

DOCS-2970: Fix FelixConfiguration reference dropping iptables/dataplane fields#2819

Merged
ctauchen merged 1 commit into
tigera:mainfrom
ctauchen:fix-felixconfig-lookup-keys
Jul 3, 2026
Merged

DOCS-2970: Fix FelixConfiguration reference dropping iptables/dataplane fields#2819
ctauchen merged 1 commit into
tigera:mainfrom
ctauchen:fix-felixconfig-lookup-keys

Conversation

@ctauchen

@ctauchen ctauchen commented Jul 3, 2026

Copy link
Copy Markdown
Collaborator

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.mdx renders field groups via the FelixConfig component (_includes/components/FelixConfig/index.js), which matches a group by exact string:

const matchedGroup = jsonData.Groups.find((group) => group.Name === name);
if (!matchedGroup) return <p>No matching group found for '{name}'.</p>;

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 sweep 573e3bb3 ("Fix prose terminology and casing across all docs") rewrote the functional name= lookup keys as if they were prose:

  • Dataplane:Data plane:
  • ...iptables dataplane...iptables data plane
  • WireguardWireGuard

Those 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 affected felixconfig.mdx files (current + versioned_docs) to exactly match each file's own config-params.json. Only the lookup keys change — the visible #### headings keep the restyled prose spelling.

  • 8 files get all 8 keys corrected.
  • calico_versioned_docs/version-3.29 already uses Data plane: in its own JSON, so only the Overlay: WireGuardOverlay: Wireguard fix applies there.
  • calico-cloud was untouched by the sweep and is unaffected.

Verified: after the change, every name= value in each file resolves to a group Name in its sibling config-params.json, and the diff touches only name= lines.

Follow-up (not in this PR): harden the FelixConfig component matching so a future prose sweep cannot silently break lookups again.

🤖 Generated with Claude Code

…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>
Copilot AI review requested due to automatic review settings July 3, 2026 11:10
@ctauchen ctauchen requested a review from a team as a code owner July 3, 2026 11:10
@netlify

netlify Bot commented Jul 3, 2026

Copy link
Copy Markdown

Deploy Preview for calico-docs-preview-next ready!

Name Link
🔨 Latest commit 13ade24
🔍 Latest deploy log https://app.netlify.com/projects/calico-docs-preview-next/deploys/6a47988bd8fb5000089f8afe
😎 Deploy Preview https://deploy-preview-2819--calico-docs-preview-next.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@netlify

netlify Bot commented Jul 3, 2026

Copy link
Copy Markdown

Deploy Preview succeeded!

Built without sensitive environment variables

Name Link
🔨 Latest commit 13ade24
🔍 Latest deploy log https://app.netlify.com/projects/tigera/deploys/6a47988bd23ed2000839d71a
😎 Deploy Preview https://deploy-preview-2819--tigera.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 71 (🔴 down 24 from production)
Accessibility: 98 (no change from production)
Best Practices: 92 (no change from production)
SEO: 100 (no change from production)
PWA: -
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify project configuration.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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 from Data plane: back to Dataplane: where required.
  • Restores exact-match key for Overlay: Wireguard (from WireGuard) to match generated group names.
  • Applies the corrections consistently across Calico OSS, Calico Enterprise, and selected versioned docs (with version-3.29 only 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).

@ctauchen ctauchen merged commit c47cc24 into tigera:main Jul 3, 2026
11 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants