Skip to content
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.

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

Add documentation for Wireguard Threaded NAPI feature #1741

Closed
wants to merge 1 commit into from

Conversation

jrcichra
Copy link
Contributor

Product Version(s):

Issue: projectcalico/calico#9260

Link to docs preview:

SME review:

  • An SME has approved this change.

DOCS review:

  • A member of the docs team has approved this change.

Additional information:

Merge checklist:

  • Deploy preview inspected wherever changes were made
  • Build completed successfully
  • Test have passed

@jrcichra jrcichra requested a review from a team as a code owner October 28, 2024 15:06
Copy link

netlify bot commented Oct 28, 2024

Deploy Preview succeeded!

Built without sensitive environment variables

Name Link
🔨 Latest commit 0721549
🔍 Latest deploy log https://app.netlify.com/sites/tigera/deploys/6720ed8cde29190008c57202
😎 Deploy Preview https://deploy-preview-1741--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: 22 (🔴 down 23 from production)
Accessibility: 90 (no change from production)
Best Practices: 75 (no change from production)
SEO: 93 (no change from production)
PWA: -
View the detailed breakdown and full score reports

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

Copy link

netlify bot commented Oct 28, 2024

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

Name Link
🔨 Latest commit 0721549
🔍 Latest deploy log https://app.netlify.com/sites/calico-docs-preview-next/deploys/6720ed8ce07fa20008eab19c
😎 Deploy Preview https://deploy-preview-1741--calico-docs-preview-next.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: 36 (🔴 down 9 from production)
Accessibility: 90 (no change from production)
Best Practices: 83 (no change from production)
SEO: 92 (no change from production)
PWA: -
View the detailed breakdown and full score reports

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

This enables Threaded NAPI for both the IPv4 and IPv6 WireGuard interfaces.

</TabItem>
<TabItem label="Manifest" value="Manifest-4">
Copy link
Member

Choose a reason for hiding this comment

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

I don't think we need a separate tab for Operator and manual install. Even in manual install it's possible to use kubectl to patch felixConfiguration.

@mazdakn
Copy link
Member

mazdakn commented Oct 28, 2024

@jrcichra Thanks for the documentation PR. You also need to make the same changes in the same file under calico-enterprise and calico-cloud directories.

@mazdakn
Copy link
Member

mazdakn commented Oct 29, 2024

Once the cherry picks and enterprise PRs are merged, we need to copy the same content to the corresponding directories.

@ctauchen
Copy link
Collaborator

We have about a dozen Wireguard-related Felix configuration parameters. Of those, only two are mentioned on this page, and both of them are required for the basic procedure to enable this feature.

So my first question: Why include this more obscure parameter so prominently?

Second: Would the warning be better placed (in a condensed form) in the parameter description in the configuration pages?

CC @jrcichra @mazdakn

We've recently changed the way we produce the Felix configuration docs. Changes to parameter descriptions need to be made in the codebase at projectcalico/calico. Perhaps see @fasaxc for details.

@jrcichra
Copy link
Contributor Author

I see. We can put this warning in the parameter description in the configuration pages instead, since it is an obscure feature like the rest of the tunables.

@ctauchen
Copy link
Collaborator

ctauchen commented Nov 4, 2024

@jrcichra Sure thing -- if you're happy to do that, you can open up a PR in projectcalico/calico. I'll close this PR for now.

Again, if you need help finding the right spot, or questions about process, @fasaxc can sort you out.

@ctauchen ctauchen closed this Nov 4, 2024
@mazdakn
Copy link
Member

mazdakn commented Nov 4, 2024

@jrcichra You can probably add extra comments to the new config as comments. This way, the text will be populated in the docs automatically. Please tag me whenever you have the PR.

@jrcichra
Copy link
Contributor Author

jrcichra commented Nov 4, 2024

I've made a PR on the main project here: projectcalico/calico#9440

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.

3 participants