Skip to content

Commit 0bccbf1

Browse files
committed
updates based on Holly review
1 parent c92c003 commit 0bccbf1

File tree

2 files changed

+31
-33
lines changed

2 files changed

+31
-33
lines changed

articles/operator-nexus/howto-baremetal-functions.md

Lines changed: 22 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
11
---
2-
title: "Azure Operator Nexus: Platform Functions for Bare Metal Machines"
3-
description: Learn how to manage Bare Metal Machines (BMM).
2+
title: "Azure Operator Nexus: Platform functions for bare metal machines"
3+
description: Learn how to manage bare metal machines (BMM).
44
author: eak13
55
ms.author: ekarandjeff
66
ms.service: azure-operator-nexus
77
ms.topic: how-to
8-
ms.date: 04/24/2024
8+
ms.date: 04/30/2024
99
ms.custom: template-how-to, devx-track-azurecli
1010
---
1111

12-
# Manage lifecycle of Bare Metal Machines
12+
# Manage the lifecycle of bare metal machines
1313

14-
This article describes how to perform lifecycle management operations on Bare Metal Machines (BMM). These steps should be used for troubleshooting purposes to recover from failures or when taking maintenance actions. The commands to manage the lifecycle of the BMM include:
14+
This article describes how to perform lifecycle management operations on bare metal machines (BMM). These steps should be used for troubleshooting purposes to recover from failures or when taking maintenance actions. The commands to manage the lifecycle of the BMM include:
1515

1616
> [!CAUTION]
17-
> Actions against management servers should not be run without consultation with Microsoft support personnel. Doing so could affect the integrity of the Operator Nexus Cluster.
17+
> Do not perform any action against management servers without first consulting with Microsoft support personnel. Doing so could affect the integrity of the Operator Nexus Cluster.
1818
1919
- **Power off the BMM**
2020
- Start the BMM
@@ -26,7 +26,7 @@ This article describes how to perform lifecycle management operations on Bare Me
2626
- **Replace the BMM**
2727

2828
> [!IMPORTANT]
29-
> Disruptive command requests against a Kubernetes Control Plane (KCP) node are rejected if there is another disruptive action command already running against another KCP node or the full KCP is not available. This check is done to maintain the integrity of the Nexus instance and ensure multiple KCP nodes don't go down at once due to simultaneous disruptive actions. If multiple nodes go down, it will break healthy quorum threshold of Kubernetes Control Plane.
29+
> Disruptive command requests against a Kubernetes Control Plane (KCP) node are rejected if there is another disruptive action command already running against another KCP node or if the full KCP is not available. This check is done to maintain the integrity of the Nexus instance and ensure multiple KCP nodes don't go down at once due to simultaneous disruptive actions. If multiple nodes go down, it will break the healthy quorum threshold of the Kubernetes Control Plane.
3030
>
3131
> The bolded actions in the above list are considered disruptive (Power off, Restart, Reimage, Replace). Cordon without evacuate is not considered disruptive. Cordon with evacuate is considered disruptive.
3232
>
@@ -35,11 +35,11 @@ This article describes how to perform lifecycle management operations on Bare Me
3535
## Prerequisites
3636

3737
1. Install the latest version of the
38-
[appropriate CLI extensions](./howto-install-cli-extensions.md)
39-
1. Get the name of the resource group for the BMM
40-
1. Get the name of the bare metal machine that requires a lifecycle management operation
41-
1. Ensure that the target bare metal machine `poweredState` set to `On` and `readyState` set to `True`
42-
1. This prerequisite isn't applicable for the `start` command
38+
[appropriate CLI extensions](./howto-install-cli-extensions.md).
39+
1. Get the name of the resource group for the BMM.
40+
1. Get the name of the bare metal machine that requires a lifecycle management operation.
41+
1. Ensure that the target bare metal machine `poweredState` set to `On` and `readyState` set to `True`.
42+
1. This prerequisite isn't applicable for the `start` command.
4343

4444
## Power off the BMM
4545

@@ -90,9 +90,9 @@ az networkcloud baremetalmachine cordon \
9090

9191
The `evacuate "True"` removes workloads from that node while `evacuate "False"` only prevents the scheduling of new workloads.
9292

93-
## Make a BMM schedulable (uncordon)
93+
## Make a BMM "schedulable" (uncordon)
9494

95-
You can make a BMM `schedulable` (usable) by executing the [`uncordon`](#make-a-bmm-schedulable-uncordon) command. All workloads in a `pending`
95+
You can make a BMM "schedulable" (usable) by executing the [`uncordon`](#make-a-bmm-schedulable-uncordon) command. All workloads in a `pending`
9696
state on the BMM are `restarted` when the BMM is `uncordoned`.
9797

9898
```azurecli
@@ -103,15 +103,14 @@ az networkcloud baremetalmachine uncordon \
103103

104104
## Reimage a BMM
105105

106-
You can restore the runtime version on a BMM by executing `reimage` command. This process **redeploys** the runtime image on the target BMM and executes the steps to rejoin the cluster with the same identifiers. This action doesn't affect the tenant workload files on this BMM.
106+
You can restore the runtime version on a BMM by executing the `reimage` command. This process **redeploys** the runtime image on the target BMM and executes the steps to rejoin the cluster with the same identifiers. This action doesn't affect the tenant workload files on this BMM.
107107
As a best practice, make sure the BMM's workloads are drained using the [`cordon`](#make-a-bmm-unschedulable-cordon)
108108
command, with `evacuate "True"`, before executing the `reimage` command.
109109

110110
> [!WARNING]
111-
> Running more than one baremetalmachine replace or reimage command at the same time, or running a replace
112-
> at the same time as a reimage, will leave servers in a nonworking state. Make sure one replace / reimage
113-
> has fully completed before starting another one. In a future release, we plan to either add the ability
114-
> to replace multiple servers at once or have the command return an error when attempting to do so.
111+
> Running more than one `baremetalmachine replace` or `reimage` command at the same time, or running a `replace`
112+
> at the same time as a `reimage` will leave servers in a nonworking state. Make sure one `replace`/`reimage`
113+
> has fully completed before starting another one.
115114
116115
```azurecli
117116
az networkcloud baremetalmachine reimage \
@@ -121,13 +120,12 @@ az networkcloud baremetalmachine reimage \
121120

122121
## Replace BMM
123122

124-
Use `Replace BMM` command when a server encounters hardware issues requiring a complete or partial hardware replacement. After replacement of components such as motherboard or Network Interface Card (NIC) replacement, the MAC address of BMM will change, however the iDRAC IP address and hostname will remain the same.
123+
Use the `replace` command when a server encounters hardware issues requiring a complete or partial hardware replacement. After replacement of components such as motherboard or Network Interface Card (NIC) replacement, the MAC address of BMM will change, however the iDRAC IP address and hostname will remain the same.
125124

126125
> [!WARNING]
127-
> Running more than one baremetalmachine replace or reimage command at the same time, or running a replace
128-
> at the same time as a reimage, will leave servers in a nonworking state. Make sure one replace / reimage
129-
> has fully completed before starting another one. In a future release, we plan to either add the ability
130-
> to replace multiple servers at once or have the command return an error when attempting to do so.
126+
> Running more than one `baremetalmachine replace` or `reimage` command at the same time, or running a `replace`
127+
> at the same time as a `reimage` will leave servers in a nonworking state. Make sure one `replace`/`reimage`
128+
> has fully completed before starting another one.
131129
132130
```azurecli
133131
az networkcloud baremetalmachine replace \

articles/operator-nexus/troubleshoot-reboot-reimage-replace.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Troubleshoot Azure Operator Nexus server problems
3-
description: Troubleshoot cluster bare-metal machines with Restart, Reimage, Replace for Azure Operator Nexus.
3+
description: Troubleshoot cluster bare metal machines with Restart, Reimage, Replace for Azure Operator Nexus.
44
ms.service: azure-operator-nexus
55
ms.custom: troubleshooting
66
ms.topic: troubleshooting
@@ -11,12 +11,12 @@ ms.author: ekarandjeff
1111

1212
# Troubleshoot Azure Operator Nexus server problems
1313

14-
This article describes how to troubleshoot server problems by using restart, reimage, and replace actions on Azure Operator Nexus bare-metal machines (BMMs). You might need to take these actions on your server for maintenance reasons, which causes a brief disruption to specific BMMs.
14+
This article describes how to troubleshoot server problems by using restart, reimage, and replace actions on Azure Operator Nexus bare metal machines (BMMs). You might need to take these actions on your server for maintenance reasons, which causes a brief disruption to specific BMMs.
1515

1616
The time required to complete each of these actions is similar. Restarting is the fastest, whereas replacing takes slightly longer. All three actions are simple and efficient methods for troubleshooting.
1717

1818
> [!CAUTION]
19-
> Actions against management servers should not be run without consultation with Microsoft support personnel. Doing so could affect the integrity of the Operator Nexus Cluster.
19+
> Do not perform any action against management servers without first consulting with Microsoft support personnel. Doing so could affect the integrity of the Operator Nexus Cluster.
2020
2121
## Prerequisites
2222

@@ -26,15 +26,15 @@ The time required to complete each of these actions is similar. Restarting is th
2626
- Name of the BMM that requires a lifecycle management operation
2727

2828
> [!IMPORTANT]
29-
> Disruptive command requests against a Kubernetes Control Plane (KCP) node are rejected if there is another disruptive action command already running against another KCP node or the full KCP is not available.
29+
> Disruptive command requests against a Kubernetes Control Plane (KCP) node are rejected if there is another disruptive action command already running against another KCP node or if the full KCP is not available.
3030
>
31-
> Restart, Reimage and Replace are all considered disruptive actions.
31+
> Restart, reimage and replace are all considered disruptive actions.
3232
>
33-
> This check is done to maintain the integrity of the Nexus instance and ensure multiple KCP nodes don't go down at once due to simultaneous disruptive actions. If multiple nodes go down, it will break healthy quorum threshold of Kubernetes Control Plane.
33+
> This check is done to maintain the integrity of the Nexus instance and ensure multiple KCP nodes don't go down at once due to simultaneous disruptive actions. If multiple nodes go down, it will break the healthy quorum threshold of the Kubernetes Control Plane.
3434
3535
## Identify the corrective action
3636

37-
When you're troubleshooting a BMM for failures and determining the best corrective action, it's important to understand the available options. Restarting or reimaging a BMM can be an efficient and effective way to fix problems or restore the software to a known-good place. This article provides direction on the best practices for each of the three Rs.
37+
When you're troubleshooting a BMM for failures and determining the best corrective action, it's important to understand the available options. Restarting or reimaging a BMM can be an efficient and effective way to fix problems or restore the software to a known-good place. Replacing a BMM might be required when one or more hardware components fail on the server. This article provides direction on the best practices for each of the three actions.
3838

3939
Troubleshooting technical problems requires a systematic approach. One effective method is to start with the least invasive solution and works your way up to more complex and drastic measures, if necessary.
4040

@@ -64,9 +64,9 @@ Servers contain many physical components that can fail over time. It's important
6464

6565
A hardware validation process is invoked to ensure the integrity of the physical host in advance of deploying the OS image. Like the reimage action, the tenant data isn't modified during replacement.
6666

67-
As a best practice, cordon off and shut down the BMM in advance of physical repairs. When you're performing the following physical repair, a replace action isn't required because the BMM host will continue to function normally after the repair:
67+
As a best practice, first issue a `cordon` command to remove the bare metal machine from workload scheduling and then shut down the BMM in advance of physical repairs.
6868

69-
- Hot swappable power supply
69+
When you're performing a physical hot swappable power supply repair, a replace action isn't required because the BMM host will continue to function normally after the repair.
7070

7171
When you're performing the following physical repairs, we recommend a replace action, though it isn't necessary to bring the BMM back into service:
7272

0 commit comments

Comments
 (0)