Skip to content

Commit fa4f547

Browse files
committed
Review aio get-started to improve new user experience
1 parent e400d4d commit fa4f547

File tree

3 files changed

+27
-13
lines changed

3 files changed

+27
-13
lines changed

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

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -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 Preview 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's generating sample data to use in the following quickstarts.
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.
1919

2020
The services deployed in this quickstart include:
2121

@@ -30,26 +30,36 @@ The services deployed in this quickstart include:
3030

3131
The following quickstarts in this series build on this one to define sample assets, data processing pipelines, and visualizations. If you want to deploy Azure IoT Operations to run your own workloads, see [Prepare your Azure Arc-enabled Kubernetes cluster](../deploy-iot-ops/howto-prepare-cluster.md) and [Deploy Azure IoT Operations Preview extensions to a Kubernetes cluster](../deploy-iot-ops/howto-deploy-iot-operations.md).
3232

33+
## Before you begin
34+
35+
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.
36+
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.
38+
39+
Once you're ready to learn more about the individual roles and tasks, the how-to guides provide more specific implementation and permissions details.
40+
3341
## Prerequisites
3442

3543
Review the prerequisites based on the environment you use to host the Kubernetes cluster.
3644

37-
For this quickstart, we recommend GitHub Codespaces as a quick way to get started in a virtual environment without installing new tools. Or, use Azure Kubernetes Service (AKS) Edge Essentials to create a cluster on Windows devices or K3s on Ubuntu Linux devices.
45+
For this quickstart, we recommend using a virtual environment as a quick way to get started without installing new tools.
3846

39-
As part of this quickstart, you create a cluster in either Codespaces, AKS Edge Essentials, or Linux. If you want to reuse a cluster that you've deployed Azure IoT Operations to before, refer to the steps in [Clean up resources](#clean-up-resources) to uninstall Azure IoT Operations before continuing.
47+
As part of this quickstart, you create a cluster in either GitHub Codespaces, AKS Edge Essentials, or K3s on Ubuntu Linux. If you want to reuse a cluster that you've deployed Azure IoT Operations to before, refer to the steps in [Clean up resources](#clean-up-resources) to uninstall Azure IoT Operations before continuing.
4048

4149
# [Virtual](#tab/codespaces)
4250

4351
* 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.
4452

4553
* A [GitHub](https://github.com) account.
4654

47-
# [Windows](#tab/windows)
55+
* Visual Studio Code installed on your development machine. For more information, see [Download Visual Studio Code](https://code.visualstudio.com/download).
4856

49-
* You'll use the `AksEdgeQuickStartForAio.ps1` script to set up an AKS Edge Essentials single-machine K3S Linux-only cluster. 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).
57+
# [Windows](#tab/windows)
5058

5159
* 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.
5260

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).
62+
5363
* Azure CLI installed on your development machine. For more information, see [How to install the Azure CLI](/cli/azure/install-azure-cli).
5464

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

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ ms.custom: include file, ignite-2023, devx-track-azurecli
1111

1212
To connect your cluster to Azure Arc:
1313

14-
1. On the machine where you deployed the Kubernetes cluster, sign in with Azure CLI:
14+
1. On the machine where you deployed the Kubernetes cluster or your codespace terminal, sign in with Azure CLI:
1515

1616
```azurecli
1717
az login
@@ -27,7 +27,7 @@ To connect your cluster to Azure Arc:
2727
```bash
2828
# Azure region where the created resource group will be located
2929
# Currently supported regions: "eastus", "eastus2", "westus", "westus2", "westus3", "westeurope", or "northeurope"
30-
export LOCATION="WestUS3"
30+
export LOCATION="<REGION>"
3131
```
3232

3333
```bash
@@ -64,13 +64,13 @@ To connect your cluster to Azure Arc:
6464
az group create --location $LOCATION --resource-group $RESOURCE_GROUP --subscription $SUBSCRIPTION_ID
6565
```
6666

67-
1. Use the [az connectedk8s connect](/cli/azure/connectedk8s#az-connectedk8s-connect) command to Arc-enable your Kubernetes cluster and manage it in the resource group you created in the previous step:
67+
1. Use the [az connectedk8s connect](/cli/azure/connectedk8s#az-connectedk8s-connect) command to Arc-enable your Kubernetes cluster and manage it as part of your Azure resource group:
6868

6969
```azurecli
7070
az connectedk8s connect -n $CLUSTER_NAME -l $LOCATION -g $RESOURCE_GROUP --subscription $SUBSCRIPTION_ID
7171
```
7272

73-
1. Get the `objectId` of the Microsoft Entra ID application that the Azure Arc service uses. Run this command in the [Azure Cloud Shell](https://portal.azure.com/#cloudshell) or on your local machine:
73+
1. Get the `objectId` of the Microsoft Entra ID application that the Azure Arc service uses. Run this command in the [Azure Cloud Shell](https://portal.azure.com/#cloudshell), on your local machine, or in a Cloudspaces terminal:
7474

7575
```azurecli
7676
az ad sp show --id bc313c14-388c-4e7d-a58e-70017303ee3b --query id -o tsv

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

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ ms.custom:
1010
- ignite-2023
1111
---
1212

13-
Use GitHub Codespaces to try Azure IoT Operations on a Kubernetes cluster without installing anything on your local machine. Use the **explore-iot-operations** codespace that is preconfigured with:
13+
Use GitHub Codespaces to try Azure IoT Operations on a Kubernetes cluster without installing anything on your local machine. The **Azure-Samples/explore-iot-operations** codespace is preconfigured with:
1414

1515
- [K3s](https://k3s.io/) running in [K3d](https://k3d.io/) for a lightweight Kubernetes cluster
1616
- [Azure CLI](/cli/azure/install-azure-cli)
@@ -22,20 +22,24 @@ Use GitHub Codespaces to try Azure IoT Operations on a Kubernetes cluster withou
2222
2323
To get started with your codespace:
2424

25-
1. Create the codespace in GitHub Codespaces.
25+
1. Create a codespace in GitHub Codespaces.
2626

27-
[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/Azure-Samples/explore-iot-operations?quickstart=1)
27+
[![Create an explore-iot-operations codespace](https://github.com/codespaces/badge.svg)](https://codespaces.new/Azure-Samples/explore-iot-operations?quickstart=1)
2828

2929
1. Provide the following details to configure your codespace:
3030

3131
| Parameter | Value |
3232
| --------- | ----- |
3333
| SUBSCRIPTION_ID | Your Azure subscription ID. |
3434
| RESOURCE_GROUP | A name for a new Azure resource group where your cluster will be created. Remember the resource group name to use in the following CLI commands. |
35-
| LOCATION | An Azure region close to you. The following regions are supported in public preview: eastus, eastus2, westus, westus2, westus3, westeurope, or northeurope. Remember the region you choose to use in the following CLI commands. |
35+
| LOCATION | An Azure region close to you. The following regions are supported in public preview: eastus, eastus2, westus, westus2, westus3, westeurope, or northeurope. Remember the region to use in the following CLI commands. |
3636

3737
1. Select **Create new codespace**.
3838

3939
1. Once the codespace is ready, select the menu button at the top left, then select **Open in VS Code Desktop**.
4040

4141
![Open VS Code desktop](media/prepare-codespaces/open-in-vs-code-desktop.png)
42+
43+
1. In Visual Studio Code, select **View** > **Terminal**.
44+
45+
Use this terminal to run all of the command line and CLI commands for managing your cluster.

0 commit comments

Comments
 (0)