Cloudfuse service linux cmd #338

Dabnsky · 2024-10-10T19:29:54Z

What type of Pull Request is this? (check all applicable)

Describe your changes in brief

This adds the following commands available to the cloudfuse executable:
cloudfuse service install
cloudfuse service uninstall

Checklist

Tested locally
Added new dependencies
Updated documentation
Added tests

Related Issues

Related Issue #
Closes #

…t mount logic

…th arguments

foodprocessor · 2024-10-31T22:05:42Z

cmd/service_linux.go

+	Short:             "Installs the startup process for Cloudfuse. Requires elevated permissions.",
+	Long:              "Installs the startup process for Cloudfuse which remounts any active previously active mounts on startup. elevated permissions.",


These descriptions should probably not refer to "the" startup process, since each call to install only affects a single mount, and we can use this command to make multiple "startup processes."

foodprocessor · 2024-11-01T17:43:54Z

cmd/service_linux.go

+}
+
+var installCmd = &cobra.Command{
+	Use:               "install",


Since you require two arguments, the usage string should include those.

foodprocessor · 2024-11-01T18:03:40Z

cmd/service_linux.go

+		// assumes dir is in cloudfuse repo dir
+		serviceData, err := collectServiceData(fmt.Sprintf("%s/setup/cloudfuse.service", dir))
+		if err != nil {
+			return fmt.Errorf("error collecting data from cloudfuse.service file due to the following error: [%s]", err)
+		}


For deployment, we need to add the cloudfuse.service file to the list of deployed files (in .goreleaser.yaml), and something like this should work. We may need to use filepath.Dir(os.Executable()) (documented here), instead of os.Getwd() to reliably get the path we need.

foodprocessor · 2024-11-01T18:09:44Z

cmd/service_linux.go

+		isDirEmpty := common.IsDirectoryEmpty(mountPath)
+		if !isDirEmpty {
+			return fmt.Errorf("error, the mount path provided is not empty")
+			// TODO: add useage output upon failure with input
+		}


I don't think we need to check this.

cloudfuse outputs an error and will not mount if the provided mount path is not empty

foodprocessor · 2024-11-01T18:20:05Z

cmd/service_linux.go

+			// TODO: add useage output upon failure with input
+		}
+
+		configExists := common.DirectoryExists(configPath)


Although this works, I don't love that DirectoryExists is checking existence for a file.
I found another place where we check if the config file exists, and we use os.Stat directly:

if _, err := os.Stat(options.ConfigFile); errors.Is(err, fs.ErrNotExist) { return errors.New("config file does not exist") }

foodprocessor · 2024-11-01T18:23:10Z

cmd/service_linux.go

+	},
+}
+
+var uninstallCmd = &cobra.Command{


The uninstall command will have to require the mount path to know which mount's startup service we need to remove.

foodprocessor · 2024-11-01T18:28:20Z

cmd/service_linux.go

+		err = modifySericeFile(mountPath, dir)
+		if err != nil {
+			return fmt.Errorf("error when attempting to write defaults into service file: [%s]", err.Error())
+		}
+
+		err = modifySericeFile(configPath, dir)
+		if err != nil {
+			return fmt.Errorf("error when attempting to write defaults into service file: [%s]", err.Error())
+		}


Since we're creating a separate service file for each mount that the user wants to mount on startup, we'll want to

not change our template cloudfuse.service file (we should write the modified unit file data straight to the destination)

name each new service/unit file after the mount path, so they don't conflict, and so we can find them to remove them when uninstalling

foodprocessor · 2024-11-01T18:48:50Z

cmd/service_linux.go

+		// 2. retrieve the newUser account from cloudfuse.service file and create it if it doesn't exist
+
+		serviceUser := serviceData["User"]
+		setUser(serviceUser)


On Linux I don't think we need a dedicated user.

While failing to specify a user with the appropriate permissions doesn't stop the cloudfuse service from running and working, it opens up a large security risk involving the default permissions that are used when the service is run.

foodprocessor · 2024-11-01T18:55:19Z

cmd/service_linux.go

+
+//--------------- command section ends
+
+func collectServiceData(serviceFilePath string) (map[string]string, error) {


I don't know, but I feel like these helper functions could be a lot shorter, and more readable. I feel like these details should be abstracted away by a standard library function that does most or all of this for us...

I agree. I'm not sure anything specifically does this, but here is a go program that installs items with systemd that our design could be based around which is a lot cleaner. https://github.com/pioz/god

…le into the /etc/systemd/system/

cmd/service_linux.go

jfantinhardesty · 2024-11-18T17:34:55Z

cmd/service_linux.go

+	}
+
+	folderList := strings.Split(mountPath, "/")
+	newFile, err := os.Create("/etc/systemd/system/" + folderList[len(folderList)-1] + ".service")


Could you set this as a constant to refer to at the top of the file.

cmd/service_linux.go

jfantinhardesty · 2024-11-18T17:50:47Z

cmd/service_linux.go

+		}
+
+		// get a list of group from reference user
+		groups, err := usr.GroupIds()


What groups do we need to add the user to? And why do we need to add them manually?

the service user at least needs the current user added to its groups to be able to access and use mount and config file typically located at the end user's home directory. There doesn't seem to be a way around using the usermod command for this.

jfantinhardesty · 2024-11-18T17:55:35Z

cmd/service_linux.go

+
+//--------------- command section ends
+
+func collectServiceData(serviceFilePath string) (map[string]string, error) {


I agree. I'm not sure anything specifically does this, but here is a go program that installs items with systemd that our design could be based around which is a lot cleaner. https://github.com/pioz/god

-changed collectServiceData() to extractValue() that outputs value from file for provided key -changed setUser() to use SUDO_USER env variable to add to service user group. and adjusted permissions for service user.

-corrected typo of moutingpoint that came from cloudfuse.service template file

… congfile access

Dabnsky added 9 commits October 7, 2024 13:19

initial service linux file with notes

13089bf

added parse and collect data from cloudfuse.service file

c60d152

added data collect and user create draft

a7d254e

Added copy and systemctl commands to the installCmd

0cd2984

added wrapper for data collection from file. started composing defaul…

74faea2

…t mount logic

added wrapper function to edit service file for config or mount Paths

b301ade

added sudo to commands

3fecd43

-fixed permission issues for mount

cf992a8

added service removal automation.

8e86337

Dabnsky requested review from Ferelith-maker, foodprocessor, jfantinhardesty and brayan-trejo as code owners October 10, 2024 19:29

Dabnsky marked this pull request as draft October 10, 2024 19:50

Added argument support and replaced default mount and config paths wi…

2129c19

…th arguments

foodprocessor removed the request for review from brayan-trejo October 31, 2024 17:52

Dabnsky marked this pull request as ready for review November 1, 2024 17:32

foodprocessor requested changes Nov 1, 2024

View reviewed changes

Dabnsky marked this pull request as draft November 8, 2024 21:12

Dabnsky added 7 commits November 13, 2024 11:32

correct Short and Long description for install

3ebbe21

corrected usage

497706c

use os.stat to check file exists

439ddcb

changed modifyServiceFile() to createServiceFile()

be9c13b

adjusted newServiceFile() to have correct paths and directly write fi…

60a3893

…le into the /etc/systemd/system/

adjusted collectServiceData to collectServiceUser

8a2c390

moved newServiceFile()

7d217ef

jfantinhardesty requested changes Nov 18, 2024

View reviewed changes

Dabnsky requested a review from jfantinhardesty November 19, 2024 20:01

Dabnsky added 2 commits November 19, 2024 13:01

-added support for referencial path arguments

ce37b74

-changed collectServiceData() to extractValue() that outputs value from file for provided key -changed setUser() to use SUDO_USER env variable to add to service user group. and adjusted permissions for service user.

-added service user getting added to current user without sudo

08feb84

-corrected typo of moutingpoint that came from cloudfuse.service template file

Dabnsky added 5 commits November 22, 2024 10:34

adjusted how the service user gets assigned the appropriate group for…

dbce110

… congfile access

added --flag string support and added user specification support

429b77d

removed servOpts var

ec849db

added required flags and unsilenced usage with cobra

4d9390a

support servcie user already existing and setting permissions as needed.

ec38957

Dabnsky marked this pull request as ready for review November 22, 2024 20:26

Dabnsky requested a review from foodprocessor November 22, 2024 20:26

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Cloudfuse service linux cmd #338

Cloudfuse service linux cmd #338

Dabnsky commented Oct 10, 2024 •

edited

Loading

foodprocessor Oct 31, 2024

foodprocessor Nov 1, 2024

foodprocessor Nov 1, 2024

foodprocessor Nov 1, 2024

Dabnsky Nov 13, 2024 •

edited

Loading

foodprocessor Nov 1, 2024

foodprocessor Nov 1, 2024

foodprocessor Nov 1, 2024

foodprocessor Nov 1, 2024

Dabnsky Nov 18, 2024

foodprocessor Nov 1, 2024

jfantinhardesty Nov 18, 2024

jfantinhardesty Nov 18, 2024

jfantinhardesty Nov 18, 2024

Dabnsky Nov 19, 2024 •

edited

Loading

jfantinhardesty Nov 18, 2024

		Short: "Installs the startup process for Cloudfuse. Requires elevated permissions.",
		Long: "Installs the startup process for Cloudfuse which remounts any active previously active mounts on startup. elevated permissions.",


		//--------------- command section ends

		func collectServiceData(serviceFilePath string) (map[string]string, error) {

Cloudfuse service linux cmd #338

Are you sure you want to change the base?

Cloudfuse service linux cmd #338

Conversation

Dabnsky commented Oct 10, 2024 • edited Loading

What type of Pull Request is this? (check all applicable)

Describe your changes in brief

Checklist

Related Issues

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Dabnsky Nov 13, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Dabnsky Nov 19, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Dabnsky commented Oct 10, 2024 •

edited

Loading

Dabnsky Nov 13, 2024 •

edited

Loading

Dabnsky Nov 19, 2024 •

edited

Loading