You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/operator-nexus/howto-baremetal-functions.md
+13-17Lines changed: 13 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,16 +11,12 @@ ms.custom: template-how-to
11
11
12
12
# Manage lifecycle of Bare Metal Machines
13
13
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:
15
15
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
24
20
25
21
## Prerequisites
26
22
@@ -50,12 +46,12 @@ This command will `start` the specified `bareMetalMachineName`.
50
46
## Make a BMM unschedulable (cordon)
51
47
52
48
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.
56
52
The cordon command supports an `evacuate` parameter with the default `false` value.
57
53
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.
59
55
60
56
```azurecli
61
57
az networkcloud baremetalmachine cordon \
@@ -64,12 +60,12 @@ parameter, the pods currently running on the BMM will be `stopped` and the BMM w
64
60
--resource-group "resourceGroupName"
65
61
```
66
62
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.
68
64
69
65
## Make a BMM schedulable (uncordon)
70
66
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`.
73
69
74
70
```azurecli
75
71
az networkcloud baremetalmachine uncordon \
@@ -79,7 +75,7 @@ state on the BMM will be `re-started` when the BMM is `uncordoned`.
79
75
80
76
## Reimage a BMM (reinstall a BMM image)
81
77
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.
83
79
Make sure the BMM's workloads are drained using the [`cordon`](#make-a-bmm-unschedulable-cordon)
84
80
command, with `evacuate "TRUE"`, prior to executing the `reimage` command.
Copy file name to clipboardExpand all lines: articles/operator-nexus/howto-cluster-manager.md
+21-24Lines changed: 21 additions & 24 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,30 +1,29 @@
1
1
---
2
2
title: How to guide for running commands for Cluster Manager on Azure Operator Nexus
3
3
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
6
6
ms.date: 01/23/2023
7
7
ms.topic: how-to
8
8
# ms.prod: used for on prem applications
9
9
ms.service: azure
10
10
---
11
11
12
-
# Cluster manager: lifecycle management
12
+
# Cluster Manager: How to manage the Cluster Manager in Operator Nexus
13
13
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.
16
15
17
16
## Before you begin
18
17
19
18
You'll need:
20
19
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.
25
24
This Azure region should be used in the `Location` field of the Cluster Manager and all associated Operator Nexus instances.
26
25
27
-
## Prerequisites: install CLI extensions
26
+
## Prerequisites: Install CLI extensions
28
27
29
28
Install latest version of the [appropriate CLI extensions](./howto-install-cli-extensions.md)
30
29
@@ -39,21 +38,21 @@ Some arguments that are available for every Azure CLI command
39
38
-**--query** - uses the JMESPath query language to filter the output returned from Azure services.
40
39
-**--verbose** - prints information about resources created in Azure during an operation, and other useful information
| 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 |
47
46
| managerExtendedLocation | The ExtendedLocation associated with the Cluster Manager |
48
47
| 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 |
50
49
| analyticsWorkspaceId | This workspace will be where any logs that 's relevant to the customer will be relayed. |
51
50
| clusterVersions[]| List of ClusterAvailableVersions objects. <br> Cluster versions that the manager supports. Will be used as an input in the cluster clusterVersion property. |
| detailedStatus | Detailed statuses that provide additional information about the status of the Cluster Manager. |
54
53
| detailedStatusMessage | Descriptive message about the current detailedStatus. |
55
54
56
-
## Create a cluster manager
55
+
## Create a Cluster Manager
57
56
58
57
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.
59
58
@@ -69,13 +68,11 @@ az networkcloud clustermanager create \
69
68
--subscription <subscription ID>
70
69
```
71
70
72
-
The command returns 200 OK in the successful creation or update. 201 Created is returned when the operation is performed asynchronously.
73
-
74
71
-**Arguments**
75
72
-**--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.
77
74
-**--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
79
76
-**--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>`.
80
77
-**--managed-resource-group-configuration** - The configuration of the managed resource group associated with the resource.
@@ -87,27 +84,27 @@ The command returns 200 OK in the successful creation or update. 201 Created is
87
84
-**--tags** - Space-separated tags: key[=value][key[=value]...]. Use '' to clear existing tags
88
85
-**--subscription** - Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.
89
86
90
-
## List/show cluster manager(s)
87
+
## List/show Cluster Manager(s)
91
88
92
89
List and show commands are used to get a list of existing Cluster Managers or the properties of a specific Cluster Manager.
93
90
94
-
### List cluster managers in resource group
91
+
### List Cluster Managers in resource group
95
92
96
93
This command lists the Cluster Managers in the specified Resource group.
97
94
98
95
```azurecli
99
96
az networkcloud clustermanager list --resource-group <Azure Resource group>
100
97
```
101
98
102
-
### List cluster managers in subscription
99
+
### List Cluster Managers in subscription
103
100
104
101
This command lists the Cluster Managers in the specified subscription.
105
102
106
103
```azurecli
107
104
az networkcloud clustermanager list --subscription <subscription ID>
108
105
```
109
106
110
-
### Show cluster manager properties
107
+
### Show Cluster Manager properties
111
108
112
109
This command lists the properties of the specified Cluster Manager.
113
110
@@ -125,7 +122,7 @@ az networkcloud clustermanager show \
125
122
-**--resource-group -g** - Name of resource group. You can configure the default group using `az configure --defaults group=<name>`.
126
123
-**--subscription** - Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.
127
124
128
-
## Update cluster manager
125
+
## Update Cluster Manager
129
126
130
127
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.
131
128
@@ -144,10 +141,10 @@ az networkcloud clustermanager update \
144
141
-**--resource-group -g** - Name of resource group. You can configure the default group using `az configure --defaults group=<name>`.
145
142
-**--subscription** - Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.
146
143
147
-
## Delete cluster manager
144
+
## Delete Cluster Manager
148
145
149
146
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
0 commit comments