diff --git a/docs/DeploymentGuide.md b/docs/DeploymentGuide.md index 362c64c5a..4c121ea9f 100644 --- a/docs/DeploymentGuide.md +++ b/docs/DeploymentGuide.md @@ -244,6 +244,9 @@ There are several ways to deploy the solution. You can deploy to run in Azure in When Deployment is complete, follow steps in [Set Up Authentication in Azure App Service](../docs/azure_app_service_auth_setup.md) to add app authentication to your web app running on Azure App Service +### 🛠️ Troubleshooting + If you encounter any issues during the deployment process, please refer [troubleshoot](../docs/Troubleshoot.md) document for detailed steps and solutions. + # Local setup > **Note for macOS Developers**: If you are using macOS on Apple Silicon (ARM64) the DevContainer will **not** work. This is due to a limitation with the Azure Functions Core Tools (see [here](https://github.com/Azure/azure-functions-core-tools/issues/3112)). diff --git a/docs/Troubleshoot.md b/docs/Troubleshoot.md new file mode 100644 index 000000000..80c867527 --- /dev/null +++ b/docs/Troubleshoot.md @@ -0,0 +1,50 @@ +# 🛠️ Troubleshooting + +## Enable `AllowBringYourOwnPublicIpAddress` Feature + +Before deploying the resources, you may need to enable the **Bring Your Own Public IP Address** feature in Azure. This is required only once per subscription. + +### Steps + +1. **Run the following command to register the feature:** + + ```bash + az feature register --namespace Microsoft.Network --name AllowBringYourOwnPublicIpAddress + ``` + +2. **Wait for the registration to complete.** + You can check the status using: + + ```bash + az feature show --namespace Microsoft.Network --name AllowBringYourOwnPublicIpAddress --query properties.state + ``` + +3. **The output should show:** + "Registered" + +4. **Once the feature is registered, refresh the provider:** + + ```bash + az provider register --namespace Microsoft.Network + ``` + + 💡 Note: Feature registration may take several minutes to complete. This needs to be done only once per Azure subscription. + +## Steps to avoid `ResourceGroupNotFound` Error + +Before starting the deployment, ensure that the target resource group exists in your Azure subscription. Here are the steps to verify. + +### Steps + +1. Go to [Azure Portal](https:/portal.azure.com/#home). + +2. Click on the **"Resource groups"** option available on the Azure portal home page. +![alt text](../docs/images/AzureHomePage.png) + + +3. In the Resource Groups search bar, search for the resource group you intend to target for deployment. If it exists, you can proceed with using it. +![alt text](../docs/images/resourcegroup1.png) + + 💡 Note: If you encounter any other issues, please feel free to reach out to us. Thank you! + + diff --git a/docs/images/AzureHomePage.png b/docs/images/AzureHomePage.png new file mode 100644 index 000000000..4a0f8bdf7 Binary files /dev/null and b/docs/images/AzureHomePage.png differ diff --git a/docs/images/resourcegroup1.png b/docs/images/resourcegroup1.png new file mode 100644 index 000000000..d784b7202 Binary files /dev/null and b/docs/images/resourcegroup1.png differ