Skip to content

Commit 68beb16

Browse files
committed
adding placeholders to install-aio-arc.sh
1 parent c85eda3 commit 68beb16

File tree

1 file changed

+32
-26
lines changed

1 file changed

+32
-26
lines changed

articles/iot-operations/develop-edge-apps/quickstart-get-started-sdks.md

Lines changed: 32 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,8 @@ GitHub Codespaces provides the most streamlined experience and can get the devel
7171

7272
1. Install prerequisites including:
7373
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
7576
1. `Helm` for Kubernetes package management
7677
1. `Step CLI` for certificate management
7778
1. `Azure CLI` for managing Azure resources
@@ -182,6 +183,7 @@ GitHub Codespaces provides the most streamlined experience and can get the devel
182183
This script does the following:
183184

184185
1. Install prerequisites including:
186+
1. `Mosquitto` MQTT client for testing
185187
1. `k3d` to run lightweight Kubernetes clusters
186188
1. `Helm` for Kubernetes package management
187189
1. `Step CLI` for certificate management
@@ -207,27 +209,19 @@ Open a new bash terminal and do the following steps:
207209
cd <REPOSITORY ROOT>
208210
```
209211

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 command in 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 for your storage account. Storage account names must be between 3 and 24 characters in 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. |
228222

229223
```bash
230-
./tools/deployment/install-aio-arc.sh
224+
./tools/deployment/install-aio-arc.sh -l <LOCATION> -g <RESOURCE_GROUP> -c <CLUSTER_NAME> -s <STORAGE_ACCOUNT_NAME> -r <SCHEMA_REGISTRY_NAME> -n <SCHEMA_REGISTRY_NAMESPACE>
231225
```
232226

233227
This script does the following:
@@ -272,15 +266,21 @@ After Azure IoT Operations is deployed, you need to configure it for development
272266
1. Create the trust bundle ConfigMap for the Broker to authentication x509 clients
273267
1. Configure a `BrokerListener` and `BrokerAuthentication` resources for SAT and x509 auth
274268

275-
<!-- ## Shell configuration
269+
## Shell configuration
276270

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 for your environment, or use the default values provided in 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 for your environment, or use the default values provided in the file:
278272

279-
To load the environment variables into your shell, run the following command in 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:
280280

281-
```bash
282-
source <REPOSITORY ROOT>/.env
283-
``` -->
281+
```bash
282+
source .env
283+
```
284284

285285
<!-- 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 -->
286286
## Testing the installation
@@ -311,6 +311,12 @@ To test the setup is working correctly, use `mosquitto_pub` to connect to the MQ
311311
mosquitto_pub -L mqtts://localhost:8884/hello -m world --cafile $SESSION/broker-ca.crt -D CONNECT authentication-method K8S-SAT -D CONNECT authentication-data $(cat $SESSION/token.txt) --debug
312312
```
313313

314+
## Testing MQTT session client sample
315+
316+
This sample demonstrates connecting to MQTT broker using the MQTT session client, and sending and receiving telemetry.
317+
318+
- TODO
319+
314320
## Configuration summary
315321

316322
### MQTT broker configuration

0 commit comments

Comments
 (0)