Garnet integration

Garnet is a high-performance cache-store from Microsoft Research that complies with the Redis serialization protocol (RESP). The Garnet integration enables you to connect to existing Garnet instances, or create new instances from Aspire with the ghcr.io/microsoft/garnet container image.

Hosting integration

The Garnet hosting integration models a Garnet resource as the GarnetResource type. To access this type and APIs, add the 📦 Aspire.Hosting.Garnet NuGet package in your AppHost project:

Aspire CLI

Aspire CLI — Aspire.Hosting.Garnet 패키지 추가

aspire add garnet

Aspire CLI는 대화형입니다. 프롬프트 시 알맞은 검색 결과 선택:

Aspire CLI — 출력 예시

Select an integration to add:

> garnet (Aspire.Hosting.Garnet)
> Other results listed as selectable options...

참고

결과가 하나라면 자동 선택됩니다. 버전은 직접 확인해야 합니다.

apphost.cs (C# file-based app)

C# — AppHost.cs

#:package Aspire.Hosting.Garnet@*

PackageReference (*.csproj)

XML — Aspire.Hosting.Garnet 패키지 참조 추가

<PackageReference Include="Aspire.Hosting.Garnet" Version="*" />

Add Garnet resource

In your AppHost project, call AddGarnet on the builder instance to add a Garnet resource:

C# — AppHost.cs

var builder = DistributedApplication.CreateBuilder(args);

var cache = builder.AddGarnet("cache");

var myService = builder.AddProject<Projects.ExampleProject>()
                       .WithReference(cache);

When Aspire adds a container image to the AppHost, it creates a new Garnet instance on your local machine.

팁

If you’d rather connect to an existing Garnet instance, call AddConnectionString instead. For more information on how to use WithReference, see Resource dependencies.

Add Garnet resource with data volume

To add a data volume to the Garnet resource, call the WithDataVolume method:

C# — AppHost.cs

var builder = DistributedApplication.CreateBuilder(args);

var cache = builder.AddGarnet("cache")
                   .WithDataVolume(isReadOnly: false);

var myService = builder.AddProject<Projects.ExampleProject>()
                       .WithReference(cache);

The data volume is used to persist the Garnet data outside the lifecycle of its container. The data volume is mounted at the /data path in the Garnet container.

Add Garnet resource with data bind mount

To add a data bind mount to the Garnet resource, call the WithDataBindMount method:

C# — AppHost.cs

var builder = DistributedApplication.CreateBuilder(args);

var cache = builder.AddGarnet("cache")
                   .WithDataBindMount(
                       source: @"C:\Garnet\Data",
                       isReadOnly: false);

var myService = builder.AddProject<Projects.ExampleProject>()
                       .WithReference(cache);

참고

Data bind mounts have limited functionality compared to volumes, and when you use a bind mount, a file or directory on the host machine is mounted into a container.

Add Garnet resource with persistence

To add persistence to the Garnet resource, call the WithPersistence method with either the data volume or data bind mount:

C# — AppHost.cs

var builder = DistributedApplication.CreateBuilder(args);

var cache = builder.AddGarnet("cache")
                   .WithDataVolume()
                   .WithPersistence(
                       interval: TimeSpan.FromMinutes(5),
                       keysChangedThreshold: 100);

var myService = builder.AddProject<Projects.ExampleProject>()
                       .WithReference(cache);

The preceding code adds persistence to the Garnet resource by taking snapshots of the data at a specified interval and threshold.

Connection properties

When you reference a Garnet resource using WithReference, the following connection properties are made available to the consuming project:

Garnet

The Garnet resource exposes the following connection properties:

Property Name	Description
Host	The hostname or IP address of the Garnet server
Port	The port number the Garnet server is listening on
Password	The password for authentication (available when a password parameter is configured)
Uri	The connection URI, with the format redis://:{Password}@{Host}:{Port}

Example connection string:

Uri: redis://:p%40ssw0rd1@localhost:6379

참고

Aspire exposes each property as an environment variable named [RESOURCE]_[PROPERTY]. For instance, the Uri property of a resource called cache becomes CACHE_URI.

Hosting integration health checks

The Garnet hosting integration automatically adds a health check for the Garnet resource. The health check verifies that the Garnet instance is running and that a connection can be established to it.

Client integration

Garnet is Redis-compatible, so you use the same Redis client packages. To get started, install the 📦 Aspire.StackExchange.Redis NuGet package:

.NET CLI

.NET CLI — Add Aspire.StackExchange.Redis package

dotnet add package Aspire.StackExchange.Redis

Program.cs (C# file-based app)

Program.cs

#:package Aspire.StackExchange.Redis@*

PackageReference (*.csproj)

XML — Add Aspire.StackExchange.Redis package reference

<PackageReference Include="Aspire.StackExchange.Redis" Version="*" />

Add Garnet client

In the Program.cs file of your client-consuming project, call the AddRedisClient extension method to register an IConnectionMultiplexer:

builder.AddRedisClient(connectionName: "cache");

팁

The connectionName parameter must match the name used when adding the Garnet resource in the AppHost project.

You can then retrieve the IConnectionMultiplexer instance using dependency injection:

public class ExampleService(IConnectionMultiplexer connectionMux)
{
    // Use connection multiplexer...
}

Configuration and other client features

Since Garnet is Redis-compatible, all Redis client configuration, keyed services, health checks, and observability features work the same way. See the Redis integration page for complete client integration documentation.

Distributed caching and output caching

Garnet also supports Redis distributed caching and output caching. Install the respective packages:

• For distributed caching: 📦 Aspire.StackExchange.Redis.DistributedCaching
• For output caching: 📦 Aspire.StackExchange.Redis.OutputCaching

See Redis Distributed Caching and Redis Output Caching for usage details.