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

fix explaining DNS policy modes #1725

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

tomastigera
Copy link
Contributor

Product Version(s):

Issue:

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

Copy link

netlify bot commented Oct 17, 2024

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

Name Link
🔨 Latest commit 0e8ab36
🔍 Latest deploy log https://app.netlify.com/sites/calico-docs-preview-next/deploys/67117de4e49ebc00087e8dc0
😎 Deploy Preview https://deploy-preview-1725--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 (🟢 up 1 from production)
Accessibility: 90 (no change from production)
Best Practices: 83 (no change from production)
SEO: 86 (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 17, 2024

Deploy Preview for tigera failed. Why did it fail? →

Built without sensitive environment variables

Name Link
🔨 Latest commit 0e8ab36
🔍 Latest deploy log https://app.netlify.com/sites/tigera/deploys/67117de41e28b10008b7f0a3

Copy link
Collaborator

@ctauchen ctauchen left a comment

Choose a reason for hiding this comment

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

At this stage, I'm just wondering where the best place is for this information.

It appears that you're explaining the what the default or supported DNS policy modes are for the different dataplanes. You provide the values for each dataplane, and then point people to the reference documentation.

I wonder whether it would be more useful to explain what these differences are and why someone should be interested in them? In other words, to provide some degree of information for users so they don't have to go to reference to get a rough idea of what this means.

The title suggests that there's something that can be done for performance and latency. I suspect these policy modes have something to do with that, but the text doesn't make the connection. Perhaps this could be more explicit?

@tomastigera
Copy link
Contributor Author

At this stage, I'm just wondering where the best place is for this information.

There will be a whole blog on this, perhaps we can reference it in the docs when it goes out https://docs.google.com/document/d/19TMYGQPsN2xA1jveZmoI8rLvsVL9o8GG8NlyQRtHp5A/edit?usp=sharing

It appears that you're explaining the what the default or supported DNS policy modes are for the different dataplanes. You provide the values for each dataplane, and then point people to the reference documentation.

yes, that is kind of what it did before, but in an incomplete and misleading way.

I wonder whether it would be more useful to explain what these differences are and why someone should be interested in them? In other words, to provide some degree of information for users so they don't have to go to reference to get a rough idea of what this means.

though about that, but I definitely do not want to maintain the same information in even more places

The title suggests that there's something that can be done for performance and latency. I suspect these policy modes have something to do with that, but the text doesn't make the connection. Perhaps this could be more explicit?

Calico Enterprise supports different DNS policy modes with different peformance and latency implications.
...
For more information, see DNSPolicyMode and BPFDNSPolicyMode.

I don't know how more explicit this can be. If you are not happy with the defaults, go and dig deeper, that is the message.

@tomastigera
Copy link
Contributor Author

@ctauchen any progress on this or are we going to stay in "I am wondering state" ? I provided the information, but I am in no position to make calls on where this should end up. It is still marked as a draft because I am not going to update other places unless I have an ack on this. But feel free to take the information and place it where ever you see fit. Currently the docs are wrong.

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