Skip to content

Commit 81ebb31

Browse files
committed
adding steps to quickstart
1 parent 25e0bf6 commit 81ebb31

File tree

2 files changed

+6
-16
lines changed

2 files changed

+6
-16
lines changed

articles/iot-operations/develop-edge-apps/overview-iot-operations-sdks.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ The SDKs provide a number of components available for simplicity and ease of use
6464

6565
* A set of clients providing integration with Azure IoT Operations services such as **state store**, **leader election**, **lease lock**, and **schema registry**.
6666

67-
* The **Protocol Compiler (codegen)** allows clients and servers to communicate via a schema contract. First describe the communication (using **Telemetry** and **Commands**) with DTDL, then generate a set of client libraries and server library stubs across the supported programming languages.
67+
* A **Protocol Compiler (codegen)**, that allows clients and servers to communicate via a schema contract. First describe the communication (using **Telemetry** and **Commands**) with DTDL, then generate a set of client libraries and server library stubs across the supported programming languages.
6868

6969
Read further about the underlying terminology and different components of the SDKs:
7070

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

Lines changed: 5 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ Developing with the Azure IoT Operations SDKs requires a Kubernetes cluster with
5454
git clone https://github.com/Azure/iot-operations-sdks
5555
```
5656

57-
1. Change to the repository root directory:
57+
1. Navigate to the repository root directory:
5858

5959
```bash
6060
cd <REPOSITORY ROOT>
@@ -138,7 +138,7 @@ Developing with the Azure IoT Operations SDKs requires a Kubernetes cluster with
138138
git clone https://github.com/Azure/iot-operations-sdks
139139
```
140140

141-
1. Change to the repository root directory:
141+
1. Navigate to the repository root directory:
142142

143143
```bash
144144
cd <REPOSITORY ROOT>
@@ -196,24 +196,13 @@ Open a new bash terminal in the VS Code Dev Container and do the following steps
196196

197197
After Azure IoT Operations is deployed, you need to configure it for development. This includes setting up the MQTT broker and authentication methods, as well as ensuring that the necessary environment variables are set for your development environment:
198198

199-
1. Check that Azure IoT Operations is successfully installed and **resolve any errors before continuing**:
199+
1. After the deployment is complete, use [az iot ops check](/cli/azure/iot/ops#az-iot-ops-check) to evaluate Azure IoT Operations service deployment for health, configuration, and usability. The *check* command can help you find problems in your deployment and configuration.
200200

201201
```azurecli
202202
az iot ops check
203203
```
204204

205-
Expected output:
206-
207-
```output
208-
╭─────── Check Summary ───────╮
209-
│ 13 check(s) succeeded. │
210-
│ 0 check(s) raised warnings. │
211-
│ 0 check(s) raised errors. │
212-
│ 4 check(s) were skipped. │
213-
╰─────────────────────────────╯
214-
```
215-
216-
1. Change to the repository root directory:
205+
1. Navigate to the repository root directory:
217206

218207
```bash
219208
cd <REPOSITORY ROOT>
@@ -242,6 +231,7 @@ To load the environment variables into your shell, run the following command in
242231
source <REPOSITORY ROOT>/.env
243232
```
244233

234+
<!-- 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 -->
245235
## Testing the installation
246236

247237
To test the setup is working correctly, use `mosquitto_pub` to connect to the MQTT broker to validate the x509 certs, SAT and trust bundle.

0 commit comments

Comments
 (0)