From 3e2ce1d4a32519b60367bae0c52ca85ded0bd9a2 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Fri, 17 May 2024 17:35:22 +0000 Subject: [PATCH] Updated docs from commit f21b39069b2a5a002cef4425b9b817ae2beac11d on refs/heads/release/latest --- ...Configuration.ActiveHealthCheckConfig.html | 35 +++- ...n.ClusterValidators.IClusterValidator.html | 185 ++++++++++++++++++ ...Proxy.Configuration.ClusterValidators.html | 119 +++++++++++ ...everseProxy.Configuration.RouteConfig.html | 12 +- ...ation.RouteValidators.IRouteValidator.html | 185 ++++++++++++++++++ ...seProxy.Configuration.RouteValidators.html | 119 +++++++++++ ...Consumption.IKestrelTelemetryConsumer.html | 96 ++++++++- api/toc.html | 20 ++ articles/ab-testing.html | 4 +- articles/authn-authz.html | 2 +- articles/config-files.html | 3 +- articles/dests-health-checks.html | 7 +- articles/getting-started.html | 2 +- articles/index.html | 2 +- articles/output-caching.html | 161 +++++++++++++++ articles/toc.html | 3 + articles/transforms.html | 5 +- index.html | 3 +- manifest.json | 94 +++++++-- readme.html | 2 +- toc.html | 2 +- xrefmap.yml | 98 ++++++++++ 22 files changed, 1117 insertions(+), 42 deletions(-) create mode 100644 api/Yarp.ReverseProxy.Configuration.ClusterValidators.IClusterValidator.html create mode 100644 api/Yarp.ReverseProxy.Configuration.ClusterValidators.html create mode 100644 api/Yarp.ReverseProxy.Configuration.RouteValidators.IRouteValidator.html create mode 100644 api/Yarp.ReverseProxy.Configuration.RouteValidators.html create mode 100644 articles/output-caching.html diff --git a/api/Yarp.ReverseProxy.Configuration.ActiveHealthCheckConfig.html b/api/Yarp.ReverseProxy.Configuration.ActiveHealthCheckConfig.html index 93af5f2b4..4e4e586db 100644 --- a/api/Yarp.ReverseProxy.Configuration.ActiveHealthCheckConfig.html +++ b/api/Yarp.ReverseProxy.Configuration.ActiveHealthCheckConfig.html @@ -217,6 +217,37 @@
Property Value
+ + | + Improve this Doc + + + View Source + + +

Query

+

Query string to append to the probe, including the leading '?'.

+
+
+
Declaration
+
+ 
public string? Query { get; set; }
+
+
Property Value
+ + + + + + + + + + + + + +
TypeDescription
Nullable<String>
| Improve this Doc @@ -255,7 +286,7 @@

Methods Improve this Doc - View Source + View Source

Equals(ActiveHealthCheckConfig)

@@ -302,7 +333,7 @@
Returns
Improve this Doc - View Source + View Source

GetHashCode()

diff --git a/api/Yarp.ReverseProxy.Configuration.ClusterValidators.IClusterValidator.html b/api/Yarp.ReverseProxy.Configuration.ClusterValidators.IClusterValidator.html new file mode 100644 index 000000000..e5226b047 --- /dev/null +++ b/api/Yarp.ReverseProxy.Configuration.ClusterValidators.IClusterValidator.html @@ -0,0 +1,185 @@ + + + + + + + + Interface IClusterValidator + + + + + + + + + + + + + + + + +
+
+ + + +
+ +
+
+
+ +
+ +
+
+
+
+
+
+
+ + +

Interface IClusterValidator +

+

Provides method to validate cluster configuration.

+
+
+
Namespace: Yarp.ReverseProxy.Configuration.ClusterValidators
+
Assembly: Yarp.ReverseProxy.dll
+
Syntax
+
+ 
public interface IClusterValidator
+
+

Methods +

+ + | + Improve this Doc + + + View Source + + +

ValidateAsync(ClusterConfig, IList<Exception>)

+

Perform validation on a cluster configuration by adding exceptions to the provided collection.

+
+
+
Declaration
+
+ 
ValueTask ValidateAsync(ClusterConfig cluster, IList<Exception> errors)
+
+
Parameters
+ + + + + + + + + + + + + + + + + + + + +
TypeNameDescription
ClusterConfigcluster

Cluster configuration to validate

+
IList<Exception>errors

Collection of all validation exceptions

+
+
Returns
+ + + + + + + + + + + + + +
TypeDescription
ValueTask

A ValueTask representing the asynchronous validation operation.

+
+
+
+ + +
+
+ + +
+ + + + + + diff --git a/api/Yarp.ReverseProxy.Configuration.ClusterValidators.html b/api/Yarp.ReverseProxy.Configuration.ClusterValidators.html new file mode 100644 index 000000000..d1ddc0330 --- /dev/null +++ b/api/Yarp.ReverseProxy.Configuration.ClusterValidators.html @@ -0,0 +1,119 @@ + + + + + + + + Namespace Yarp.ReverseProxy.Configuration.ClusterValidators + + + + + + + + + + + + + + + + +
+
+ + + +
+ +
+
+
+ +
+ +
+
+
+
+
+
+
+ +

Namespace Yarp.ReverseProxy.Configuration.ClusterValidators +

+
+
+
+

Interfaces +

+

IClusterValidator

+

Provides method to validate cluster configuration.

+
+
+
+ + +
+
+ + +
+ + + + + + diff --git a/api/Yarp.ReverseProxy.Configuration.RouteConfig.html b/api/Yarp.ReverseProxy.Configuration.RouteConfig.html index d6a4f18fb..34b073d25 100644 --- a/api/Yarp.ReverseProxy.Configuration.RouteConfig.html +++ b/api/Yarp.ReverseProxy.Configuration.RouteConfig.html @@ -165,7 +165,7 @@
Property Value
Improve this Doc - View Source + View Source

CorsPolicy

@@ -231,7 +231,7 @@
Property Value
Improve this Doc - View Source + View Source

MaxRequestBodySize

@@ -263,7 +263,7 @@
Property Value
Improve this Doc - View Source + View Source

Metadata

@@ -357,7 +357,7 @@
Property Value
Improve this Doc - View Source + View Source

Transforms

@@ -390,7 +390,7 @@

Methods Improve this Doc - View Source + View Source

Equals(RouteConfig)

@@ -437,7 +437,7 @@
Returns
Improve this Doc - View Source + View Source

GetHashCode()

diff --git a/api/Yarp.ReverseProxy.Configuration.RouteValidators.IRouteValidator.html b/api/Yarp.ReverseProxy.Configuration.RouteValidators.IRouteValidator.html new file mode 100644 index 000000000..93800013a --- /dev/null +++ b/api/Yarp.ReverseProxy.Configuration.RouteValidators.IRouteValidator.html @@ -0,0 +1,185 @@ + + + + + + + + Interface IRouteValidator + + + + + + + + + + + + + + + + +
+
+ + + +
+ +
+
+
+ +
+ +
+
+
+
+
+
+
+ + +

Interface IRouteValidator +

+

Provides method to validate route configuration.

+
+
+
Namespace: Yarp.ReverseProxy.Configuration.RouteValidators
+
Assembly: Yarp.ReverseProxy.dll
+
Syntax
+
+ 
public interface IRouteValidator
+
+

Methods +

+ + | + Improve this Doc + + + View Source + + +

ValidateAsync(RouteConfig, IList<Exception>)

+

Perform validation on a route by adding exceptions to the provided collection.

+
+
+
Declaration
+
+ 
ValueTask ValidateAsync(RouteConfig routeConfig, IList<Exception> errors)
+
+
Parameters
+ + + + + + + + + + + + + + + + + + + + +
TypeNameDescription
RouteConfigrouteConfig

Route configuration to validate

+
IList<Exception>errors

Collection of all validation exceptions

+
+
Returns
+ + + + + + + + + + + + + +
TypeDescription
ValueTask

A ValueTask representing the asynchronous validation operation.

+
+
+
+ + +
+
+ + +
+ + + + + + diff --git a/api/Yarp.ReverseProxy.Configuration.RouteValidators.html b/api/Yarp.ReverseProxy.Configuration.RouteValidators.html new file mode 100644 index 000000000..9920b9b7f --- /dev/null +++ b/api/Yarp.ReverseProxy.Configuration.RouteValidators.html @@ -0,0 +1,119 @@ + + + + + + + + Namespace Yarp.ReverseProxy.Configuration.RouteValidators + + + + + + + + + + + + + + + + +
+
+ + + +
+ +
+
+
+ +
+ +
+
+
+
+
+
+
+ +

Namespace Yarp.ReverseProxy.Configuration.RouteValidators +

+
+
+
+

Interfaces +

+

IRouteValidator

+

Provides method to validate route configuration.

+
+
+
+ + +
+
+ + +
+ + + + + + diff --git a/api/Yarp.Telemetry.Consumption.IKestrelTelemetryConsumer.html b/api/Yarp.Telemetry.Consumption.IKestrelTelemetryConsumer.html index 6eaed6d5b..f189e8138 100644 --- a/api/Yarp.Telemetry.Consumption.IKestrelTelemetryConsumer.html +++ b/api/Yarp.Telemetry.Consumption.IKestrelTelemetryConsumer.html @@ -84,12 +84,104 @@
Syntax

Methods

+ + | + Improve this Doc + + + View Source + + +

OnConnectionStart(DateTime, String, Nullable<String>, Nullable<String>)

+

Called at the start of a connection.

+
+
+
Declaration
+
+ 
virtual void OnConnectionStart(DateTime timestamp, string connectionId, string? localEndPoint, string? remoteEndPoint)
+
+
Parameters
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescription
DateTimetimestamp

Timestamp when the event was fired.

+
StringconnectionId

ID of the connection.

+
Nullable<String>localEndPoint

Local endpoint for the connection.

+
Nullable<String>remoteEndPoint

Remote endpoint for the connection.

+
+ + | + Improve this Doc + + + View Source + + +

OnConnectionStop(DateTime, String)

+

Called at the end of a connection.

+
+
+
Declaration
+
+ 
virtual void OnConnectionStop(DateTime timestamp, string connectionId)
+
+
Parameters
+ + + + + + + + + + + + + + + + + + + + +
TypeNameDescription
DateTimetimestamp

Timestamp when the event was fired.

+
StringconnectionId

ID of the connection.

+
| Improve this Doc - View Source + View Source

OnRequestStart(DateTime, String, String, String, String, String)

@@ -153,7 +245,7 @@
Parameters
Improve this Doc - View Source + View Source

OnRequestStop(DateTime, String, String, String, String, String)

diff --git a/api/toc.html b/api/toc.html index ca4b29451..70a5babaa 100644 --- a/api/toc.html +++ b/api/toc.html @@ -155,6 +155,26 @@ +
  • + + Yarp.ReverseProxy.Configuration.ClusterValidators + + +
    • +
  • + + Yarp.ReverseProxy.Configuration.RouteValidators + + +
  • Yarp.ReverseProxy.Delegation diff --git a/articles/ab-testing.html b/articles/ab-testing.html index 0ea1dd3dd..37b3b04e5 100644 --- a/articles/ab-testing.html +++ b/articles/ab-testing.html @@ -77,7 +77,7 @@

    Example

    // Custom cluster selection proxyPipeline.Use((context, next) => { - context.RequestServices.GetRequiredService<IProxyStateLookup>(); + var lookup = context.RequestServices.GetRequiredService<IProxyStateLookup>(); if (lookup.TryGetCluster(ChooseCluster(context), out var cluster)) { context.ReassignProxyRequest(cluster); @@ -89,7 +89,7 @@

    Example

    proxyPipeline.UseLoadBalancing(); }); -private string ChooseCluster(HttpContext context) +string ChooseCluster(HttpContext context) { // Decide which cluster to use. This could be random, weighted, based on headers, etc. return Random.Shared.Next(2) == 1 ? "cluster1" : "cluster2"; diff --git a/articles/authn-authz.html b/articles/authn-authz.html index a725a7578..2cc534118 100644 --- a/articles/authn-authz.html +++ b/articles/authn-authz.html @@ -128,7 +128,7 @@

    These authentication types already pass their values in the request headers and these will flow to the destination server by default. That server will still need to verify and interpret those values, causing some double work.

    OAuth2, OpenIdConnect, WsFederation

    These protocols are commonly used with remote identity providers. The authentication process can be configured in the proxy application and will result in an authentication cookie. That cookie will flow to the destination server as a normal request header.

    -

    Windows, Negotiate, NTLM, Kerbereos

    +

    Windows, Negotiate, NTLM, Kerberos

    These authentication types are often bound to a specific connection. They are not supported as means of authenticating a user in a destination server behind the YARP proxy (see #166. They can be used to authenticate an incoming request to the proxy, but that identity information will have to be communicated to the destination server in another form. They can also be used to authenticate the proxy to the destination servers, but only as the proxy's own user, impersonating the client is not supported.

    Client Certificates

    Client certificates are a TLS feature and are negotiated as part of a connection. See these docs for additional information. The certificate can be forwarded to the destination server as an HTTP header using the ClientCert transform.

    diff --git a/articles/config-files.html b/articles/config-files.html index d60605995..bbf6028ac 100644 --- a/articles/config-files.html +++ b/articles/config-files.html @@ -241,7 +241,8 @@

    All config properties

    "Interval": "00:00:10", "Timeout": "00:00:10", "Policy": "ConsecutiveFailures", - "Path": "/api/health" // API endpoint to query for health state + "Path": "/api/health", // API endpoint to query for health state + "Query": "?foo=bar" }, "Passive": { // Disables destinations based on HTTP response codes "Enabled": true, // Defaults to false diff --git a/articles/dests-health-checks.html b/articles/dests-health-checks.html index 2e9486da2..770c70c86 100644 --- a/articles/dests-health-checks.html +++ b/articles/dests-health-checks.html @@ -82,7 +82,8 @@

    File example

    "Interval": "00:00:10", "Timeout": "00:00:10", "Policy": "ConsecutiveFailures", - "Path": "/api/health" + "Path": "/api/health", + "Query": "?foo=bar" } }, "Metadata": { @@ -114,7 +115,8 @@

    Code example

    Interval = TimeSpan.FromSeconds(10), Timeout = TimeSpan.FromSeconds(10), Policy = HealthCheckConstants.ActivePolicy.ConsecutiveFailures, - Path = "/api/health" + Path = "/api/health", + Query = "?foo=bar", } }, Metadata = new Dictionary<string, string> { { ConsecutiveFailuresHealthPolicyOptions.ThresholdMetadataName, "5" } }, @@ -136,6 +138,7 @@

    Configuration

  • Timeout - probing request timeout. Default 00:00:10
  • Policy - name of a policy evaluating destinations' active health states. Mandatory parameter
  • Path - health check path on all cluster's destinations. Default null.
    • +
  • Query - health check query on all cluster's destinations. Default null.

    • Destination section and DestinationConfig.