ボリュームまたはバインドマウント .NET.NET Aspire 使用してプロジェクトデータを保持する

[アーティクル]
2025-04-16

.NET .NET Aspire プロジェクトを開始および停止するたびに、アプリはアプリリソースコンテナーも作成および破棄します。デバッグセッション中にこれらのコンテナーに格納されているデータまたはファイルは、後続のセッションでは失われます。多くの開発チームは、たとえば、実行ごとにサンプルデータをデータベースに再作成する必要がないように、デバッグセッション間でこのデータを保持することを好みます。

この記事では、アプリの起動時にデータを保持するように .NET.NET Aspire プロジェクトを構成する方法について説明します。ローカル開発中の継続的なデータセットは、多くのシナリオで役立ちます。 PostgreSQL、Redis、Azure Storage など、さまざまな.NET Aspireリソースコンテナーの種類でボリュームとバインドマウントを利用できます。

プロジェクトデータを保持するタイミング

データベースリソースを含む .NET.NET Aspire ソリューションがあるとします。既定では、データはそのリソースのコンテナーに保存されます。アプリを停止するとすべてのリソースコンテナーが破棄されるため、そのデータは失われ、次回ソリューションを実行したときには表示されません。このセットアップでは、テストまたはデバッグのためにアプリの起動間にデータベースまたはストレージサービスにデータを保持する場合に問題が発生します。たとえば、次のようなことをしてみてください。

複数の再起動にわたる拡張開発セッション中に、データベース内の継続的なデータセットを操作します。
Azure Blob Storage エミュレーターで変更されるファイルセットをテストまたはデバッグします。
アプリの起動間で、キャッシュされたデータまたはメッセージを Redis インスタンスに保持します。

ボリュームまたはバインドマウントを使用して、これらの目標を達成できます。これらのオブジェクトは、コンテナーの外部にあるデータをコンテナーホスト上のディレクトリに格納するため、コンテナーで破棄されません。この方法では、 .NET.NET Aspire プロジェクトの起動間にデータを保持するサービスを決定します。

注

ボリュームとバインドマウントは、コンテナーランタイムの機能 ( Docker または Podman) です。 .NET .NET Aspire には、これらの機能を簡単に操作できるようにするメソッドが含まれています。

ボリュームとバインドマウントを比較する

ボリュームとバインドマウントの両方で、コンテナーホスト上のディレクトリにデータが格納されます。このディレクトリはコンテナーの外部にあるため、コンテナーが停止してもデータは破棄されません。ただし、ボリュームとバインドマウントの動作は異なります。

ボリューム: コンテナーランタイムは、ボリュームを作成および制御します。ボリュームは、コンテナーホストのコア機能から分離されます。
バインドマウント: コンテナーランタイムは、ホストコンピューターにファイルまたはディレクトリをマウントします。コンテナーとホストマシンの両方が、バインドマウントの内容にアクセスできます。

ボリュームは、バインドマウントよりも安全で移植性が高いです。また、パフォーマンスも向上し、可能な限り使用する必要があります。バインドマウントは、ホストコンピューターからデータにアクセスまたは変更する必要がある場合にのみ使用します。

ボリュームを使用する

ボリュームは、コンテナーによって生成されたデータを保持するための推奨される方法であり、Windows と Linuxの両方でサポートされています。ボリュームは、一度に複数のコンテナーのデータを格納し、高いパフォーマンスを提供し、バックアップや移行が簡単です。 .NET .NET Aspireでは、次の 3 つのパラメーターを受け取る ContainerResourceBuilderExtensions.WithVolume メソッドを使用して、各リソースコンテナーのボリュームを構成します。

name: ボリュームのオプションの名前。
target: 保持するデータのコンテナー内のターゲットパス。
isReadOnly: ボリューム内のデータを変更できるかどうかを示すブール型フラグ。既定値は false です。

この記事の残りの部分では、分散アプリビルダービットが既に定義されている .NET.NET Aspireapp ホストプロジェクトでProgram クラスを調べることを想像してください。

var builder = DistributedApplication.CreateBuilder(args);

// TODO:
//   Consider various code snippets for configuring 
//   volumes here and persistent passwords.

builder.Build().Run();

考慮すべき最初のコードスニペットでは、ContainerResourceBuilderExtensions.WithVolume API を使用して、SQL Server リソースのボリュームを構成します。次のコードは、SQL Server アプリホストプロジェクトで .NET Aspire リソースのボリュームを構成する方法を示しています。

var sql = builder.AddSqlServer("sql")
                 .WithVolume(target: "/var/opt/mssql")
                 .AddDatabase("sqldb");

この例では、 /var/opt/mssql コンテナー内のデータベースファイルへのパスを設定します。

すべての .NET.NET Aspire コンテナーリソースはボリュームを利用でき、一部のリソースから派生した名前付きボリュームを追加するための便利な API が提供されます。 WithDataVolumeメソッドを例として使用すると、次のコードは機能的には前の例と同等ですが、より簡潔です。

var sql = builder.AddSqlServer("sql")
                 .WithDataVolume()
                 .AddDatabase("sqldb");

VolumeMount.AppHostという名前のアプリホストプロジェクトでは、WithDataVolume メソッドによって名前付きボリュームが VolumeMount.AppHost-sql-data として自動的に作成され、/var/opt/mssql コンテナー内の SQL Server パスにマウントされます。名前付け規則は次のとおりです。

{appHostProjectName}-{resourceName}-data: ボリューム名は、アプリホストプロジェクト名とリソース名から派生します。

バインドマウントを活用する

バインドマウントを使用すると、コンテナー内とホストコンピューター上のプロセスの両方からデータにアクセスできます。たとえば、バインドマウントが確立されたら、ホストコンピューター上のファイルをコピーできます。その後、ファイルは、リソースのコンテナー内のバインドされたパスで使用できます。 .NET .NET Aspireでは、次の 3 つのパラメーターを受け取る WithBindMount メソッドを使用して、各リソースコンテナーのバインドマウントを構成します。

source: コンテナーにマウントするホストコンピューター上のフォルダーへのパス。
target: フォルダーのコンテナー内のターゲットパス。
isReadOnly: バインドマウント内のデータを変更できるかどうかを示すブール型フラグ。既定値は false です。

WithBindMount API を使用して、SQL Server リソースのバインドマウントを構成する次のコードスニペットを考えてみましょう。

var sql = builder.AddSqlServer("sql")
                 .WithBindMount(source: @"C:\SqlServer\Data", target: "/var/opt/mssql")
                 .AddDatabase("sqldb");

この例では、次の操作を行います。

source: @"C:\SqlServer\Data" は、バインドされるホストコンピューター上のフォルダーを設定します。
target: "/var/opt/mssql" コンテナー内のデータベースファイルへのパスを設定します。

ボリュームに関しては、一部の .NET.NET Aspire コンテナーリソースは、バインドマウントを追加するための便利な API を提供します。 WithDataBindMountメソッドを例として使用すると、次のコードは機能的には前の例と同等ですが、より簡潔です。

var sql = builder.AddSqlServer("sql")
                 .WithDataBindMount(source: @"C:\SqlServer\Data")
                 .AddDatabase("sqldb");

永続的なパスワードを作成する

名前付きボリュームでは、アプリの起動間に一貫したパスワードが必要です。 .NET .NET Aspire は、ランダムなパスワード生成機能を便利に提供します。パスワードが自動的に生成される前の例をもう一度考えてみましょう。

var sql = builder.AddSqlServer("sql")
                 .WithDataVolume()
                 .AddDatabase("sqldb");

password パラメーターは AddSqlServerを呼び出すときには指定されないため、.NET AspireSQL Server リソースのパスワードが自動的に生成されます。

大事な

これは永続的なパスワードではありません。代わりに、アプリホストが実行されるたびに変更されます。

永続的な パスワードを作成するには、生成されたパスワードをオーバーライドする必要があります。これを行うには、アプリホストプロジェクトディレクトリで次のコマンドを実行して、.NET ユーザーシークレットにローカルパスワードを設定します。

dotnet user-secrets set Parameters:sql-password <password>

これらのシークレットの名前付け規則を理解しておくことが重要です。パスワードは、Parameters:sql-password キーを使用して構成に格納されます。名前付け規則は、次のパターンに従います。

Parameters:{resourceName}-password: SQL Server リソース ("sql"という名前) の場合、パスワードはキー Parameters:sql-passwordを使用して構成に格納されます。

次の表に示すような、他のサーバーベースのリソースの種類にも同じパターンが適用されます。

リソースの種類	ホスティングパッケージ	リソース名の例	オーバーライドキー
MySQL	📦 Aspire.Hosting.MySql	`mysql`	`Parameters:mysql-password`
Oracle	📦 Aspire.ホスティング。Oracle	`oracle`	`Parameters:oracle-password`
PostgreSQL	📦 Aspire.ホスティング。PostgreSQL	`postgresql`	`Parameters:postgresql-password`
RabbitMQ	📦 Aspire.Hosting.RabbitMq	`rabbitmq`	`Parameters:rabbitmq-password`
SQL Server	📦 Aspire.Hosting.SqlServer	`sql`	`Parameters:sql-password`

生成されたパスワードをオーバーライドすることで、アプリの起動間でパスワードの一貫性を保つことができます。別の方法として、AddParameter メソッドを使用して、パスワードとして使用できるパラメーターを作成します。次のコードは、SQL Server リソースの永続的なパスワードを作成する方法を示しています。

var sqlPassword = builder.AddParameter("sql-password", secret: true);

var sql = builder.AddSqlServer("sql", password: sqlPassword)
                 .WithDataVolume()
                 .AddDatabase("sqldb");

AddParameter メソッドは、シークレットと見なされる sql-password という名前のパラメーターを作成するために使用されます。 AddSqlServer メソッドは、password パラメーターを使用して呼び出され、SQL Server リソースのパスワードを設定します。詳細については、「外部パラメーターを参照してください。

次の手順

前のコードのボリュームの概念をさまざまなサービスに適用できます。これには、アプリの起動時に保持されるデータを含むデータベースのシード処理が含まれます。これらの手法と、次のチュートリアルで示されているリソース実装を組み合わせてみます。

チュートリアル: ASP.NET Core アプリを.NET Aspire ストレージ統合に接続する
ASP.NET Core を使用して SQL Server アプリを .NET Aspire に接続する
概要オーケストレーション .NET.NET Aspire

次の方法で共有

ボリュームまたはバインド マウント .NET.NET Aspire 使用してプロジェクト データを保持する

プロジェクト データを保持するタイミング

ボリュームとバインド マウントを比較する