TELCODOCS#2230: Coordinating reboots for configuration changes

[sr1kar99]

Version(s):
4.19

Issue:
TELCODOCS-2230

Link to docs preview:

• Coordinating reboots for configuration changes
• About the Node Tuning Operator

QE review:

• QE has approved this change.

[ocpdocs-previewbot]

🤖 Sun Apr 27 13:17:44 - Prow CI generated the docs preview:

https://91723--ocpdocs-pr.netlify.app/openshift-enterprise/latest/edge_computing/policygenerator_for_ztp/ztp-configuring-managed-clusters-policygenerator.html
https://91723--ocpdocs-pr.netlify.app/openshift-enterprise/latest/scalability_and_performance/using-node-tuning-operator.html

[xenolinux]

Suggested conditionals for trial as per #91723 (comment)

[sr1kar99]

/label peer-review-needed

[GroceryBoyJr]

/label peer-review-in-progress
/remove-label peer-review-needed
/assign GroceryBoyJr

[GroceryBoyJr]

LGTM

[GroceryBoyJr]

/label peer-review-done
/remove-label peer-review-in-progress
/unassign GroceryBoyJr

[openshift-ci]

@sr1kar99: 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.

[sudomakeinstall2]

/lgtm

[sr1kar99]

/label merge-review-needed

[michaelryanpeter]

/label merge-review-in-progress

[michaelryanpeter]

I left a few style and minimalism nits that do not block merging. Please consider addressing these comments in a follow up PR. Great work.

[michaelryanpeter]

This isn't really a step that the customer performs. This is a consequence of applying the CR.

This is not a merge blocker, but in a follow up PR, I recommend explicitly adding the oc apply -f command and then you can include this information below the procedure step, similar to the following example:

Suggested change

	. After you apply the CGU custom resource, {cgu-operator} rolls out the configuration policies in order. Once all policies are compliant, it applies the reboot policy and triggers a reboot of all nodes in the specified `MachineConfigPool`.
	. Apply the CGU CR by entering the following command:
	+
	[source,terminal]
	----
	$ oc apply -f <cgu_cr>.yaml
	----
	+
	After you apply the CGU custom resource, {cgu-operator} rolls out the configuration policies in order. Once all policies are compliant, it applies the reboot policy and triggers a reboot of all nodes in the specified machine config pool.

Also, when you use a generic reference to an API object, as you do in the previous sentence, the guidance is to drop the camel case and backticks, hence "machine config pool". If you are referring to the specific API object, which you can do but I don't think is necessary, then MachineConfigPool should be followed by a noun such as object or resource. See the repo guidelines for more information: https://github.com/openshift/openshift-docs/blob/main/contributing_to_docs/doc_guidelines.adoc#api-object-formatting

[michaelryanpeter]

Not a blocker, but the first part of the step is fluff and can be cut:

Suggested change

	. Monitor the CGU rollout status.
	+
	You can monitor the rollout of the CGU custom resource on the hub by checking the status. Verify the successful rollout of the reboot by running the following command:
	. You can monitor the rollout of the CGU custom resource on the hub by checking the status. Verify the successful rollout of the reboot by running the following command:

[michaelryanpeter]

Same comment as above, this section is fluff and can be deleted. Not a merge blocker.

[michaelryanpeter]

Similar to the comment above, to conform with the rules around API objects, the correct usage is "MachineConfigPool " or simply "machine config pool". Not a merge blocker.

[michaelryanpeter]

/cherrypick enterprise-4.19

[openshift-cherrypick-robot]

@michaelryanpeter: new pull request created: #92789

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.