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/overview-iot-operations-sdks.md
+1-3Lines changed: 1 addition & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -68,8 +68,6 @@ The SDKs provide a number of components available for simplicity and ease of use
68
68
69
69
Read further about the underlying terminology and different components of the SDKs:
70
70
71
-
<!-- TODO: Move all .md files under /doc, /doc/edge_application, /doc/akri_connector, /samples/event_driven_app folders to learn? -->
72
-
73
71
*[Terminology](https://github.com/Azure/iot-operations-sdks/blob/main/doc/terminology.md) - Understand the different terms used to describe the concepts and construction of the SDKs.
74
72
*[Components](https://github.com/Azure/iot-operations-sdks/blob/main/doc/components.md) - An outline of each component and their function.
75
73
@@ -89,7 +87,7 @@ The SDKs supports the following application types:
89
87
90
88
Review the [samples](https://github.com/Azure/iot-operations-sdks/tree/main/samples) directory for samples about creating applications for Azure IoT Operation on the supported languages.
91
89
92
-
To deploy a fully functional application to a cluster and see the SDKs in action, follow the [Tutorial: Develop an edge app with Azure IoT Operations SDKs for efficient data handling](tutorial-develop-edge-app.md).
90
+
To deploy a fully functional application to a cluster and see the SDKs in action, follow the [Tutorial: Build an event-driven app](https://github.com/Azure/iot-operations-sdks/blob/main/samples/event_driven_app/README.md).
Copy file name to clipboardExpand all lines: articles/iot-operations/develop-edge-apps/quickstart-get-started-sdks.md
-93Lines changed: 0 additions & 93 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -23,12 +23,10 @@ Before you begin, prepare the following prerequisites:
23
23
24
24
* Azure access permissions. For more information, see [Deployment details > Required permissions](../deploy-iot-ops/overview-deploy.md#required-permissions).
25
25
26
-
<!-- TODO: Confirm it works for options VS Code Dev Containers and WSL -->
27
26
## Setting up
28
27
29
28
Developing with the Azure IoT Operations SDKs requires a Kubernetes cluster with Azure IoT Operations deployed. Additional configuration will allow the MQTT broker to be accessed directly from the developer environment.
30
29
31
-
<!-- TODO: Point to the new article Production Cluster when published -->
32
30
> [!IMPORTANT]
33
31
> The following development environment setup options, use [K3s](https://k3s.io/) running in [K3d](https://k3d.io/) for a lightweight Kubernetes cluster, and deploys Azure IoT Operations with [test settings](../deploy-iot-ops/overview-deploy.md#test-settings-deployment). For production deployments, choose [secure settings](../deploy-iot-ops/overview-deploy.md#secure-settings-deployment). <br> If you want to use secure settings, we recommend you follow the instructions in [Prepare your Azure Arc-enabled Kubernetes cluster](../deploy-iot-ops/howto-prepare-cluster.md) to create a K3s cluster on Ubuntu and [Deploy Azure IoT Operations to a production cluster](../deploy-iot-ops/howto-deploy-iot-operations.md) to deploy with secure settings. Then proceed to [configure Azure IoT Operations for deployment](#configure-azure-iot-operations-for-deployment).
34
32
@@ -109,93 +107,6 @@ GitHub Codespaces provides the most streamlined experience and can get the devel
109
107
sudo sysctl -p
110
108
```
111
109
112
-
113
-
### [Visual Studio Code Dev Containers](#tab/vscode-dev-containers)
114
-
115
-
> [!WARNING]
116
-
> The latest WSL release **doesn't support Azure IoT Operations**. You will need to install [WSL v2.3.14](https://github.com/microsoft/WSL/releases/tag/2.3.14) as outlined in the steps below.
1. Install [Docker Desktop for Windows](https://docs.docker.com/desktop/features/wsl/) with WSL 2 backend, and confirm it's running the **v6.6 kernel**:
121
-
122
-
```bash
123
-
wsl -d docker-desktop -e uname -a
124
-
```
125
-
126
-
output:
127
-
128
-
```output
129
-
Linux docker-desktop 6.6.36.3-microsoft-standard-WSL2 ...
130
-
```
131
-
132
-
1. Install [VS Code](https://code.visualstudio.com/) and the [Dev Containers extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers)
133
-
134
-
1. Launch VS Code, and clone the repository in a container:
135
-
136
-
`F1 > Dev Containers: Clone Repository in Container Volume...`
137
-
138
-
1. When prompted, enter the *Azure IoT Operations SDKs* URL and selectthe`main` branch:
139
-
140
-
```bash
141
-
https://github.com/azure/iot-operations-sdks
142
-
```
143
-
144
-
> [!TIP]
145
-
> To reconnect to the container in VSCode, choose `F1 > Dev Containers: Attach to Running Container...` and thenselectthe container name created previously.
146
-
147
-
### [Windows Subsystem for Linux (WSL)](#tab/wsl)
148
-
149
-
> [!WARNING]
150
-
> The latest WSL release **doesn't support Azure IoT Operations**. You will need to install [WSL v2.3.14](https://github.com/microsoft/WSL/releases/tag/2.3.14) as outlined in the steps below.
1. Install [Docker Desktop for Windows](https://docs.docker.com/desktop/features/wsl/) with WSL 2 backend, and confirm it's running the **v6.6 kernel**:
155
-
156
-
```bash
157
-
wsl -d docker-desktop -e uname -a
158
-
```
159
-
160
-
output:
161
-
162
-
```output
163
-
Linux docker-desktop 6.6.36.3-microsoft-standard-WSL2 ...
164
-
```
165
-
166
-
1. Clone the *Azure IoT Operations SDKs* repository:
1. Initialize the cluster and install required dependencies using the `initialize-cluster.sh` script:
179
-
180
-
```bash
181
-
sudo ./tools/deployment/initialize-cluster.sh
182
-
```
183
-
184
-
This script does the following:
185
-
186
-
1. Install prerequisites including:
187
-
1. `Mosquitto` MQTT client for testing
188
-
1. `k3d` to run lightweight Kubernetes clusters
189
-
1. `Helm`for Kubernetes package management
190
-
1. `Step CLI`for certificate management
191
-
1. `Azure CLI`for managing Azure resources
192
-
1. `kubectl` (Kubernetes CLI) for interacting with Kubernetes clusters
193
-
1. `k9s`for managing Kubernetes clusters
194
-
1. **DELETE** any existing k3d cluster
195
-
1. Deploy a new k3d cluster
196
-
1. Set up port forwarding for ports `1883`, `8883`, and `8884` to enable TLS
197
-
1. Create a local container registry
198
-
199
110
---
200
111
201
112
## Deploy Azure IoT Operations
@@ -243,7 +154,6 @@ Open a new bash terminal and do the following steps:
243
154
az iot ops check
244
155
```
245
156
246
-
<!-- TODO: Confirm that this works well on a K3s cluster running AIO with Secure Settings -->
247
157
## Configure Azure IoT Operations for development
248
158
249
159
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 setfor your development environment:
@@ -267,7 +177,6 @@ After Azure IoT Operations is deployed, you need to configure it for development
267
177
1. Create the trust bundle ConfigMap for the Broker to authentication x509 clients
268
178
1. Configure a `BrokerListener` and `BrokerAuthentication` resources for SAT and x509 auth
269
179
270
-
<!-- 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 -->
271
180
## Testing the installation
272
181
273
182
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.
@@ -296,7 +205,6 @@ To test the setup is working correctly, use `mosquitto_pub` to connect to the MQ
This sample demonstrates a simple communication between a client and a server using [telemetry](https://github.com/Azure/iot-operations-sdks/blob/main/doc/reference/telemetry.md) and [remote procedure call (RPC)](https://github.com/Azure/iot-operations-sdks/blob/main/doc/reference/rpc-protocol.md). The server tracks the value of a counter and accepts RPC requests from the client to either read or increment that counter.
@@ -413,7 +321,6 @@ As part of the deployment script, the following files are created in the local e
413
321
414
322
Check the troubleshooting guide forcommon issuesin the Azure IoT Operations SDKs github repository: [Troubleshooting](https://github.com/Azure/iot-operations-sdks/blob/main/doc/troubleshooting.md).
415
323
416
-
<!-- TODO: Next step should be the tutorial "Develop an edge app" -->
417
324
## Next steps
418
325
In this Quickstart, you set up the Azure IoT Operations SDKs and ran a sample application. To learn more about developing with the SDKs, check out the following resources:
0 commit comments