diff --git a/docs/dev-guide.md b/docs/dev-guide.md index 1b8416a46..06cc390d5 100644 --- a/docs/dev-guide.md +++ b/docs/dev-guide.md @@ -60,7 +60,7 @@ _Secrets_ are used to fill in the login credentials to the cloud platform. You h ```json { - "StorageAccount:ConnectionString": "", + "Azure:StorageAccount:ConnectionString": "", "StorageAccount:BlobContainerName": "", "OIDC:Scope": "", "OIDC:MetadataUrl": "", @@ -68,17 +68,18 @@ _Secrets_ are used to fill in the login credentials to the cloud platform. You h "OIDC:Authority": "", "OIDC:ApiClientId": "", "LoRaRegionRouterConfig:Url": "", - "LoRaKeyManagement:Url": "", - "LoRaKeyManagement:Code": "", + "Azure:LoRaKeyManagement:Url": "", + "Azure:LoRaKeyManagement:Code": "", "LoRaFeature:Enabled": "", "Kestrel:Certificates:Development:Password": "", - "IoTHub:ConnectionString": "", - "IoTHub:EventHub:Endpoint": "", - "IoTHub:EventHub:ConsumerGroup": "", - "IoTDPS:ServiceEndpoint": "", - "IoTDPS:LoRaEnrollmentGroup": "", - "IoTDPS:DefaultEnrollmentGroup": "", - "IoTDPS:ConnectionString": "", + "Azure:IoTHub:ConnectionString": "", + "Azure:IoTHub:EventHub:Endpoint": "", + "Azure:IoTHub:EventHub:ConsumerGroup": "", + "Azure:IoTDPS:ServiceEndpoint": "", + "Azure:IoTDPS:LoRaEnrollmentGroup": "", + "Azure:IoTDPS:DefaultEnrollmentGroup": "", + "Azure:IoTDPS:ConnectionString": "", + "Azure:IoTDPS:IDScope": "", "PostgreSQL:ConnectionString": "" } ``` @@ -105,13 +106,13 @@ Here are different settings that the user can configure: * **OIDC__ClientId**: The OpenID Connect client ID for the Web UI. * **OIDC__ApiClientId**: The OpenID Connect client ID for the API. * **OIDC__Scope**: The OpenID Connect scope that represents the portal API. -* **IoTDPS__ServiceEndpoint**: The IoT Device Provisioning Service endpoint. -* **IoTDPS__IDScope**: The IoT Device Provisioning Service ID scope. +* **Azure__IoTDPS__ServiceEndpoint**: The IoT Device Provisioning Service endpoint. +* **Azure__IoTDPS__IDScope**: The IoT Device Provisioning Service ID scope. * **LoRaFeature__Enabled**: Whether the LoRaWAN feature is enabled or not. -* **LoRaKeyManagement__Url**: The LoRa Key Management Facade URL. +* **Azure__LoRaKeyManagement__Url**: The LoRa Key Management Facade URL. * **StorageAccount__BlobContainerName**: The name of the Azure Storage container where the device models images are stored. -* **IoTHub__EventHub__Endpoint**: The IotHub Event Hub compatible endpoint. -* **IoTHub__EventHub__ConsumerGroup**: (Default value `iothub-portal`) The name of the consumer group used to to pull data from the IoT Hub (Automatically created by the Bicep/ARM deployement) +* **Azure__IoTHub__EventHub__Endpoint**: The IotHub Event Hub compatible endpoint. +* **Azure__IoTHub__EventHub__ConsumerGroup**: (Default value `iothub-portal`) The name of the consumer group used to to pull data from the IoT Hub (Automatically created by the Bicep/ARM deployement) * **ASPNETCORE_ENVIRONMENT**: Built-in environment variable, used to target the configuration provided by a specific environment. Two accepted values: * `Development`: On this environment, logs are produced up to `Debug` level. * `Production`: Default value if ASPNETCORE_ENVIRONMENT is not set. On this environment, logs are produced up to `Information` level. @@ -127,10 +128,10 @@ Here are different settings that the user can configure: Here are different connection strings that the user can configure: -* **IoTHub__ConnectionString**: The connection string to the IoT Hub. -* **IoTDPS__ConnectionString**: The connection string to the Azure IoT Device Provisioning Service. -* **StorageAccount__ConnectionString**: The connection string to the Azure Storage account. -* **LoRaKeyManagement__Code**: The LoRa Key Management Facade code. +* **Azure__IoTHub__ConnectionString**: The connection string to the IoT Hub. +* **Azure__IoTDPS__ConnectionString**: The connection string to the Azure IoT Device Provisioning Service. +* **Azure__StorageAccount__ConnectionString**: The connection string to the Azure Storage account. +* **Azure__LoRaKeyManagement__Code**: The LoRa Key Management Facade code. * **PostgreSQL__ConnectionString**: The connection string allowing the connection to the PostgreSQL database. > Note: For a production environment, an Azure Key Vault is advised to store the connection strings. @@ -346,12 +347,6 @@ Follow the next steps to create EF migration: dotnet ef migrations add "" -p ..\IoTHub.Portal.Postgres\ -v -- --DbProvider PostgreSQL ``` -1. Execute this command for MySQL provider - - ```console - dotnet ef migrations add "" -p ..\IoTHub.Portal.MySql\ -v -- --DbProvider MySQL - ``` - 1. Open the created migration and follow the following steps: 1. Move the using directive into the namespace directive @@ -359,3 +354,11 @@ Follow the next steps to create EF migration: 1. Add "_ =" before each statement of the Up and Down methods 1. Add the CGI copyright to the top of the file + +1. Execute this command for MySQL provider + + ```console + dotnet ef migrations add "" -p ..\IoTHub.Portal.MySql\ -v -- --DbProvider MySQL + ``` + +1. Open the newly created migration for MySQL and repeat step 3 diff --git a/docs/dev-guide/migrations/v4-to-v5.md b/docs/dev-guide/migrations/v4-to-v5.md index 3e4f3aa6a..9aa95ccb0 100644 --- a/docs/dev-guide/migrations/v4-to-v5.md +++ b/docs/dev-guide/migrations/v4-to-v5.md @@ -27,4 +27,5 @@ You have to add also `Azure__` prefix in all setting to the portal web app. | `Azure__IoTDP__LoRaEnrollmentGroup` | Application setting | The name of the IotDPS LoRa Enrollment group | | `Azure__IoTDPS__DefaultEnrollmentGroup` | Application setting | The name of the default IotDPS Enrollment group | | `Azure__IoTDPS__ConnectionString` | Connection string | The IotDPS Connection String | +| `Azure__IoTDPS__IDScope` | Application setting | The IotDPS Scope ID | | `Azure__StorageAccount__ConnectionString` | Connection string | The Storage Account Connection String |