Jean-Thierry Kéchichian Clusters

Directory.Packages.props

@@ -64,6 +64,7 @@
     <PackageVersion Include="SixLabors.ImageSharp.Web.Providers.AWS" Version="3.2.0" />
     <PackageVersion Include="StackExchange.Redis" Version="2.12.8" />
     <PackageVersion Include="StyleCop.Analyzers" Version="1.1.118" />
+    <PackageVersion Include="Yarp.ReverseProxy" Version="2.3.0" />
     <PackageVersion Include="xunit.v3.mtp-v2" Version="3.2.2" />
     <PackageVersion Include="YesSql" Version="5.4.7" />
     <PackageVersion Include="YesSql.Abstractions" Version="5.4.7" />

OrchardCore.slnx

@@ -181,6 +181,7 @@
   </Folder>
   <Folder Name="/src/OrchardCore/">
     <Project Path="src/OrchardCore/OrchardCore.Abstractions/OrchardCore.Abstractions.csproj" />
+    <Project Path="src/OrchardCore/OrchardCore.Clusters.Yarp/OrchardCore.Clusters.Yarp.csproj" />
     <Project Path="src/OrchardCore/OrchardCore.Admin.Abstractions/OrchardCore.Admin.Abstractions.csproj" />
     <Project Path="src/OrchardCore/OrchardCore.AdminMenu.Abstractions/OrchardCore.AdminMenu.Abstractions.csproj" />
     <Project Path="src/OrchardCore/OrchardCore.Apis.GraphQL.Abstractions/OrchardCore.Apis.GraphQL.Abstractions.csproj" />

mkdocs.yml

@@ -169,6 +169,8 @@ nav:
       - Secure your application: topics/security/README.md
       - Data: topics/data/README.md
       - Configuration: topics/configuration/README.md
+      - Tenant Clustering: topics/tenant-clustering/README.md
+      - Tenant Clustering Demo: topics/tenant-clustering/local-demo.md
       - Workflows: topics/workflows/README.md
       - Publishing a new release: topics/publishing-releases/README.md
       - Using Docker: topics/docker/README.md
@@ -292,6 +294,7 @@ nav:
               - Background Tasks: reference/modules/BackgroundTasks/README.md
               - URL Rewriting: reference/modules/UrlRewriting/README.md
               - Reverse Proxy: reference/modules/ReverseProxy/README.md
+              - Tenant Clustering: reference/modules/ReverseProxy/TenantClusters.md
       - Branding: reference/branding/README.md
       - Libraries: reference/libraries/README.md
       - Glossary: reference/glossary/README.md

src/OrchardCore.Cms.Web/NLog.config

@@ -15,6 +15,7 @@
         <target xsi:type="File" name="file"
                 fileName="${var:configDir}/logs/orchard-log-${shortdate}.log"
                 layout="${longdate}|${orchard-tenant-name}|${aspnet-traceidentifier}|${event-properties:item=EventId}|${logger}|${uppercase:${level}}|${message} ${exception:format=ToString,StackTrace}"
+                concurrentWrites = "true"
         />
 
         <!-- console target -->

src/OrchardCore.Cms.Web/OrchardCore.Cms.Web.csproj

@@ -44,6 +44,7 @@
 
   <ItemGroup>
     <ProjectReference Include="..\OrchardCore\OrchardCore.Application.Cms.Targets\OrchardCore.Application.Cms.Targets.csproj" />
+    <ProjectReference Include="..\OrchardCore\OrchardCore.Clusters.Yarp\OrchardCore.Clusters.Yarp.csproj" />
     <ProjectReference Include="..\OrchardCore\OrchardCore.Logging.NLog\OrchardCore.Logging.NLog.csproj" />
   </ItemGroup>
 

src/OrchardCore.Cms.Web/Program.cs

@@ -1,3 +1,4 @@
+using OrchardCore.Clusters;
 using OrchardCore.Logging;
 
 var builder = WebApplication.CreateBuilder(args);
@@ -6,7 +7,15 @@
 
 builder.Services
     .AddOrchardCms()
-    .AddSetupFeatures("OrchardCore.AutoSetup");
+    .AddSetupFeatures("OrchardCore.AutoSetup")
+    .AddClusteredTenantInactivityCheck()
+    ;
+
+builder.Services
+    .AddReverseProxy()
+    .AddTenantClusters()
+    .LoadFromConfig(builder.Configuration.GetSection("OrchardCore_Clusters"))
+    ;
 
 var app = builder.Build();
 
@@ -16,7 +25,16 @@
 }
 
 app.UseStaticFiles();
-
 app.UseOrchardCore();
 
+app.MapReverseProxy(proxyPipeline =>
+{
+    proxyPipeline
+        .UseTenantClusters()
+        .UseSessionAffinity()
+        .UseLoadBalancing()
+        .UsePassiveHealthChecks()
+        ;
+});
+
 await app.RunAsync();

src/OrchardCore.Cms.Web/appsettings.json

@@ -7,6 +7,8 @@
     }
   },
   //"AllowedHosts": "example.com;localhost", // A semicolon-delimited list of host names without port numbers. Set it for public-facing edge servers or when the Host header is directly forwarded.
+  //"AllowedHosts": "*",
+  // See the Tenant Clustering documentation for OrchardCore_Clusters configuration examples.
   "OrchardCore": {
     // See https://docs.orchardcore.net/en/latest/reference/modules/Admin/#custom-admin-prefix
     //"OrchardCore_Admin": {

src/OrchardCore.Themes/TheBlogTheme/Views/Layout.liquid

@@ -46,4 +46,4 @@
     </footer>
     {% resources type: "FootScript" %}
 </body>
-</html>
+</html>

src/OrchardCore/OrchardCore.Abstractions/Clusters/ClusterFeature.cs

@@ -0,0 +1,12 @@
+namespace OrchardCore.Clusters;
+
+/// <summary>
+/// Used to capture the selected tenant cluster identifier.
+/// </summary>
+public class ClusterFeature
+{
+    /// <summary>
+    /// The selected tenant cluster identifier.
+    /// </summary>
+    public string ClusterId { get; set; }
+}

src/OrchardCore/OrchardCore.Abstractions/Clusters/ClusterOptions.cs

@@ -0,0 +1,22 @@
+namespace OrchardCore.Clusters;
+
+/// <summary>
+/// Tenant Cluster options.
+/// </summary>
+public class ClusterOptions
+{
+    /// <summary>
+    /// The cluster identifier.
+    /// </summary>
+    public string ClusterId { get; set; }
+
+    /// <summary>
+    /// The minimum tenant slot number.
+    /// </summary>
+    public int SlotMin { get; set; }
+
+    /// <summary>
+    /// The maximum tenant slot number.
+    /// </summary>
+    public int SlotMax { get; set; }
+}

src/OrchardCore/OrchardCore.Abstractions/Clusters/ClustersOptions.cs

@@ -0,0 +1,28 @@
+using System;
+using System.Collections.Generic;
+
+namespace OrchardCore.Clusters;
+
+/// <summary>
+/// Tenant Clusters options.
+/// </summary>
+public class ClustersOptions
+{
+    // The identifier of the route template used by the clusters proxy.
+    public static readonly string RouteTemplate = nameof(RouteTemplate);
+
+    /// <summary>
+    /// Wether tenant clusters is enabled or not.
+    /// </summary>
+    public bool Enabled { get; set; }
+
+    /// <summary>
+    /// The maximum idle time before a tenant is released.
+    /// </summary>
+    public TimeSpan? MaxIdleTime { get; set; }
+
+    /// <summary>
+    /// List of all single <see cref="ClusterOptions"/>.
+    /// </summary>
+    public List<ClusterOptions> Clusters { get; set; } = new();
+}

src/OrchardCore/OrchardCore.Abstractions/Clusters/Crc16XModem.cs

@@ -0,0 +1,54 @@
+using System.Text;
+
+namespace OrchardCore.Clusters;
+
+/// <summary>
+/// Implements the 'CRC-16/XMODEM' algorithm.
+/// </summary>
+public class Crc16XModem
+{
+    private static readonly int[] _lookup = new int[256];
+
+    static Crc16XModem()
+    {
+        for (var i = 0; i < _lookup.Length; i++)
+        {
+            var result = i << 8;
+            for (var n = 0; n < 8; n++)
+            {
+                result <<= 1;
+                if ((result & 0x10000) != 0)
+                {
+                    result ^= 0x1021;
+                }
+            }
+
+            _lookup[i] = result;
+        }
+    }
+
+    /// <summary>
+    /// Checks the 'CRC-16' algorithm.
+    /// </summary>
+    public static bool Check() => Compute("123456789") == 0x31c3;
+
+    /// <summary>
+    /// Computes the 'CRC-16' of the provided string.
+    /// </summary>
+    public static int Compute(string input) => Compute(Encoding.ASCII.GetBytes(input));
+
+
+    /// <summary>
+    /// Computes the 'CRC-16' of the provided byte array.
+    /// </summary>
+    public static int Compute(byte[] input)
+    {
+        var result = 0;
+        for (var i = 0; i < input.Length; i++)
+        {
+            result = _lookup[(result >> 8 ^ input[i]) & 0xff] ^ result << 8;
+        }
+
+        return result & 0xffff;
+    }
+}

src/OrchardCore/OrchardCore.Abstractions/Clusters/HttpContextExtensions.cs

@@ -0,0 +1,44 @@
+using System.Linq;
+using Microsoft.AspNetCore.Http;
+
+namespace OrchardCore.Clusters;
+
+/// <summary>
+/// Extension methods for checking clusters proxy requests.
+/// </summary>
+public static class HttpContextExtensions
+{
+    /// <summary>
+    /// Checks if this instance runs as a clusters proxy.
+    /// </summary>
+    public static bool AsClustersProxy(this HttpContext context, ClustersOptions options) =>
+        options.Enabled && !context.FromClustersProxy();
+
+    /// <summary>
+    /// Checks if the current request comes from a clusters proxy.
+    /// </summary>
+    public static bool FromClustersProxy(this HttpContext context) =>
+        context.Request.Headers.TryGetValue(RequestHeaderNames.FromClustersProxy, out _);
+
+    /// <summary>
+    /// Tries to get the <see cref="ClusterFeature"/> holding the selected tenant cluster identifier.
+    /// </summary>
+    public static bool TryGetClusterFeature(this HttpContext context, out ClusterFeature feature)
+    {
+        feature = context.Features.Get<ClusterFeature>();
+        return feature != null;
+    }
+
+    /// <summary>
+    /// Returns the original host header if it exists, otherwise the request host.
+    /// </summary>
+    public static string GetClustersRequestHost(this HttpContext context)
+    {
+        if (!context.Request.Headers.TryGetValue(RequestHeaderNames.XOriginalHost, out var hosts))
+        {
+            return context.Request.Host.ToString();
+        }
+
+        return hosts.FirstOrDefault();
+    }
+}

src/OrchardCore/OrchardCore.Abstractions/Clusters/RequestHeaderNames.cs

@@ -0,0 +1,22 @@
+namespace OrchardCore.Clusters;
+
+/// <summary>
+/// Request headers used by the clusters proxy.
+/// </summary>
+public class RequestHeaderNames
+{
+    /// <summary>
+    /// Sent by any clusters proxy request, prevents network loops.
+    /// </summary>
+    public static readonly string FromClustersProxy = "From-Clusters-Proxy";
+
+    /// <summary>
+    /// Prevents proxy requests matching while tenant clusters is disabled.
+    /// </summary>
+    public static readonly string FakeClustersHeader = "Fake-Clusters-Header";
+
+    /// <summary>
+    /// Used to retrieve the original host while behind a clusters proxy.
+    /// </summary>
+    public static readonly string XOriginalHost = "X-Original-Host";
+}

src/OrchardCore/OrchardCore.Abstractions/Clusters/ShellSettingsExtensions.cs

@@ -0,0 +1,26 @@
+using OrchardCore.Environment.Shell;
+
+namespace OrchardCore.Clusters;
+
+/// <summary>
+/// Extension methods for managing tenant clusters.
+/// </summary>
+public static class ShellSettingsExtensions
+{
+    /// <summary>
+    /// Returns the selected tenant cluster based on the provided <see cref="ShellSettings"/>.
+    /// </summary>
+    public static string GetClusterId(this ShellSettings settings, ClustersOptions options)
+    {
+        foreach (var cluster in options.Clusters)
+        {
+            // Check if the cluster slot of the current tenant is in the cluster slot range.
+            if (settings.ClusterSlot >= cluster.SlotMin && settings.ClusterSlot <= cluster.SlotMax)
+            {
+                return cluster.ClusterId;
+            }
+        }
+
+        return null;
+    }
+}

src/OrchardCore/OrchardCore.Abstractions/Shell/Builders/ShellContext.cs

@@ -13,6 +13,7 @@ public class ShellContext : IDisposable, IAsyncDisposable
     private bool _disposed;
     private volatile int _refCount;
     private int _terminated;
+    internal long _requestTicks;
     private bool _released;
 
     /// <summary>
@@ -45,6 +46,16 @@ public class ShellContext : IDisposable, IAsyncDisposable
     /// </summary>
     public bool IsActivated { get; set; }
 
+    /// <summary>
+    /// The UTC date and time of the last request.
+    /// Read and write operations are both atomic.
+    /// </summary>
+    public DateTime LastRequestTimeUtc
+    {
+        get => new(Interlocked.Read(ref _requestTicks));
+        internal set => Interlocked.Exchange(ref _requestTicks, value.Ticks);
+    }
+
     /// <summary>
     /// The Pipeline built for this shell.
     /// </summary>