Skip to content

Commit db3fbc0

Browse files
committed
review continued
1 parent fa4f547 commit db3fbc0

File tree

4 files changed

+26
-28
lines changed

4 files changed

+26
-28
lines changed
69 KB
Loading

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

Lines changed: 17 additions & 25 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: 01/31/2024
9+
ms.date: 03/15/2024
1010

1111
#CustomerIntent: As a < type of user >, I want < what? > so that < why? >.
1212
---
@@ -15,7 +15,7 @@ ms.date: 01/31/2024
1515

1616
[!INCLUDE [public-preview-note](../includes/public-preview-note.md)]
1717

18-
In this quickstart, you will deploy a suite of IoT services to an Azure Arc-enabled Kubernetes cluster so that you can remotely manage your devices and workloads. Azure IoT Operations is a digital operations suite of services that includes Azure IoT Orchestrator Preview. This quickstart guides you through using Orchestrator to deploy these services to a Kubernetes cluster. At the end of the quickstart, you have a cluster that you can manage from the cloud that generates sample data to use in the following quickstarts.
18+
In this quickstart, you deploy a suite of IoT services to an Azure Arc-enabled Kubernetes cluster so that you can remotely manage your devices and workloads. Azure IoT Operations is a digital operations suite of services that includes Azure IoT Orchestrator Preview. This quickstart guides you through using Orchestrator to deploy these services to a Kubernetes cluster. At the end of the quickstart, you have a cluster that you can manage from the cloud that generates sample data to use in the following quickstarts.
1919

2020
The services deployed in this quickstart include:
2121

@@ -34,7 +34,7 @@ The following quickstarts in this series build on this one to define sample asse
3434

3535
This series of quickstarts is intended to give you an opportunity to evaluate an end-to-end scenario with Azure IoT Operations. In a true development or production environment, these tasks would be performed by multiple teams working together and some tasks require elevated permissions.
3636

37-
For the best new user experience, we recommend using a free Azure subscription so that you have owner permissions over the resources in these quickstarts. We also recommend using GitHub Codespaces as a virtual environment in which you can quickly begin deploying resources and running commands without installing new tools on your own machines.
37+
For the best new user experience, we recommend using a free Azure subscription so that you have owner permissions over the resources in these quickstarts. We also recommend using GitHub Codespaces as a virtual environment in which you can quickly begin deploying resources and running commands without installing new tools on your own machines. For more information about these options, continue to the prerequisites.
3838

3939
Once you're ready to learn more about the individual roles and tasks, the how-to guides provide more specific implementation and permissions details.
4040

@@ -58,7 +58,7 @@ As part of this quickstart, you create a cluster in either GitHub Codespaces, AK
5858

5959
* An Azure subscription. If you don't have an Azure subscription, [create one for free](https://azure.microsoft.com/free/?WT.mc_id=A261C142F) before you begin.
6060

61-
* Ensure that your machine has a minimum of 10 GB RAM, 4 vCPUs, and 40 GB free disk space. To learn more, see the [AKS Edge Essentials system requirements](/azure/aks/hybrid/aks-edge-system-requirements).
61+
* Ensure that your machine has a minimum of 10-GB RAM, 4 vCPUs, and 40-GB free disk space. To learn more, see the [AKS Edge Essentials system requirements](/azure/aks/hybrid/aks-edge-system-requirements).
6262

6363
* Azure CLI installed on your development machine. For more information, see [How to install the Azure CLI](/cli/azure/install-azure-cli).
6464

@@ -222,7 +222,7 @@ This helper command checks connectivity to Azure Resource Manager and Microsoft
222222

223223
Part of the deployment process is to configure your cluster so that it can communicate securely with your Azure IoT Operations components and key vault. The Azure CLI command `az iot ops init` does this for you. Once your cluster is configured, then you can deploy Azure IoT Operations.
224224

225-
Use the Azure CLI to create a key vault, build the `az iot ops init` command based on your resources, and then deploy Azure IoT Operations components to your Arc-enabled Kubernetes cluster.
225+
In this section, you use the Azure CLI to create a key vault, build the `az iot ops init` command based on your resources, and then deploy Azure IoT Operations components to your Arc-enabled Kubernetes cluster.
226226

227227
### Create a key vault
228228

@@ -231,20 +231,22 @@ You can use an existing key vault for your secrets, but verify that the **Permis
231231
To create a new key vault, use the following command:
232232

233233
```azurecli
234-
az keyvault create --enable-rbac-authorization false --name "<your unique key vault name>" --resource-group "<the name of the resource group that contains your Kubernetes cluster>"
234+
az keyvault create --enable-rbac-authorization false --name "<KEYVAULT_NAME>" --resource-group "<RESOURCE_GROUP_NAME>"
235235
```
236236

237-
### Deploy Azure IoT Operations Preview
237+
### Deploy Azure IoT Operations
238238

239-
1. In the Azure portal search bar, search for and select **Azure Arc**.
239+
In this section, you use the Azure CLI to deploy Azure IoT Operations, but the Azure portal has a helper wizard to build the correct CLI command based on your cluster, cloud resources, and configuration choices.
240+
241+
1. In a web browser, open the [Azure portal](https://portal.azure.com). In the Azure portal search bar, search for and select **Azure Arc**.
240242

241243
1. Select **Azure IoT Operations (preview)** from the **Application Services** section of the Azure Arc menu.
242244

243245
:::image type="content" source="./media/quickstart-deploy/arc-iot-operations.png" alt-text="Screenshot of selecting Azure IoT Operations from Azure Arc.":::
244246

245247
1. Select **Create**.
246248

247-
1. On the **Basic** tab of the **Install Azure IoT Operations Arc Extension** page, provide the following information:
249+
1. On the **Basics** tab of the **Install Azure IoT Operations Arc Extension** page, provide the following information:
248250

249251
| Field | Value |
250252
| ----- | ----- |
@@ -260,7 +262,7 @@ az keyvault create --enable-rbac-authorization false --name "<your unique key va
260262

261263
| Field | Value |
262264
| ----- | ----- |
263-
| **Deploy a simulated PLC** | Switch this toggle to **Yes**. The simulated PLC creates demo telemetry data that you use in the following quickstarts. |
265+
| **Deploy a simulated PLC** | Switch this toggle to **Yes**. The simulated PLC creates demo data that you use in the following quickstarts. |
264266
| **Mode** | Set the MQ configuration mode to **Auto**. |
265267

266268
:::image type="content" source="./media/quickstart-deploy/install-extension-configuration.png" alt-text="Screenshot of the configuration tab for installing the Azure IoT Operations Arc extension in the Azure portal.":::
@@ -274,26 +276,14 @@ az keyvault create --enable-rbac-authorization false --name "<your unique key va
274276
| **Subscription** | Select the subscription that contains your Arc-enabled Kubernetes cluster. |
275277
| **Azure Key Vault** | Use the **Select a key vault** drop-down menu to choose the key vault that you set up in the previous section. |
276278

277-
1. Once you select a key vault, the **Automation** tab uses all the information you've selected so far to populate an Azure CLI command that configures your cluster and deploys Azure IoT Operations. Copy the CLI command.
279+
1. Once you select a key vault, the **Automation** tab uses all the information you selected in the previous tabs to populate an Azure CLI command that configures your cluster and deploys Azure IoT Operations. Copy the CLI command.
278280

279281
:::image type="content" source="./media/quickstart-deploy/install-extension-automation.png" alt-text="Screenshot of copying the CLI command from the automation tab for installing the Azure IoT Operations Arc extension in the Azure portal.":::
280282

281-
1. Sign in to Azure CLI on your development machine or in your codespace terminal. To prevent potential permission issues later, sign in interactively with a browser here even if you've already logged in before.
282-
283-
```azurecli
284-
az login
285-
```
286-
287-
> [!NOTE]
288-
> When using a GitHub codespace in a browser, `az login` returns a localhost error in the browser window after logging in. To fix, either:
289-
>
290-
> * Open the codespace in VS Code desktop, and then run `az login` again in the browser terminal.
291-
> * After you get the localhost error on the browser, copy the URL from the browser and run `curl "<URL>"` in a new terminal tab. You should see a JSON response with the message "You have logged into Microsoft Azure!."
292-
293283
1. Run the copied `az iot ops init` command on your development machine or in your codespace terminal.
294284

295285
>[!TIP]
296-
>If you get an error that says *Your device is required to be managed to access your resource*, go back to the previous step and make sure that you signed in interactively.
286+
>If you get an error that says *Your device is required to be managed to access your resource*, run `az login` again and make sure that you sign in interactively with a browser.
297287
298288
## View resources in your cluster
299289

@@ -313,7 +303,9 @@ To view your cluster on the Azure portal, use the following steps:
313303

314304
1. From the **Overview** of the resource group, select the name of your cluster.
315305

316-
1. On your cluster, select **Extensions** from the menu.
306+
1. On your cluster, select **Extensions** from the **Settings** section of the menu.
307+
308+
:::image type="content" source="./media/quickstart-deploy/view-extensions.png" alt-text="Screenshot that shows the deployed extensions on your Arc-enabled cluster.":::
317309

318310
You can see that your cluster is running extensions of the type **microsoft.iotoperations.x**, which is the group name for all of the Azure IoT Operations components and the orchestration service.
319311

articles/iot-operations/includes/connect-cluster.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
description: include file
44
author: kgremban
55
ms.topic: include
6-
ms.date: 11/03/2023
6+
ms.date: 03/15/2024
77
ms.author: kgremban
88
ms.custom: include file, ignite-2023, devx-track-azurecli
99
---
@@ -17,6 +17,12 @@ To connect your cluster to Azure Arc:
1717
az login
1818
```
1919

20+
> [!TIP]
21+
> If you're using a GitHub codespace in a browser, `az login` returns a localhost error in the browser window after logging in. To fix, either:
22+
>
23+
> * Open the codespace in VS Code desktop, and then return to the browser terminal and rerun `az login`.
24+
> * Or, after you get the localhost error on the browser, copy the URL from the browser and run `curl "<URL>"` in a new terminal tab. You should see a JSON response with the message "You have logged into Microsoft Azure!."
25+
2026
1. Set environment variables for the rest of the setup. Replace values in `<>` with valid values or names of your choice. A new cluster and resource group are created in your Azure subscription based on the names you provide:
2127

2228
```bash
@@ -76,7 +82,7 @@ To connect your cluster to Azure Arc:
7682
az ad sp show --id bc313c14-388c-4e7d-a58e-70017303ee3b --query id -o tsv
7783
```
7884

79-
Make a note of the `objectId` that's returned. You use it in the next step.
85+
Make a note of the `objectId`. You use it in the next step.
8086

8187
1. Use the [az connectedk8s enable-features](/cli/azure/connectedk8s#az-connectedk8s-enable-features) command to enable custom location support on your cluster. This command uses the `objectId` of the Microsoft Entra ID application that the Azure Arc service uses. Run this command on the machine where you deployed the Kubernetes cluster:
8288

articles/iot-operations/includes/prepare-codespaces.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
description: include file
44
author: kgremban
55
ms.topic: include
6-
ms.date: 11/03/2023
6+
ms.date: 03/15/2024
77
ms.author: kgremban
88
ms.custom:
99
- include file

0 commit comments

Comments
 (0)