Skip to content

Docs for MCO-836 [GA] Machine Config Node #92503

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

mburke5678
Copy link
Contributor

@mburke5678 mburke5678 commented Apr 22, 2025

https://issues.redhat.com/browse/OSDOCS-14404
Updates needed

Previews:
About checking machine config node status:

  • Updated the list of phases and subphases;
  • Updated output of oc get machineconfignode -o wide command to remove the UPDATECOMPATIBLE and RELOADEDCRIO columns;
  • Removed the following description of each; replaced the output of the oc describe machineconfignode/<machine_config_node_name> -o yaml command.

Checking machine config node status:

  • Edited intro to remove the custom machine config pool restriction;
  • Added custom mcp to the output for the oc get machineconfignodes command;
  • Updated output of oc get machineconfignode -o wide command to remove the UPDATECOMPATIBLE and RELOADEDCRIO columns;
  • Added callout to command; updated output of oc describe machineconfignode/<node_name> command.

QE review:

  • QE has approved this change.

@mburke5678 mburke5678 added this to the Planned for 4.19 GA milestone Apr 22, 2025
@openshift-ci openshift-ci bot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Apr 22, 2025
@ocpdocs-previewbot
Copy link

ocpdocs-previewbot commented Apr 22, 2025

🤖 Thu May 08 11:33:46 - Prow CI generated the docs preview:

https://92503--ocpdocs-pr.netlify.app/openshift-enterprise/latest/machine_configuration/index.html

@openshift-ci openshift-ci bot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Apr 23, 2025
@mburke5678
Copy link
Contributor Author

@isabella-janssen PTAL

@isabella-janssen
Copy link
Member

I still see a description here talking about custom MCPs not being supported. I think that needs to be updated as well.

** *ReloadedCRIO*
* *NodeDegraded* The node update failed. You can view the reason for the failure by using the `oc describe machineconfignode` command, as described later in this section.
* *Update Post update action* The MCO reloads CRI-O, as needed.
* *Rebooted Node* The MCO reboots the node, as needed.
* *Update Complete*. The MCO uncordons the nodes, updates the node state to the cluster, and resumes producing node metrics.
Copy link
Member

@isabella-janssen isabella-janssen May 2, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* *Update Complete*. The MCO uncordons the nodes, updates the node state to the cluster, and resumes producing node metrics.
* *Update Complete*. The MCO uncordons the nodes, updates the node state to the cluster, and resumes producing node metrics. It contains the following sub-phase:

Suggestion: Add the It contains the following sub-phase: phrase to be consistent with how the Update Executed bullet was written.

@mburke5678
Copy link
Contributor Author

@ptalgulk01 PTAL

@@ -6,37 +6,31 @@
[id="checking-mco-node-status_{context}"]
= About checking machine config node status

If you make changes to the default control plane or worker nodes in your cluster, for example by using a machine config or kubelet config, you can get detailed information about the progress of the node updates by using the machine config nodes custom resource. Any change that results in a new machine config triggers the node update process.
If you make changes to the to a machine config pool that results in a new machine config, for example by using a machine config or kubelet config, you can get detailed information about the progress of the node updates by using the machine config nodes custom resource.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is typo here between to the / to a

@mburke5678 mburke5678 force-pushed the mco-machine-config-node-419 branch 2 times, most recently from 38b2824 to fe56b4d Compare May 7, 2025 16:16
@mburke5678 mburke5678 added the peer-review-needed Signifies that the peer review team needs to review this PR label May 7, 2025
@kowen-rh
Copy link
Contributor

kowen-rh commented May 7, 2025

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

@openshift-ci openshift-ci bot added peer-review-in-progress Signifies that the peer review team is reviewing this PR and removed peer-review-needed Signifies that the peer review team needs to review this PR labels May 7, 2025
Copy link
Contributor

@kowen-rh kowen-rh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks really good! I just noticed one typo. 🙂

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

** *Updated*
* *NodeDegraded* The node update failed. You can view the reason for the failure by using the `oc describe machineconfignode` command, as described later in this section.
* *Update Post update action* The MCO is reloading CRI-O, as needed.
* *Rebooted Node* The is MCO rebooting the node, as needed.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Typo: "The is MCO" should be "The MCO is".

@@ -6,37 +6,31 @@
[id="checking-mco-node-status_{context}"]
= About checking machine config node status

If you make changes to the default control plane or worker nodes in your cluster, for example by using a machine config or kubelet config, you can get detailed information about the progress of the node updates by using the machine config nodes custom resource. Any change that results in a new machine config triggers the node update process.
If you make changes to a machine config pool that results in a new machine config, for example by using a `MachineConfig` or `KubeletConfig` object, you can get detailed information about the progress of the node updates by using the machine config nodes custom resource.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we also introduce the "MCP" acronym here?

@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 7, 2025
@mburke5678 mburke5678 force-pushed the mco-machine-config-node-419 branch from fe56b4d to 8ea5d64 Compare May 8, 2025 11:22
Copy link

openshift-ci bot commented May 8, 2025

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

@isabella-janssen
Copy link
Member

This looks great to me, many thanks @mburke5678 🎉

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

Successfully merging this pull request may close these issues.

5 participants