Skip to content

Commit a733b7f

Browse files
asergazdominicbetts
authored andcommitted
adding screenshots v1
1 parent 42b7275 commit a733b7f

File tree

3 files changed

+40
-36
lines changed

3 files changed

+40
-36
lines changed

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

Lines changed: 40 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,45 @@ To help you get started, Azure IoT Operations is deployed with a default self-si
9393
status: "True"
9494
type: Ready
9595
```
96+
97+
## Manage certificates for external communications
98+
99+
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).
100+
101+
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. 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 edge to be used in the *Trust list* and *Issuer list* stores for OPC UA connections:
102+
103+
<!-- **************TODO: Screenshot of upload/add from AKV page - I want it to be coming from AKV instead**************** -->
104+
:::image type="content" source="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 asset endpoints page.":::
105+
106+
- **Upload Certificate**: Uploads a certificate which is then added as a secret to Azure Key Vault and automatically synchronized to the edge using Secret Store extension.
107+
108+
> [!TIP]
109+
> View the certificate once uploaded to ensure you have uploaded the correct certificate before adding to Azure Key Vault and synchronizing to edge.
110+
111+
> [!TIP]
112+
> Use an intuitive name so that you can recognize which secret represents your secret in the future.
113+
114+
> [!NOTE]
115+
> Simply uploading the certificate will not add the secret to Azure Kery Vault and synchronize to edge, you must click **Apply** to the changes to be applied. 
116+
117+
118+
- **Add from Azure Key Vault**: Add an existing secret from the Azure Key vault to be synchronized to the edge.
119+
120+
> [!NOTE]
121+
> Make sure to select the secret which holds the certificate you would like to synchronize to the edge. Selecting a secret which is not the correct certificate will cause the connection to fail.
122+
123+
<!-- TODO: Can we add more clarity here? -->
124+
Unlike in [Manage secrets for your Azure IoT Operations deployment](howto-manage-secrets.md) where you directly manage the synchronized secret used for authentication, Azure IoT Operations manages the synchronized secrets which represents the certificates on behalf of you.
125+
126+
Using the list view you can manage the synchronized certificates. You can view all the synchronized certificates, and which certificate store it is synchronized to:
127+
128+
<!-- ***********TODO: Screenshot of list view with some certificates there************* -->
129+
:::image type="content" source="media/howto-manage-certificates/list-certificates.png" alt-text="Screenshot that shows the list of certificates in the asset endpoints page and how to filter by Trust List and Issuer List.":::
130+
131+
- 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-opcua-certificates-infrastructure.md).
132+
133+
You can delete synced certificates as well. When you delete a synced certificate, it only deletes the synced certificate from the edge, and doesn't delete the contained secret reference from Azure Key Vault. You must delete the certificate secret manually from the key vault.
134+
96135
## Bring your own issuer
97136
98137
For production deployments, we recommend that you set up Azure IoT Operations with an enterprise PKI to manage certificates and that you bring your own issuer which works with your enterprise PKI instead of using the default self-signed issuer to issue TLS certificates for internal communication.
@@ -145,39 +184,4 @@ To set up Azure IoT Operations with your own issuer, use the following steps **b
145184
146185
```bash
147186
az iot ops create --subscription <SUBSCRIPTION_ID> -g <RESOURCE_GROUP> --cluster <CLUSTER_NAME> --custom-location <CUSTOM_LOCATION> -n <INSTANCE_NAME> --sr-resource-id <SCHEMAREGISTRY_RESOURCE_ID> --trust-settings configMapName=<CONFIGMAP_NAME> configMapKey=<CONFIGMAP_KEY_WITH_PUBLICKEY_VALUE> issuerKind=<CLUSTERISSUER_OR_ISSUER> issuerName=<ISSUER_NAME>
148-
```
149-
150-
## Manage certificates for external communications
151-
152-
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).
153-
154-
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. 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 edge to be used in the *Trust list* and *Issuer list* stores for OPC UA connections:
155-
156-
**************TODO: Screenshot of upload/add from AKV page****************
157-
158-
- **Upload Certificate**: Uploads a certificate which is then added as a secret to Azure Key Vault and automatically synchronized to the edge using Secret Store extension.
159-
160-
> [!TIP]
161-
> View the certificate once uploaded to ensure you have uploaded the correct certificate before adding to Azure Key Vault and synchronizing to edge.
162-
163-
> [!TIP]
164-
> Use an intuitive name so that you can recognize which secret represents your secret in the future.
165-
166-
> [!NOTE]
167-
> Simply uploading the certificate will not add the secret to Azure Kery Vault and synchronize to edge, you must click **Apply** to the changes to be applied. 
168-
169-
170-
- **Add from Azure Key Vault**: Add an existing secret from the Azure Key vault to be synchronized to the edge.
171-
172-
> [!NOTE]
173-
> Make sure to select the secret which holds the certificate you would like to synchronize to the edge. Selecting a secret which is not the correct certificate will cause the connection to fail.
174-
175-
Unlike in [Manage secrets for your Azure IoT Operations deployment](howto-manage-secrets.md) where you directly manage the synchronized secret used for authentication, Azure IoT Operations manages the synchronized secrets which represents the certificates on behalf of you.
176-
177-
Using the list view you can manage the synchronized certificates. You can view all the synchronized certificates, and which certificate store it is synchronized to:
178-
179-
***********TODO: Screenshot of list view*************
180-
181-
- 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-opcua-certificates-infrastructure.md).
182-
183-
You can delete synced certificates as well. When you delete a synced certificate, it only deletes the synced certificate from the edge, and doesn't delete the contained secret reference from Azure Key Vault. You must delete the certificate secret manually from the key vault.
187+
```
126 KB
Loading
94 KB
Loading

0 commit comments

Comments
 (0)