Skip to content

Commit 1609b9d

Browse files
committed
Simplify codespaces steps
1 parent 13a113c commit 1609b9d

File tree

3 files changed

+14
-14
lines changed

3 files changed

+14
-14
lines changed

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -137,9 +137,9 @@ This script automates the following steps:
137137

138138
* Create the Azure resource group in your Azure subscription to store all the resources.
139139

140-
* Connect the cluster to Azure Arc and registers the required Azure resource providers.
140+
* Connect the cluster to Azure Arc and register the required Azure resource providers.
141141

142-
* Apply all the required configurations for Azure IoT Operations, including:
142+
* Apply all of the required configurations for Azure IoT Operations, including:
143143

144144
* Enable a firewall rule and port forwarding for port 8883 to enable incoming connections to Azure IoT Operations broker.
145145

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

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -23,29 +23,23 @@ To connect your cluster to Azure Arc:
2323
> * Open the codespace in VS Code desktop, and then return to the browser terminal and rerun `az login`.
2424
> * 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!."
2525
26-
1. Set an environment variable for the cluster name as it will show up in your resource group.
26+
1. Set environment variables for your Azure subscription, location, a new resource group, and the cluster name as it will show up in your resource group.
2727

28-
```bash
29-
# Name of the Arc-enabled cluster to create in your resource group
30-
export CLUSTER_NAME=<NEW_CLUSTER_NAME>
31-
```
32-
33-
1. Set environment variables for your Azure subscription, location, and a new resource group. If you're using GitHub Codespaces and set these secrets when creating your codespace, you can skip this step.
28+
If you're using GitHub Codespaces and set up these values as recommended secrets when creating your codespace, skip this step. The codespace automatically sets the cluster name to be the same as the codespace name.
3429

3530
```bash
3631
# Id of the subscription where your resource group and Arc-enabled cluster will be created
3732
export SUBSCRIPTION_ID=<SUBSCRIPTION_ID>
38-
```
3933

40-
```bash
4134
# Azure region where the created resource group will be located
4235
# Currently supported regions: "eastus", "eastus2", "westus", "westus2", "westus3", "westeurope", or "northeurope"
4336
export LOCATION=<REGION>
44-
```
4537

46-
```bash
4738
# Name of a new resource group to create which will hold the Arc-enabled cluster and Azure IoT Operations resources
4839
export RESOURCE_GROUP=<NEW_RESOURCE_GROUP_NAME>
40+
41+
# Name of the Arc-enabled cluster to create in your resource group
42+
export CLUSTER_NAME=<NEW_CLUSTER_NAME>
4943
```
5044

5145
1. Set the Azure subscription context for all commands:
@@ -56,6 +50,9 @@ To connect your cluster to Azure Arc:
5650

5751
1. Register the required resource providers in your subscription:
5852

53+
>[!NOTE]
54+
>This step only needs to be run once per subscription.
55+
5956
```azurecli
6057
az provider register -n "Microsoft.ExtendedLocation"
6158
az provider register -n "Microsoft.Kubernetes"

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

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,14 +26,17 @@ To get started with your codespace:
2626

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

29-
You don't have to provide the recommended secrets at this step. If you do, they get saved on your GitHub account to be used in this and future codespaces. They're also added as environment variables in the codespace terminal, and you don't have to run the CLI commands in the next section that configure the subscription, resource group, or location variables.
29+
1. Provide the following recommended secrets for 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. |
3535
| LOCATION | An Azure region close to you. The following regions are supported in public preview: eastus, eastus2, westus, westus2, westus3, westeurope, or northeurope. |
3636

37+
>[!TIP]
38+
> The values you provide as secrets in this step get saved on your GitHub account to be used in this and future codespaces. They're also automatically added as environment variables in the codespace terminal, and you can use those environment variables in the CLI commands in the next section.
39+
3740
1. Select **Create new codespace**.
3841

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

0 commit comments

Comments
 (0)