Configure Rust apps in the AppHost

Цей контент ще не доступний вашою мовою.

⭐ Community Toolkit

This reference describes the Community Toolkit Rust hosting integration. If you are new to it, begin with Get started with the Rust integration.

Install the package

C#
TypeScript

aspire add communitytoolkit-rust

Or add 📦 CommunityToolkit.Aspire.Hosting.Rust to the AppHost project.

aspire add communitytoolkit-rust

This adds the package to aspire.config.json and generates the TypeScript AppHost module.

Add a Cargo app

AddRustApp / addRustApp starts cargo run in the supplied working directory. The path is resolved relative to the AppHost directory, so it normally contains the Rust project’s Cargo.toml.

C#
TypeScript

var builder = DistributedApplication.CreateBuilder(args);

var api = builder.AddRustApp("rust-api", "../rust-api");

builder.Build().Run();

import { createBuilder } from './.aspire/modules/aspire.mjs';

const builder = await createBuilder();

const api = await builder.addRustApp('rust-api', '../rust-api');

await builder.build().run();

Pass Cargo arguments and choose a working directory

The optional args are appended after cargo run. For example, --release produces cargo run --release; use -- before arguments intended for your Rust application. The working directory is normalized to the current platform after Aspire combines it with the AppHost directory.

C#
TypeScript

var builder = DistributedApplication.CreateBuilder(args);

var api = builder.AddRustApp(
    name: "rust-api",
    workingDirectory: "../rust-api",
    args: ["--release", "--", "--environment", "development"]);

builder.Build().Run();

import { createBuilder } from './.aspire/modules/aspire.mjs';

const builder = await createBuilder();

const api = await builder.addRustApp('rust-api', '../rust-api', [
  '--release',
  '--',
  '--environment',
  'development',
]);

await builder.build().run();

Add a Bacon app

AddBaconApp / addBaconApp runs the Bacon CLI from the working directory. Without arguments it runs bacon run; supply args to use another Bacon command.

C#
TypeScript

var builder = DistributedApplication.CreateBuilder(args);

var checks = builder.AddBaconApp(
    name: "rust-checks",
    workingDirectory: "../rust-api",
    args: ["check"]);

builder.Build().Run();

import { createBuilder } from './.aspire/modules/aspire.mjs';

const builder = await createBuilder();

const checks = await builder.addBaconApp('rust-checks', '../rust-api', [
  'check',
]);

await builder.build().run();

Configure endpoints, environment, and health checks

Rust app resources support standard executable-resource configuration. Use WithHttpEndpoint / withHttpEndpoint to allocate a port and put it in an environment variable that the application reads. Use WithHttpHealthCheck / withHttpHealthCheck when the application exposes an HTTP health endpoint. WithExternalHttpEndpoints / withExternalHttpEndpoints makes an HTTP endpoint externally accessible.

C#
TypeScript

var builder = DistributedApplication.CreateBuilder(args);

var api = builder.AddRustApp("rust-api", "../rust-api")
    .WithEnvironment("RUST_LOG", "info")
    .WithHttpEndpoint(port: 8080, env: "PORT")
    .WithExternalHttpEndpoints()
    .WithHttpHealthCheck("/health");

builder.Build().Run();

import { createBuilder } from './.aspire/modules/aspire.mjs';

const builder = await createBuilder();

const api = await builder.addRustApp('rust-api', '../rust-api');
await api.withEnvironment('RUST_LOG', 'info');
await api.withHttpEndpoint({ port: 8080, env: 'PORT' });
await api.withExternalHttpEndpoints();
await api.withHttpHealthCheck({ path: '/health' });

await builder.build().run();

The integration configures the Rust app with the OpenTelemetry Protocol exporter. Add OpenTelemetry instrumentation to the Rust application to emit telemetry to Aspire. You can also use standard resource references to model dependencies and provide their configuration to the Rust process.

The dashboard exposes the standard executable-resource lifecycle actions and process logs. The integration doesn’t add Rust-specific dashboard commands.

Publish Rust apps

Both Cargo and Bacon app resources are configured as Dockerfile-published resources when they are added. During aspire publish, Aspire converts the executable resource to a container resource and uses the Rust app’s working directory as the Docker build context. Include a suitable Dockerfile there. The local Cargo or Bacon arguments are cleared for the containerized resource, so configure the Dockerfile with the command and arguments it needs.