chore: improve deployment scripts and guides

Author: christianacca

docs/add-application.md

@@ -6,8 +6,9 @@
   * [4. Add initial azure container app definition to infra-as-code bicep](#4-add-initial-azure-container-app-definition-to-infra-as-code-bicep)
   * [5. Adjust infra-as-code provisioning scripts](#5-adjust-infra-as-code-provisioning-scripts)
   * [6. Adjust dev deploy script to deploy new azure container app](#6-adjust-dev-deploy-script-to-deploy-new-azure-container-app)
-  * [7. Add app to the solution's CI/CD pipeline](#7-add-app-to-the-solutions-cicd-pipeline)
-  * [8. Implement custom domain for the new app](#8-implement-custom-domain-for-the-new-app)
+  * [7. Update dev setup guide](#7-update-dev-setup-guide)
+  * [8. Add app to the solution's CI/CD pipeline](#8-add-app-to-the-solutions-cicd-pipeline)
+  * [9. Implement custom domain for the new app](#9-implement-custom-domain-for-the-new-app)
 <!-- TOC -->
 
 # Instructions for adding a new application to the solution
@@ -103,7 +104,7 @@ for "inner-loop" development.
    add file named Dockerfile to the root of the new project with the following definition:
 
    ```yaml
-   FROM mcr.microsoft.com/dotnet/aspnet:8.0-noble-chiseled-extra # <- change '8.0' to the version of the .net you are targeting
+   FROM mcr.microsoft.com/dotnet/aspnet:8.0-noble-chiseled-extra
    #EXPOSE 8080 <- this is the default port that a .net 8+ application will be configured to listen on and is the port exposed in the base docker image
    
    WORKDIR /app
@@ -151,11 +152,12 @@ for "inner-loop" development.
 
    ```pwsh
    $dev = ./tools/infrastructure/get-product-conventions.ps1 -EnvironmentName dev -AsHashtable
+   $subProductName = 'App'
    @{
-     App = $dev.SubProducts.App
-     AppAvailabilityTest = $dev.SubProducts.AppAvailabilityTest
-     AppTrafficManager = $dev.SubProducts.AppTrafficManager
-   } | ConvertTo-Json
+     ContainerApp = $dev.SubProducts[$subProductName]
+     AvailabilityTest = $dev.SubProducts["$($subProductName)AvailabilityTest"]
+     TrafficManager = $dev.SubProducts["$($subProductName)TrafficManager"]
+   } | ConvertTo-Json -Depth 100
     ```
 
 
@@ -164,8 +166,8 @@ for "inner-loop" development.
 1. Add new parameters to the [main.bicep](../tools/infrastructure/arm-templates/main.bicep) file:
 
    ```bicep
-   param appPrimaryExists bool = true
    param appFailoverExists bool = true
+   param appPrimaryExists bool = true
    ```
 
    Name these parameters with a prefix to match the new app name. For example if your app was named `Template.Web`, then
@@ -332,9 +334,16 @@ Extend [provision-azure-resources.ps1](../tools/infrastructure/provision-azure-r
    
       * When prompted for build number, enter the same value you provided above when building the solution
 
-   3. Test that it worked by browsing to the "App health Url" printed to the console
+   3. Test that it worked by browsing to the "App Url" printed to the console
+
+## 7. Update dev setup guide
+
+Add a section to the [dev-setup.md](../docs/dev-setup.md) guide to explain how to configure and run new app for local 
+development.
+
+For an example section to add, see [dev-setup.md](../docs/dev-setup.md#app)
 
-## 7. Add app to the solution's CI/CD pipeline
+## 8. Add app to the solution's CI/CD pipeline
 
 1. Modify the 'Map variables' step in the [__Application Deployment](../.github/workflows/__app-deploy.yml) github workflow 
    to include the variables required for the new app. At minimum this will be:
@@ -382,7 +391,7 @@ Extend [provision-azure-resources.ps1](../tools/infrastructure/provision-azure-r
    3. Manually run the [Application CI/CD](../.github/workflows/app-ci-cd.yml) github workflow selecting the PR branch
       * This will execute the deployment steps for the new app
 
-## 8. Implement custom domain for the new app
+## 9. Implement custom domain for the new app
 
 1. Create DNS records for the new app
 

docs/deploy-app.md

@@ -27,7 +27,6 @@
   * [Troubleshooting `provision-azure-resources.ps1`](#troubleshooting-provision-azure-resourcesps1)
     * [Problem deploying SQL server](#problem-deploying-sql-server)
     * [Problem deploying one or more Entra-ID app registrations](#problem-deploying-one-or-more-entra-id-app-registrations)
-    * [Problem Activating initial container app](#problem-activating-initial-container-app)
 <!-- TOC -->
 
 ## Overview
@@ -490,7 +489,7 @@ In practice the only way to run these scripts from a dev machine is:
    ./tools/dev-scripts/deploy.ps1 -InfA Continue -Login -SubscriptionId xxxxxxxx-xxxx-xxxxxxxxx-xxxxxxxxxxxx
    ````
 7. Test that it worked:
-   * browse to the "Api health Url" printed to the console
+   * browse to the "Api Url" printed to the console
    * Import the postman [collection](../tests/postman/api.postman_collection.json) and [environment](../tests/postman/api-dev.postman_environment.json),
      change the baseUrl postman variable to the "Api Url" printed to the console. Run the requests in the collection
 
@@ -560,17 +559,3 @@ To resolve:
    * select the "Delete permanently" button
    * wait until the application is permanently deleted (might take up to a minute)
 5. retry the failing infrastructure workflow run
-
-### Problem Activating initial container app
-
-After successfully running `provision-azure-resources.ps1` for the first time for the environment, but before you have
-deployed the application that's hosted by the infrastructure (ie before running [deploy.ps1](../tools/dev-scripts/deploy.ps1) 
-or the git workflow [Application CI/CD](../.github/workflows/app-ci-cd.yml))), you will see that the container app has
-failed to start and in the "Revisions and issues" tab for the container it will show the error "Activation failed".
-
-This is expected behaviour right now due to the initial docker container image that is deployed to the container app
-during the initial infrastructure deployment. This initial docker image exposes port 80, but the container app is 
-configured expected to expose port 8080.
-
-This issue will be resolved when the application docker image is deployed to the container app.
-

tools/dev-scripts/deploy.ps1

@@ -106,7 +106,6 @@ process {
         Write-Host '******************* Summary: start ******************************'
         Write-Host "Api Url: https://$($apiAca.configuration.ingress.fqdn)" -ForegroundColor Yellow
         Write-Host "App Url: https://$($appAca.configuration.ingress.fqdn)" -ForegroundColor Yellow
-        Write-Host "Api Health Url: https://$($apiAca.configuration.ingress.fqdn)/health" -ForegroundColor Yellow
         Write-Host "Function App Url: https://$($funcApp.HostName)" -ForegroundColor Yellow
         Write-Host "Azure SQL Public Url: https://$($convention.SubProducts.Sql.Primary.ResourceName).database.windows.net:1433" -ForegroundColor Yellow
         Write-Host '******************* Summary: end ********************************'

tools/infrastructure/arm-templates/api.bicep

@@ -4,7 +4,7 @@ param sharedSettings sharedSettingsType
 
 var location = instanceSettings.ResourceLocation
 
-var initialAppImage = 'mcr.microsoft.com/azuredocs/containerapps-helloworld:latest'
+var initialAppImage = 'mcr.microsoft.com/dotnet/samples:aspnetapp'
 var appImage = exists ? existingApp.properties.template.containers[0].image : initialAppImage
 // initial image does not define a http health endpoint at the path we want for our image, therefore for a reasonable
 // default exerience when creating the container app for the first time fallback to defaults that container-apps will configure