Content for .NET Aspire - Release 8.1

docfx.json

@@ -149,6 +149,7 @@
           "Docker",
           "Dockerfile",
           "EF Core",
+          "Elasticsearch",
           "Entity Framework Core",
           "Git",
           "GitHub",

docs/app-host/withdockerfile.md

@@ -0,0 +1,22 @@
+---
+title: Add Dockerfiles to your .NET app model
+description: Learn how to add Dockerfiles to your .NET app model.
+ms.date: 07/19/2024
+---
+
+# Add Dockerfiles to your .NET app model
+
+<!--
+https://github.com/dotnet/docs-aspire/issues/1063
+
+We are adding a new extension method called WithDockerfile which allows .NET Aspire to dynamically build a container image from a Dockerfile and run it.
+
+Article abstract
+Needs to cover these things:
+
+Basics of getting it working.
+Using build arguments
+Using build secrets
+Using to augment existing custom container resources (e.g. AddSqlServer(...)).
+Troubleshooting (example of images not being rebuilt)
+-->

docs/caching/includes/garnet-app-host.md

@@ -0,0 +1,56 @@
+<!--
+https://github.com/dotnet/docs-aspire/issues/1049
+
+We are introducing support for Garnet in this PR:
+
+dotnet/aspire#4324
+
+It is presently a drop in alternative for Redis. We probably need an article that sites right alongside the Redis articles so that folks who might be looking for Redis content to understand how Garnet works can find it.
+
+The article should cover:
+
+AddGarnet
+WithDataVolume/WithBindMount
+WithPersistence
+It can probably cover off the client side pieces by just referring back to the Redis article although the Redis article might need to more clearly call out which is service code and which is app host code.
+
+Configuring Garnet using AddGarnet and using the data volume and persistence extension methods.
+
+Include links to:
+- https://github.com/microsoft/Garnet
+- https://microsoft.github.io/garnet/docs
+-->
+
+To model the Garnet resource in the app host, install the [Aspire.Hosting.Garnet](https://www.nuget.org/packages/Aspire.Hosting.Garnet) NuGet package in the [app host](xref:aspire/app-host) project.
+
+### [.NET CLI](#tab/dotnet-cli)
+
+```dotnetcli
+dotnet add package Aspire.Hosting.Garnet
+```
+
+### [PackageReference](#tab/package-reference)
+
+```xml
+<PackageReference Include="Aspire.Hosting.Garnet"
+                  Version="[SelectVersion]" />
+```
+
+---
+
+In your app host project, register the .NET Aspire Garnet as a resource using the `AddGarnet` method and consume the service using the following methods:
+
+```csharp
+var builder = DistributedApplication.CreateBuilder(args);
+
+var cache = builder.AddGarnet("cache");
+
+builder.AddProject<Projects.ExampleProject>()
+       .WithReference(cache)
+```
+
+The <xref:Aspire.Hosting.ResourceBuilderExtensions.WithReference%2A> method configures a connection in the `ExampleProject` project named `cache`. In the _:::no-loc text="Program.cs":::_ file of `ExampleProject`, the Garnet connection can be consumed using:
+
+```csharp
+builder.AddGarnet("cache");
+```

docs/caching/includes/redis-app-host.md

@@ -16,3 +16,18 @@ dotnet add package Aspire.Hosting.Redis
 ---
 
 In your app host project, register the .NET Aspire Stack Exchange Redis as a resource using the <xref:Aspire.Hosting.RedisBuilderExtensions.AddRedis%2A> method and consume the service using the following methods:
+
+```csharp
+var builder = DistributedApplication.CreateBuilder(args);
+
+var cache = builder.AddRedis("cache");
+
+builder.AddProject<Projects.ExampleProject>()
+       .WithReference(cache)
+```
+
+The <xref:Aspire.Hosting.ResourceBuilderExtensions.WithReference%2A> method configures a connection in the `ExampleProject` project named `cache`. In the _:::no-loc text="Program.cs":::_ file of `ExampleProject`, the Redis connection can be consumed using:
+
+```csharp
+builder.AddRedis("cache");
+```

docs/caching/includes/valkey-app-host.md

@@ -0,0 +1,56 @@
+<!--
+https://github.com/dotnet/docs-aspire/issues/1049
+
+We are introducing support for Valkey in this PR:
+
+dotnet/aspire#4324
+
+It is presently a drop in alternative for Redis. We probably need an article that sites right alongside the Redis articles so that folks who might be looking for Redis content to understand how Valkey works can find it.
+
+The article should cover:
+
+AddValkey
+WithDataVolume/WithBindMount
+WithPersistence
+It can probably cover off the client side pieces by just referring back to the Redis article although the Redis article might need to more clearly call out which is service code and which is app host code.
+
+Configuring Valkey using AddValkey and using the data volume and persistence extension methods.
+
+Include links to:
+- https://github.com/valkey-io/valkey
+- https://valkey.io/docs/
+-->
+
+To model the Valkey resource in the app host, install the [Aspire.Hosting.Valkey](https://www.nuget.org/packages/Aspire.Hosting.Valkey) NuGet package in the [app host](xref:aspire/app-host) project.
+
+### [.NET CLI](#tab/dotnet-cli)
+
+```dotnetcli
+dotnet add package Aspire.Hosting.Valkey
+```
+
+### [PackageReference](#tab/package-reference)
+
+```xml
+<PackageReference Include="Aspire.Hosting.Valkey"
+                  Version="[SelectVersion]" />
+```
+
+---
+
+In your app host project, register the .NET Aspire Valkey as a resource using the `AddValkey` method and consume the service using the following methods:
+
+```csharp
+var builder = DistributedApplication.CreateBuilder(args);
+
+var cache = builder.AddValkey("cache");
+
+builder.AddProject<Projects.ExampleProject>()
+       .WithReference(cache)
+```
+
+The <xref:Aspire.Hosting.ResourceBuilderExtensions.WithReference%2A> method configures a connection in the `ExampleProject` project named `cache`. In the _:::no-loc text="Program.cs":::_ file of `ExampleProject`, the Valkey connection can be consumed using:
+
+```csharp
+builder.AddValkey("cache");
+```

docs/caching/stackexchange-redis-component.md

@@ -3,6 +3,7 @@ title: .NET Aspire Stack Exchange Redis component
 description: This article describes the .NET Aspire Stack Exchange Redis component features and capabilities
 ms.topic: how-to
 ms.date: 07/17/2024
+zone_pivot_groups: resp-host
 ---
 
 # .NET Aspire Stack Exchange Redis component
@@ -49,41 +50,64 @@ public class ExampleService(IConnectionMultiplexer connectionMultiplexer)
 
 ## App host usage
 
+:::zone pivot="redis"
+
 [!INCLUDE [redis-app-host](includes/redis-app-host.md)]
 
-```csharp
-var builder = DistributedApplication.CreateBuilder(args);
+:::zone-end
+:::zone pivot="garnet"
 
-var redis = builder.AddRedis("redis");
+[!INCLUDE [garnet-app-host](includes/garnet-app-host.md)]
 
-builder.AddProject<Projects.ExampleProject>()
-       .WithReference(redis)
-```
+:::zone-end
+:::zone pivot="valkey"
 
-The <xref:Aspire.Hosting.ResourceBuilderExtensions.WithReference%2A> method configures a connection in the `ExampleProject` project named `redis`. In the _:::no-loc text="Program.cs":::_ file of `ExampleProject`, the Redis connection can be consumed using:
+[!INCLUDE [valkey-app-host](includes/valkey-app-host.md)]
 
-```csharp
-builder.AddRedis("cache");
-```
+:::zone-end
 
 ## Configuration
 
 The .NET Aspire Stack Exchange Redis component provides multiple options to configure the Redis connection based on the requirements and conventions of your project.
 
 ### Use a connection string
 
+:::zone pivot="redis"
+
 When using a connection string from the `ConnectionStrings` configuration section, you can provide the name of the connection string when calling `builder.AddRedis`:
 
 ```csharp
-builder.AddRedis("RedisConnection");
+builder.AddRedis("cache");
+```
+
+:::zone-end
+:::zone pivot="garnet"
+
+When using a connection string from the `ConnectionStrings` configuration section, you can provide the name of the connection string when calling `builder.AddGarnet`:
+
+```csharp
+builder.AddGarnet("cache");
 ```
 
+:::zone-end
+:::zone pivot="valkey"
+
+[!INCLUDE [valkey-app-host](includes/valkey-app-host.md)]
+
+When using a connection string from the `ConnectionStrings` configuration section, you can provide the name of the connection string when calling `builder.AddValkey`:
+
+```csharp
+builder.AddValkey("cache");
+```
+
+:::zone-end
+
 And then the connection string will be retrieved from the `ConnectionStrings` configuration section:
 
 ```json
 {
   "ConnectionStrings": {
-    "RedisConnection": "localhost:6379"
+    "cache": "localhost:6379"
   }
 }
 ```
@@ -115,12 +139,36 @@ The .NET Aspire Stack Exchange Redis component supports <xref:Microsoft.Extensio
 
 You can also pass the `Action<StackExchangeRedisSettings>` delegate to set up some or all the options inline, for example to configure `DisableTracing`:
 
+:::zone pivot="redis"
+
 ```csharp
 builder.AddRedis(
     "cache",
     settings => settings.DisableTracing = true);
 ```
 
+:::zone-end
+:::zone pivot="garnet"
+
+```csharp
+builder.AddGarnet(
+    "cache",
+    settings => settings.DisableTracing = true);
+```
+
+:::zone-end
+:::zone pivot="valkey"
+
+[!INCLUDE [valkey-app-host](includes/valkey-app-host.md)]
+
+```csharp
+builder.AddValkey(
+    "cache",
+    settings => settings.DisableTracing = true);
+```
+
+:::zone-end
+
 [!INCLUDE [component-health-checks](../includes/component-health-checks.md)]
 
 The .NET Aspire Stack Exchange Redis component handles the following:

docs/caching/stackexchange-redis-distributed-caching-component.md

@@ -3,6 +3,7 @@ title: .NET Aspire Stack Exchange Redis distributed caching component
 description: This article describes the .NET Aspire Stack Exchange Redis distributed caching component features and capabilities
 ms.topic: how-to
 ms.date: 07/17/2024
+zone_pivot_groups: resp-host
 ---
 
 # .NET Aspire Stack Exchange Redis distributed caching component
@@ -49,22 +50,21 @@ public class ExampleService(IDistributedCache cache)
 
 ## App host usage
 
+:::zone pivot="redis"
+
 [!INCLUDE [redis-app-host](includes/redis-app-host.md)]
 
-```csharp
-var builder = DistributedApplication.CreateBuilder(args);
+:::zone-end
+:::zone pivot="garnet"
 
-var redis = builder.AddRedis("cache");
+[!INCLUDE [garnet-app-host](includes/garnet-app-host.md)]
 
-builder.AddProject<Projects.ExampleProject>()
-       .WithReference(redis)
-```
+:::zone-end
+:::zone pivot="valkey"
 
-The <xref:Aspire.Hosting.ResourceBuilderExtensions.WithReference%2A> method configures a connection in the `ExampleProject` project named `cache`. In the _:::no-loc text="Program.cs":::_ file of `ExampleProject`, the Redis connection can be consumed using:
+[!INCLUDE [valkey-app-host](includes/valkey-app-host.md)]
 
-```csharp
-builder.AddRedisDistributedCache("cache");
-```
+:::zone-end
 
 ## Configuration
 

docs/caching/stackexchange-redis-output-caching-component.md

@@ -2,12 +2,13 @@
 title: .NET Aspire Stack Exchange Redis output caching Component
 description: This article describes the .NET Aspire Stack Exchange Redis output caching component features and capabilities
 ms.topic: how-to
-ms.date: 07/17/2024
+ms.date: 07/19/2024
+zone_pivot_groups: resp-host
 ---
 
 # .NET Aspire Stack Exchange Redis output caching component
 
-In this article, you learn how to use the .NET Aspire Stack Exchange Redis output caching component. The `Aspire.StackExchange.Redis.OutputCaching` library is used to register an [ASP.NET Core Output Caching](/aspnet/core/performance/caching/output) provider backed by a [Redis](https://redis.io/) server. It enables corresponding health check, logging, and telemetry.
+In this article, you learn how to use the .NET Aspire Stack Exchange Redis output caching component. The `Aspire.StackExchange.Redis.OutputCaching` library is used to register an [ASP.NET Core Output Caching](/aspnet/core/performance/caching/output) provider backed by a [Redis](https://redis.io/) server. It enables corresponding health check, logging, and telemetry..
 
 ## Get started
 
@@ -56,22 +57,21 @@ For apps with controllers, apply the `[OutputCache]` attribute to the action met
 
 ## App host usage
 
+:::zone pivot="redis"
+
 [!INCLUDE [redis-app-host](includes/redis-app-host.md)]
 
-```csharp
-var builder = DistributedApplication.CreateBuilder(args);
+:::zone-end
+:::zone pivot="garnet"
 
-var redis = builder.AddRedis("redis");
+[!INCLUDE [garnet-app-host](includes/garnet-app-host.md)]
 
-var basket = builder.AddProject<Projects.ExampleProject>()
-                    .WithReference(redis)
-```
+:::zone-end
+:::zone pivot="valkey"
 
-The <xref:Aspire.Hosting.ResourceBuilderExtensions.WithReference%2A> method configures a connection in the `ExampleProject` project named `redis`. In the _:::no-loc text="Program.cs":::_ file of `ExampleProject`, the Redis connection can be consumed using:
+[!INCLUDE [valkey-app-host](includes/valkey-app-host.md)]
 
-```csharp
-builder.AddRedisOutputCache("messaging");
-```
+:::zone-end
 
 ## Configuration
 

docs/database/milvus-component.md

@@ -0,0 +1,22 @@
+---
+title: .NET Aspire Milvus database component
+description: This article describes the .NET Aspire Milvus database component.
+ms.topic: how-to
+ms.date: 07/19/2024
+---
+
+# .NET Aspire Milvus database component
+
+<!--
+https://github.com/dotnet/docs-aspire/issues/1039
+
+We added a new Aspire.Milvus.Client component and Aspire.Hosting.Milvus hosting library in main. See:
+
+Add Milvus Aspire Component aspire#796
+Adds Milvus to the Aspire hosting/component packages aspire#4179
+https://github.com/dotnet/aspire/tree/main/src/Components/Aspire.Milvus.Client
+
+Include links to:
+- https://milvus.io/
+- https://github.com/milvus-io/milvus
+-->