You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/iot-operations/develop-edge-apps/quickstart-get-started-sdks.md
+32-26Lines changed: 32 additions & 26 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -71,7 +71,8 @@ GitHub Codespaces provides the most streamlined experience and can get the devel
71
71
72
72
1. Install prerequisites including:
73
73
1. `Docker`if not already installed
74
-
1. `k3d` to run lightweight Kubernetes clusters
74
+
1. `Mosquitto` MQTT client for testing
75
+
1. `k3d` to run lightweight Kubernetes clusters
75
76
1. `Helm`for Kubernetes package management
76
77
1. `Step CLI`for certificate management
77
78
1. `Azure CLI`for managing Azure resources
@@ -182,6 +183,7 @@ GitHub Codespaces provides the most streamlined experience and can get the devel
182
183
This script does the following:
183
184
184
185
1. Install prerequisites including:
186
+
1. `Mosquitto` MQTT client for testing
185
187
1. `k3d` to run lightweight Kubernetes clusters
186
188
1. `Helm`for Kubernetes package management
187
189
1. `Step CLI`for certificate management
@@ -207,27 +209,19 @@ Open a new bash terminal and do the following steps:
207
209
cd<REPOSITORY ROOT>
208
210
```
209
211
210
-
1. Edit the `.env` file to set the values for your environment:
211
-
212
-
> [!NOTE]
213
-
> The `.env` file contains the environment variables used by the `install-aio-arc.sh` script, and the samples to connect to the MQTT Broker. You can use the default values provided in the file or set your own values.
214
-
215
-
To edit the `.env` file, you can use any text editor of your choice. For example, using `nano`:
216
-
217
-
```bash
218
-
nano .env
219
-
```
220
-
221
-
1. Load the environment variables into your shell, run the following commandin your terminal:
222
-
223
-
```bash
224
-
source .env
225
-
```
226
-
227
-
1. Run the `install-aio-arc.sh` script to arc-enable your cluster and deploy Azure IoT Operations:
212
+
1. Run the `install-aio-arc.sh` script to arc-enable your cluster and deploy Azure IoT Operations, replacing the placeholders with your values:
213
+
214
+
| Parameter | Value |
215
+
| --------- | ----- |
216
+
| LOCATION | An Azure region close to you. For the list of currently supported regions, see [Supported regions](../overview-iot-operations.md#supported-regions). |
217
+
| RESOURCE_GROUP | A name for a new Azure resource group where your cluster will be created. |
218
+
| CLUSTER_NAME | A name for your Kubernetes cluster. |
219
+
| STORAGE_ACCOUNT_NAME | A name foryour storage account. Storage account names must be between 3 and 24 charactersin length and only contain numbers and lowercase letters. |
220
+
| SCHEMA_REGISTRY_NAME | A name for your schema registry. Schema registry names can only contain numbers, lowercase letters, and hyphens. |
221
+
| SCHEMA_REGISTRY_NAMESPACE | A name for your schema registry namespace. The namespace uniquely identifies a schema registry within a tenant. Schema registry namespace names can only contain numbers, lowercase letters, and hyphens. |
@@ -272,15 +266,21 @@ After Azure IoT Operations is deployed, you need to configure it for development
272
266
1. Create the trust bundle ConfigMap for the Broker to authentication x509 clients
273
267
1. Configure a `BrokerListener` and `BrokerAuthentication` resources for SAT and x509 auth
274
268
275
-
<!-- ## Shell configuration
269
+
## Shell configuration
276
270
277
-
The samples within [Azure IoT Operations SDKs github repository](https://github.com/Azure/iot-operations-sdks) read configuration from environment variables. We have provided an `.env` file in the repository root that exports the variables used by the samples to connect to the MQTT Broker. Edit the `.env` file to set the values foryour environment, or use the default values providedin the file.
271
+
The samples within [Azure IoT Operations SDKs github repository](https://github.com/Azure/iot-operations-sdks) read configuration from environment variables. We have provided an `.env` file in the repository root that exports the variables used by the samples to connect to the MQTT Broker. Edit the `.env` file to set the values foryour environment, or use the default values providedin the file:
278
272
279
-
To load the environment variables into your shell, run the following commandin your terminal:
273
+
1. Navigate to the repository root directory:
274
+
275
+
```bash
276
+
cd<REPOSITORY ROOT>
277
+
```
278
+
279
+
1. Load the environment variables into your shell:
280
280
281
-
```bash
282
-
source<REPOSITORY ROOT>/.env
283
-
``` -->
281
+
```bash
282
+
source.env
283
+
```
284
284
285
285
<!-- TODO: Check why this only works with VSCode Dev Containers when I do: kubectl port-forward -n azure-iot-operations service/aio-broker-external 8883:8883 -->
286
286
## Testing the installation
@@ -311,6 +311,12 @@ To test the setup is working correctly, use `mosquitto_pub` to connect to the MQ
0 commit comments