Skip to content

Commit e3f730e

Browse files
committed
Review edits
1 parent 7616944 commit e3f730e

File tree

6 files changed

+36
-40
lines changed

6 files changed

+36
-40
lines changed

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

Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,10 @@ Observability provides visibility into every layer of your Azure IoT Operations
1919

2020
## Prerequisites
2121

22-
- Azure IoT Operations Preview installed. For more information, see [Quickstart: Run Azure IoT Operations Preview in GitHub Codespaces with K3s](../get-started-end-to-end-sample/quickstart-deploy.md).
23-
- [Git](https://git-scm.com/downloads) for cloning the repository.
22+
* An Arc-enabled Kubernetes cluster.
23+
* Helm installed on your development machine. For instructions, see [Install Helm](https://helm.sh/docs/intro/install/).
24+
* Kubectl installed on your development machine. For instructions, see [Install Kubernetes tools](https://kubernetes.io/docs/tasks/tools/).
25+
* Azure CLI installed on your development machine. For more information, see [How to install the Azure CLI](/cli/azure/install-azure-cli).
2426

2527
## Configure your subscription
2628

@@ -39,17 +41,11 @@ az provider register -n "Microsoft.AlertsManagement"
3941

4042
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. In this section, you also deploy an [OpenTelemetry (Otel) Collector](https://opentelemetry.io/docs/collector/)
4143

42-
1. In your console, go to the local folder where you want to clone the Azure IoT Operations repo:
44+
1. Clone or download the Azure IoT Operations repo to your local machine: [azure-iot-operations.git](https://github.com/Azure/azure-iot-operations.git).
4345

4446
> [!NOTE]
4547
> The repo contains the deployment definition of Azure IoT Operations, and samples that include the sample dashboards used in this article.
4648
47-
1. Clone the repo to your local machine, using the following command:
48-
49-
```shell
50-
git clone https://github.com/Azure/azure-iot-operations.git
51-
```
52-
5349
1. Browse to the following path in your local copy of the repo:
5450

5551
*azure-iot-operations\tools\setup-3p-obs-infra*

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

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,8 @@ A cluster host:
6565
az iot ops verify-host
6666
```
6767

68+
* (Optional) Prepare your cluster for observability before deploying Azure IoT Operations: [Configure observability](../configure-observability-monitoring/howto-configure-observability.md).
69+
6870
## Deploy
6971

7072
Use the Azure portal or Azure CLI to deploy Azure IoT Operations to your Arc-enabled Kubernetes cluster.
@@ -136,7 +138,7 @@ Azure IoT Operations requires a schema registry on your cluster. Schema registry
136138
| Optional parameter | Value | Description |
137139
| --------- | ----- | ----------- |
138140
| `--no-progress` | | Disables the deployment progress display in the terminal. |
139-
| `--disable-rsync-rules` | | Disable the resource sync rules on the deployment feature flag if you don't have **Microsoft.Authorization/roleAssignment/write** permissions in the resource group. |
141+
| `--enable-rsync-rules` | | Enable the resource sync rules on the instance to project resources from the cloud to the edge. |
140142
| `--add-insecure-listener` | | Add an insecure 1883 port config to the default listener. *Not for production use*. |
141143
| `--broker-config-file` | Path to JSON file | Provide a configuration file for the MQTT broker. For more information, see [Advanced MQTT broker config](https://github.com/Azure/azure-iot-ops-cli-extension/wiki/Advanced-Mqtt-Broker-Config) and [Configure core MQTT broker settings](../manage-mqtt-broker/howto-configure-availability-scale.md). |
142144

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

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -103,8 +103,6 @@ This section provides steps to create clusters in validated environments on Linu
103103

104104
The [AksEdgeQuickStartForAio.ps1](https://github.com/Azure/AKS-Edge/blob/main/tools/scripts/AksEdgeQuickStart/AksEdgeQuickStartForAio.ps1) script automates the process of creating and connecting a cluster, and is the recommended path for deploying Azure IoT Operations on AKS Edge Essentials.
105105

106-
107-
108106
1. Open an elevated PowerShell window and change the directory to a working folder.
109107

110108
1. Get the `objectId` of the Microsoft Entra ID application that the Azure Arc service uses in your tenant.
@@ -124,18 +122,19 @@ The [AksEdgeQuickStartForAio.ps1](https://github.com/Azure/AKS-Edge/blob/main/to
124122
| CLUSTER_NAME | A name for the new cluster to be created. |
125123
| ARC_APP_OBJECT_ID | The object ID value that you retrieved in the previous step. |
126124

127-
> [!NOTE]
128-
> > **Special instructions for AIO Internal Bugbash**:
125+
> [!NOTE]
126+
> **Special instructions for AIO Internal Bugbash**:
127+
>
129128
> The instructions below for AksEdgeQuickStartForAio.ps1 from AKS-Edge GitHub repo are for external customer consumption and will only work after AIO 0.7 is released.
130129
> For internal bug bashes, use this powershell script below instead
131-
> ```powershell
132-
> $url = "https://raw.githubusercontent.com/jagadishmurugan/AKS-Edge/blob/users/jagamu/changes-for-M2-integration/tools/scripts/AksEdgeQuickStart/AksEdgeQuickStartForAio.ps1"
133-
> Invoke-WebRequest -Uri $url -OutFile .\AksEdgeQuickStartForAio.ps1
134-
> Unblock-File .\AksEdgeQuickStartForAio.ps1
135-
> Set-ExecutionPolicy -ExecutionPolicy Bypass -Scope Process -Force
136-
> .\AksEdgeQuickStartForAio.ps1 -SubscriptionId "<SUBSCRIPTION_ID>" -TenantId "<TENANT_ID>" -ResourceGroupName "<RESOURCE_GROUP_NAME>" -Location "<LOCATION>" -ClusterName "<CLUSTER_NAME>" -Tag "test-v0.3" -CustomLocationOid $customlocationOid
137-
> ```
138-
130+
>
131+
>```powershell
132+
>$url = "https://raw.githubusercontent.com/jagadishmurugan/AKS-Edge/blob/users/jagamu/changes-for-M2-integration/tools/scripts/AksEdgeQuickStart/AksEdgeQuickStartForAio.ps1"
133+
>Invoke-WebRequest -Uri $url -OutFile .\AksEdgeQuickStartForAio.ps1
134+
>Unblock-File .\AksEdgeQuickStartForAio.ps1
135+
>Set-ExecutionPolicy -ExecutionPolicy Bypass -Scope Process -Force
136+
>.\AksEdgeQuickStartForAio.ps1 -SubscriptionId "<SUBSCRIPTION_ID>" -TenantId "<TENANT_ID>" -ResourceGroupName "<RESOURCE_GROUP_NAME>" -Location "<LOCATION>" -ClusterName "<CLUSTER_NAME>" -Tag "test-v0.3" -CustomLocationOid $customlocationOid
137+
>```
139138
140139
```powershell
141140
$url = "https://raw.githubusercontent.com/Azure/AKS-Edge/main/tools/scripts/AksEdgeQuickStart/AksEdgeQuickStartForAio.ps1"

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -49,9 +49,9 @@ The following table described Azure IoT Operations deployment and management tas
4949
| Task | Required permission | Comments |
5050
| ---- | ------------------- | -------- |
5151
| Deploy Azure IoT Operations | **Contributor** permissions at the subscription level. | |
52-
| Creating secrets in Key Vault | **Key Vault Secrets Officer** permissions at the resource level. | Only required for secure settings deployment. |
53-
| Enabling resource sync rules on an Azure IoT Operations instance | **Microsoft/Authorization/roleAssignments/write** permissions at the resource group level. | Resource sync rules can be disabled during instance creation if the user doesn't have permissions. |
54-
| Creating a schema registry. | **Microsoft/Authorization/roleAssignments/write** permissions at the resource group level. | |
52+
| Create secrets in Key Vault | **Key Vault Secrets Officer** permissions at the resource level. | Only required for secure settings deployment. |
53+
| Enable resource sync rules on an Azure IoT Operations instance | **Microsoft/Authorization/roleAssignments/write** permissions at the resource group level. | Resource sync rules are disabled by default, but can be enabled during instance creation. |
54+
| Create a schema registry. | **Microsoft/Authorization/roleAssignments/write** permissions at the resource group level. | |
5555

5656
> [!TIP]
5757
>

articles/iot-operations/get-started-end-to-end-sample/quickstart-deploy.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,17 @@ To connect your cluster to Azure Arc:
8181
8282
1. After signing in, Azure CLI displays all of your subscriptions and indicates your default subscription with an asterisk `*`. To continue with your default subscription, select `Enter`. Otherwise, type the number of the Azure subscription that you want to use.
8383

84+
> [!NOTE]
85+
> **Special instructions for AIO Internal Bugbash**:
86+
>
87+
> Official IoT Ops CLI releases are installed via extension index like so az extension add --upgrade --name azure-iot-ops mentioned below.
88+
> However for bug bashes, we will distribute one-off release candidates intended to expose functionality to exercise internally. Use this for Bug Bash 2 on 9/27:
89+
>
90+
> ``` bash
91+
> az storage blob download --auth-mode login --blob-url https://azedgecli.blob.core.windows.net/drop/azure_iot_ops-0.7.0a10-py3-none-any.whl -f ./azure_iot_ops-0.7.0a10-py3-none-any.whl
92+
> az extension add --upgrade --source ./azure_iot_ops-0.7.0a10-py3-none-any.whl
93+
> ```
94+
8495
1. Register the required resource providers in your subscription:
8596
8697
>[!NOTE]

articles/iot-operations/includes/connect-cluster-k3s.md

Lines changed: 3 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -37,29 +37,17 @@ ms.custom: include file, ignite-2023, devx-track-azurecli
3737
az extension add --upgrade --source connectedk8s-1.10.0-py2.py3-none-any.whl
3838
```
3939

40-
1. Use the [az connectedk8s connect](/cli/azure/connectedk8s#az-connectedk8s-connect) command to Arc-enable your Kubernetes cluster and manage it as part of your Azure resource group:
41-
42-
```azurecli
43-
az connectedk8s connect --name $CLUSTER_NAME -l $LOCATION --resource-group $RESOURCE_GROUP --subscription $SUBSCRIPTION_ID --disable-auto-upgrade
44-
```
45-
4640
1. Export environment variables that the `az connectedk8s upgrade` command requires.
4741

4842
```bash
4943
export KUBECONFIG=/etc/rancher/k3s/k3s.yaml
5044
export HELMREGISTRY=azurearcfork8sdev.azurecr.io/merge/private/azure-arc-k8sagents:0.1.15392-private
5145
```
5246

53-
1. Upgrade the Azure Arc agent to use a preview build that supports the workload identity feature that Azure IoT Operations uses for user-assigned managed identities.
54-
55-
```azurecli
56-
az connectedk8s upgrade --resource-group $RESOURCE_GROUP --name $CLUSTER_NAME --agent-version 0.1.15392-private
57-
```
58-
59-
1. Enable the workload identity feature on the cluster.
47+
1. Use the [az connectedk8s connect](/cli/azure/connectedk8s#az-connectedk8s-connect) command to Arc-enable your Kubernetes cluster and manage it as part of your Azure resource group:
6048

6149
```azurecli
62-
az connectedk8s update --resource-group $RESOURCE_GROUP --name $CLUSTER_NAME --enable-oidc-issuer --enable-workload-identity
50+
az connectedk8s connect --name $CLUSTER_NAME -l $LOCATION --resource-group $RESOURCE_GROUP --subscription $SUBSCRIPTION_ID --disable-auto-upgrade --enable-oidc-issuer --enable-workload-identity
6351
```
6452

6553
1. Get the cluster's issuer URL.
@@ -79,7 +67,7 @@ ms.custom: include file, ignite-2023, devx-track-azurecli
7967
1. Add the following content to the `config.yaml` file, replacing the `<SERVICE_ACCOUNT_ISSUER>` placeholder with your cluster's issuer URL.
8068

8169
```yml
82-
kube-apiserver-arg: 'service-account-issuer=<SERVICE_ACCOUNT_ISSUER>' kube-apiserver-arg: 'service-account-max-token-expiration=24h'
70+
kube-apiserver-arg: 'service-account-issuer=<SERVICE_ACCOUNT_ISSUER>'
8371
```
8472
8573
1. Save the file and exit the nano editor.

0 commit comments

Comments
 (0)