How to Set Custom Docker Network Name in .NET Aspire Publish?

[benreisinger]

I'm using the latest version of .NET Aspire 9.2 with the new Aspire.Hosting.Docker and deploying multiple applications to the same server using aspire publish. I've noticed that each generated Docker Compose file assigns containers to a default network named aspire.​ ("aspire")

This becomes problematic when deploying multiple applications, as they all share the same network name, leading to potential conflicts.​

Question:
Is there a way to specify a custom Docker network name during the aspire publish process? Something like .WithNetwork("")

Example:
builder.AddDockerComposePublisher()
.WithNetworkName("my_custom_network");

Would implementing this approach ensure that each application's containers are assigned to a unique Docker network, thereby preventing conflicts when multiple applications are deployed on the same server?​

I'm looking for a solution that integrates seamlessly with the aspire publish workflow, without requiring manual edits to the generated Docker Compose files.​

Any guidance or best practices on this matter would be greatly appreciated.​

Thank you!

[davidfowl]

It's not possible in 9.2 (we're still super early!). Some changes just went into 9.3 to allow mutating the compose service after it's been built.

Thanks for using the feature and leaving this feedback!

[davidfowl]

#8845

@maddymontaquila would love to chat with you about using docker compose with aspire and your experience (not matter how rough it is).

[benreisinger]

Sure, mail is in my profile. :-) @maddymontaquila

[benreisinger]

Also: Why is the value of .WithContainerName() ignored when publishing? Is this intended?

[davidfowl]

Oversight. Some of the annotations expressed in the app model are high fidelity and a 1:1 translation to docker compose, others need to be transformed. If you find ones (like container name), that aren’t being handled and you are trying to use it, file an issue

[benreisinger]

Issue 8862

[davidfowl]

@benreisinger in 9.2 it's possible to use

builder.AddDockerComposePublisher(o => o.ExistingNetworkName= "xx");

[benreisinger]

Thank you @davidfowl. Currently, this setting places all created services and containers into the same network. However, in certain scenarios, this approach might be too broad. For example, the reverse proxy should ideally have access only to the ASP project and not directly to other containers like the database. Introducing a per-project or per-resource configuration could provide more control over the exposure.

[davidfowl]

We don’t attempt to do anything that granular by default in the app model. In 9.3 you get control over the compose file and the service

[POORIANSARI]

@davidfowl
"We don’t attempt to do anything that granular by default in the app model. In 9.3 you get control over the compose file and the service"

Do we have it now?

[davidfowl]

Yes and we're at 9.4 now 😄

https://learn.microsoft.com/en-us/dotnet/aspire/whats-new/dotnet-aspire-9.3#-customize-the-compose-file-and-service-definitions