✨ deploy to azure from aspire (#539)

* Added the ability to deploy to app service, azure sql, and app insights on azure.

* 📖 Update README with Azure deployment instructions

* 📖 Update README for improved Azure deployment instructions formatting

* Use github markdown for notes

* Fixed up formatting

* Fixed integration tests

* Remove commented-out SqlServer package reference from AppHost.csproj

* Refactor environment variable handling in Azure App Service configuration

Author: danielmackay

Directory.Packages.props

@@ -5,6 +5,9 @@
   <ItemGroup>
     <PackageVersion Include="Ardalis.Specification" Version="9.2.0"/>
     <PackageVersion Include="Ardalis.Specification.EntityFrameworkCore" Version="9.2.0"/>
+    <PackageVersion Include="Aspire.Hosting.Azure.ApplicationInsights" Version="9.4.0"/>
+    <PackageVersion Include="Aspire.Hosting.Azure.AppService" Version="9.4.0-preview.1.25378.8"/>
+    <PackageVersion Include="Aspire.Hosting.Azure.Sql" Version="9.4.0"/>
     <PackageVersion Include="AspNetCore.HealthChecks.SqlServer" Version="9.0.0" />
     <PackageVersion Include="AspNetCore.HealthChecks.UI" Version="9.0.0" />
     <PackageVersion Include="AspNetCore.HealthChecks.UI.Client" Version="9.0.0" />

README.md

@@ -109,29 +109,32 @@ This is a template for creating a new project using [Clean Architecture](https:/
 
 1. Install the SSW CA template
 
-```bash
-dotnet new install SSW.CleanArchitecture.Template
-```
-
-> NOTE: The template only needs to be installed once. Running this command again will update your version of the template.
+    ```bash
+    dotnet new install SSW.CleanArchitecture.Template
+    ```
+    
+> [!NOTE]
+> The template only needs to be installed once. Running this command again will update your version of the template.
 
 2. Create a new directory
 
-```bash
-mkdir Northwind365
-cd Northwind365
-```
+    ```bash
+    mkdir Northwind365
+    cd Northwind365
+    ```
 
 3. Create a new solution
 
-```bash
-dotnet new ssw-ca
-```
+    ```bash
+    dotnet new ssw-ca
+    ```
 
-> NOTE: `name` is optional; if you don't specify it, the directory name will be used as the solution name and project namespaces.
+> [!NOTE]
+> `name` is optional; if you don't specify it, the directory name will be used as the solution name and project namespaces.
 
-Alternatively, you can specify the `name` and `output` directory as follows:
 
+Alternatively, you can specify the `name` and `output` directory as follows:
+    
 ```bash
 dotnet new ssw-ca --name {{SolutionName}} --output .\
 ```
@@ -140,21 +143,21 @@ dotnet new ssw-ca --name {{SolutionName}} --output .\
 
 1. Create a query
 
-```bash
-cd src/Application/UseCases
-mkdir {{FeatureName}}
-cd {{FeatureName}}
-dotnet new ssw-ca-query --name {{QueryName}} --entityName {{Entity}} --slnName {{SolutionName}}
-```
+    ```bash
+    cd src/Application/UseCases
+    mkdir {{FeatureName}}
+    cd {{FeatureName}}
+    dotnet new ssw-ca-query --name {{QueryName}} --entityName {{Entity}} --slnName {{SolutionName}}
+    ```
 
 2. Create a command
 
-```bash
-cd src/Application/UseCases
-mkdir {{FeatureName}}
-cd {{FeatureName}}
-dotnet new ssw-ca-command --name {{CommandName}} --entityName {{Entity}} --slnName {{SolutionName}}
-```
+    ```bash
+    cd src/Application/UseCases
+    mkdir {{FeatureName}}
+    cd {{FeatureName}}
+    dotnet new ssw-ca-command --name {{CommandName}} --entityName {{Entity}} --slnName {{SolutionName}}
+    ```
 
 ### Running the Solution
 
@@ -176,9 +179,52 @@ dotnet new ssw-ca-command --name {{CommandName}} --entityName {{Entity}} --slnNa
     dotnet run
     ```
 
-> **NOTE:** The first time you run the solution, it may take a while to download the docker images, create the DB, and seed the data.
+> [!NOTE]
+> The first time you run the solution, it may take a while to download the docker images, create the DB, and seed the data.
+
+3. Open https://localhost:7255/scalar/v1 in your browser to see it running ️🏃‍♂️
+
+## Deploying to Azure
+
+The template can be deployed to Azure via
+the [Azure Developer CLI (AZD)](https://learn.microsoft.com/en-us/azure/developer/azure-developer-cli/install-azd?tabs=winget-windows,brew-mac,script-linux&pivots=os-mac).
+This will setup the following:
+
+- Azure App Services: API + MigrationService
+- Azure SQL Server + Database: Data storage
+- Application Insights + Log Analytics: For monitoring and logging
+- Managed Identities: For secure access to Azure resources
+- Azure Container Registry: For storing Docker images
+
+### Steps to Deploy
+
+1. Authenticate with Azure
+
+    ```bash
+    azd auth login
+    ```
+
+2. Initialize AZD for the project
+
+    ```bash
+    azd init
+    ```
+
+3. Update environment variables
+
+    ```bash
+    azd env set ASPNETCORE_ENVIRONMENT Development
+    ```
+
+4. Deploy to Azure
+
+    ```bash
+    azd up
+    ```
 
-4. Open https://localhost:7255/scalar/v1 in your browser to see it running ️🏃‍♂️
+> [!NOTE]
+> `azd up` combines `azd provision` and `azd deploy` commands to create the resources and deploy the application. If running this from a CI/CD
+> pipeline, you can use `azd provision` and `azd deploy` separately in the appropriate places.
 
 ## 🚀 Publishing Template
 
@@ -191,7 +237,8 @@ Template will be published to NuGet.org when changes are made to `CleanArchitect
 3. `package` GitHub Action will run and publish the new version to NuGet.org
 4. Create a GitHub release to document the changes
 
-> **NOTE:** We are now using CalVer for versioning. The version number should be in the format `YYYY.M.D` (e.g. `2024.2.12`).
+> [!NOTE]
+> We are now using CalVer for versioning. The version number should be in the format `YYYY.M.D` (e.g. `2024.2.12`).
 
 <!-- TODO Issue #99: Getting Started using the dotnet new template -->
 

src/Infrastructure/DependencyInjection.cs

@@ -11,7 +11,7 @@ public static class DependencyInjection
 {
     public static void AddInfrastructure(this IHostApplicationBuilder builder)
     {
-        builder.AddSqlServerDbContext<ApplicationDbContext>("Clean-Architecture",
+        builder.AddSqlServerDbContext<ApplicationDbContext>("CleanArchitecture",
             null,
             options =>
             {

tests/WebApi.IntegrationTests/Common/Infrastructure/Web/WebApiTestFactory.cs

@@ -29,6 +29,6 @@ protected override void ConfigureWebHost(IWebHostBuilder builder)
             // x.Services.AddSingleton<ILoggerProvider>(new XUnitLoggerProvider(Output));
         });
 
-        builder.UseSetting("ConnectionStrings:clean-architecture", _dbConnection.ConnectionString);
+        builder.UseSetting("ConnectionStrings:CleanArchitecture", _dbConnection.ConnectionString);
     }
 }

tools/AppHost/AppHost.cs

@@ -1,25 +1,71 @@
 using AppHost.Commands;
+using Azure.Provisioning;
+using Azure.Provisioning.AppService;
 using Projects;
 
 var builder = DistributedApplication.CreateBuilder(args);
 
+// Configure the Azure App Service environment
+builder.AddAzureAppServiceEnvironment("plan").ConfigureInfrastructure(infra =>
+{
+    var plan = infra.GetProvisionableResources()
+        .OfType<AppServicePlan>()
+        .Single();
+
+    plan.Sku = new AppServiceSkuDescription
+    {
+        Name = "B1", // Basic tier, 1 core
+    };
+});
+
 var sqlServer = builder
-    // If desired, set SQL Server Port to a constant value
-    .AddSqlServer("sql" /*, port: 1800*/)
-    .WithLifetime(ContainerLifetime.Persistent);
+    .AddAzureSqlServer("sql")
+    .RunAsContainer(container =>
+    {
+        // Configure SQL Server to run locally as a container
+        container.WithLifetime(ContainerLifetime.Persistent);
+
+        // If desired, set SQL Server Port to a constant value
+        //container.WithHostPort(1800);
+    });
 
 var db = sqlServer
-    .AddDatabase("clean-architecture")
+    .AddDatabase("CleanArchitecture", "clean-architecture")
     .WithDropDatabaseCommand();
 
 var migrationService = builder.AddProject<MigrationService>("migrations")
+    .PublishAsAzureAppServiceWebsite((_, site) =>
+    {
+        const string envNetCoreEnvironment = "ASPNETCORE_ENVIRONMENT";
+
+        // Needed for hosted service to run
+        site.SiteConfig.IsAlwaysOn = true;
+
+        // Dynamically set environment, so we can enable seeding of data (only happens in 'development')
+        var environment = Environment.GetEnvironmentVariable(envNetCoreEnvironment);
+        if (string.IsNullOrWhiteSpace(environment))
+            return;
+
+        var envSetting = new AppServiceNameValuePair { Name = envNetCoreEnvironment, Value = environment };
+        site.SiteConfig.AppSettings.Add(new BicepValue<AppServiceNameValuePair>(envSetting));
+    })
     .WithReference(db)
     .WaitFor(sqlServer);
 
-builder
+var api = builder
     .AddProject<WebApi>("api")
     .WithExternalHttpEndpoints()
     .WithReference(db)
     .WaitForCompletion(migrationService);
 
+// Configure Application Insights and Log Analytics only if in publish mode
+// When running locally, use Aspire Dashboard instead
+if (builder.ExecutionContext.IsPublishMode)
+{
+    var logAnalytics = builder.AddAzureLogAnalyticsWorkspace("log-analytics");
+    var insights = builder.AddAzureApplicationInsights("insights", logAnalytics);
+    api.WithReference(insights);
+    migrationService.WithReference(insights);
+}
+
 builder.Build().Run();

tools/AppHost/AppHost.csproj

@@ -10,7 +10,9 @@
 
   <ItemGroup>
     <PackageReference Include="Aspire.Hosting.AppHost" />
-    <PackageReference Include="Aspire.Hosting.SqlServer" />
+    <PackageReference Include="Aspire.Hosting.Azure.ApplicationInsights"/>
+    <PackageReference Include="Aspire.Hosting.Azure.AppService"/>
+    <PackageReference Include="Aspire.Hosting.Azure.Sql"/>
     <PackageReference Include="Microsoft.EntityFrameworkCore.SqlServer" />
   </ItemGroup>
 

tools/AppHost/Commands/SqlServerCommandExt.cs

@@ -1,13 +1,12 @@
+using Aspire.Hosting.Azure;
 using Microsoft.EntityFrameworkCore;
-using Microsoft.Extensions.Diagnostics.HealthChecks;
-using SqlServerDatabaseResource = Aspire.Hosting.ApplicationModel.SqlServerDatabaseResource;
 
 namespace AppHost.Commands;
 
 public static class SqlServerDatabaseCommandExt
 {
-    public static IResourceBuilder<SqlServerDatabaseResource> WithDropDatabaseCommand(
-        this IResourceBuilder<SqlServerDatabaseResource> builder)
+    public static IResourceBuilder<AzureSqlDatabaseResource> WithDropDatabaseCommand(
+        this IResourceBuilder<AzureSqlDatabaseResource> builder)
     {
         builder.WithCommand(
             "drop-database",
@@ -25,6 +24,7 @@ public static IResourceBuilder<SqlServerDatabaseResource> WithDropDatabaseComman
                 return CommandResults.Success();
             },
             null); // Intentionally using 'null' for the command state resolver as this command does not require health status checks. Downstream code is expected to handle 'null' appropriately.
+
         return builder;
     }
 }

tools/MigrationService/Program.cs

@@ -19,7 +19,7 @@
 builder.Services.AddScoped<ICurrentUserService, MigrationUserService>();
 builder.Services.AddSingleton(TimeProvider.System);
 
-builder.AddSqlServerDbContext<ApplicationDbContext>("Clean-Architecture",
+builder.AddSqlServerDbContext<ApplicationDbContext>("CleanArchitecture",
     null,
     options =>
     {