Aspire Hosting

Quartz.Aspire.Hosting is the Quartz.NET hosting integration for Aspire (4.8): an AppHost resource that runs the dashboard host's image beside your workers. It shows every scheduler in a database, and the schedulers of the workers that dial in as agents.

dotnet add package Quartz.Aspire.Hosting

In the AppHost project. The workers keep Quartz.Aspire, the client integration, for their store.

Usage

var builder = DistributedApplication.CreateBuilder(args);

var quartzDb = builder.AddPostgres("postgres").AddDatabase("quartz");

var dashboard = builder.AddQuartzDashboard("quartz-dashboard")
    .WithAttachedStore(quartzDb);

builder.AddProject<Projects.Orders_Worker>("orders")
    .WithReference(quartzDb)
    .WithReference(dashboard);

builder.Build().Run();

The worker dials in with UseDashboardAgent(), which reads what WithReference(dashboard) sets:

HostApplicationBuilder builder = Host.CreateApplicationBuilder(args);

builder.AddQuartz(q =>
{
    // Endpoint, Token and Target come from Quartz:DashboardAgent - an Aspire AppHost's
    // WithReference(dashboard) sets them as Quartz__DashboardAgent__* environment variables.
    q.UseDashboardAgent();
});

builder.AddQuartzHostedService();

Open the resource's URL in the Aspire dashboard: it signs the browser in as an administrator.

• Choose one per scheduler. WithAttachedStore shows every scheduler in the database, read from its tables; WithReference(dashboard) shows the worker's scheduler through the worker. A scheduler reached both ways is listed twice.
• An agent is driven through its worker: starting, standing by, interrupting and the live events work. A store-attached scheduler is read from the database; see What a window can and cannot do.

The calls

QuartzAttachedStoreSettings, the configure callback's argument, says what the nodes writing the database were configured with: Provider (inferred when unset), TablePrefix, Serializer, ExecutionHistory and RediscoveryInterval. Each is the store-attached target key of the same name.

• A target name is one scheduler's. A second store or agent under a name the dashboard already has throws while the AppHost is built.
• schedulerName is for a worker with several named schedulers: it writes that scheduler's own section, Quartz__Schedulers__{schedulerName}__DashboardAgent__*.

Tokens and the sign-in link

• Generated values are kept in the AppHost's user secrets, under Parameters:{name}-admin-token. Set one there, or pass a parameter of your own as adminToken or agentToken, to choose it.
• The resource's URL is /login?t=<admin token>. The resource sets AllowTokenInUrl on the dashboard; nothing else does. The dashboard moves the browser on to an address without the token.

The environment it writes

These keys are the contract between this package and the two programs. The package references nothing of Quartz.

The image

The image is ghcr.io/quartznet/quartz-dashboard at this package's version, so the two are released together. A build of the package that is not a release runs a tag that does not exist; give it one with .WithImageTag("4.8.0").

Limitations

• One dashboard replica. It holds its agents' connections in memory; WithReplicas(n) above one splits them between replicas.
• A worker with replicas is shown one replica at a time. Every replica registers under the same target, and the dashboard holds a target for one scheduler instance: the others are refused until it leaves. For a replicated worker, cluster its store and use WithAttachedStore, which shows the cluster and every node in it.
• Store-attached schedulers show Quartz's own job data types; see Dashboard Host.
• net10.0, like every Quartz 4 package.