Skip to content

Commit 70e8d27

Browse files
committed
Simplify add/update step; clarify verify-host
1 parent d8825fa commit 70e8d27

File tree

3 files changed

+17
-41
lines changed

3 files changed

+17
-41
lines changed

articles/iot-operations/deploy-iot-ops/howto-deploy-iot-operations.md

Lines changed: 6 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ ms.author: kgremban
66
# ms.subservice: orchestrator
77
ms.topic: how-to
88
ms.custom: ignite-2023, devx-track-azurecli
9-
ms.date: 01/22/2024
9+
ms.date: 01/31/2024
1010

1111
#CustomerIntent: As an OT professional, I want to deploy Azure IoT Operations to a Kubernetes cluster.
1212
---
@@ -21,25 +21,17 @@ Deploy Azure IoT Operations preview - enabled by Azure Arc to a Kubernetes clust
2121

2222
* Azure CLI installed on your development machine. For more information, see [How to install the Azure CLI](/cli/azure/install-azure-cli). This scenario requires Azure CLI version 2.42.0 or higher. Use `az --version` to check your version and `az upgrade` to update if necessary.
2323

24-
* The Azure IoT Operations extension for Azure CLI.
24+
* The Azure IoT Operations extension for Azure CLI. Use the following command to add the extension or update it to the latest version:
2525

26-
* If you haven't installed the extension before, use `az extension add`:
27-
28-
```bash
29-
az extension add --name azure-iot-ops
30-
```
31-
32-
* If you have installed the extension before, use `az extension update` to make sure that you have the latest version:
33-
34-
```bash
35-
az extension update --name azure-iot-ops
36-
```
26+
```bash
27+
az extension add --upgrade --name azure-iot-ops
28+
```
3729

3830
* An Azure Arc-enabled Kubernetes cluster. If you don't have one, follow the steps in [Prepare your Azure Arc-enabled Kubernetes cluster](./howto-prepare-cluster.md?tabs=wsl-ubuntu). Using Ubuntu in Windows Subsystem for Linux (WSL) is the simplest way to get a Kubernetes cluster for testing.
3931

4032
Azure IoT Operations should work on any CNCF-conformant kubernetes cluster. Currently, Microsoft only supports K3s on Ubuntu Linux and WSL, or AKS Edge Essentials on Windows.
4133

42-
Use the Azure IoT Operations extension for Azure CLI to verify that your cluster host is configured correctly for deployment by using the [verify-host](/cli/azure/iot/ops#az-iot-ops-verify-host) command:
34+
Use the Azure IoT Operations extension for Azure CLI to verify that your cluster host is configured correctly for deployment by using the [verify-host](/cli/azure/iot/ops#az-iot-ops-verify-host) command on the cluster host:
4335

4436
```azurecli
4537
az iot ops verify-host

articles/iot-operations/deploy-iot-ops/howto-prepare-cluster.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -176,7 +176,7 @@ pod/resource-sync-agent-769bb66b79-z9n46 2/2 Running 0
176176
pod/metrics-agent-6588f97dc-455j8 2/2 Running 0 10m
177177
```
178178

179-
To verify that your cluster is ready for Azure IoT Operations deployment, you can use the [verify-host](/cli/azure/iot/ops#az-iot-ops-verify-host) helper command in the Azure IoT Operations extension for Azure CLI. This helper command checks connectivity to Azure Resource Manager and Microsoft Container Registry endpoints. If the cluster has an Ubuntu OS, it checks if `nfs-common` is installed, and if not give you the option to install on your behalf.
179+
To verify that your cluster is ready for Azure IoT Operations deployment, you can use the [verify-host](/cli/azure/iot/ops#az-iot-ops-verify-host) helper command in the Azure IoT Operations extension for Azure CLI. When run on the cluster host, this helper command checks connectivity to Azure Resource Manager and Microsoft Container Registry endpoints. If the cluster has an Ubuntu OS, it checks if `nfs-common` is installed, and if not give you the option to install on your behalf.
180180

181181
```azurecli
182182
az iot ops verify-host

articles/iot-operations/get-started/quickstart-deploy.md

Lines changed: 10 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ ms.author: kgremban
66
# ms.subservice: orchestrator
77
ms.topic: quickstart
88
ms.custom: ignite-2023, devx-track-azurecli
9-
ms.date: 12/06/2023
9+
ms.date: 01/31/2024
1010

1111
#CustomerIntent: As a < type of user >, I want < what? > so that < why? >.
1212
---
@@ -52,19 +52,11 @@ For this quickstart, we recommend GitHub Codespaces as a quick way to get starte
5252

5353
This quickstart requires Azure CLI version 2.42.0 or higher. Use `az --version` to check your version and `az upgrade` to update if necessary.
5454

55-
* The Azure IoT Operations extension for Azure CLI.
55+
* The Azure IoT Operations extension for Azure CLI. Use the following command to add the extension or update it to the latest version:
5656

57-
* If you haven't installed the extension before, use `az extension add`:
58-
59-
```bash
60-
az extension add --name azure-iot-ops
61-
```
62-
63-
* If you have installed the extension before, use `az extension update` to make sure that you have the latest version:
64-
65-
```bash
66-
az extension update --name azure-iot-ops
67-
```
57+
```bash
58+
az extension add --upgrade --name azure-iot-ops
59+
```
6860

6961
# [Linux](#tab/linux)
7062

@@ -74,19 +66,11 @@ For this quickstart, we recommend GitHub Codespaces as a quick way to get starte
7466

7567
This quickstart requires Azure CLI version 2.42.0 or higher. Use `az --version` to check your version and `az upgrade` to update if necessary.
7668

77-
* The Azure IoT Operations extension for Azure CLI.
78-
79-
* If you haven't installed the extension before, use `az extension add`:
80-
81-
```bash
82-
az extension add --name azure-iot-ops
83-
```
84-
85-
* If you have installed the extension before, use `az extension update` to make sure that you have the latest version:
69+
* The Azure IoT Operations extension for Azure CLI. Use the following command to add the extension or update it to the latest version:
8670

87-
```bash
88-
az extension update --name azure-iot-ops
89-
```
71+
```bash
72+
az extension add --upgrade --name azure-iot-ops
73+
```
9074

9175
---
9276

@@ -218,7 +202,7 @@ On Ubuntu Linux, use K3s to create a Kubernetes cluster.
218202

219203
## Verify cluster
220204

221-
Use the Azure IoT Operations extension for Azure CLI to verify that your cluster host is configured correctly for deployment by using the [verify-host](/cli/azure/iot/ops#az-iot-ops-verify-host) command:
205+
Use the Azure IoT Operations extension for Azure CLI to verify that your cluster host is configured correctly for deployment by using the [verify-host](/cli/azure/iot/ops#az-iot-ops-verify-host) command on the cluster host:
222206

223207
```azurecli
224208
az iot ops verify-host

0 commit comments

Comments
 (0)