Skip to content

Commit b70cefa

Browse files
Addressing feedback
1 parent 27198f0 commit b70cefa

File tree

3 files changed

+22
-23
lines changed

3 files changed

+22
-23
lines changed

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

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,6 @@ ms.date: 10/22/2024
1515

1616
Observability provides visibility into every layer of your Azure IoT Operations configuration. It gives you insight into the actual behavior of issues, which increases the effectiveness of site reliability engineering. Azure IoT Operations offers observability through custom curated Grafana dashboards that are hosted in Azure. These dashboards are powered by Azure Monitor managed service for Prometheus and by Container Insights. This guide shows you how to set up Azure Managed Prometheus and Grafana and enable monitoring for your Azure Arc cluster.
1717

18-
Complete the steps in this article *before* deploying Azure IoT Operations to your cluster.
19-
2018
## Prerequisites
2119

2220
* An Arc-enabled Kubernetes cluster.
@@ -231,6 +229,23 @@ Configure Prometheus metrics collection on your cluster.
231229
kubectl apply -f ama-metrics-prometheus-config.yaml
232230
```
233231

232+
233+
## Set up observability configuration
234+
235+
You can set up the observability configuration of your Azure IoT Operations deployment at any time. Once observability resources are configured, 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.
236+
237+
```azurecli
238+
az iot ops upgrade --resource-group <rg name> -n <instance name> --ops-config observability.metrics.openTelemetryCollectorAddress=<>
239+
```
240+
241+
| Parameter | Value | Description |
242+
| --------- | ----- | ----------- |
243+
| `--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 [instructions in this article](#deploy-opentelemetry-collector) use the sample values **fullnameOverride=aio-otel-collector** and **grpc.endpoint=4317**. |
244+
| `--ops-config` | `observability.metrics.exportInternalSeconds=<CHECK_INTERVAL>` | Provide the **check_interval** value you configured in the otel-collector-values.yaml file.<br><br>The [instructions in this article](#deploy-opentelemetry-collector) use the sample value **check_interval=60**. |
245+
246+
> [!NOTE]
247+
> 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.
248+
234249
## Deploy dashboards to Grafana
235250

236251
Azure IoT Operations provides a [sample dashboard](https://github.com/Azure/azure-iot-operations/tree/main/samples/grafana-dashboard) designed to give you many of the visualizations you need to understand the health and performance of your Azure IoT Operations deployment.
@@ -254,3 +269,6 @@ Complete the following steps to install the Azure IoT Operations curated Grafana
254269
1. When the application prompts, select your managed Prometheus data source.
255270

256271
1. Select **Import**.
272+
273+
274+

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

Lines changed: 0 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -118,25 +118,6 @@ If you want to upgrade to a specific version of Azure IoT Operations that isn't
118118
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-
136-
> [!NOTE]
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.
138-
139-
140121
## MQTT broker upgrade considerations
141122

142123
To ensure zero data loss and high availability during deployment upgrades, the MQTT broker implements rolling updates across the MQTT broker pods. The health manager pod coordinates an incremental upgrade process for the MQTT broker pods to ensure that:

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -149,7 +149,7 @@ 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-
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.
152+
Connectors use the certificate management experience to configure client application authentication to external servers. To learn more about how connectors use certificates to establish mutual trust with external servers, see the connector-specific certificate management documentation.
153153

154154
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.
155155

@@ -191,6 +191,6 @@ To manage certificates for external communications, follow these steps:
191191
:::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.":::
192192
193193
194-
To learn more about the *Trust list* and *Issuer list* stores, see the connector-specific certificate management documentation.
194+
To learn more about how trust certificates are managed for specific connectors, see the connector-specific certificate management documentation.
195195
196196
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.

0 commit comments

Comments
 (0)