Skip to content

TELCODOCS-1731 - Update low latency tuning docs #71797

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

Merged
merged 1 commit into from
May 10, 2024

Conversation

aireilly
Copy link
Contributor

@aireilly aireilly commented Feb 19, 2024

Refactoring Low latency tuning assembly into more manageable sections.

Version(s):
openshift-4.14+

Issue:
https://issues.redhat.com/browse/TELCODOCS-1731

Link to docs preview:
https://71797--ocpdocs-pr.netlify.app/openshift-enterprise/latest/scalability_and_performance/low_latency_tuning/cnf-performing-platform-verification-latency-tests.html
https://71797--ocpdocs-pr.netlify.app/openshift-enterprise/latest/scalability_and_performance/low_latency_tuning/cnf-provisioning-low-latency-workloads.html
https://71797--ocpdocs-pr.netlify.app/openshift-enterprise/latest/scalability_and_performance/low_latency_tuning/cnf-tuning-low-latency-nodes-with-perf-profile.html
https://71797--ocpdocs-pr.netlify.app/openshift-enterprise/latest/scalability_and_performance/low_latency_tuning/cnf-understanding-low-latency.html

QE review:

  • QE has approved this change.

Note for Peer reviewers:

  • This PR might look ominous but it's really not. This is a high priority refactor PR that sets the ground for future content changes. What looks like new content here is in fact content that has been modularized out of parent assemblies with minimal rewrites.
  • A lot of the files in the PR are just updated modules with "Module used in..." comments.
  • SME comments on content will be actioned in https://issues.redhat.com/browse/TELCODOCS-1733

@openshift-ci openshift-ci bot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Feb 19, 2024
@ocpdocs-previewbot
Copy link

ocpdocs-previewbot commented Feb 19, 2024

🤖 Fri May 10 08:54:56 - Prow CI generated the docs preview:
https://71797--ocpdocs-pr.netlify.app
Complete list of updated preview URLs: artifacts/updated_preview_urls.txt

@aireilly aireilly added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Feb 19, 2024
@openshift-ci openshift-ci bot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Feb 19, 2024
@aireilly aireilly force-pushed the TELCODOCS-1731 branch 5 times, most recently from cf4d710 to 09106c0 Compare February 20, 2024 14:17
@openshift-ci openshift-ci bot added size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. labels Feb 20, 2024
@aireilly aireilly force-pushed the TELCODOCS-1731 branch 4 times, most recently from b59fb25 to 19b6b33 Compare February 21, 2024 09:57
@openshift-ci openshift-ci bot added size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. and removed size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. labels Feb 21, 2024
@aireilly aireilly requested a review from MarSik February 21, 2024 12:15
@aireilly
Copy link
Contributor Author

aireilly commented Feb 21, 2024

@MarSik Can you PTAL at this Low latency tuning docs rework. This is based on the suggested changes from you and Ashley some time back. Note though it might looks like there are lots of changes in the PR, the content has not be changed or reworded. Content changes are minimal - mainly just moving stuff around and fixing xrefs..

Start by looking at the preview linked in comment #1 ...

@MarSik
Copy link

MarSik commented Feb 21, 2024

@aireilly There are still some things to fix

  1. Switch the order of Provisioning real-time and low latency workloads and Tuning nodes for low latency with the performance profile . The user should first set up the nodes and then deploy the workloads.

  2. Reducing NIC queues using the Node Tuning Operator belongs to the Tuning nodes section

  3. There is a whole page about Creating a Performance profile that should be moved to the low latency chapter. Probably to the Tuning nodes sub-chapter.

@MarSik
Copy link

MarSik commented Feb 21, 2024

  1. Upgrading the performance profile to use device interrupt processing and Configuring a node for IRQ dynamic load balancing should be moved from the Workload sub-chapters to the Node tuning sub-chapter. Possibly under a common Interrupt handling topic (together with About support of IRQ affinity setting)

@openshift-merge-robot openshift-merge-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Mar 3, 2024
@aireilly
Copy link
Contributor Author

/retest

@dfitzmau
Copy link
Contributor

dfitzmau commented May 3, 2024

/remove-label peer-review-in-progress

/label peer-review-done

@openshift-ci openshift-ci bot added peer-review-done Signifies that the peer review team has reviewed this PR and removed peer-review-in-progress Signifies that the peer review team is reviewing this PR labels May 3, 2024
@mburke5678
Copy link
Contributor

@aireilly Found a few things. Awesome work here. Much easier to scan and use.

@aireilly aireilly force-pushed the TELCODOCS-1731 branch 2 times, most recently from a9029ba to a111659 Compare May 3, 2024 14:04
@shajmakh
Copy link

LGTM from QE end considering this comment.

@openshift-merge-robot openshift-merge-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label May 10, 2024
@openshift-merge-robot openshift-merge-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label May 10, 2024
@aireilly aireilly force-pushed the TELCODOCS-1731 branch 3 times, most recently from 31f151c to 1a136e3 Compare May 10, 2024 08:10
Changes for Martin

Martin's 3rd review comments

Martin's 4th review

Final comments from Martin

More updates for Martin

Tweaks for Martin

Martin's comments 22-Apr - workload pods

Apr 30 review comments

final review comments

Michael's comments
Copy link

openshift-ci bot commented May 10, 2024

@aireilly: all tests passed!

Full PR test history. Your PR dashboard.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here.

@aireilly aireilly merged commit a1bfa14 into openshift:main May 10, 2024
3 checks passed
@aireilly
Copy link
Contributor Author

/cherrypick enterprise-4.15

@aireilly
Copy link
Contributor Author

/cherrypick enterprise-4.16

@openshift-cherrypick-robot

@aireilly: #71797 failed to apply on top of branch "enterprise-4.15":

Applying: low latency tuning refactor
Using index info to reconstruct a base tree...
M	_topic_maps/_topic_map.yml
M	installing/installing-preparing.adoc
M	modules/cnf-configure_for_irq_dynamic_load_balancing.adoc
M	modules/cnf-provisioning-real-time-and-low-latency-workloads.adoc
M	modules/cnf-understanding-low-latency.adoc
A	virt/virtual_machines/advanced_vm_management/virt-configuring-cluster-realtime-workloads.adoc
Falling back to patching base and 3-way merge...
CONFLICT (modify/delete): virt/virtual_machines/advanced_vm_management/virt-configuring-cluster-realtime-workloads.adoc deleted in HEAD and modified in low latency tuning refactor. Version low latency tuning refactor of virt/virtual_machines/advanced_vm_management/virt-configuring-cluster-realtime-workloads.adoc left in tree.
Removing scalability_and_performance/cnf-low-latency-tuning.adoc
Removing scalability_and_performance/cnf-create-performance-profiles.adoc
Removing modules/cnf-understanding-workload-hints.adoc
Auto-merging modules/cnf-understanding-low-latency.adoc
Removing modules/cnf-reducing-netqueues-using-nto.adoc
CONFLICT (modify/delete): modules/cnf-provisioning-real-time-and-low-latency-workloads.adoc deleted in low latency tuning refactor and modified in HEAD. Version HEAD of modules/cnf-provisioning-real-time-and-low-latency-workloads.adoc left in tree.
Auto-merging modules/cnf-configure_for_irq_dynamic_load_balancing.adoc
CONFLICT (content): Merge conflict in modules/cnf-configure_for_irq_dynamic_load_balancing.adoc
Removing modules/cnf-about_hyperthreading_for_low_latency_and_real_time_applications.adoc
Auto-merging installing/installing-preparing.adoc
Auto-merging _topic_maps/_topic_map.yml
error: Failed to merge in the changes.
hint: Use 'git am --show-current-patch=diff' to see the failed patch
Patch failed at 0001 low latency tuning refactor
When you have resolved this problem, run "git am --continue".
If you prefer to skip this patch, run "git am --skip" instead.
To restore the original branch and stop patching, run "git am --abort".

In response to this:

/cherrypick enterprise-4.15

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@openshift-cherrypick-robot

@aireilly: new pull request created: #75758

In response to this:

/cherrypick enterprise-4.16

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
peer-review-done Signifies that the peer review team has reviewed this PR size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.