Add a DB maintenance mode to ServiceControl

Added the-maintenance  command line switch to allow ServiceControl to be
started with reduced functionality.  In this mode it serves up the
RavenDB Web UI but disables the Raven Bundles and the periodic deletion
code and does not start the bus so message processing and the REST API
are also disabled.

Author: Greg Bielleman

src/ServiceControl/Bootstrapper.cs

@@ -22,6 +22,7 @@ public class Bootstrapper
         IStartableBus bus;
         public static IContainer Container { get; set; }
 
+
         public Bootstrapper(ServiceBase host = null, HostArguments hostArguments = null)
         {
             Settings.ServiceName = DetermineServiceName(host, hostArguments);
@@ -81,6 +82,18 @@ static bool IsExternalContract(Type t)
 
         public void Start()
         {
+             var Logger = NServiceBus.Logging.LogManager.GetLogger(typeof(Bootstrapper));
+            if (Settings.MaintenanceMode)
+            {
+                Logger.InfoFormat("RavenDB is now accepting requests on {0}", Settings.StorageUrl);
+                Logger.Warn("RavenDB Maintenance Mode - Press Enter to exit");
+                while (Console.ReadLine() == null)
+                {
+                }
+                return;
+            }
+
+            
             bus.Start(() =>
             {
                 if (Environment.UserInteractive && Debugger.IsAttached)
@@ -123,11 +136,6 @@ static void ConfigureLogging()
             nlogConfig.LoggingRules.Add(new LoggingRule("Raven.*", LogLevel.Warn, fileTarget));
             nlogConfig.LoggingRules.Add(new LoggingRule("Raven.*", LogLevel.Warn, consoleTarget) { Final = true });
             nlogConfig.LoggingRules.Add(new LoggingRule("Particular.ServiceControl.Licensing.*", LogLevel.Info, fileTarget));
-
-#if (DEBUG)  //TODO : Remove once we've stabilized deletions
-            nlogConfig.LoggingRules.Add(new LoggingRule("ServiceControl.Infrastructure.RavenDB.Expiration.*", LogLevel.Debug, consoleTarget));
-            nlogConfig.LoggingRules.Add(new LoggingRule("ServiceControl.Infrastructure.RavenDB.Expiration.*", LogLevel.Debug, fileTarget));
-#endif
             nlogConfig.LoggingRules.Add(new LoggingRule("NServiceBus.Licensing.*", LogLevel.Error, fileTarget));
             nlogConfig.LoggingRules.Add(new LoggingRule("NServiceBus.Licensing.*", LogLevel.Error, consoleTarget) { Final = true });
             nlogConfig.LoggingRules.Add(new LoggingRule("*", LogLevel.Warn, fileTarget));

src/ServiceControl/Hosting/Commands/MaintCommand.cs

@@ -0,0 +1,17 @@
+namespace ServiceControl.Hosting.Commands
+{
+    using Particular.ServiceControl;
+    using Particular.ServiceControl.Commands;
+    using Particular.ServiceControl.Hosting;
+
+    class MaintCommand : AbstractCommand
+    {
+        Bootstrapper bootstrapper;
+
+        public override void Execute(HostArguments args)
+        {
+            bootstrapper = new Bootstrapper(null, args);
+            bootstrapper.Start();
+        }
+    }
+}

src/ServiceControl/Hosting/Help.txt

@@ -6,6 +6,7 @@ USAGE:
    ServiceControl.exe --restart [options]
    ServiceControl.exe --install [options]
    ServiceControl.exe --uninstall [options]
+   ServiceControl.exe --maintenance [options]
 
 DEFAULT OPTIONS:
 
@@ -19,6 +20,13 @@ UNINSTALL OPTIONS:
 
 {2}
 
+MAINTENANCE 
+
+The maintenance switch allows RavenDB Maintenance tasks to be carried out.  In this mode ServiceControl enables the RavenDB Web UI only.  
+The REST API, message importers and the background document expiry are all disabled.
+
+This mode is only supported when run interactively. 
+
 CONFIGURATION OPTIONS:
 
 ServiceControl/LogPath string

src/ServiceControl/Hosting/HostArguments.cs

@@ -8,6 +8,7 @@ namespace Particular.ServiceControl.Hosting
     using System.Text;
     using Commands;
     using global::ServiceControl.Hosting.Commands;
+    using ServiceBus.Management.Infrastructure.Settings;
 
     public class HostArguments
     {
@@ -79,9 +80,25 @@ public HostArguments(string[] args)
                     "serviceName=",
                     @"Specify the service name for the installed service."
                     , s => { ServiceName = s; }
+                },
+            };
+
+            maintenanceOptions = new OptionSet
+            {
+                {
+                    "m|maint|maintenance",
+                    @"Run RavenDB only - use for DB maintenance", 
+                    s => {
+                        commands = new List<Type>
+                        {
+                            typeof(MaintCommand)
+                        };
+                        executionMode = ExecutionMode.Maintenance;
+                    }
                 }
             };
 
+         
             uninstallOptions = new OptionSet
             {
                 {
@@ -103,8 +120,6 @@ public HostArguments(string[] args)
                 }
             };
 
-            
-
             installOptions = new OptionSet
             {
                 {
@@ -207,6 +222,12 @@ public HostArguments(string[] args)
                 {
                     return;
                 }
+                maintenanceOptions.Parse(args);
+                if (executionMode == ExecutionMode.Maintenance)
+                {
+                    Settings.MaintenanceMode = true;
+                    return;
+                }
 
                 defaultOptions.Parse(args);
             }
@@ -278,6 +299,7 @@ public void PrintUsage()
         readonly OptionSet installOptions;
         readonly OptionSet uninstallOptions;
         readonly OptionSet defaultOptions;
+        readonly OptionSet maintenanceOptions;
         List<Type> commands;
         Dictionary<string, string> options = new Dictionary<string, string>();
         StartMode startMode;
@@ -287,7 +309,8 @@ internal enum ExecutionMode
     {
         Install,
         Uninstall,
-        Run
+        Run,
+        Maintenance
     }
 
     public enum StartMode

src/ServiceControl/Infrastructure/RavenDB/RavenBootstrapper.cs

@@ -16,7 +16,6 @@
 
     public class RavenBootstrapper : INeedInitialization
     {
-
         public static string ReadLicense()
         {
             using (var resourceStream = typeof(RavenBootstrapper).Assembly.GetManifestResourceStream("ServiceControl.Infrastructure.RavenDB.RavenLicense.xml"))
@@ -33,7 +32,7 @@ public void Init()
             var documentStore = new EmbeddableDocumentStore
             {
                 DataDirectory = Settings.DbPath,
-                UseEmbeddedHttpServer = Settings.ExposeRavenDB,
+                UseEmbeddedHttpServer = Settings.MaintenanceMode || Settings.ExposeRavenDB,
                 EnlistInDistributedTransactions = false,
             };
 
@@ -48,19 +47,20 @@ public void Init()
                 Logger.InfoFormat("Loading Embedded RavenDB license");
                 documentStore.Configuration.Settings["Raven/License"] = ReadLicense();
             }
-            
+
             documentStore.Configuration.Catalog.Catalogs.Add(new AssemblyCatalog(GetType().Assembly));
-            documentStore.Configuration.Settings.Add("Raven/ActiveBundles", "CustomDocumentExpiration"); 
+            
+            if (!Settings.MaintenanceMode) {
+                documentStore.Configuration.Settings.Add("Raven/ActiveBundles", "CustomDocumentExpiration");
+            }
+
             documentStore.Configuration.Port = Settings.Port;
             documentStore.Configuration.HostName = (Settings.Hostname == "*" || Settings.Hostname == "+")
                 ? "localhost"
                 : Settings.Hostname;
             documentStore.Configuration.CompiledIndexCacheDirectory = Settings.DbPath;
             documentStore.Configuration.VirtualDirectory = Settings.VirtualDirectory + "/storage";
-
             documentStore.Conventions.SaveEnumsAsIntegers = true;
-
-            
             documentStore.Initialize();
 
             Logger.Info("Index creation started");

src/ServiceControl/Infrastructure/Settings/Settings.cs

@@ -18,6 +18,8 @@ static Settings()
             TransportType = SettingsReader<string>.Read("TransportType", typeof(Msmq).AssemblyQualifiedName);
         }
 
+        public static bool MaintenanceMode;
+
         public static string ApiUrl
         {
             get

src/ServiceControl/ServiceControl.csproj

@@ -240,6 +240,7 @@
     <Compile Include="Hosting\Commands\AbstractCommand.cs" />
     <Compile Include="Hosting\Commands\CommandRunner.cs" />
     <Compile Include="Hosting\Commands\InstallCommand.cs" />
+    <Compile Include="Hosting\Commands\MaintCommand.cs" />
     <Compile Include="Hosting\Commands\RestartCommand.cs" />
     <Compile Include="Hosting\Commands\RunBootstrapperAndNServiceBusInstallers.cs" />
     <Compile Include="Hosting\Commands\RunCommand.cs" />