instance config (#1791)

* instance config

* address PR comments

* make logs scoped

* make logs scoped

Co-authored-by: stas <statis@microsoft.com>

Author: 2 people

src/ApiService/ApiService/Info.cs

@@ -132,22 +132,34 @@ public interface ILogTracer
     void ForceFlush();
     void Info(string message);
     void Warning(string message);
+    void Verbose(string message);
 
-    ILogTracer AddTags((string, string)[]? tags);
+    ILogTracer WithTag(string k, string v);
+    ILogTracer WithTags((string, string)[]? tags);
 }
 
 internal interface ILogTracerInternal : ILogTracer
+{
+    void ReplaceCorrelationId(Guid newCorrelationId);
+    void AddTags((string, string)[] tags);
+}
+
+
+
+public class LogTracer : ILogTracerInternal
 {
     private string? GetCaller()
     {
         return new StackTrace()?.GetFrame(2)?.GetMethod()?.DeclaringType?.FullName;
     }
 
+    private Guid _correlationId;
     private List<ILog> _loggers;
+    private Dictionary<string, string> _tags;
+    private SeverityLevel _logSeverityLevel;
 
-    public Guid CorrelationId { get; }
-    public IReadOnlyDictionary<string, string> Tags { get; }
-
+    public Guid CorrelationId => _correlationId;
+    public IReadOnlyDictionary<string, string> Tags => _tags;
 
     private static List<KeyValuePair<string, string>> ConvertTags((string, string)[]? tags)
     {
@@ -166,17 +178,43 @@ private static List<KeyValuePair<string, string>> ConvertTags((string, string)[]
         }
     }
 
-    public LogTracer(Guid correlationId, (string, string)[]? tags, List<ILog> loggers) : this(correlationId, new Dictionary<string, string>(ConvertTags(tags)), loggers) { }
+    public LogTracer(Guid correlationId, (string, string)[]? tags, List<ILog> loggers, SeverityLevel logSeverityLevel) :
+        this(correlationId, new Dictionary<string, string>(ConvertTags(tags)), loggers, logSeverityLevel)
+    { }
 
 
-    public LogTracer(Guid correlationId, IReadOnlyDictionary<string, string> tags, List<ILog> loggers)
+    public LogTracer(Guid correlationId, IReadOnlyDictionary<string, string> tags, List<ILog> loggers, SeverityLevel logSeverityLevel)
     {
-        CorrelationId = correlationId;
-        Tags = tags;
+        _correlationId = correlationId;
+        _tags = new(tags);
         _loggers = loggers;
+        _logSeverityLevel = logSeverityLevel;
+    }
+
+    //Single threaded only
+    public void ReplaceCorrelationId(Guid newCorrelationId)
+    {
+        _correlationId = newCorrelationId;
+    }
+
+    //single threaded only
+    public void AddTags((string, string)[] tags)
+    {
+        if (tags is not null)
+        {
+            foreach (var (k, v) in tags)
+            {
+                _tags[k] = v;
+            }
+        }
     }
 
-    public ILogTracer AddTags((string, string)[]? tags)
+    public ILogTracer WithTag(string k, string v)
+    {
+        return WithTags(new[] { (k, v) });
+    }
+
+    public ILogTracer WithTags((string, string)[]? tags)
     {
         var newTags = new Dictionary<string, string>(Tags);
         if (tags is not null)
@@ -186,42 +224,66 @@ public ILogTracer AddTags((string, string)[]? tags)
                 newTags[k] = v;
             }
         }
-        return new LogTracer(CorrelationId, newTags, _loggers);
+        return new LogTracer(CorrelationId, newTags, _loggers, _logSeverityLevel);
+    }
+
+    public void Verbose(string message)
+    {
+        if (_logSeverityLevel >= SeverityLevel.Verbose)
+        {
+            var caller = GetCaller();
+            foreach (var logger in _loggers)
+            {
+                logger.Log(CorrelationId, message, SeverityLevel.Verbose, Tags, caller);
+            }
+        }
     }
 
     public void Info(string message)
     {
-        var caller = GetCaller();
-        foreach (var logger in _loggers)
+        if (_logSeverityLevel >= SeverityLevel.Information)
         {
-            logger.Log(CorrelationId, message, SeverityLevel.Information, Tags, caller);
+            var caller = GetCaller();
+            foreach (var logger in _loggers)
+            {
+                logger.Log(CorrelationId, message, SeverityLevel.Information, Tags, caller);
+            }
         }
     }
 
     public void Warning(string message)
     {
-        var caller = GetCaller();
-        foreach (var logger in _loggers)
+        if (_logSeverityLevel >= SeverityLevel.Warning)
         {
-            logger.Log(CorrelationId, message, SeverityLevel.Warning, Tags, caller);
+            var caller = GetCaller();
+            foreach (var logger in _loggers)
+            {
+                logger.Log(CorrelationId, message, SeverityLevel.Warning, Tags, caller);
+            }
         }
     }
 
     public void Error(string message)
     {
-        var caller = GetCaller();
-        foreach (var logger in _loggers)
+        if (_logSeverityLevel >= SeverityLevel.Error)
         {
-            logger.Log(CorrelationId, message, SeverityLevel.Error, Tags, caller);
+            var caller = GetCaller();
+            foreach (var logger in _loggers)
+            {
+                logger.Log(CorrelationId, message, SeverityLevel.Error, Tags, caller);
+            }
         }
     }
 
     public void Critical(string message)
     {
-        var caller = GetCaller();
-        foreach (var logger in _loggers)
+        if (_logSeverityLevel >= SeverityLevel.Critical)
         {
-            logger.Log(CorrelationId, message, SeverityLevel.Critical, Tags, caller);
+            var caller = GetCaller();
+            foreach (var logger in _loggers)
+            {
+                logger.Log(CorrelationId, message, SeverityLevel.Critical, Tags, caller);
+            }
         }
     }
 
@@ -254,7 +316,7 @@ public void ForceFlush()
 
 public interface ILogTracerFactory
 {
-    LogTracer MakeLogTracer(Guid correlationId, (string, string)[]? tags = null);
+    LogTracer CreateLogTracer(Guid correlationId, (string, string)[]? tags = null, SeverityLevel severityLevel = SeverityLevel.Verbose);
 }
 
 public class LogTracerFactory : ILogTracerFactory
@@ -266,9 +328,9 @@ public LogTracerFactory(List<ILog> loggers)
         _loggers = loggers;
     }
 
-    public LogTracer MakeLogTracer(Guid correlationId, (string, string)[]? tags = null)
+    public LogTracer CreateLogTracer(Guid correlationId, (string, string)[]? tags = null, SeverityLevel severityLevel = SeverityLevel.Verbose)
     {
-        return new(correlationId, tags, _loggers);
+        return new(correlationId, tags, _loggers, severityLevel);
     }
 
 }

src/ApiService/ApiService/Log.cs

@@ -1,9 +1,14 @@
 using Microsoft.OneFuzz.Service.OneFuzzLib.Orm;
 using System;
 using System.Collections.Generic;
-using PoolName = System.String;
-using Region = System.String;
+using System.Text.Json.Serialization;
+
 using Container = System.String;
+using Region = System.String;
+using PoolName = System.String;
+using Endpoint = System.String;
+using GroupId = System.Guid;
+using PrincipalId = System.Guid;
 
 namespace Microsoft.OneFuzz.Service;
 
@@ -16,6 +21,7 @@ namespace Microsoft.OneFuzz.Service;
 /// the "partion key" and "row key" are identified by the [PartitionKey] and [RowKey] attributes
 /// Guids are mapped to string in the db
 
+
 public record Authentication
 (
     string Password,
@@ -259,5 +265,118 @@ public record Task(
 {
     List<TaskEventSummary> Events { get; set; } = new List<TaskEventSummary>();
     List<NodeAssignment> Nodes { get; set; } = new List<NodeAssignment>();
+}
+public record AzureSecurityExtensionConfig();
+public record GenevaExtensionConfig();
+
+
+public record KeyvaultExtensionConfig(
+    string KeyVaultName,
+    string CertName,
+    string CertPath,
+    string ExtensionStore
+);
+
+public record AzureMonitorExtensionConfig(
+    string ConfigVersion,
+    string Moniker,
+    string Namespace,
+    [property: JsonPropertyName("monitoringGSEnvironment")] string MonitoringGSEnvironment,
+    [property: JsonPropertyName("monitoringGCSAccount")] string MonitoringGCSAccount,
+    [property: JsonPropertyName("monitoringGCSAuthId")] string MonitoringGCSAuthId,
+    [property: JsonPropertyName("monitoringGCSAuthIdType")] string MonitoringGCSAuthIdType
+);
 
+public record AzureVmExtensionConfig(
+    KeyvaultExtensionConfig? Keyvault,
+    AzureMonitorExtensionConfig AzureMonitor
+);
+
+public record NetworkConfig(
+    string AddressSpace,
+    string Subnet
+)
+{
+    public NetworkConfig() : this("10.0.0.0/8", "10.0.0.0/16") { }
+}
+
+public record NetworkSecurityGroupConfig(
+    string[] AllowedServiceTags,
+    string[] AllowedIps
+)
+{
+    public NetworkSecurityGroupConfig() : this(Array.Empty<string>(), Array.Empty<string>()) { }
+}
+
+public record ApiAccessRule(
+    string[] Methods,
+    Guid[] AllowedGroups
+);
+
+public record InstanceConfig
+(
+    [PartitionKey, RowKey] string InstanceName,
+    //# initial set of admins can only be set during deployment.
+    //# if admins are set, only admins can update instance configs.
+    Guid[]? Admins,
+    //# if set, only admins can manage pools or scalesets
+    bool AllowPoolManagement,
+    string[] AllowedAadTenants,
+    NetworkConfig NetworkConfig,
+    NetworkSecurityGroupConfig ProxyNsgConfig,
+    AzureVmExtensionConfig? Extensions,
+    string ProxyVmSku,
+    IDictionary<Endpoint, ApiAccessRule>? ApiAccessRules,
+    IDictionary<PrincipalId, GroupId[]>? GroupMembership,
+
+    IDictionary<string, string>? VmTags,
+    IDictionary<string, string>? VmssTags
+) : EntityBase()
+{
+    public InstanceConfig(string instanceName) : this(
+        instanceName,
+        null,
+        true,
+        Array.Empty<string>(),
+        new NetworkConfig(),
+        new NetworkSecurityGroupConfig(),
+        null,
+        "Standard_B2s",
+        null,
+        null,
+        null,
+        null)
+    { }
+
+    public List<Guid>? CheckAdmins(List<Guid>? value)
+    {
+        if (value is not null && value.Count == 0)
+        {
+            throw new ArgumentException("admins must be null or contain at least one UUID");
+        }
+        else
+        {
+            return value;
+        }
+    }
+
+
+    //# At the moment, this only checks allowed_aad_tenants, however adding
+    //# support for 3rd party JWT validation is anticipated in a future release.
+    public ResultOk<List<string>> CheckInstanceConfig()
+    {
+        List<string> errors = new();
+        if (AllowedAadTenants.Length == 0)
+        {
+            errors.Add("allowed_aad_tenants must not be empty");
+        }
+        if (errors.Count == 0)
+        {
+            return ResultOk<List<string>>.Ok();
+        }
+        else
+        {
+            return ResultOk<List<string>>.Error(errors);
+        }
+    }
 }