Skip to content

Commit 738b82f

Browse files
authored
Merge pull request #228703 from jaredr80/NexusUpdates-0227
Nexus updates 0227
2 parents 59a2abf + 2fef0d1 commit 738b82f

6 files changed

+78
-83
lines changed

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

Lines changed: 13 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -11,16 +11,12 @@ ms.custom: template-how-to
1111

1212
# Manage lifecycle of Bare Metal Machines
1313

14-
This article describes how to perform lifecycle management operations on Bare Metal Machines (BMM). 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

16-
- power-off
17-
- start the BMM
18-
- make the BMM unschedulable or schedulable
19-
- reinstall the BMM image
20-
21-
When you want to reinstall or update the image, or replace the BMM, make the BMM unschedulable. In these cases, you need to evacuate existing workloads. You may have a need for no new workloads to be scheduled on a BMM, in which case make it unschedulable but without evacuating the workloads.
22-
23-
Make your BMM schedulable for it to be used.
16+
- Power-off
17+
- Start the BMM
18+
- Make the BMM unschedulable or schedulable
19+
- Reinstall the BMM image
2420

2521
## Prerequisites
2622

@@ -50,12 +46,12 @@ This command will `start` the specified `bareMetalMachineName`.
5046
## Make a BMM unschedulable (cordon)
5147

5248
You can make a BMM unschedulable by executing the [`cordon`](#make-a-bmm-unschedulable-cordon) command.
53-
On execution of the `cordon` command,
54-
Kubernetes won't schedule any new pods on the BMM; any attempt to create a pod on a `cordoned`
55-
BMM results in the pod being set to `pending` state. Existing pods continue to run.
49+
On the execution of the `cordon` command,
50+
Operator Nexus workloads are not scheduled on the BMM when cordon is set; any attempt to create a workload on a `cordoned`
51+
BMM results in the workload being set to `pending` state. Existing workloads continue to run.
5652
The cordon command supports an `evacuate` parameter with the default `false` value.
5753
On executing the `cordon` command, with the value `true` for the `evacuate`
58-
parameter, the pods currently running on the BMM will be `stopped` and the BMM will be set to `pending` state.
54+
parameter, the workloads that are running on the BMM are `stopped` and the BMM is set to `pending` state.
5955

6056
```azurecli
6157
az networkcloud baremetalmachine cordon \
@@ -64,12 +60,12 @@ parameter, the pods currently running on the BMM will be `stopped` and the BMM w
6460
--resource-group "resourceGroupName"
6561
```
6662

67-
The `evacuate "True"` removes pods from that node while `evacuate "FALSE"` only prevents the scheduling of new pods.
63+
The `evacuate "True"` removes workloads from that node while `evacuate "FALSE"` only prevents the scheduling of new workloads.
6864

6965
## Make a BMM schedulable (uncordon)
7066

71-
You can make a BMM `schedulable` (usable) by executing the [`uncordon`](#make-a-bmm-schedulable-uncordon) command. All pods in `pending`
72-
state on the BMM will be `re-started` when the BMM is `uncordoned`.
67+
You can make a BMM `schedulable` (usable) by executing the [`uncordon`](#make-a-bmm-schedulable-uncordon) command. All workloads in a `pending`
68+
state on the BMM are `restarted` when the BMM is `uncordoned`.
7369

7470
```azurecli
7571
az networkcloud baremetalmachine uncordon \
@@ -79,7 +75,7 @@ state on the BMM will be `re-started` when the BMM is `uncordoned`.
7975

8076
## Reimage a BMM (reinstall a BMM image)
8177

82-
The existing BMM image can be **reinstalled** using the `reimage` command but won't install a new image.
78+
The existing BMM image can be **reinstalled** using the `reimage` command but will not install a new image.
8379
Make sure the BMM's workloads are drained using the [`cordon`](#make-a-bmm-unschedulable-cordon)
8480
command, with `evacuate "TRUE"`, prior to executing the `reimage` command.
8581

articles/operator-nexus/howto-cluster-manager.md

Lines changed: 21 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,29 @@
11
---
22
title: How to guide for running commands for Cluster Manager on Azure Operator Nexus
33
description: Learn to create, view, list, update, delete commands for Cluster Manager on Operator Nexus
4-
author: krishnaposa
5-
ms.author: sriposa
4+
author: jaredr80
5+
ms.author: jaredro
66
ms.date: 01/23/2023
77
ms.topic: how-to
88
# ms.prod: used for on prem applications
99
ms.service: azure
1010
---
1111

12-
# Cluster manager: lifecycle management
12+
# Cluster Manager: How to manage the Cluster Manager in Operator Nexus
1313

14-
You'll need to upgrade or patch a Cluster Manager. You may need to examine or change its properties. When all Operator Nexus instances have been deleted from your sites, you may need to delete the Cluster Manager.
15-
In this how-to guide you'll learn to manage a Cluster Manager. The `networkcloud` resource provider supports `create`, `list` (also known as read), `show`, `update` and `delete` operations on the `clustermanager` resource.
14+
The Cluster Manager is deployed in the operator's Azure subscription to manage the lifecycle of Operator Nexus clusters.
1615

1716
## Before you begin
1817

1918
You'll need:
2019

21-
- **Azure subscription ID** - The Azure subscription ID where Cluster Manager needs to be created (should be the same subscription ID of the Network fabric Controller) or exists.
22-
- **Fabric Controller ID** - Network fabric Controller and Cluster Manager have a 1:1 association. You'll need the resource ID of the Network fabric Controller associated with the Cluster Manager. Both the Cluster Manager and Fabric Controller need to be in your same Resource group.
23-
- **analytics workspace ID** - The resource ID of the Log Analytics workspace used for the logs collection.
24-
- **Azure Region** - The Cluster Manager should be created in the same region as the Network fabric Controller.
20+
- **Azure Subscription ID** - The Azure subscription ID where Cluster Manager needs to be created (should be the same subscription ID of the Network Fabric Controller).
21+
- **Fabric Controller ID** - Network Fabric Controller and Cluster Manager have a 1:1 association. You'll need the resource ID of the Network Fabric Controller associated with the Cluster Manager. Both the Cluster Manager and Fabric Controller need to be in the same resource group.
22+
- **Log Analytics Workspace ID** - The resource ID of the Log Analytics Workspace used for the logs collection.
23+
- **Azure Region** - The Cluster Manager should be created in the same region as the Network Fabric Controller.
2524
This Azure region should be used in the `Location` field of the Cluster Manager and all associated Operator Nexus instances.
2625

27-
## Prerequisites: install CLI extensions
26+
## Prerequisites: Install CLI extensions
2827

2928
Install latest version of the [appropriate CLI extensions](./howto-install-cli-extensions.md)
3029

@@ -39,21 +38,21 @@ Some arguments that are available for every Azure CLI command
3938
- **--query** - uses the JMESPath query language to filter the output returned from Azure services.
4039
- **--verbose** - prints information about resources created in Azure during an operation, and other useful information
4140

42-
## Cluster manager elements
41+
## Cluster Manager elements
4342

4443
| Elements | Description |
4544
| --------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
4645
| Name, ID, location, tags, type | Name: User friendly name <br> ID: < Resource ID > <br> Location: Azure region where the Cluster Manager is created. Values from: `az account list -locations`.<br> Tags: Resource tags <br> Type: Microsoft.NetworkCloud/clusterManagers |
4746
| managerExtendedLocation | The ExtendedLocation associated with the Cluster Manager |
4847
| managedResourceGroupConfiguration | Information about the Managed Resource Group |
49-
| fabricControllerId | A reference to the fabric controller that is 1:1 with this Cluster Manager |
48+
| fabricControllerId | A reference to the Network Fabric Controller that is 1:1 with this Cluster Manager |
5049
| analyticsWorkspaceId | This workspace will be where any logs that 's relevant to the customer will be relayed. |
5150
| clusterVersions[] | List of ClusterAvailableVersions objects. <br> Cluster versions that the manager supports. Will be used as an input in the cluster clusterVersion property. |
5251
| provisioningState | Succeeded, Failed, Canceled, Provisioning, Accepted, Updating |
5352
| detailedStatus | Detailed statuses that provide additional information about the status of the Cluster Manager. |
5453
| detailedStatusMessage | Descriptive message about the current detailedStatus. |
5554

56-
## Create a cluster manager
55+
## Create a Cluster Manager
5756

5857
Use the `az network clustermanager create` command to create a Cluster Manager. This command creates a new Cluster Manager or updates the properties of the Cluster Manager if it exists. If you have multiple Azure subscriptions, select the appropriate subscription ID using the [az account set](/cli/azure/account#az-account-set) command.
5958

@@ -69,13 +68,11 @@ az networkcloud clustermanager create \
6968
--subscription <subscription ID>
7069
```
7170

72-
The command returns 200 OK in the successful creation or update. 201 Created is returned when the operation is performed asynchronously.
73-
7471
- **Arguments**
7572
- **--name -n [Required]** - The name of the Cluster Manager.
76-
- **--fabric-controller-id [Required]** - The resource ID of the Network fabric Controller that is associated with the Cluster Manager.
73+
- **--fabric-controller-id [Required]** - The resource ID of the Network Fabric Controller that is associated with the Cluster Manager.
7774
- **--resource-group -g [Required]** - Name of resource group. You can configure the default resource group using `az configure --defaults group=<name>`.
78-
- **--analytics-workspace-id** - The resource ID of the Log Analytics workspace that is used for the logs collection
75+
- **--analytics-workspace-id** - The resource ID of the Log Analytics Workspace that is used for the logs collection
7976
- **--location -l** - Location. Azure region where the Cluster Manager is created. Values from: `az account list -locations`. You can configure the default location using `az configure --defaults location=<location>`.
8077
- **--managed-resource-group-configuration** - The configuration of the managed resource group associated with the resource.
8178
- Usage: --managed-resource-group-configuration location=XX name=XX
@@ -87,27 +84,27 @@ The command returns 200 OK in the successful creation or update. 201 Created is
8784
- **--tags** - Space-separated tags: key[=value] [key[=value]...]. Use '' to clear existing tags
8885
- **--subscription** - Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.
8986

90-
## List/show cluster manager(s)
87+
## List/show Cluster Manager(s)
9188

9289
List and show commands are used to get a list of existing Cluster Managers or the properties of a specific Cluster Manager.
9390

94-
### List cluster managers in resource group
91+
### List Cluster Managers in resource group
9592

9693
This command lists the Cluster Managers in the specified Resource group.
9794

9895
```azurecli
9996
az networkcloud clustermanager list --resource-group <Azure Resource group>
10097
```
10198

102-
### List cluster managers in subscription
99+
### List Cluster Managers in subscription
103100

104101
This command lists the Cluster Managers in the specified subscription.
105102

106103
```azurecli
107104
az networkcloud clustermanager list --subscription <subscription ID>
108105
```
109106

110-
### Show cluster manager properties
107+
### Show Cluster Manager properties
111108

112109
This command lists the properties of the specified Cluster Manager.
113110

@@ -125,7 +122,7 @@ az networkcloud clustermanager show \
125122
- **--resource-group -g** - Name of resource group. You can configure the default group using `az configure --defaults group=<name>`.
126123
- **--subscription** - Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.
127124

128-
## Update cluster manager
125+
## Update Cluster Manager
129126

130127
This command is used to Patch properties of the provided Cluster Manager, or update the tags assigned to the Cluster Manager. Properties and tag updates can be done independently.
131128

@@ -144,10 +141,10 @@ az networkcloud clustermanager update \
144141
- **--resource-group -g** - Name of resource group. You can configure the default group using `az configure --defaults group=<name>`.
145142
- **--subscription** - Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.
146143

147-
## Delete cluster manager
144+
## Delete Cluster Manager
148145

149146
This command is used to Delete the provided Cluster Manager.
150-
A Cluster Manager that has an existing associated Network fabric Controller, or any Clusters that reference this Cluster Manager may not be deleted
147+
A Cluster Manager that has an existing associated Network Fabric Controller, or any Clusters that reference this Cluster Manager may not be deleted
151148

152149
```azurecli
153150
az networkcloud clustermanager delete \

0 commit comments

Comments
 (0)