Skip to content

Commit 4764077

Browse files
author
Dan Crank
committed
edits from review
1 parent d4c65cc commit 4764077

File tree

2 files changed

+18
-13
lines changed

2 files changed

+18
-13
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -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 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.
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 become non-operational at once due to simultaneous disruptive actions. If multiple nodes become non-operational, 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
>

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

Lines changed: 17 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -18,17 +18,18 @@ run simple actions on bare metal machines without using the Azure console or com
1818
> 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.
1919
2020
> [!IMPORTANT]
21-
> 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.
21+
> 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 become non-operational at once due to simultaneous disruptive actions. If multiple nodes become non-operational, it will break the healthy quorum threshold of the Kubernetes Control Plane.
2222
>
2323
> Powering off a KCP node is the only nexusctl action considered disruptive in the context of this check.
2424
2525
## Prerequisites
2626

27-
1. Create a [BareMetalMachineKeySet](./howto-baremetal-bmm-ssh.md) to allow ssh access to the bare metal machines.
27+
1. Create a [BareMetalMachineKeySet](./howto-baremetal-bmm-ssh.md) to allow ssh access to the bare metal machines. The user must have superuser privilege level.
28+
1. The platform Kubernetes must be up and running on site.
2829

2930
## Overview
3031

31-
`nexusctl` is a stand-alone program that can be run using `nc-toolbox` from an `ssh` session on any management node. Since `nexusctl` is contained in the `nc-toolbox-breakglass` container image and isn't installed directly on the host, it must be run with a command-line like:
32+
`nexusctl` is a stand-alone program that can be run using `nc-toolbox` from an `ssh` session on any control-plane or management-plane node. Since `nexusctl` is contained in the `nc-toolbox-breakglass` container image and isn't installed directly on the host, it must be run with a command-line like:
3233

3334
```
3435
sudo nc-toolbox nc-toolbox-breakglass nexusctl <command> [subcommand] [options]
@@ -46,9 +47,13 @@ sudo nc-toolbox nc-toolbox-breakglass nexusctl baremetal power-off --help
4647

4748
etc.
4849

50+
> [!NOTE]
51+
>
52+
> > There is no bulk execution against multiple machines. Commands are executed on a machine by machine basis.
53+
4954
## Power off a bare metal machine
5055

51-
A single bare metal machine can be powered off by connecting to a management node via ssh and running the command:
56+
A single bare metal machine can be powered off by connecting to a control-plane or management-plane node via ssh and running the command:
5257

5358
```
5459
sudo nc-toolbox nc-toolbox-breakglass nexusctl baremetal power-off --name <machine name>
@@ -64,7 +69,7 @@ The status is blank until the operation completes and reaches either a "succeede
6469

6570
## Start a bare metal machine
6671

67-
A single bare metal machine can be started from a power-off state by connecting to a management node via ssh and running the command:
72+
A single bare metal machine can be started from a power-off state by connecting to a control-plane or management-plane node via ssh and running the command:
6873

6974
```
7075
sudo nc-toolbox nc-toolbox-breakglass nexusctl baremetal start --name <machine name>
@@ -80,19 +85,19 @@ The status is blank until the operation completes and reaches either a "succeede
8085

8186
## Unmanage a bare metal machine (set to unmanaged state)
8287

83-
A single bare metal machine can be moved from a managed state to an unmanaged state by connecting to a management node via ssh and running the command:
88+
A single bare metal machine can be moved from a managed state to an unmanaged state by connecting to a control-plane or management-plane node via ssh and running the command:
8489

8590
```
8691
sudo nc-toolbox nc-toolbox-breakglass nexusctl baremetal unmanage --name <machine name>
8792
```
8893

89-
While in an unmanaged state, no actions are permitted for that machine, except for returning it to a managed state (see next section).
94+
While in an unmanaged state, no actions are permitted for that machine, except for returning it to a managed state (see next section). This can be used to keep a bare metal machine powered off in the instance it's caught in a rebooting crash loop.
9095

9196
`unmanage` isn't a long-running command, so there's no associated command to check operation status.
9297

9398
## Manage a bare metal machine (set to managed state)
9499

95-
A single bare metal machine can be moved from an unmanaged state to a managed state by connecting to a management node via ssh and running the command:
100+
A single bare metal machine can be moved from an unmanaged state to a managed state by connecting to a control-plane or management-plane node via ssh and running the command:
96101

97102
```
98103
sudo nc-toolbox nc-toolbox-breakglass nexusctl baremetal manage --name <machine name>
@@ -102,7 +107,7 @@ sudo nc-toolbox nc-toolbox-breakglass nexusctl baremetal manage --name <machine
102107

103108
## Create users on storage appliances
104109

105-
User accounts can be created on the Pure storage appliance by connecting to a management node via ssh and running the command:
110+
User accounts can be created on the Pure storage appliance by connecting to a control-plane or management-plane node via ssh and running the command:
106111

107112
```
108113
sudo nc-toolbox nc-toolbox-breakglass nexusctl storage users create --file <user-file> --keyvault <keyvault>
@@ -122,7 +127,7 @@ If a user in the given list already exists on the appliance, their account and p
122127

123128
## Delete users on storage appliances
124129

125-
User accounts can be deleted on the Pure storage appliance by connecting to a management node via ssh and running the command:
130+
User accounts can be deleted on the Pure storage appliance by connecting to a control-plane or management-plane node via ssh and running the command:
126131

127132
```
128133
sudo nc-toolbox nc-toolbox-breakglass nexusctl storage users delete --file <user-file> --keyvault <keyvault>
@@ -132,15 +137,15 @@ sudo nc-toolbox nc-toolbox-breakglass nexusctl storage users delete --file <user
132137

133138
## List users on storage appliances
134139

135-
The current user accounts on the storage appliance can be listed by connecting to a management node via ssh and running the command:
140+
The current user accounts on the storage appliance can be listed by connecting to a control-plane or management-plane node via ssh and running the command:
136141

137142
```
138143
sudo nc-toolbox nc-toolbox-breakglass nexusctl storage users get
139144
```
140145

141146
## Rotate passwords for users on storage appliances
142147

143-
Passwords can be rotated for users on the Pure storage appliance by connecting to a management node via ssh and running the command:
148+
Passwords can be rotated for users on the Pure storage appliance by connecting to a control-plane or management-plane node via ssh and running the command:
144149

145150
```
146151
sudo nc-toolbox nc-toolbox-breakglass nexusctl storage users rotate --file <user-file> --keyvault <keyvault>

0 commit comments

Comments
 (0)