How to exclude a service from a docker compose environment?

[sliekens]

Hey, I'm updating to Aspire 9.3 to replace my handcrafted docker-compose.yaml with a generated one,

Q: how do I configure the publisher to ignore Seq, which is deployed out-of-band? I've excluded it from the manifest, but the publisher still tries to process it.

var builder = DistributedApplication.CreateBuilder(args);

builder.AddDockerComposeEnvironment("docker-compose");

var seq = builder.AddSeq("seq")
    .WithLifetime(ContainerLifetime.Persistent)
    .ExcludeFromManifest();

builder.AddProject<Projects.WebApp>("webapp")
    .WithReference(seq)
    .PublishAsDockerComposeService((resource, service) =>
    {
        service.ContainerName = "webapp";
    });

I think the publisher still attempts to create a seq entry but then fails because of the ExcludeFromManifest, as removing that line makes the error go away (and I end up with seq in the final docker-compose.yaml, which is not desired).

$ dotnet aspire publish
...
info: Aspire.Hosting.DistributedApplication[0]
      Aspire version: 9.3.0+f76a033601ade4a17a422d5d1e4d004ab85e5179
info: Aspire.Hosting.Publishing.Publisher[807050189]
      Generating Compose output
fail: Aspire.Hosting.DistributedApplicationRunner[0]
      Failed to publish the distributed application.
      System.Collections.Generic.KeyNotFoundException: The given key 'Aspire.Hosting.ApplicationModel.SeqResource' was not 
present in the dictionary.
         at System.Collections.Generic.Dictionary`2.get_Item(TKey key)
         at DockerComposeServiceResourceExtensions.ProcessValue(DockerComposeServiceResource resource, Object value) in 
/_/src/Aspire.Hosting.Docker/DockerComposeServiceResourceExtensions.cs:line 50
         at DockerComposeServiceResourceExtensions.ProcessValue(DockerComposeServiceResource resource, Object value) in 
/_/src/Aspire.Hosting.Docker/DockerComposeServiceResourceExtensions.cs:line 63
         at Aspire.Hosting.Docker.DockerComposeServiceResource.AddEnvironmentVariablesAndCommandLineArgs(Service 
composeService) in /_/src/Aspire.Hosting.Docker/DockerComposeServiceResource.cs:line 167
         at Aspire.Hosting.Docker.DockerComposeServiceResource.BuildComposeService() in 
/_/src/Aspire.Hosting.Docker/DockerComposeServiceResource.cs:line 79
         at Aspire.Hosting.Docker.DockerComposePublishingContext.WriteDockerComposeOutputAsync(DistributedApplicationModel 
model, DockerComposeEnvironmentResource environment) in /_/src/Aspire.Hosting.Docker/DockerComposePublishingContext.cs:line 77
         at Aspire.Hosting.Docker.DockerComposePublishingContext.WriteModelAsync(DistributedApplicationModel model, 
DockerComposeEnvironmentResource environment) in /_/src/Aspire.Hosting.Docker/DockerComposePublishingContext.cs:line 52
         at Aspire.Hosting.ApplicationModel.PublishingContext.WriteModelAsync(DistributedApplicationModel model) in 
/_/src/Aspire.Hosting/Publishing/PublishingContext.cs:line 68
         at Aspire.Hosting.DistributedApplicationRunner.ExecuteAsync(CancellationToken stoppingToken) in 
/_/src/Aspire.Hosting/DistributedApplicationRunner.cs:line 46

[davidfowl]

You don't want to remove seq in publish mode, you just want to change how it's expressed.

var builder = DistributedApplication.CreateBuilder(args);

builder.AddDockerComposeEnvironment("docker-compose");

var seq = builder.ExecutionContext.IsPublishMode 
   ? builder.AddConnectionString("seq") 
   : builder.AddSeq("seq").WithLifetime(ContainerLifetime.Persistent);

builder.AddProject<Projects.WebApp>("webapp")
    .WithReference(seq)
    .PublishAsDockerComposeService((resource, service) =>
    {
        service.ContainerName = "webapp";
    });

[sliekens]

Thanks David, I hadn't discovered ExecutionContect.IsPublishMode, that looks perfect for solving this kind of problem.

In this particular case, I'm not really sure what the format of the connection string is. The docs for Aspire.Hosting.Seq don't mention the possibility of using "ConnectionStrings:Seq" but instead talks about configuring "Aspire:Seq:ServerUrl". So, I'm still fiddling with this, still unsure what is the right way to do this.

[davidfowl]

Ah seq does look different from the other integrations as it doesn't expose a connection string, it's just a url. We don't have a good primitive here like a connection string. There's also no common type for this (yet) so it'll be slightly ugly:

var builder = DistributedApplication.CreateBuilder(args);

builder.AddDockerComposeEnvironment("docker-compose");

var webApp = builder.AddProject<Projects.WebApp>("webapp")
    .PublishAsDockerComposeService((resource, service) =>
    {
        service.ContainerName = "webapp";
    });

if (builder.ExecutionContext.IsPublishMode)
{
   webApp.WithEnvironment("Aspire__Seq__Url", builder.AddParameter("seq"));
}
else
{
   var seq = builder.AddSeq("seq").WithLifetime(ContainerLifetime.Persistent);
   webApp.WithReference(seq);
}

[sliekens]

It does seem that your first answer is also valid, because the client integration assigns it to SeqSettings.ServerUrl, this behavior is just not documented. But then I guess I still have to do something similar to your second answer for configuring my production Aspire__Seq__ApiKey.

aspire/src/Components/Aspire.Seq/AspireSeqExtensions.cs

Lines 48 to 51 in ff68c9c

	if (builder.Configuration.GetConnectionString(connectionName) is string connectionString)
	{
	settings.ServerUrl = connectionString;
	}

[davidfowl]

If the client integration supports both things then it'll work in production with the original configuration as well.