Skip to main content

Enabling .NET Aspire for an existing solution

I hope that you already had a change to try .NET Aspire, a comprehensive set of tools, templates, and packages designed to help developers build observable, production-ready applications. It enhances the development experience by providing dev-time orchestration, integrations with commonly used services, and robust tooling support. .The goal is to simplify the management of multi-project applications, container resources, and other dependencies, making it easier to develop interconnected apps.

To make it even better, it includes features like service discovery, connection string management, and environment variable configuration, streamlining the setup process for local development environments.

And if that couldn’t convince you yet, than maybe the Aspire Dashboard will.

Sounds great right? Reason enough to add it to your existing projects if you are not using it yet. A great tutorial exists on Microsoft Learn to help you add it to your existing projects. Unfortunately I had a little bit more trouble when trying to add it to an existing solution. In this post I want to share some of the issues I encountered when enabling .NET Aspire.

Adding .NET Aspire

Before we dive in, let me first share some details about the application involved. The solution contains 3 projects:

  • One (older) ASP.NET Core application that I upgraded to .NET 9 but was still using the old Startup.cs experience.
  • One (newer) ASP.NET Core application that was using the Minimal API approach.
  • One .NET console application that was hosting a WorkerService.

Ok, let’s get started!

  • I right click on the first project(the ASP.NET Core project using Startup.cs) and choose Add –> .NET Aspire Orchestrator Support…

  • I get a popup mentioning that 2 projects will be added to my solution. I can change the Project name prefix and location but I’m happy with the defaults so I click OK.

  • Whoops! I got an error saying that it couldn’t find a call to methods Build in the program main.

  • When I take a look at the solution however I noticed that the 2 Aspire related projects were added to the solution and that my project was added.
  • OK. Let’s try to build the project. That failed with 2 NuGet related errors. I forgot to mention that I’m using NuGet Central package management. Unfortunately the Add Aspire wizard didn’t take this into account and wrongfully added the nuget packages in the specific project files.

 

  • I manually fixed it by adding the packages myself to the Central Package Management and removing the version reference from the csproj files.

 

  • Now it’s time to add a second project. I right click on the project(the ASP.NET Core Minimal API) and choose Add –> .NET Aspire Orchestrator Support… again.

  • This time I get a message that an .NET Aspire Orchestrator project already exists and that Visual Studio will update it. Sounds fine to me! So I click OK.
  • That worked. Great!

  • Let’s do this one last time, but now for the .NET Console Application. I right click on the the project choose Add –> .NET Aspire Orchestrator Support… again.

  • I got the same message that an .NET Aspire Orchestrator project already exists. I click OK.

  • Whoops! This time he complains that he cannot find any of the Create…Builder methods.

  • However when I checked the .NET Aspire project, I noticed that the Worker project was successfully added.

The most important impact of those errors was that the default middleware (like Service Discovery, etc…) couldn’t be added automatically but the AppHost itself worked fine.

More information

.NET Aspire overview - .NET Aspire | Microsoft Learn

Add .NET Aspire to an existing .NET app - .NET Aspire | Microsoft Learn

Labels:

Popular posts from this blog

.NET 8–Keyed/Named Services

A feature that a lot of IoC container libraries support but that was missing in the default DI container provided by Microsoft is the support for Keyed or Named Services. This feature allows you to register the same type multiple times using different names, allowing you to resolve a specific instance based on the circumstances. Although there is some controversy if supporting this feature is a good idea or not, it certainly can be handy. To support this feature a new interface IKeyedServiceProvider got introduced in .NET 8 providing 2 new methods on our ServiceProvider instance: object? GetKeyedService(Type serviceType, object? serviceKey); object GetRequiredKeyedService(Type serviceType, object? serviceKey); To use it, we need to register our service using one of the new extension methods: Resolving the service can be done either through the FromKeyedServices attribute: or by injecting the IKeyedServiceProvider interface and calling the GetRequiredKeyedServic...
Read more

Azure DevOps/ GitHub emoji

I’m really bad at remembering emoji’s. So here is cheat sheet with all emoji’s that can be used in tools that support the github emoji markdown markup: All credits go to rcaviers who created this list.
Read more

Kubernetes–Limit your environmental impact

Reducing the carbon footprint and CO2 emission of our (cloud) workloads, is a responsibility of all of us. If you are running a Kubernetes cluster, have a look at Kube-Green . kube-green is a simple Kubernetes operator that automatically shuts down (some of) your pods when you don't need them. A single pod produces about 11 Kg CO2eq per year( here the calculation). Reason enough to give it a try! Installing kube-green in your cluster The easiest way to install the operator in your cluster is through kubectl. We first need to install a cert-manager: kubectl apply -f https://github.com/cert-manager/cert-manager/releases/download/v1.14.5/cert-manager.yaml Remark: Wait a minute before you continue as it can take some time before the cert-manager is up & running inside your cluster. Now we can install the kube-green operator: kubectl apply -f https://github.com/kube-green/kube-green/releases/latest/download/kube-green.yaml Now in the namespace where we want t...
Read more