Skip to content

Commit 34335b2

Browse files
author
Jill Grant
authored
Merge pull request #269851 from timlt/update-observability
Update the directions for cloning the repo and installing the observa…
2 parents 6a6c7a0 + 836af4e commit 34335b2

File tree

1 file changed

+42
-33
lines changed

1 file changed

+42
-33
lines changed

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

Lines changed: 42 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ Observability provides visibility into every layer of your Azure IoT Operations
2020
## Prerequisites
2121

2222
- Azure IoT Operations Preview installed. For more information, see [Quickstart: Deploy Azure IoT Operations Preview to an Arc-enabled Kubernetes cluster](../get-started/quickstart-deploy.md).
23+
- [Git](https://git-scm.com/downloads) for cloning the repository.
2324

2425
## Configure your subscription
2526

@@ -34,37 +35,51 @@ az provider register -n "Microsoft.AlertsManagement"
3435
## Install observability components
3536
The steps in this section install shared monitoring resources and configure your Arc enabled cluster to emit observability signals to these resources. The shared monitoring resources include Azure Managed Grafana, Azure Monitor Workspace, Azure Managed Prometheus, Azure Log Analytics, and Container Insights.
3637

37-
To deploy, run the following command. Use the subscription ID and resource group of your Arc-enabled cluster that you want to monitor.
38+
1. In your console, navigate to a local folder where you want to clone the Azure IoT Operations repo:
39+
> [!NOTE]
40+
> The repo contains the deployment definition of Azure IoT Operations, and samples that include the sample dashboards used in this article.
3841
39-
> [!NOTE]
40-
> To discover other optional parameters you can set, see the [bicep file](https://github.com/Azure/azure-iot-operations/blob/main/tools/setup-3p-obs-infra/observability-full.bicep). The optional parameters can specify things like alternative locations for cluster resources.
42+
1. Clone the repo to your local machine, using the following command:
4143

42-
```azurecli
43-
az deployment group create \
44-
--subscription <subscription-id> \
45-
--resource-group <cluster-resource-group> \
46-
--template-file observability-full.bicep \
47-
--parameters grafanaAdminId=$(az ad user show --id $(az account show --query user.name --output tsv) --query=id --output tsv) \
48-
clusterName=<cluster-name> \
49-
sharedResourceGroup=<shared-resource-group> \
50-
sharedResourceLocation=<shared-resource-location> \
51-
--query=properties.outputs
52-
```
44+
```shell
45+
git clone https://github.com/Azure/azure-iot-operations.git
46+
```
5347

54-
The previous command grants admin access for the newly created Grafana instance to the user who runs it. If that access isn't what you want, run the following command instead. You need to set up permissions manually before anyone can access the Grafana instance.
48+
1. Navigate to the following path in your local copy of the repo:
5549

56-
```azurecli
57-
az deployment group create \
58-
--subscription <subscription-id> \
59-
--resource-group <cluster-resource-group> \
60-
--template-file observability-full.bicep \
61-
--parameters clusterName=<cluster-name> \
62-
sharedResourceGroup=<shared-resource-group> \
63-
sharedResourceLocation=<shared-resource-location> \
64-
--query=properties.outputs
65-
```
50+
*azure-iot-operations\tools\setup-3p-obs-infra*
6651

67-
To set up permissions manually, [add a role assignment](../../managed-grafana/how-to-share-grafana-workspace.md#add-a-grafana-role-assignment) to the Grafana instance for any users who should have access. Assign one of the Grafana roles (Grafana Admin, Grafana Editor, Grafana Viewer) depending on the level of access desired.
52+
1. To deploy the observability components, run the following command. Use the subscription ID and resource group of your Arc-enabled cluster that you want to monitor.
53+
54+
> [!NOTE]
55+
> To discover other optional parameters you can set, see the [bicep file](https://github.com/Azure/azure-iot-operations/blob/main/tools/setup-3p-obs-infra/observability-full.bicep). The optional parameters can specify things like alternative locations for cluster resources.
56+
57+
```azurecli
58+
az deployment group create \
59+
--subscription <subscription-id> \
60+
--resource-group <cluster-resource-group> \
61+
--template-file observability-full.bicep \
62+
--parameters grafanaAdminId=$(az ad user show --id $(az account show --query user.name --output tsv) --query=id --output tsv) \
63+
clusterName=<cluster-name> \
64+
sharedResourceGroup=<shared-resource-group> \
65+
sharedResourceLocation=<shared-resource-location> \
66+
--query=properties.outputs
67+
```
68+
69+
The previous command grants admin access for the newly created Grafana instance to the user who runs it. If that access isn't what you want, run the following command instead. You need to set up permissions manually before anyone can access the Grafana instance.
70+
71+
```azurecli
72+
az deployment group create \
73+
--subscription <subscription-id> \
74+
--resource-group <cluster-resource-group> \
75+
--template-file observability-full.bicep \
76+
--parameters clusterName=<cluster-name> \
77+
sharedResourceGroup=<shared-resource-group> \
78+
sharedResourceLocation=<shared-resource-location> \
79+
--query=properties.outputs
80+
```
81+
82+
To set up permissions manually, [add a role assignment](../../managed-grafana/how-to-share-grafana-workspace.md#add-a-grafana-role-assignment) to the Grafana instance for any users who should have access. Assign one of the Grafana roles (Grafana Admin, Grafana Editor, Grafana Viewer) depending on the level of access desired.
6883
6984
If the deployment succeeds, a few pieces of information are printed at the end of the command output. The information includes the Grafana URL and the resource IDs for both the Log Analytics and Azure Monitor resources that were created. The Grafana URL allows you to navigate to the Grafana instance that you configure in [Deploy dashboards to Grafana](#deploy-dashboards-to-grafana). The two resource IDs enable you to configure other Arc enabled clusters by following the steps in [Add an Arc-enabled cluster to existing observability infrastructure](howto-add-cluster.md).
7085
@@ -134,15 +149,9 @@ Azure IoT Operations provides a collection of dashboards designed to give you ma
134149
135150
Complete the following steps to install the Azure IoT Operations curated Grafana dashboards.
136151
137-
1. Clone the Azure IoT Operations repo by using the following command:
138-
139-
```console
140-
git clone https://github.com/Azure/azure-iot-operations.git
141-
```
142-
143152
1. Sign in to the Grafana console, then in the upper right area of the Grafana application, select the **+** icon
144153
145-
1. Select **Import dashboard**, follow the prompts to browse to the *samples\grafana-dashboards* path in your cloned copy of the repo, and select a JSON dashboard file
154+
1. Select **Import dashboard**, follow the prompts to browse to the *samples\grafana-dashboards* path in your local cloned copy of the repo, and select a JSON dashboard file
146155
147156
1. When the application prompts, select your managed Prometheus data source
148157

0 commit comments

Comments
 (0)