Add YARP container support #8856
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| { | ||
| "Logging": { | ||
| "LogLevel": { | ||
| "Default": "Information", | ||
| "Microsoft.AspNetCore": "Warning" | ||
| } | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,49 @@ | ||
| { | ||
| "Logging": { | ||
| "LogLevel": { | ||
| "Default": "Information", | ||
| "Microsoft.AspNetCore": "Information" | ||
| } | ||
| }, | ||
| "AllowedHosts": "*", | ||
| "ReverseProxy": { | ||
| "Routes": { | ||
| "catalog": { | ||
| "ClusterId": "catalog", | ||
| "Match": { | ||
| "Path": "/catalog/{**catch-all}" | ||
| }, | ||
| "Transforms": [ | ||
| { "PathRemovePrefix": "/catalog" } | ||
| ] | ||
| }, | ||
| "basket": { | ||
| "ClusterId": "basket", | ||
| "Match": { | ||
| "Path": "/basket/{**catch-all}" | ||
| }, | ||
| "Transforms": [ | ||
| { "PathRemovePrefix": "/basket" } | ||
| ] | ||
| } | ||
| }, | ||
| "Clusters": { | ||
| "catalog": { | ||
| "Destinations": { | ||
| "catalog": { | ||
| "Address": "http://catalogservice", | ||
| "Health": "http://catalogservice/readiness" | ||
| } | ||
| } | ||
| }, | ||
| "basket": { | ||
| "Destinations": { | ||
| "basket": { | ||
| "Address": "http://basketservice", | ||
| "Health": "http://basketservice/readiness" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -65,3 +65,4 @@ urls | |
| kubernetes | ||
| Pgweb | ||
| elasticsearch | ||
| Yarp | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| <Project Sdk="Microsoft.NET.Sdk"> | ||
|
|
||
| <PropertyGroup> | ||
| <TargetFramework>$(DefaultTargetFramework)</TargetFramework> | ||
| <IsPackable>true</IsPackable> | ||
| <PackageTags>aspire integration hosting yarp reverse-proxy</PackageTags> | ||
| <Description>YARP support for .NET Aspire.</Description> | ||
| <EnablePackageValidation>false</EnablePackageValidation> | ||
| <SuppressFinalPackageVersion>true</SuppressFinalPackageVersion> | ||
| </PropertyGroup> | ||
|
|
||
| <PropertyGroup> | ||
| <MinCodeCoverage>0</MinCodeCoverage> | ||
| </PropertyGroup> | ||
|
|
||
| <ItemGroup> | ||
| <ProjectReference Include="..\Aspire.Hosting\Aspire.Hosting.csproj" /> | ||
| </ItemGroup> | ||
|
|
||
| </Project> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,92 @@ | ||
| # Aspire.Hosting.Yarp library | ||
|
|
||
| Provides extension methods and resource definitions for a .NET Aspire AppHost to configure a YARP instance. | ||
|
|
||
| ## Getting started | ||
|
|
||
| ### Install the package | ||
|
|
||
| In your AppHost project, install the .NET Aspire YARP Hosting library with [NuGet](https://www.nuget.org): | ||
|
|
||
| ```dotnetcli | ||
| dotnet add package Aspire.Hosting.Yarp | ||
| ``` | ||
|
|
||
| ## Usage example | ||
|
|
||
| Then, in the _Program.cs_ file of `AppHost`, add a YARP resource and provide the configuration file using the following methods: | ||
|
|
||
| ```csharp | ||
| var catalogService = builder.AddProject<Projects.CatalogService>("catalogservice") | ||
| [...]; | ||
| var basketService = builder.AddProject<Projects.BasketService>("basketservice") | ||
| [...]; | ||
|
|
||
| builder.AddYarp("apigateway") | ||
| .WithConfigFile("yarp.json") | ||
| .WithReference(basketService) | ||
| .WithReference(catalogService); | ||
| ``` | ||
|
|
||
| The `yarp.json` configuration file can use the referenced service like this: | ||
|
|
||
| ```json | ||
| { | ||
| "Logging": { | ||
| "LogLevel": { | ||
| "Default": "Information", | ||
| "Microsoft.AspNetCore": "Information" | ||
| } | ||
| }, | ||
| "AllowedHosts": "*", | ||
| "ReverseProxy": { | ||
| "Routes": { | ||
| "catalog": { | ||
| "ClusterId": "catalog", | ||
| "Match": { | ||
| "Path": "/catalog/{**catch-all}" | ||
| }, | ||
| "Transforms": [ | ||
| { "PathRemovePrefix": "/catalog" } | ||
| ] | ||
| }, | ||
| "basket": { | ||
| "ClusterId": "basket", | ||
| "Match": { | ||
| "Path": "/basket/{**catch-all}" | ||
| }, | ||
| "Transforms": [ | ||
| { "PathRemovePrefix": "/basket" } | ||
| ] | ||
| } | ||
| }, | ||
| "Clusters": { | ||
| "catalog": { | ||
| "Destinations": { | ||
| "catalog": { | ||
| "Address": "http://catalogservice", | ||
| } | ||
| } | ||
| }, | ||
| "basket": { | ||
| "Destinations": { | ||
| "basket": { | ||
| "Address": "http://basketservice", | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
benjaminpetit marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| ``` | ||
|
|
||
| ## Additional documentation | ||
|
|
||
| * https://learn.microsoft.com/dotnet/aspire/caching/stackexchange-redis-component | ||
| * https://learn.microsoft.com/dotnet/aspire/caching/stackexchange-redis-output-caching-component | ||
| * https://learn.microsoft.com/dotnet/aspire/caching/stackexchange-redis-distributed-caching-component | ||
|
|
||
| ## Feedback & contributing | ||
|
|
||
| https://github.com/dotnet/aspire | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| // Licensed to the .NET Foundation under one or more agreements. | ||
| // The .NET Foundation licenses this file to you under the MIT license. | ||
|
|
||
| namespace Aspire.Hosting.Yarp; | ||
|
|
||
| internal static class YarpContainerImageTags | ||
|
There was a problem hiding this comment. Seems like the other ones all have tags for each of these. There was a problem hiding this comment. I am not sure to understand? |
||
| { | ||
| public const string Registry = "mcr.microsoft.com"; | ||
|
|
||
| public const string Image = "dotnet/nightly/yarp"; | ||
|
|
||
| public const string Tag = "2-preview"; | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| // Licensed to the .NET Foundation under one or more agreements. | ||
| // The .NET Foundation licenses this file to you under the MIT license. | ||
|
|
||
| using Aspire.Hosting.ApplicationModel; | ||
|
|
||
| namespace Aspire.Hosting.Yarp; | ||
|
|
||
| /// <summary> | ||
| /// A resource that represents a YARP resource independent of the hosting model. | ||
| /// </summary> | ||
| /// <param name="name">The name of the resource.</param> | ||
| public class YarpResource(string name) : ContainerResource(name) | ||
| { | ||
| /// <summary> | ||
| /// File path of the config file for this YARP resource. | ||
| /// </summary> | ||
| internal string? ConfigFilePath { get; set; } | ||
| } |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.