openshift-docs icon indicating copy to clipboard operation
openshift-docs copied to clipboard

[OSDOCS-3974]: new node tuning topic for hosted control planes

Open lahinson opened this issue 2 years ago • 8 comments

Version(s): 4.12

Issue: https://issues.redhat.com/browse/OSDOCS-3974

Link to docs preview (VPN required): http://file.rdu.redhat.com/lahinson/node-tuning-hosted-cps/scalability_and_performance/using-node-tuning-operator.html#node-tuning-hosted-cluster_node-tuning-operator

QE review:

  • [ ] QE has approved this change.

Additional information:

lahinson avatar Oct 05 '22 17:10 lahinson

🤖 Updated build preview is available at: https://51302--docspreview.netlify.app

Build log: https://circleci.com/gh/ocpdocs-previewbot/openshift-docs/3331

ocpdocs-previewbot avatar Oct 05 '22 17:10 ocpdocs-previewbot

Hi @sheriff-rh! As we discussed on Slack a few weeks ago, I've been working on the docs about configuring NTO in hosted control planes (aka HyperShift). When you can, would you mind taking a look at my draft? In particular, let me know if I got any of the NTO-related terminology wrong. Thank you! (Preview link is in the first comment 👆 )

lahinson avatar Oct 06 '22 13:10 lahinson

@dagrayvid PTAL at the draft of the docs about configuring NTO in hosted control planes. The preview link is in the first comment 👆

I also asked Andrew Taylor to take a look, since he usually covers the NTO-related docs.

One question: Is Liquan Cui the right person from QE to review this? I'm not sure if I should ask the QE rep for PSAP or for HyperShift.

Thanks!

lahinson avatar Oct 06 '22 14:10 lahinson

Thanks @lahinson for the draft. We are expanding on the NTO functionality in HyperShift a bit in this PR which should be landing in the next hours / days (it has been fully approved). That PR includes new docs for the new features, so we should probably include/adapt those project docs into this PR as well.

dagrayvid avatar Oct 12 '22 19:10 dagrayvid

Thanks for letting me know, @dagrayvid. I'll keep an eye on that PR, and after it's merged, I'll add the new info to this PR.

lahinson avatar Oct 12 '22 20:10 lahinson

/assign lahinson

lahinson avatar Oct 12 '22 20:10 lahinson

Thanks for letting me know, @dagrayvid. I'll keep an eye on that PR, and after it's merged, I'll add the new info to this PR.

Thanks @lahinson, the PR has now merged!

dagrayvid avatar Oct 13 '22 14:10 dagrayvid

@dagrayvid I updated this PR with the additional content. PTAL when you can.

@sheriff-rh I incorporated your feedback, and used what I learned to (hopefully) format the new content from David correctly. Let me know what you think.

@liqcui When you can, please take a look at this new content about node tuning for hosted control planes. The preview link is in the first comment in this PR.

Thank you all!

lahinson avatar Oct 14 '22 16:10 lahinson

/lgtm

liqcui avatar Oct 18 '22 04:10 liqcui

New changes are detected. LGTM label has been removed.

openshift-ci[bot] avatar Oct 18 '22 14:10 openshift-ci[bot]

Thanks a bunch, @sheriff-rh! I learned a lot from your feedback. I made the changes that you mentioned and squashed my commits. I also updated the preview link in the first comment so that you can jump directly to either of the two modules.

lahinson avatar Oct 18 '22 15:10 lahinson

/label peer-review-done

sheriff-rh avatar Oct 18 '22 17:10 sheriff-rh

Hi @dagrayvid- Any thoughts on the latest draft of the docs? https://51302--docspreview.netlify.app/openshift-enterprise/latest/scalability_and_performance/using-node-tuning-operator.html#node-tuning-hosted-cluster_node-tuning-operator

lahinson avatar Oct 18 '22 18:10 lahinson

Hi @lahinson, I will try to do a review today or tomorrow... We do have one pending change to rename a part of the NodePool spec which will impact the documentation, so I would suggest we hold this PR until that has merged.

dagrayvid avatar Oct 18 '22 19:10 dagrayvid

Thanks @lahinson, based on the guidelines I went through the changes and made my best attempt at deciding the correct formatting for the different object names (Tuned, NodePool, ConfigMap, etc...), though I am open to a second opinion on these!

I also made some other minor suggestions.

dagrayvid avatar Oct 19 '22 20:10 dagrayvid

Thanks so much, @dagrayvid! I'll go through your revisions and will let you know if I have any questions.

lahinson avatar Oct 19 '22 20:10 lahinson

@dagrayvid I incorporated your feedback, and you can see the latest preview here: https://51302--docspreview.netlify.app/openshift-enterprise/latest/scalability_and_performance/using-node-tuning-operator.html#node-tuning-hosted-cluster_node-tuning-operator

PTAL when you can. Thanks!

lahinson avatar Oct 20 '22 13:10 lahinson

@dagrayvid Thanks for your additional review! I made the changes that you suggested. Do you think we're at a good place for me to move this forward to be merged?

lahinson avatar Oct 24 '22 14:10 lahinson

@dagrayvid Just checking in again. I think we're ready to move this forward to be merged. Any objections before I do that?

lahinson avatar Nov 01 '22 13:11 lahinson

/label merge-review-needed

lahinson avatar Nov 09 '22 15:11 lahinson

Good catch, @jeana-redhat. I added the metadata. Thanks!

/label merge-review-needed

lahinson avatar Nov 09 '22 21:11 lahinson

Great! will merge once Travis is done. Thanks :)

/remove-label merge-review-in-progress /remove-label merge-review-needed

jeana-redhat avatar Nov 09 '22 21:11 jeana-redhat

/cherrypick enterprise-4.12

jeana-redhat avatar Nov 09 '22 21:11 jeana-redhat

hm :thinking: /cherrypick enterprise-4.12

jeana-redhat avatar Nov 10 '22 13:11 jeana-redhat

@jeana-redhat: new pull request created: #52680

In response to this:

hm :thinking: /cherrypick enterprise-4.12

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/test-infra repository.