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

ON-15464: Troubleshooting guide #123

Merged
merged 1 commit into from
Jan 16, 2024

Conversation

pcolledg-amd
Copy link
Collaborator

@pcolledg-amd pcolledg-amd commented Jan 12, 2024

Preview this PR's Troubleshooting Guide

  • sfnettest example now uses latency profile by default rather than just recommending it
  • Removed trailing slash on $REGISTRY_BASE causing duplicate slashes which is invalid in docker container image paths
  • Added built-in syntax validation to user-modifiable commands
  • Documented containers of Onload Device Plugin pod
  • Updated README to reflect recent setPreload changes
  • Symlinks to existing docs in docs/

(May further refine 'Modules and devices already loaded or mounted' and 'Day 0/1 MachineConfig' troubleshooting sections.)

@pcolledg-amd pcolledg-amd requested a review from a team as a code owner January 12, 2024 17:28
@ivatet-amd ivatet-amd requested review from jjay-xilinx and a team January 15, 2024 09:26
Comment on lines 94 to 95
* The version of Onload compiled in the `onload-user` images and the kernel modules compiled in-cluster or out of
cluster from `onload-source` image match the standard Linux packages and are not customised variants.
Copy link
Contributor

Choose a reason for hiding this comment

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

I don't really understand what this is trying to say,

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Onload Operator v2.0 introduced a third variant of Onload: OpenOnload, EnterpriseOnload, and CloudOnload. In v3.0 we do not have such a variant and Onload's internals do not have Kubernetes- or container-related conditionals that may vary its performance. I'm open to a more precise rewording suggestion (provided it doesn't dredge up the history).

* sfnettest example now uses latency profile by default rather than recommended
* Removed trailing slash on `$REGISTRY_BASE` causing invalid duplicate slashes
* Added built-in syntax validation to user-modifiable commands
* Documented containers of Onload Device Plugin pod
* Updated README to reflect recent `setPreload` changes
* Symlinks to existing docs in `docs/`
Copy link
Collaborator Author

@pcolledg-amd pcolledg-amd left a comment

Choose a reason for hiding this comment

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

Updated with Thomas' clarifications + minor linter.

Comment on lines 94 to 95
* The version of Onload compiled in the `onload-user` images and the kernel modules compiled in-cluster or out of
cluster from `onload-source` image match the standard Linux packages and are not customised variants.
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Onload Operator v2.0 introduced a third variant of Onload: OpenOnload, EnterpriseOnload, and CloudOnload. In v3.0 we do not have such a variant and Onload's internals do not have Kubernetes- or container-related conditionals that may vary its performance. I'm open to a more precise rewording suggestion (provided it doesn't dredge up the history).

Copy link
Contributor

@tcrawley-xilinx tcrawley-xilinx left a comment

Choose a reason for hiding this comment

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

Thanks for the updates

@pcolledg-amd pcolledg-amd merged commit 53eb9d5 into Xilinx-CNS:master Jan 16, 2024
5 checks passed
@pcolledg-amd pcolledg-amd deleted the troubleshooting branch January 16, 2024 11:15
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