Add commands on Windows to remount as either user or system (#490)

* Add enable remount with system or user on Windows

* Add unmount command

* First pass on using windows service for system startup

* Fix build

* Fix issues with service starting correctly.

* Fix error messages

* Finish windows service start tool

* Final changes

* Cleanup documentation and simplify some logic

Author: jfantinhardesty

.goreleaser.yaml

@@ -41,6 +41,22 @@ builds:
     ldflags:
       - -s -w -X github.com/Seagate/cloudfuse/common.GitCommit={{.Commit}} -X github.com/Seagate/cloudfuse/common.CommitDate={{ .CommitDate }}
 
+  - id: windows-service
+    main: ./tools/windows-service/main.go
+    binary: windows-service
+    goos:
+      - windows
+    goarch:
+      - amd64
+    env:
+      - CGO_ENABLED=0
+    flags:
+      - -trimpath
+      - -buildmode=pie
+    mod_timestamp: "{{ .CommitTimestamp }}"
+    ldflags:
+      - -s -w -X github.com/Seagate/cloudfuse/common.GitCommit={{.Commit}} -X github.com/Seagate/cloudfuse/common.CommitDate={{ .CommitDate }}
+
   - id: windows-health-monitor
     main: ./tools/health-monitor/main.go
     binary: cfusemon
@@ -181,6 +197,7 @@ archives:
       - windows
       - windows-startup
       - windows-health-monitor
+      - windows-service
     formats: ["zip"]
     files:
       - LICENSE
@@ -196,7 +213,9 @@ archives:
   - id: windows_no_gui
     ids:
       - windows
+      - windows-startup
       - windows-health-monitor
+      - windows-service
     formats: ["zip"]
     name_template: "{{ .ProjectName }}_no_gui_{{ .Version }}_{{ .Os }}_{{ .Arch }}"
     files:

build.sh

@@ -21,6 +21,10 @@ else
     rm -rf windows-startup
     go build -o windows-startup.exe ./tools/windows-startup/
 
+    # Build Windows Service Tool
+    rm -rf windows-service
+    go build -o windows-service.exe ./tools/windows-service/
+
     # Build cloudfuse
     rm -rf cloudfuse.exe
     go build -o cloudfuse.exe

build/windows_installer_build.iss

@@ -51,6 +51,7 @@ Source: "..\gui\dist\cloudfuseGUI_Windows\_internal\*"; DestDir: "{app}\_interna
 Source: "..\cloudfuse.exe"; DestDir: "{app}"; Flags: ignoreversion
 Source: "..\cfusemon.exe"; DestDir: "{app}"; Flags: ignoreversion
 Source: "..\windows-startup.exe"; DestDir: "{app}"; Flags: ignoreversion
+Source: "..\windows-service.exe"; DestDir: "{app}"; Flags: ignoreversion
 Source: "..\NOTICE"; DestDir: "{app}"; Flags: ignoreversion
 Source: "..\LICENSE"; DestDir: "{app}"; Flags: ignoreversion
 Source: "..\README.md"; DestDir: "{app}"; Flags: ignoreversion
@@ -128,7 +129,7 @@ var
 begin
   if CurUninstallStep = usUninstall then
   begin
-    // Install the Cloudfuse Startup Tool
+    // Uninstall the Cloudfuse Startup Tool
     if not Exec(ExpandConstant('{app}\{#MyAppExeCLIName}'), 'service uninstall', '', SW_HIDE, ewWaitUntilTerminated, ResultCode) then
     begin
       SuppressibleMsgBox('Failed to remove cloudfuse as a service.', mbError, MB_OK, IDOK);

build/windows_installer_build_no_gui.iss

@@ -45,6 +45,7 @@ Name: "{userappdata}\{#MyAppName}"; Flags: uninsalwaysuninstall
 Source: "..\cloudfuse.exe"; DestDir: "{app}"; Flags: ignoreversion
 Source: "..\cfusemon.exe"; DestDir: "{app}"; Flags: ignoreversion
 Source: "..\windows-startup.exe"; DestDir: "{app}"; Flags: ignoreversion
+Source: "..\windows-service.exe"; DestDir: "{app}"; Flags: ignoreversion
 Source: "..\NOTICE"; DestDir: "{app}"; Flags: ignoreversion
 Source: "..\LICENSE"; DestDir: "{app}"; Flags: ignoreversion
 Source: "..\README.md"; DestDir: "{app}"; Flags: ignoreversion
@@ -115,7 +116,7 @@ var
 begin
   if CurUninstallStep = usUninstall then
   begin
-    // Install the Cloudfuse Startup Tool
+    // Uninstall the Cloudfuse Startup Tool
     if not Exec(ExpandConstant('{app}\{#MyAppExeCLIName}'), 'service uninstall', '', SW_HIDE, ewWaitUntilTerminated, ResultCode) then
     begin
       SuppressibleMsgBox('Failed to remove cloudfuse as a service.', mbError, MB_OK, IDOK);

cmd/mount.go

@@ -66,23 +66,24 @@ type mountOptions struct {
 	MountPath  string
 	ConfigFile string
 
-	DryRun            bool
-	Logging           LogOptions     `config:"logging"`
-	Components        []string       `config:"components"`
-	Foreground        bool           `config:"foreground"`
-	NonEmpty          bool           `config:"nonempty"`
-	DefaultWorkingDir string         `config:"default-working-dir"`
-	CPUProfile        string         `config:"cpu-profile"`
-	MemProfile        string         `config:"mem-profile"`
-	PassPhrase        string         `config:"passphrase"`
-	SecureConfig      bool           `config:"secure-config"`
-	DynamicProfiler   bool           `config:"dynamic-profile"`
-	ProfilerPort      int            `config:"profiler-port"`
-	ProfilerIP        string         `config:"profiler-ip"`
-	MonitorOpt        monitorOptions `config:"health_monitor"`
-	WaitForMount      time.Duration  `config:"wait-for-mount"`
-	LazyWrite         bool           `config:"lazy-write"`
-	EnableRemount     bool
+	DryRun              bool
+	Logging             LogOptions     `config:"logging"`
+	Components          []string       `config:"components"`
+	Foreground          bool           `config:"foreground"`
+	NonEmpty            bool           `config:"nonempty"`
+	DefaultWorkingDir   string         `config:"default-working-dir"`
+	CPUProfile          string         `config:"cpu-profile"`
+	MemProfile          string         `config:"mem-profile"`
+	PassPhrase          string         `config:"passphrase"`
+	SecureConfig        bool           `config:"secure-config"`
+	DynamicProfiler     bool           `config:"dynamic-profile"`
+	ProfilerPort        int            `config:"profiler-port"`
+	ProfilerIP          string         `config:"profiler-ip"`
+	MonitorOpt          monitorOptions `config:"health_monitor"`
+	WaitForMount        time.Duration  `config:"wait-for-mount"`
+	LazyWrite           bool           `config:"lazy-write"`
+	EnableRemountUser   bool
+	EnableRemountSystem bool
 
 	// v1 support
 	Streaming      bool     `config:"streaming"`
@@ -273,7 +274,6 @@ var mountCmd = &cobra.Command{
 	FlagErrorHandling: cobra.ExitOnError,
 	RunE: func(_ *cobra.Command, args []string) error {
 		options.MountPath = common.ExpandPath(args[0])
-		configFileProvided := options.ConfigFile != ""
 		common.MountPath = options.MountPath
 
 		if options.ConfigFile == "" {
@@ -321,7 +321,7 @@ var mountCmd = &cobra.Command{
 				return errors.New("config file does not exist")
 			}
 			// mount using WinFSP, and persist on reboot
-			err = createMountInstance(options.EnableRemount)
+			err = createMountInstance(options.EnableRemountUser, options.EnableRemountSystem)
 			if err != nil {
 				return fmt.Errorf("failed to mount instance [%s]", err.Error())
 			}
@@ -492,14 +492,8 @@ var mountCmd = &cobra.Command{
 				return Destroy(fmt.Sprintf("failed to initialize new pipeline :: To authenticate using MSI with object-ID, ensure Azure CLI is installed. Alternatively, use app/client ID or resource ID for authentication. [%s]", err.Error()))
 			}
 
-			errorMessage := ""
-			if !configFileProvided {
-				errorMessage += "config file not provided."
-			} else {
-				errorMessage += "Config file " + options.ConfigFile + " not found."
-			}
-			log.Err("mount : "+errorMessage+" failed to initialize new pipeline [%v]", err)
-			return Destroy(fmt.Sprintf("%s failed to initialize new pipeline [%s]", errorMessage, err.Error()))
+			log.Err("mount :  failed to initialize new pipeline [%v]", err)
+			return Destroy(fmt.Sprintf("mount : failed to initialize new pipeline [%s]", err.Error()))
 		}
 
 		// Dry run ends here
@@ -745,8 +739,11 @@ func init() {
 	mountCmd.Flags().Lookup("basic-remount-check").Hidden = true
 
 	if runtime.GOOS == "windows" {
-		mountCmd.Flags().BoolVar(&options.EnableRemount, "enable-remount", true, "Remount mount on server restart.")
-		config.BindPFlag("enable-remount", mountCmd.Flags().Lookup("enable-remount"))
+		mountCmd.Flags().BoolVar(&options.EnableRemountSystem, "enable-remount-system", false, "Remount container on server restart. Mount will restart on reboot.")
+		config.BindPFlag("enable-remount-system", mountCmd.Flags().Lookup("enable-remount-system"))
+
+		mountCmd.Flags().BoolVar(&options.EnableRemountUser, "enable-remount-user", false, "Remount container on server restart for current user. Mount will restart on current user log in.")
+		config.BindPFlag("enable-remount-user", mountCmd.Flags().Lookup("enable-remount-user"))
 	}
 
 	mountCmd.PersistentFlags().StringSliceVarP(&options.LibfuseOptions, "o", "o", []string{}, "FUSE options.")

cmd/mount_linux.go

@@ -131,6 +131,6 @@ func sigusrHandler(pipeline *internal.Pipeline, ctx context.Context) daemon.Sign
 }
 
 // stub for compilation
-func createMountInstance(bool) error {
+func createMountInstance(bool, bool) error {
 	return nil
 }

cmd/mount_windows.go

@@ -42,14 +42,14 @@ func createDaemon(pipeline *internal.Pipeline, ctx context.Context, pidFileName
 }
 
 // Use WinFSP to mount and if successful, add instance to persistent mount list
-func createMountInstance(enableRemount bool) error {
+func createMountInstance(enableRemountUser bool, enableRemountSystem bool) error {
 	err := winservice.StartMount(options.MountPath, options.ConfigFile, encryptedPassphrase)
 	if err != nil {
 		return err
 	}
 	// Add the mount to the JSON file so it persists on restart.
-	if enableRemount {
-		err = winservice.AddMountJSON(options.MountPath, options.ConfigFile)
+	if enableRemountUser || enableRemountSystem {
+		err = winservice.AddMountJSON(options.MountPath, options.ConfigFile, enableRemountSystem)
 		if err != nil {
 			return fmt.Errorf("failed to add entry to json file [%s]", err.Error())
 		}