Skip to content

Commit 27198f0

Browse files
Merge pull request #303425 from SoniaLopezBravo/aio250-screenhots-3otel
Update observability and screenshots in certificates
2 parents 1a89451 + e50ab77 commit 27198f0

File tree

10 files changed

+54
-48
lines changed

10 files changed

+54
-48
lines changed

articles/iot-operations/configure-observability-monitoring/howto-configure-observability.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -245,9 +245,9 @@ Complete the following steps to install the Azure IoT Operations curated Grafana
245245
az grafana show --name <GRAFANA_NAME> --resource-group <RESOURCE_GROUP> --query url -o tsv
246246
```
247247

248-
1. In the Grafana application, select the **+** icon.
248+
1. On the Grafana landing page, select the **Create your first dashboard** tile.
249249

250-
1. Select **Import dashboard**.
250+
1. Select **Import Dashboard**.
251251

252252
1. Browse to the sample dashboard directory in your local copy of the Azure IoT Operations repository, **azure-iot-operations** > **samples** > **grafana-dashboard**, then select the `aio.sample.json` dashboard file.
253253

articles/iot-operations/deploy-iot-ops/howto-deploy-iot-operations.md

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -54,8 +54,6 @@ A cluster host:
5454

5555
If you deployed Azure IoT Operations to your cluster previously, uninstall those resources before continuing. For more information, see [Update Azure IoT Operations](./howto-manage-update-uninstall.md#uninstall).
5656

57-
* (Optional) Prepare your cluster for observability before deploying Azure IoT Operations: [Configure observability](../configure-observability-monitoring/howto-configure-observability.md).
58-
5957
* (Recommended) Configure your own certificate authority issuer before deploying Azure IoT Operations: [Bring your own issuer](../secure-iot-ops/howto-manage-certificates.md#bring-your-own-issuer).
6058

6159
## Deploy in Azure portal
@@ -186,14 +184,6 @@ One at a time, run each Azure CLI command on the **Automation** tab in a termina
186184
--feature connectors.settings.preview=Enabled
187185
```
188186
189-
* If you followed the optional prerequisites to prepare your cluster for observability, add the following optional parameters to the `create` command:
190-
191-
| Optional parameter | Value | Description |
192-
| --------- | ----- | ----------- |
193-
| `--ops-config` | `observability.metrics.openTelemetryCollectorAddress=<FULLNAMEOVERRIDE>.azure-iot-operations.svc.cluster.local:<GRPC_ENDPOINT>` | Provide the OpenTelemetry (OTel) collector address you configured in the otel-collector-values.yaml file.<br><br>The sample values used in [Configure observability](../configure-observability-monitoring/howto-configure-observability.md) are **fullnameOverride=aio-otel-collector** and **grpc.endpoint=4317**. |
194-
| `--ops-config` | `observability.metrics.exportInternalSeconds=<CHECK_INTERVAL>` | Provide the **check_interval** value you configured in the otel-collector-values.yaml file.<br><br>The sample value used in [Configure observability](../configure-observability-monitoring/howto-configure-observability.md) is **check_interval=60**. |
195-
196-
197187
* If you followed the optional prerequisites to set up your own certificate authority issuer, add the `--trust-settings` parameters to the `create` command:
198188
199189
```bash

articles/iot-operations/deploy-iot-ops/howto-deploy-iot-test-operations.md

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,6 @@ A cluster host:
5454

5555
If you deployed Azure IoT Operations to your cluster previously, uninstall those resources before continuing. For more information, see [Update Azure IoT Operations](./howto-manage-update-uninstall.md#uninstall).
5656

57-
* (Optional) Prepare your cluster for observability before deploying Azure IoT Operations: [Configure observability](../configure-observability-monitoring/howto-configure-observability.md).
5857

5958
## Deploy in Azure portal
6059

@@ -168,14 +167,6 @@ One at a time, run each Azure CLI command on the **Automation** tab in a termina
168167
--feature connectors.settings.preview=Enabled
169168
```
170169
171-
* If you followed the optional prerequisites to prepare your cluster for observability, add the following parameters to the `create` command:
172-
173-
| Parameter | Value | Description |
174-
| --------- | ----- | ----------- |
175-
| `--ops-config` | `observability.metrics.openTelemetryCollectorAddress=<FULLNAMEOVERRIDE>.azure-iot-operations.svc.cluster.local:<GRPC_ENDPOINT>` | Provide the OpenTelemetry (OTel) collector address you configured in the otel-collector-values.yaml file.<br><br>The sample values used in [Configure observability](../configure-observability-monitoring/howto-configure-observability.md) are **fullnameOverride=aio-otel-collector** and **grpc.endpoint=4317**. |
176-
| `--ops-config` | `observability.metrics.exportInternalSeconds=<CHECK_INTERVAL>` | Provide the **check_interval** value you configured in the otel-collector-values.yaml file.<br><br>The sample value used in [Configure observability](../configure-observability-monitoring/howto-configure-observability.md) is **check_interval=60**. |
177-
178-
179170
1. Once all of the Azure CLI commands complete successfully, you can close the **Install Azure IoT Operations** wizard.
180171
181172
Once the `create` command completes successfully, you have a working Azure IoT Operations instance running on your cluster. At this point, your instance is configured for most testing and evaluation scenarios.

articles/iot-operations/deploy-iot-ops/howto-upgrade.md

Lines changed: 19 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ ms.date: 07/18/2025
1212

1313
# Upgrade to a new version
1414

15-
Learn how to upgrade an Azure IoT Operations deployment to a newer version. There's no support for upgrading from any preview version of Azure IoT Operations to any generally available (GA) version.
15+
Learn how to upgrade an Azure IoT Operations deployment to a newer version.
1616

1717
## Prerequisites
1818

@@ -114,17 +114,27 @@ You can only install a preview version using the Azure CLI.
114114

115115
If you want to upgrade to a specific version of Azure IoT Operations that isn't the latest, you can run `az iot ops get-versions` or refer to [IoT Operations versions](https://aka.ms/aio-versions) to find the CLI extension version associated with the Azure IoT Operations version that you want. Get the version number and run the following command to upgrade to that version:
116116

117-
```azurecli
118-
az extension add --upgrade --name azure-iot-ops --version <VERSION_NUMBER>
117+
```azurecli
118+
az extension add --upgrade --name azure-iot-ops --version <VERSION_NUMBER>
119119
```
120120

121+
## Upgrade observability configuration
122+
123+
To upgrade the observability configuration of your Azure IoT Operations instance, first you need to follow the steps in [Deploy observability resources](../configure-observability-monitoring/howto-configure-observability.md).
124+
125+
You can upgrade the observability configuration by running the `az iot ops upgrade` command with the `--ops-config` parameter to specify the new configuration values.
126+
127+
```azurecli
128+
az iot ops upgrade --resource-group <rg name> -n <instance name> --ops-config observability.metrics.openTelemetryCollectorAddress=<>
129+
```
130+
131+
| Parameter | Value | Description |
132+
| --------- | ----- | ----------- |
133+
| `--ops-config` | `observability.metrics.openTelemetryCollectorAddress=<FULLNAMEOVERRIDE>.azure-iot-operations.svc.cluster.local:<GRPC_ENDPOINT>` | Provide the OpenTelemetry (OTel) collector address you configured in the otel-collector-values.yaml file.<br><br>The sample values used in [Configure observability](../configure-observability-monitoring/howto-configure-observability.md) are **fullnameOverride=aio-otel-collector** and **grpc.endpoint=4317**. |
134+
| `--ops-config` | `observability.metrics.exportInternalSeconds=<CHECK_INTERVAL>` | Provide the **check_interval** value you configured in the otel-collector-values.yaml file.<br><br>The sample value used in [Configure observability](../configure-observability-monitoring/howto-configure-observability.md) is **check_interval=60**. |
135+
121136
> [!NOTE]
122-
> In preview releases, the `az iot ops upgrade` command doesn't work for upgrading to a preview version, but it works for configuring the Azure IoT Operations for observability. Add the following parameters to the `upgrade` command:
123-
>
124-
> | Parameter | Value | Description |
125-
> | --------- | ----- | ----------- |
126-
> | `--ops-config` | `observability.metrics.openTelemetryCollectorAddress=<FULLNAMEOVERRIDE>.azure-iot-operations.svc.cluster.local:<GRPC_ENDPOINT>` | Provide the OpenTelemetry (OTel) collector address you configured in the otel-collector-values.yaml file.<br><br>The sample values used in [Configure observability](../configure-observability-monitoring/howto-configure-observability.md) are **fullnameOverride=aio-otel-collector** and **grpc.endpoint=4317**. |
127-
> | `--ops-config` | `observability.metrics.exportInternalSeconds=<CHECK_INTERVAL>` | Provide the **check_interval** value you configured in the otel-collector-values.yaml file.<br><br>The sample value used in [Configure observability](../configure-observability-monitoring/howto-configure-observability.md) is **check_interval=60**. |
137+
> In preview releases, the `az iot ops upgrade` command doesn't work for upgrading to a preview version, but it works for configuring the Azure IoT Operations for observability.
128138
129139

130140
## MQTT broker upgrade considerations

articles/iot-operations/secure-iot-ops/howto-manage-certificates.md

Lines changed: 33 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: Azure IoT Operations uses TLS to encrypt communication. Learn how t
44
author: asergaz
55
ms.author: sergaz
66
ms.topic: how-to
7-
ms.date: 05/20/2025
7+
ms.date: 07/20/2025
88

99
#CustomerIntent: As an operator, I want to configure Azure IoT Operations components to use TLS so that I have secure communication between all components.
1010
---
@@ -149,33 +149,48 @@ To set up Azure IoT Operations with your own issuer for internal communications,
149149

150150
The certificate management experience for external communications uses Azure Key vault as the managed vault solution on the cloud. Certificates are added to the key vault as secrets and synchronized to the edge as Kubernetes secrets via [Azure Key Vault Secret Store extension](/azure/azure-arc/kubernetes/secret-store-extension).
151151

152-
For example, the connector for OPC UA uses the certificate management experience to configure OPC UA client application authentication to an external OPC UA server. Azure IoT Operations manages two distinct certificate stores for the connector for OPC UA: one for the *Trust list* and one for the *Issuer list*. To learn more about how the connector for OPC UA uses certificates to establish mutual trust with an OPC UA server, see [OPC UA certificates infrastructure for the connector for OPC UA](../discover-manage-assets/overview-opc-ua-connector-certificates-management.md).
152+
Connectors use the certificate management experience to configure client application authentication to external servers. Azure IoT Operations manages two distinct certificate stores for connectors: one for the *Trust list* and one for the *Issuer list*. To learn more about how connectors use certificates to establish mutual trust with external servers, see the connector-specific certificate management documentation.
153153

154+
When you [deploy Azure IoT Operations with secure settings](../deploy-iot-ops/overview-deploy.md#secure-settings-deployment), you can start adding certificates to Azure Key Vault, and sync them to the Kubernetes cluster to be used in the *Trust list* and *Issuer list* stores for external connections.
154155

155-
When you [deploy Azure IoT Operations with secure settings](../deploy-iot-ops/overview-deploy.md#secure-settings-deployment), you can start adding certificates to Azure Key Vault, and sync them to the Kubernetes cluster to be used in the *Trust list* and *Issuer list* stores for OPC UA connections:
156+
To manage certificates for external communications, follow these steps:
156157

157-
:::image type="content" source="media/howto-manage-certificates/add-new-certificate.png" lightbox="media/howto-manage-certificates/add-new-certificate.png" alt-text="Screenshot that shows the Upload certificate and Add from Azure Key Vault options when adding a new certificate to the devices page.":::
158+
1. Go to [Azure IoT Operations experience](https://iotoperations.azure.com), and choose your site and Azure IoT Operations instance.
159+
1. In the left navigation pane, select **Asset endpoints**.
160+
1. Click on **Manage certificates and secrets**.
158161

159-
- **Upload Certificate**: Uploads a certificate which is then added as a secret to Azure Key Vault and automatically synchronized to the cluster using Secret Store extension.
162+
:::image type="content" source="media/howto-manage-certificates/manage-certificates.png" lightbox="media/howto-manage-certificates/manage-certificates.png" alt-text="Screenshot that shows the Manage certificates and secrets option in the left navigation pane.":::
160163

161-
> [!TIP]
162-
> - View the certificate details once uploaded, to ensure you have the correct certificate before adding to Azure Key Vault and synchronizing to the cluster.
163-
> - Use an intuitive name so that you can recognize which secret represents your secret in the future.
164-
165-
> [!NOTE]
166-
> Simply uploading the certificate won't add the secret to Azure Key Vault and synchronize to the cluster, you must select **Apply** for the changes to be applied.
167-
164+
1. In the Certificates and Secrets page, click on **Add new certificate**.
165+
166+
:::image type="content" source="media/howto-manage-certificates/add-new-certificate.png" lightbox="media/howto-manage-certificates/add-new-certificate.png" alt-text="Screenshot that shows the Add new certificate button in the devices page.":::
168167

169-
- **Add from Azure Key Vault**: Add an existing secret from the Azure Key vault to be synchronized to the cluster.
168+
1. You can add a new certificate in two ways:
170169

171-
> [!NOTE]
172-
> Make sure to select the secret that holds the certificate you would like to synchronize to the cluster. Selecting a secret which isn't the correct certificate causes the connection to fail.
170+
- **Upload Certificate**: Uploads a certificate which is then added as a secret to Azure Key Vault and automatically synchronized to the cluster using Secret Store extension.
171+
172+
- View the certificate details once uploaded, to ensure you have the correct certificate before adding to Azure Key Vault and synchronizing to the cluster.
173+
- Use an intuitive name so that you can recognize which secret represents your secret in the future.
174+
175+
:::image type="content" source="media/howto-manage-certificates/upload-certificate.png" lightbox="media/howto-manage-certificates/upload-certificate.png" alt-text="Screenshot that shows the Upload certificate option when adding a new certificate to the devices page.":::
176+
177+
> [!NOTE]
178+
> Simply uploading the certificate won't add the secret to Azure Key Vault and synchronize to the cluster, you must select **Apply** for the changes to be applied.
179+
180+
181+
- **Add from Azure Key Vault**: Add an existing secret from the Azure Key vault to be synchronized to the cluster.
182+
183+
:::image type="content" source="media/howto-manage-certificates/add-from-key-vault.png" lightbox="media/howto-manage-certificates/add-from-key-vault.png" alt-text="Screenshot that shows the Add from Azure Key Vault option when adding a new certificate to the devices page.":::
184+
185+
> [!NOTE]
186+
> Make sure to select the secret that holds the certificate you would like to synchronize to the cluster. Selecting a secret which isn't the correct certificate causes the connection to fail.
187+
173188

189+
1. Using the list view you can manage the synchronized certificates. You can view all the synchronized certificates, and which certificate store it's synchronized to:
174190
175-
Using the list view you can manage the synchronized certificates. You can view all the synchronized certificates, and which certificate store it's synchronized to:
191+
:::image type="content" source="media/howto-manage-certificates/list-certificates.png" lightbox="media/howto-manage-certificates/list-certificates.png" alt-text="Screenshot that shows the list of certificates in the devices page and how to filter by Trust List and Issuer List.":::
176192
177-
:::image type="content" source="media/howto-manage-certificates/list-certificates.png" lightbox="media/howto-manage-certificates/list-certificates.png" alt-text="Screenshot that shows the list of certificates in the devices page and how to filter by Trust List and Issuer List.":::
178193
179-
- To learn more about the *Trust list* and *Issuer list* stores, see [Configure OPC UA certificates infrastructure for the connector for OPC UA](../discover-manage-assets/howto-configure-opc-ua-certificates-infrastructure.md).
194+
To learn more about the *Trust list* and *Issuer list* stores, see the connector-specific certificate management documentation.
180195
181196
You can delete synced certificates as well. When you delete a synced certificate, it only deletes the synced certificate from the Kubernetes cluster, and doesn't delete the contained secret reference from Azure Key Vault. You must delete the certificate secret manually from the key vault.
49.7 KB
Loading
-82 KB
Loading
-28.3 KB
Loading
61.1 KB
Loading
32.5 KB
Loading

0 commit comments

Comments
 (0)