Nits on the VPA documentation by prozehna · Pull Request #91921 · openshift/openshift-docs

prozehna · 2025-04-09T14:05:22Z

Attempt #2.

While investigation PR ##91896
I found some nits that'd I'd like to correct.
All but one are punctuation/grammar, the other being a small clarification (node being used changing from master to infra.)

Version(s): 4.12 to 4.19

Issue:
N/A, just nits I found

Link to docs preview:
I don't know how to this

@mburke5678 Since I am QE, I'm not sure who else would run through these suggestions other than the two of us. Would you take a look?

ocpdocs-previewbot · 2025-04-09T14:16:27Z

🤖 Thu Apr 10 09:31:13 - Prow CI generated the docs preview:

https://91921--ocpdocs-pr.netlify.app/openshift-enterprise/latest/machine_management/creating-infrastructure-machinesets.html
https://91921--ocpdocs-pr.netlify.app/openshift-enterprise/latest/nodes/pods/nodes-pods-vertical-autoscaler.html

mburke5678 · 2025-04-09T14:46:59Z

-<3> Set the mode to `Auto`, `Recreate`, or `Off`. The `Recreate` mode should be used rarely, only if you need to ensure that the pods are restarted whenever the resource request changes.
-<4> Specify the containers you want to opt-out and set `mode` to `Off`.
+<3> Set the mode to `Auto`, `Recreate`, `Initial`, or `Off`. The `Recreate` mode should be used rarely, only if you need to ensure that the pods are restarted whenever the resource request changes.
+<4> Specify the containers you want to opt-out of and set `mode` to `Off`.


Specify the containers you want to opt-out of

This means I want to opt out of the container, where we want to opt the container out of the VPA. How about:

Specify the containers that you do not want updated by the VPA and set the mode to Off.

Yes, I think that's best.

mburke5678 · 2025-04-09T14:49:43Z

@prozehna Thanks for catching these. I had a couple of comments, and you will need a rebase because I merged #91896. After, I can merge this PR.

Co-authored-by: Michael Burke <mburke@redhat.com>

prozehna · 2025-04-10T09:17:55Z

Awesome @mburke5678 , I've rebased and committed your suggestions.

openshift-ci · 2025-04-10T09:33:21Z

@prozehna: all tests passed!

Full PR test history. Your PR dashboard.

Details

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.

mburke5678 · 2025-04-10T12:18:18Z

/cherrypick enterprise-4.12

mburke5678 · 2025-04-10T12:18:27Z

/cherrypick enterprise-4.13

mburke5678 · 2025-04-10T12:18:32Z

/cherrypick enterprise-4.14

mburke5678 · 2025-04-10T12:18:36Z

/cherrypick enterprise-4.15

mburke5678 · 2025-04-10T12:18:40Z

/cherrypick enterprise-4.16

mburke5678 · 2025-04-10T12:18:43Z

/cherrypick enterprise-4.17

mburke5678 · 2025-04-10T12:18:47Z

/cherrypick enterprise-4.18

mburke5678 · 2025-04-10T12:18:51Z

/cherrypick enterprise-4.19

openshift-cherrypick-robot · 2025-04-10T12:19:03Z

@mburke5678: #91921 failed to apply on top of branch "enterprise-4.12":

Applying: VPA nits
Using index info to reconstruct a base tree...
M	modules/nodes-pods-vertical-autoscaler-about.adoc
M	modules/nodes-pods-vertical-autoscaler-custom.adoc
A	modules/nodes-pods-vertical-autoscaler-moving-vpa.adoc
A	modules/nodes-pods-vertical-autoscaler-tuning.adoc
M	modules/nodes-pods-vertical-autoscaler-using-about.adoc
Falling back to patching base and 3-way merge...
Auto-merging modules/nodes-pods-vertical-autoscaler-using-about.adoc
CONFLICT (modify/delete): modules/nodes-pods-vertical-autoscaler-tuning.adoc deleted in HEAD and modified in VPA nits. Version VPA nits of modules/nodes-pods-vertical-autoscaler-tuning.adoc left in tree.
CONFLICT (modify/delete): modules/nodes-pods-vertical-autoscaler-moving-vpa.adoc deleted in HEAD and modified in VPA nits. Version VPA nits of modules/nodes-pods-vertical-autoscaler-moving-vpa.adoc left in tree.
Auto-merging modules/nodes-pods-vertical-autoscaler-custom.adoc
Auto-merging modules/nodes-pods-vertical-autoscaler-about.adoc
error: Failed to merge in the changes.
hint: Use 'git am --show-current-patch=diff' to see the failed patch
hint: When you have resolved this problem, run "git am --continue".
hint: If you prefer to skip this patch, run "git am --skip" instead.
hint: To restore the original branch and stop patching, run "git am --abort".
hint: Disable this message with "git config advice.mergeConflict false"
Patch failed at 0001 VPA nits

Details

In response to this:

/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-sigs/prow repository.

openshift-cherrypick-robot · 2025-04-10T12:19:08Z

@mburke5678: #91921 failed to apply on top of branch "enterprise-4.13":

Applying: VPA nits
Using index info to reconstruct a base tree...
A	modules/nodes-pods-vertical-autoscaler-moving-vpa.adoc
A	modules/nodes-pods-vertical-autoscaler-tuning.adoc
Falling back to patching base and 3-way merge...
CONFLICT (modify/delete): modules/nodes-pods-vertical-autoscaler-tuning.adoc deleted in HEAD and modified in VPA nits. Version VPA nits of modules/nodes-pods-vertical-autoscaler-tuning.adoc left in tree.
CONFLICT (modify/delete): modules/nodes-pods-vertical-autoscaler-moving-vpa.adoc deleted in HEAD and modified in VPA nits. Version VPA nits of modules/nodes-pods-vertical-autoscaler-moving-vpa.adoc left in tree.
error: Failed to merge in the changes.
hint: Use 'git am --show-current-patch=diff' to see the failed patch
hint: When you have resolved this problem, run "git am --continue".
hint: If you prefer to skip this patch, run "git am --skip" instead.
hint: To restore the original branch and stop patching, run "git am --abort".
hint: Disable this message with "git config advice.mergeConflict false"
Patch failed at 0001 VPA nits

Details

In response to this:

/cherrypick enterprise-4.13

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 · 2025-04-10T12:19:14Z

@mburke5678: #91921 failed to apply on top of branch "enterprise-4.14":

Applying: VPA nits
Using index info to reconstruct a base tree...
M	modules/nodes-pods-vertical-autoscaler-about.adoc
A	modules/nodes-pods-vertical-autoscaler-moving-vpa.adoc
A	modules/nodes-pods-vertical-autoscaler-tuning.adoc
Falling back to patching base and 3-way merge...
CONFLICT (modify/delete): modules/nodes-pods-vertical-autoscaler-tuning.adoc deleted in HEAD and modified in VPA nits. Version VPA nits of modules/nodes-pods-vertical-autoscaler-tuning.adoc left in tree.
CONFLICT (modify/delete): modules/nodes-pods-vertical-autoscaler-moving-vpa.adoc deleted in HEAD and modified in VPA nits. Version VPA nits of modules/nodes-pods-vertical-autoscaler-moving-vpa.adoc left in tree.
Auto-merging modules/nodes-pods-vertical-autoscaler-about.adoc
error: Failed to merge in the changes.
hint: Use 'git am --show-current-patch=diff' to see the failed patch
hint: When you have resolved this problem, run "git am --continue".
hint: If you prefer to skip this patch, run "git am --skip" instead.
hint: To restore the original branch and stop patching, run "git am --abort".
hint: Disable this message with "git config advice.mergeConflict false"
Patch failed at 0001 VPA nits

Details

In response to this:

/cherrypick enterprise-4.14

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 · 2025-04-10T12:19:17Z

@mburke5678: #91921 failed to apply on top of branch "enterprise-4.15":

Patch is empty.
hint: When you have resolved this problem, run "git am --continue".
hint: If you prefer to skip this patch, run "git am --skip" instead.
hint: To record the empty patch as an empty commit, run "git am --allow-empty".
hint: To restore the original branch and stop patching, run "git am --abort".
hint: Disable this message with "git config advice.mergeConflict false"

Details

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 · 2025-04-10T12:19:38Z

@mburke5678: new pull request created: #91991

Details

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.

openshift-cherrypick-robot · 2025-04-10T12:19:39Z

@mburke5678: new pull request created: #91992

Details

In response to this:

/cherrypick enterprise-4.17

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 · 2025-04-10T12:19:43Z

@mburke5678: new pull request created: #91993

Details

In response to this:

/cherrypick enterprise-4.18

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 · 2025-04-10T12:19:46Z

@mburke5678: new pull request created: #91994

Details

In response to this:

/cherrypick enterprise-4.19

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.

mburke5678 · 2025-04-10T12:24:38Z

/cherrypick enterprise-4.15

openshift-cherrypick-robot · 2025-04-10T12:25:21Z

@mburke5678: #91921 failed to apply on top of branch "enterprise-4.15":

Applying: VPA nits
Using index info to reconstruct a base tree...
A	modules/nodes-pods-vertical-autoscaler-moving-vpa.adoc
Falling back to patching base and 3-way merge...
CONFLICT (modify/delete): modules/nodes-pods-vertical-autoscaler-moving-vpa.adoc deleted in HEAD and modified in VPA nits. Version VPA nits of modules/nodes-pods-vertical-autoscaler-moving-vpa.adoc left in tree.
error: Failed to merge in the changes.
hint: Use 'git am --show-current-patch=diff' to see the failed patch
hint: When you have resolved this problem, run "git am --continue".
hint: If you prefer to skip this patch, run "git am --skip" instead.
hint: To restore the original branch and stop patching, run "git am --abort".
hint: Disable this message with "git config advice.mergeConflict false"
Patch failed at 0001 VPA nits

Details

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-ci Bot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Apr 9, 2025

prozehna mentioned this pull request Apr 9, 2025

Nits in VPA documentation #91918

Closed

mburke5678 reviewed Apr 9, 2025

View reviewed changes

Comment thread modules/nodes-pods-vertical-autoscaler-moving-vpa.adoc Outdated

mburke5678 reviewed Apr 9, 2025

View reviewed changes

openshift-merge-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Apr 10, 2025

prozehna and others added 3 commits April 10, 2025 11:15

VPA nits

8c09272

Update modules/nodes-pods-vertical-autoscaler-moving-vpa.adoc

55100bd

Co-authored-by: Michael Burke <mburke@redhat.com>

added mburke's suggestion

c03872d

prozehna force-pushed the prozehna-nits-vpa branch from c78a096 to c03872d Compare April 10, 2025 09:16

openshift-merge-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Apr 10, 2025

openshift-ci Bot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Apr 10, 2025

prozehna mentioned this pull request Apr 10, 2025

VPA updateMode values show lower cased options which won't work in cluster #91896

Merged

mburke5678 added branch/enterprise-4.12 branch/enterprise-4.13 branch/enterprise-4.14 branch/enterprise-4.15 branch/enterprise-4.16 branch/enterprise-4.17 branch/enterprise-4.18 branch/enterprise-4.19 labels Apr 10, 2025

mburke5678 added this to the Continuous Release milestone Apr 10, 2025

mburke5678 merged commit 812e476 into openshift:main Apr 10, 2025
2 checks passed

openshift-cherrypick-robot mentioned this pull request Apr 10, 2025

[enterprise-4.16] Nits on the VPA documentation #91991

Merged

openshift-cherrypick-robot mentioned this pull request Apr 10, 2025

[enterprise-4.17] Nits on the VPA documentation #91992

Merged

openshift-cherrypick-robot mentioned this pull request Apr 10, 2025

[enterprise-4.18] Nits on the VPA documentation #91993

Merged

openshift-cherrypick-robot mentioned this pull request Apr 10, 2025

[enterprise-4.19] Nits on the VPA documentation #91994

Merged

Conversation

prozehna commented Apr 9, 2025

Uh oh!

ocpdocs-previewbot commented Apr 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

mburke5678 Apr 9, 2025

Choose a reason for hiding this comment

Uh oh!

prozehna Apr 10, 2025

Choose a reason for hiding this comment

Uh oh!

mburke5678 commented Apr 9, 2025

Uh oh!

prozehna commented Apr 10, 2025

Uh oh!

openshift-ci Bot commented Apr 10, 2025

Uh oh!

Uh oh!

mburke5678 commented Apr 10, 2025

Uh oh!

mburke5678 commented Apr 10, 2025

Uh oh!

mburke5678 commented Apr 10, 2025

Uh oh!

mburke5678 commented Apr 10, 2025

Uh oh!

mburke5678 commented Apr 10, 2025

Uh oh!

mburke5678 commented Apr 10, 2025

Uh oh!

mburke5678 commented Apr 10, 2025

Uh oh!

mburke5678 commented Apr 10, 2025

Uh oh!

openshift-cherrypick-robot commented Apr 10, 2025

Uh oh!

openshift-cherrypick-robot commented Apr 10, 2025

Uh oh!

openshift-cherrypick-robot commented Apr 10, 2025

Uh oh!

openshift-cherrypick-robot commented Apr 10, 2025

Uh oh!

openshift-cherrypick-robot commented Apr 10, 2025

Uh oh!

openshift-cherrypick-robot commented Apr 10, 2025

Uh oh!

openshift-cherrypick-robot commented Apr 10, 2025

Uh oh!

openshift-cherrypick-robot commented Apr 10, 2025

Uh oh!

mburke5678 commented Apr 10, 2025

Uh oh!

openshift-cherrypick-robot commented Apr 10, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

ocpdocs-previewbot commented Apr 9, 2025 •

edited

Loading