OSDOCS-17042 [CQA] Simplify VPA and CRO resource movement documentation#105996
OSDOCS-17042 [CQA] Simplify VPA and CRO resource movement documentation#105996bscott-rh wants to merge 3 commits into
Conversation
openshift-ci
Bot
added
the
size/L
bscott-rh
changed the title
There was a problem hiding this comment.
This module was two nearly-identical procedures, one that moved the pod to an arbitrary node, and one that specifically moved it to an infra node. Because both of the assemblies that include this module are dealing with infra nodes, I flattened the module into one simpler procedure that works for both scenarios.
jeana-redhat
left a comment
jeana-redhat
left a comment
There was a problem hiding this comment.
Good fixes imho. Some callout replacement things to look at, and I think this does unfortunately need QA ack if you are changing the YAML in that one step (even though I am sure you are correct and it's just been in there wrong for years)
| .Procedure | ||
|
|
||
| .Example node list | ||
| . Determine the nodes where the Cluster Resource Override pods are running by running the following command: |
There was a problem hiding this comment.
Do you think there is value to preserving the example output (the pod list not the node list) here with the explanation that it had?
There was a problem hiding this comment.
I think it would actually be best to remove this step, and add a prerequisite that states that the user has created one or more infrastructure nodes and is ready to move pods to them.
| nodeSelector: | ||
| node-role.kubernetes.io/worker: "" | ||
| tolerations: <1> | ||
| node-role.kubernetes.io/infra: "" |
There was a problem hiding this comment.
So, I am sure this is correct, but this should get a QA ✔️
| `<node_role>`:: Specifies the node role of the node where you want to move the VPA Operator pod, for example `infra` to move the pod to an infrastructure node. | ||
| `<tolerations>`:: Specifies a toleration for a taint on the node where you want to move the VPA Operator pod. This parameter is only necessary if the destination node uses a taint. |
There was a problem hiding this comment.
<tolerations> is not a variable above. Because the first former callout is referring to part of the param, I think you'd need to do something like this to be able to mention both and use consistent presentation:
| `<node_role>`:: Specifies the node role of the node where you want to move the VPA Operator pod, for example `infra` to move the pod to an infrastructure node. | |
| `<tolerations>`:: Specifies a toleration for a taint on the node where you want to move the VPA Operator pod. This parameter is only necessary if the destination node uses a taint. | |
| `spec.config.nodeSelector`:: Specifies the node selector of the node where you want to move the VPA Operator pod and `<node_role>` is the node role. For example, to move the pod to an infrastructure node, this value would be `node-role.kubernetes.io/infra: ""`. | |
| `spec.config.tolerations`:: Specifies a toleration for a taint on the node where you want to move the VPA Operator pod. This parameter is only necessary if the destination node uses a taint. |
| `<node_role>`:: Specifies the node role for the admission, recommender, and updater pods, for example `infra` to move the pod to an infrastructure node.. | ||
| `<tolerations>`:: Specifies a toleration for a taint on the node where you want to move the admission, recommender, and updater pods. This parameter is only necessary if the destination node uses a taint. |
There was a problem hiding this comment.
same issue w/callouts here
There was a problem hiding this comment.
Resolved by adding specific full path descriptions for admission, recommender, and updater pods.
Refactor and consolidate the documentation for moving Vertical Pod Autoscaler (VPA) and Cluster Resource Override (CRO) resources to infrastructure nodes. - Reduce nodes-pods-vertical-autoscaler-moving-vpa.adoc by 249 lines - Reduce nodes-cluster-resource-override-move-infra.adoc by 103 lines - Streamline procedures and remove redundant content Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
bscott-rh
force-pushed
the
OSDOCS-17042-pr2-vpa-cro
branch
from
3776244 to
b08de84
Compare
|
@bscott-rh: all tests passed! Full PR test history. Your PR dashboard. DetailsInstructions 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. |
|
Hi @miyadav - would you PTAL at this PR to make sure the updates I made to the YAML files are accurate? I made the changes as part of our content quality assessments as we are preparing to migrate our codebase to a new content management system. Thanks |
|
Hi @bscott-rh , Not certain I’m the right reviewer here—adding @joelsmith in case this falls under their area... |
4 participants
Refactor and consolidate the documentation for moving Vertical Pod Autoscaler (VPA) and Cluster Resource Override (CRO) resources to infrastructure nodes.
Version(s):
4.16+
Issue:
https://issues.redhat.com/browse/OSDOCS-17042
Link to docs preview:
Moving VPA
Moving CRO
This is 1 of 3 PRs split out from #103488 by Claude. The other two PRs are #105995 and #105997