Skip to content

Commit bd49f8b

Browse files
Merge pull request #293215 from eak13/main
Updates to remove preview for BYOSA
2 parents 1d9fb6d + 2d686aa commit bd49f8b

File tree

2 files changed

+41
-48
lines changed

2 files changed

+41
-48
lines changed

articles/operator-nexus/howto-baremetal-run-data-extract.md

Lines changed: 21 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ author: eak13
55
ms.author: ekarandjeff
66
ms.service: azure-operator-nexus
77
ms.topic: how-to
8-
ms.date: 10/16/2024
8+
ms.date: 1/17/2025
99
ms.custom: template-how-to, devx-track-azurecli
1010
---
1111

@@ -22,23 +22,7 @@ The command produces an output file containing the results of the data extract.
2222
- The syntax for these commands is based on the 0.3.0+ version of the `az networkcloud` CLI.
2323
- Get the Cluster Managed Resource group name (cluster_MRG) that you created for Cluster resource.
2424

25-
## Verify access to the Cluster Manager storage account
26-
27-
> [!NOTE]
28-
> The Cluster Manager storage account output method will be deprecated in the future once Cluster on-boarding to Trusted Services is complete and the user managed storage option is fully supported.
29-
30-
If using the Cluster Manager storage method, verify you have access to the Cluster Manager's storage account:
31-
32-
1. From Azure portal, navigate to Cluster Manager's Storage account.
33-
1. In the Storage account details, select **Storage browser** from the navigation menu on the left side.
34-
1. In the Storage browser details, select on **Blob containers**.
35-
1. If you encounter a `403 This request is not authorized to perform this operation.` while accessing the storage account, storage account’s firewall settings need to be updated to include the public IP address.
36-
1. Request access by creating a support ticket via Portal on the Cluster Manager resource. Provide the public IP address that requires access.
37-
38-
## **PREVIEW:** Send command output to a user specified storage account
39-
40-
> [!IMPORTANT]
41-
> Please note that this method of specifying a user storage account for command output is in preview. **This method should only be used with user storage accounts that do not have firewall enabled.** If your environment requires the storage account firewall be enabled, use the existing Cluster Manager output method.
25+
## Send command output to a user specified storage account
4226

4327
### Create and configure storage resources
4428

@@ -156,12 +140,25 @@ User-assigned identity example:
156140
},
157141
```
158142

143+
## DEPRECATED METHOD: Verify access to the Cluster Manager storage account
144+
145+
> [!IMPORTANT]
146+
> The Cluster Manager storage account is targeted for removal in April 2025 at the latest. If you're using this method today for command output, consider converting to using a user provided storage account.
147+
148+
If using the Cluster Manager storage method, verify you have access to the Cluster Manager's storage account:
149+
150+
1. From Azure portal, navigate to Cluster Manager's Storage account.
151+
1. In the Storage account details, select **Storage browser** from the navigation menu on the left side.
152+
1. In the Storage browser details, select on **Blob containers**.
153+
1. If you encounter a `403 This request is not authorized to perform this operation.` while accessing the storage account, storage account’s firewall settings need to be updated to include the public IP address.
154+
1. Request access by creating a support ticket via Portal on the Cluster Manager resource. Provide the public IP address that requires access.
155+
159156
## Execute a run-data-extract command
160157

161158
The run data extract command executes one or more predefined scripts to extract data from a bare metal machine.
162159

163160
> [!WARNING]
164-
> Microsoft does not provide or support any Operator Nexus API calls that expect plaintext username and/or password to be supplied. Please note any values sent will be logged and are considered exposed secrets, which should be rotated and revoked. The Microsoft documented method for securely using secrets is to store them in an Azure Key Vault, if you have specific questions or concerns please submit a request via the Azure Portal.
161+
> Microsoft doesn't provide or support any Operator Nexus API calls that expect plaintext username and/or password to be supplied. Note any values sent are logged and are considered exposed secrets, which should be rotated and revoked. The Microsoft documented method for securely using secrets is to store them in an Azure Key Vault. If you have specific questions or concerns, submit a request via the Azure portal.
165162
166163
The current list of supported commands are
167164

@@ -192,7 +189,6 @@ The current list of supported commands are
192189
- [Collect Helm Releases](#collect-helm-releases)\
193190
Command Name: `collect-helm-releases`\
194191
Arguments: None
195-
196192
- [Collect `systemctl status` Output](#collect-systemctl-status-output)\
197193
Command Name: `platform-services-status`\
198194
Arguments: None
@@ -455,7 +451,7 @@ Vulnerability data is collected with the `cluster-cve-report` command and format
455451
This example executes the `cluster-cve-report` command without arguments.
456452

457453
> [!NOTE]
458-
> The target machine must be a control-plane node or the action will not execute.
454+
> The target machine must be a control-plane node or the action doesn't execute.
459455
460456
```azurecli
461457
az networkcloud baremetalmachine run-data-extract --name "bareMetalMachineName" \
@@ -677,7 +673,7 @@ Helm release data is collected with the `collect-helm-releases` command and form
677673
This example executes the `collect-helm-releases` command without arguments.
678674

679675
> [!NOTE]
680-
> The target machine must be a control-plane node or the action will not execute.
676+
> The target machine must be a control-plane node or the action doesn't execute.
681677
682678
```azurecli
683679
az networkcloud baremetalmachine run-data-extract --name "bareMetalMachineName" \
@@ -786,7 +782,7 @@ https://cmcr5xp3mbn7st.blob.core.windows.net/bmm-run-command-output/a29dcbdb-552
786782
### Collect Systemctl Status Output
787783

788784
Service status is collected with the `platform-services-status` command. The output is in plain text format and
789-
returns an overview of the status of the services on the host as well as the `systemctl status` for each found service.
785+
returns an overview of the status of the services on the host and the `systemctl status` for each found service.
790786

791787
This example executes the `platform-services-status` command without arguments.
792788

@@ -843,7 +839,7 @@ TriggeredBy: ● atop-rotate.timer
843839
The command provides a link (if using cluster manager storage) or another command (if using user provided storage) to download the full output. The tar.gz file also contains the zipped extract command file outputs. Download the output file from the storage blob to a local directory by specifying the directory path in the optional argument `--output-directory`.
844840

845841
> [!WARNING]
846-
> Using the `--output-directory` argument will overwrite any files in the local directory that have the same name as the new files being created.
842+
> Using the `--output-directory` argument overwrites any files in the local directory that have the same name as the new files being created.
847843
848844
> [!NOTE]
849-
> Storage Account could be locked resulting in `403 This request is not authorized to perform this operation.` due to networking or firewall restrictions. Refer to the [cluster manager storage](#verify-access-to-the-cluster-manager-storage-account) or the [user managed storage](#create-and-configure-storage-resources) sections for procedures to verify access.
845+
> Storage Account could be locked resulting in `403 This request is not authorized to perform this operation.` due to networking or firewall restrictions. Refer to the [cluster manager storage](#deprecated-method-verify-access-to-the-cluster-manager-storage-account) or the [user managed storage](#create-and-configure-storage-resources) sections for procedures to verify access.

articles/operator-nexus/howto-baremetal-run-read.md

Lines changed: 20 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
---
22
title: Troubleshoot bare metal machine issues using the `az networkcloud baremetalmachine run-read-command` for Operator Nexus
33
description: Step by step guide on using the `az networkcloud baremetalmachine run-read-command` to run diagnostic commands on a BMM.
4-
author: matternst7258
5-
ms.author: matthewernst
4+
author: eak13
5+
ms.author: ekarandjeff
66
ms.service: azure-operator-nexus
77
ms.topic: how-to
8-
ms.date: 10/24/2024
8+
ms.date: 1/17/2025
99
ms.custom: template-how-to
1010
---
1111

@@ -22,23 +22,7 @@ The command produces an output file containing the results of the run-read comma
2222
1. Ensure that the target BMM must have its `poweredState` set to `On` and have its `readyState` set to `True`
2323
1. Get the Managed Resource group name (cluster_MRG) that you created for `Cluster` resource
2424

25-
## Verify access to the Cluster Manager storage account
26-
27-
> [!NOTE]
28-
> The Cluster Manager storage account output method will be deprecated in the future once Cluster on-boarding to Trusted Services is complete and the user managed storage option is fully supported.
29-
30-
If using the Cluster Manager storage method, verify you have access to the Cluster Manager's storage account:
31-
32-
1. From Azure portal, navigate to Cluster Manager's Storage account.
33-
1. In the Storage account details, select **Storage browser** from the navigation menu on the left side.
34-
1. In the Storage browser details, select on **Blob containers**.
35-
1. If you encounter a `403 This request is not authorized to perform this operation.` while accessing the storage account, storage account’s firewall settings need to be updated to include the public IP address.
36-
1. Request access by creating a support ticket via Portal on the Cluster Manager resource. Provide the public IP address that requires access.
37-
38-
## **PREVIEW:** Send command output to a user specified storage account
39-
40-
> [!IMPORTANT]
41-
> Please note that this method of specifying a user storage account for command output is in preview. **This method should only be used with user storage accounts that do not have firewall enabled.** If your environment requires the storage account firewall be enabled, use the existing Cluster Manager output method.
25+
## Send command output to a user specified storage account
4226

4327
### Create and configure storage resources
4428

@@ -156,6 +140,19 @@ User-assigned identity example:
156140
},
157141
```
158142

143+
## DEPRECATED METHOD: Verify access to the Cluster Manager storage account
144+
145+
> [!IMPORTANT]
146+
> The Cluster Manager storage account is targeted for removal in April 2025 at the latest. If you're using this method today for command output, consider converting to using a user provided storage account.
147+
148+
If using the Cluster Manager storage method, verify you have access to the Cluster Manager's storage account:
149+
150+
1. From Azure portal, navigate to Cluster Manager's Storage account.
151+
1. In the Storage account details, select **Storage browser** from the navigation menu on the left side.
152+
1. In the Storage browser details, select on **Blob containers**.
153+
1. If you encounter a `403 This request is not authorized to perform this operation.` while accessing the storage account, storage account’s firewall settings need to be updated to include the public IP address.
154+
1. Request access by creating a support ticket via Portal on the Cluster Manager resource. Provide the public IP address that requires access.
155+
159156
## Execute a run-read command
160157

161158
The run-read command lets you run a command on the BMM that doesn't change anything. Some commands have more
@@ -174,7 +171,7 @@ An example of run-read commands that require specific arguments is the allowed M
174171
which requires the `query` argument be provided to enforce read-only.
175172

176173
> [!WARNING]
177-
> Microsoft does not provide or support any Operator Nexus API calls that expect plaintext username and/or password to be supplied. Please note any values sent will be logged and are considered exposed secrets, which should be rotated and revoked. The Microsoft documented method for securely using secrets is to store them in an Azure Key Vault, if you have specific questions or concerns please submit a request via the Azure Portal.
174+
> Microsoft doesn't provide or support any Operator Nexus API calls that expect plaintext username and/or password to be supplied. Note any values sent are logged and are considered exposed secrets, which should be rotated and revoked. The Microsoft documented method for securely using secrets is to store them in an Azure Key Vault. If you have specific questions or concerns, submit a request via the Azure portal.
178175
179176
This list shows the commands you can use. Commands in `*italics*` can't have `arguments`; the rest can.
180177

@@ -363,7 +360,7 @@ This command runs synchronously. If you wish to skip waiting for the command to
363360
When an optional argument `--output-directory` is provided, the output result is downloaded and extracted to the local directory.
364361

365362
> [!WARNING]
366-
> Using the `--output-directory` argument will overwrite any files in the local directory that have the same name as the new files being created.
363+
> Using the `--output-directory` argument overwrites any files in the local directory that have the same name as the new files being created.
367364
368365
### This example executes a 'kubectl get pods'
369366

@@ -407,7 +404,7 @@ This guide walks you through accessing the output file that is created in the Cl
407404

408405
1. Select the baremetal-run-command-output blob container.
409406

410-
1. Storage Account could be locked resulting in `403 This request is not authorized to perform this operation.` due to networking or firewall restrictions. Refer to the [cluster manager storage](#verify-access-to-the-cluster-manager-storage-account) or the [customer-managed storage](#create-and-configure-storage-resources) sections for procedures to verify access.
407+
1. Storage Account could be locked resulting in `403 This request is not authorized to perform this operation.` due to networking or firewall restrictions. Refer to the [cluster manager storage](#deprecated-method-verify-access-to-the-cluster-manager-storage-account) or the [customer-managed storage](#create-and-configure-storage-resources) sections for procedures to verify access.
411408

412409
1. Select the output file from the run-read command. The file name can be identified from the `az rest --method get` command. Additionally, the **Last modified** timestamp aligns with when the command was executed.
413410

0 commit comments

Comments
 (0)