Skip to content

Commit 0ad0784

Browse files
Merge pull request #289715 from kgremban/nov1-misc
Add pointers to byoca steps
2 parents 54d8337 + 3046169 commit 0ad0784

File tree

3 files changed

+18
-8
lines changed

3 files changed

+18
-8
lines changed

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

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -147,16 +147,24 @@ Use these steps if you chose the **Test settings** option on the **Dependency ma
147147
>[!TIP]
148148
>The `init` command only needs to be run once per cluster. If you're reusing a cluster that already had Azure IoT Operations version 0.8.0 deployed on it, you can skip this step.
149149
150+
If you followed the optional prerequisite to set up your own certificate authority issuer, add the `--user-trust` flag to the `init` command.
151+
150152
This command might take several minutes to complete. You can watch the progress in the deployment progress display in the terminal.
151153
152154
1. Deploy Azure IoT Operations. Copy and run the provided [az iot ops create](/cli/azure/iot/ops#az-iot-ops-create) command.
153155
154-
If you followed the optional prerequisites to prepare your cluster for observability, add the following optional parameters to the `create` command:
156+
* If you followed the optional prerequisites to prepare your cluster for observability, add the following parameters to the `create` command:
155157
156-
| Optional parameter | Value | Description |
157-
| --------- | ----- | ----------- |
158-
| `--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.enpoint=4317**. |
159-
| `--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**. |
158+
| Parameter | Value | Description |
159+
| --------- | ----- | ----------- |
160+
| `--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.enpoint=4317**. |
161+
| `--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**. |
162+
163+
* If you followed the optional prerequisites to set up your own certificate authority issuer, add the `--trust-settings` parameters to the `create` command:
164+
165+
```bash
166+
--trust-settings configMapName=<CONFIGMAP_NAME> configMapKey=<CONFIGMAP_KEY_WITH_PUBLICKEY_VALUE> issuerKind=<CLUSTERISSUER_OR_ISSUER> issuerName=<ISSUER_NAME>
167+
```
160168
161169
This command might take several minutes to complete. You can watch the progress in the deployment progress display in the terminal.
162170

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -222,7 +222,8 @@ az iot ops verify-host
222222

223223
At this point, when you have an Azure Arc-enabled Kubernetes cluster but before you deploy Azure IoT Operations to it, you might want to configure your cluster for advanced scenarios.
224224

225-
If you want to enable observability features on the cluster, follow the steps in [Deploy observability resources and set up logs](../configure-observability-monitoring/howto-configure-observability.md) before continuing to deploy.
225+
* If you want to enable observability features on the cluster, follow the steps in [Deploy observability resources and set up logs](../configure-observability-monitoring/howto-configure-observability.md).
226+
* If you want to configure your own certificate issuer on the cluster, follow the steps in [Certificate management > Bring your own issuer](../secure-iot-ops/concept-default-root-ca.md#bring-your-own-issuer).
226227

227228
## Next steps
228229

articles/iot-operations/secure-iot-ops/concept-default-root-ca.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,7 @@ To help you get started, Azure IoT Operations Preview is deployed with a default
8787
## Bring your own issuer
8888

8989
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.
90+
9091
To set up Azure IoT Operations with your own issuer, use the following steps before deploying an instance to your cluster:
9192

9293
1. Follow the steps in [Prepare your cluster](../deploy-iot-ops/howto-prepare-cluster.md) to set up your cluster.
@@ -116,7 +117,7 @@ To set up Azure IoT Operations with your own issuer, use the following steps bef
116117
1. Set up trust bundle in the Azure IoT Operations namespace.
117118

118119
1. To set up trust bundle, create a ConfigMap in the Azure IoT Operations namespace. Place the public key portion of your CA certificate into the config map with a key name of your choice.
119-
1. Get the public key portion of your CA certificate. The steps to acquire the public key depend on the issuer you have chosen.
120+
1. Get the public key portion of your CA certificate. The steps to acquire the public key depend on the issuer you choose.
120121
1. Create the ConfigMap. For example:
121122

122123
```bash
@@ -133,5 +134,5 @@ To set up Azure IoT Operations with your own issuer, use the following steps bef
133134
2. Add the `--trust-settings` parameter with the necessary information while deploying Azure IoT Operations. For example:
134135

135136
```bash
136-
az iot ops create --subscription <SUBSCRIPTION_ID> -g <RESOURCE_GROUP> --cluster <CLUSTER_NAME> --custom-location <CUSTOME_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>
137+
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>
137138
```

0 commit comments

Comments
 (0)