Skip to content

Commit 6566d93

Browse files
committed
manage secrets and acrolinx
1 parent 537ba7d commit 6566d93

File tree

2 files changed

+18
-26
lines changed

2 files changed

+18
-26
lines changed

articles/iot-operations/deploy-iot-ops/howto-enable-secure-settings.md

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,19 @@
11
---
22
title: Enable secure settings
33
description: Enable secure settings on your Azure IoT Operations Preview deployment by configuring an Azure Key Vault and enabling workload identities.
4-
author: kgremban
5-
ms.author: kgremban
4+
author: asergaz
5+
ms.author: sergaz
66
ms.topic: how-to
7-
ms.custom:
8-
ms.date: 09/17/2024
7+
ms.date: 09/24/2024
98

109
#CustomerIntent: I deployed Azure IoT Operations with test settings for the quickstart scenario, now I want to enable secure settings to use the full feature set.
1110
---
1211

13-
# Enable secure settings
12+
# Enable secure settings in Azure IoT Operations Preview deployment
1413

1514
[!INCLUDE [public-preview-note](../includes/public-preview-note.md)]
1615

17-
The secure settings for Azure IoT Operations includes the setup of Secrets Management and user-assigned managed identity for cloud connections, for example, an OPC UA server, or dataflow endpoints.
16+
The secure settings for Azure IoT Operations include the setup of Secrets Management and user-assigned managed identity for cloud connections, for example, an OPC UA server, or dataflow endpoints.
1817

1918
The test settings are easier and quicker to get you started with a deployment, but after your initial deployment you might want to start using the secure settings. This article provides instructions for enabling secure settings on an existing deployment.
2019

@@ -61,7 +60,7 @@ Use the following steps to enable workload identity on an existing connected K3s
6160
az extension add --source <PATH_TO_WHL_FILE>
6261
```
6362

64-
1. Export environment variables and set the release tag to `0.1.15392-private`.
63+
1. Export environment variables, and set the release tag to `0.1.15392-private`.
6564

6665
```bash
6766
export KUBECONFIG=/etc/rancher/k3s/k3s.yaml
@@ -309,7 +308,7 @@ Now that secret synchronization setup is complete, you can refer to [Manage Secr
309308

310309
## Set up user-assigned managed identity for cloud connections
311310

312-
Some Azure IoT Operations components like dataflow endpoints use user-assigned managed identity for cloud connections. It is recommended to use a separate identity from the one used to set up Secrets Management.
311+
Some Azure IoT Operations components like dataflow endpoints use user-assigned managed identity for cloud connections. It's recommended to use a separate identity from the one used to set up Secrets Management.
313312

314313
1. Create a user-assigned managed identity which can be used for cloud connections. Use the [az identity create](/cli/azure/identity#az-identity-create) command to create the user-assigned managed identity.
315314

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

Lines changed: 11 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,8 @@ title: Manage secrets
33
description: Create, update, and manage secrets that are required to give your Arc-enabled Kubernetes cluster access to Azure resources.
44
author: asergaz
55
ms.author: sergaz
6-
ms.subservice: orchestrator
76
ms.topic: how-to
8-
ms.date: 03/21/2024
9-
ms.custom: ignite-2023, devx-track-azurecli
7+
ms.date: 09/24/2024
108

119
#CustomerIntent: As an IT professional, I want to manage secrets in Azure IoT Operations, by leveraging Key Vault and Azure Secrete Store to sync the secrets down from the cloud and store them on the edge as Kubernetes secrets.
1210
---
@@ -15,33 +13,28 @@ ms.custom: ignite-2023, devx-track-azurecli
1513

1614
[!INCLUDE [public-preview-note](../includes/public-preview-note.md)]
1715

18-
Azure IoT Operations uses Azure Key Vault as the managed vault solution on the cloud and uses [Azure Secret Store](#TODO-ADD-LINK) to sync the secrets down from the cloud and store them on the edge as Kubernetes secrets.
16+
Azure IoT Operations uses Azure Key Vault as the managed vault solution on the cloud, and uses [Azure Secret Store](#TODO-ADD-LINK) to sync the secrets down from the cloud and store them on the edge as Kubernetes secrets.
1917

2018
## Prerequisites
2119

22-
* An Azure IoT Operations instance deployed with secure settings.
23-
* If you deployed Azure IoT Operations with test settings and now want to use secrets with Azure IoT Operations, you need to first [enable secure settings](./howto-enable-secure-settings.md).
20+
* An Azure IoT Operations instance deployed with secure settings. If you deployed Azure IoT Operations with test settings and now want to use secrets, you need to first [enable secure settings](./howto-enable-secure-settings.md).
2421

2522
## Add and use secrets
2623

27-
Azure IoT Operations has integrated with [Azure Secret Store](#TODO-ADD-LINK) to provide a seamless secret management experience.
24+
Secrets management for Azure IoT Operations uses Azure Secret Store to sync the secrets from an Azure Key Vault and store them on the edge as Kubernetes secrets. When you enabled secure settings during deployment, you selected an Azure Key Vault for secret management. It is in this Key Vault where all secrets to be used within Azure IoT Operations are stored. Azure IoT Operations instances work with only one Azure Key Vault, multiple key vaults per instance isn't supported.
2825

29-
To use secrets with AIO components, deployment in “Secure Settings” is required. In “Secure Settings” deployment, you will have selected an Azure Key Vault for secret managed. It is in this Key Vault where all secrets to be used within AIO should be placed. AIO instances works with only one Azure Key Vault, multiple Azure Key Vault per instance is not supported.
26+
Once the setup secrets management steps are completed, you can start adding secrets to Azure Key Vault, and sync them to the edge to be used in Asset Endpoint Profile or Dataflow Endpoints using the [operations experience web UI](https://iotoperations.azure.com).
3027

31-
Once the set-up steps are completed, you can now add secrets to Azure Key Vault, sync it to the edge to be used in Asset Endpoint Profile or Dataflow Endpoints using Digital Operators Experience.
28+
Secrets are used in Asset Endpoint profile and Dataflow endpoints for authentication. In this section, we use Asset Endpoint profile as an example, the same can be applied to dataflow endpoints. You have the following options When using a secret from the selected key vault:
3229

33-
Secrets are used in Asset Endpoint profile and Dataflow endpoints for authentication. In this section, we will use Asset Endpoint profile as an example, the same can be applied to dataflow endpoints.
30+
1. **Create a new secret**: creates a secret reference in the Azure Key Vault and also automatically synchronizes the secret down to the edge using Azure Secret Store. Use this option if you didn't create the secret you require for this scenario in the key vault beforehand.
3431

35-
While using a secret from the selected key vault, there are a few options:
32+
1. **Add from Azure Key Vault**: synchronizes an existing secret in key vault down to the edge in Azure Key Vault that wasn't synchronized before. Selecting this option shows you the list of secret references in the selected key vault. Use this option if you created the secret in the key vault beforehand.
3633

37-
1. Create a new secret: This creates a secret reference in the azure key vault and also automatically synchronizes the secret down to the edge using SSC. Use this option if you haven’t already created the secret you require for this scenario in the key vault.
38-
39-
1. Add from Azure Key Vault: This synchronizes an existing secret in key vault down to the edge in azure key vault which has not been synchronized before. Selecting this option will show you the list of secret references in the selected key vault. Use this option if you have already created the secret in the key vault.
40-
41-
1. Add synced secret: This uses an existing and synchronized to the edge secret for the component. Selecting this option will show you the list of already synchronized secrets. Use this if you have previously created and synchronized the secret but have not used it in an AIO component.
34+
1. **Add synced secret**: uses an existing and synchronized to the edge secret for the component. Selecting this option shows you the list of already synchronized secrets. Use this option if you previously created and synchronized the secret but didn't use it in an Azure IoT Operations component.
4235

4336
## Manage Synced Secrets
4437

45-
You can use manage synced secrets for asset endpoint profiles and dataflow endpoints to view or delete synced secrets.
38+
You can use Manage Synced Secrets for asset endpoint profiles and dataflow endpoints to view or delete synced secrets.
4639

47-
You can delete synced secrets as well, this will only delete the secret from the edge, this will not delete the secret from key vault. Before deleting synced secret, make sure all references of the secret from AIO components have been removed.
40+
You can delete synced secrets as well. When you delete a synced secret, it only deletes the secret from the edge, and doesn't delete the secret from key vault. Before deleting a synced secret, make sure that all references to the secret from Azure IoT Operations components are removed.

0 commit comments

Comments
 (0)