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

cmd/service_linux.go

…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.

cmd/service_linux.go

-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

foodprocessor

Great improvements!!

cmd/service_linux.go

foodprocessor · 2024-11-26T18:29:32Z

cmd/service_linux.go

+	mountPathInfo, err := os.Stat(mountPath)
+	if err != nil {
+		return fmt.Errorf("failed to stat file: %v", err)
+	}
+
+	// Get file's group ID
+	stat, ok = mountPathInfo.Sys().(*syscall.Stat_t)
+	if !ok {
+		return fmt.Errorf("failed to get file system stats")
+	}
+	mountGroupID := stat.Gid
+
+	// Get configFileGroup name
+	mountPathGroup, err := user.LookupGroupId(fmt.Sprint(mountGroupID))
+	if err != nil {
+		return fmt.Errorf("failed to lookup group: %v", err)
+	}


And can we do the same for the mount directory (just make sure the service user has the access it needs)?

foodprocessor · 2024-11-26T18:44:50Z

cmd/service_linux.go

+	if err != nil {
+		if strings.Contains(err.Error(), "unknown user") {
+			//create the user
+			userAddCmd := exec.Command("sudo", "useradd", "-m", serviceUser)


We probably shouldn't use sudo in our code. The user will already run our CLI with sudo, right?

foodprocessor · 2024-11-26T18:47:36Z

cmd/service_linux.go

+			//add group to serviceUser group
+			usermodCmd := exec.Command("sudo", "usermod", "-aG", configFileGroup.Name, serviceUser)
+			err = usermodCmd.Run()
+			if err != nil {
+				return fmt.Errorf("failed to create user due to following error: [%s]", err.Error())
+			}
+			usermodCmd = exec.Command("sudo", "usermod", "-aG", mountPathGroup.Name, serviceUser)
+			err = usermodCmd.Run()
+			if err != nil {
+				return fmt.Errorf("failed to create user due to following error: [%s]", err.Error())
+			}
+
+			//set set folder permission on the mount path
+			chmodCmd := exec.Command("sudo", "chmod", "770", mountPath)
+			err = chmodCmd.Run()
+			if err != nil {
+				return fmt.Errorf("failed set permisions on mount path due to following error: [%s]", err.Error())
+			}


Maybe we can suggest these commands on error, instead of doing them ourselves.

I agree. I think that makes it a bit easier and prevents us from doing something wrong to the users system.

foodprocessor · 2024-11-26T18:59:17Z

cmd/service_linux.go

+	folderList := strings.Split(mountPath, "/")
+	serviceName := folderList[len(folderList)-1] + ".service"


Once you get the absolute path for the mount folder, you could ensure the service name is perfectly specific and unique by just replacing slashes with dashes.
This is already the best practice / standard for mounts on startup using systemd.

foodprocessor · 2024-11-26T19:00:17Z

cmd/service_linux.go

+	newFile, err := os.Create("/etc/systemd/system/" + serviceName)
+	if err != nil {
+		return "", fmt.Errorf("error creating new service file: [%s]", err.Error())
+	}


Could you overwrite it, in case they want to use the install command to update an existing service?
Or would you rather they uninstall first?

jfantinhardesty

Left a few more comments to simplify some of this. Also, I tend to agree with Michael that we probably should not run a lot of these commands ourselves, and instead suggest them to the user. Also, there are a variety of lint and spelling errors that should be fixed.

jfantinhardesty · 2024-11-26T21:08:21Z

cmd/service_linux.go

+var installCmd = &cobra.Command{
+	Use:               "install",
+	Short:             "Installs a service file for a single mount with Cloudfuse. Requires elevated permissions.",
+	Long:              "Installs a service file for a single mount with Cloudfuse which remounts any active previously active mounts on startup. elevated permissions.",


This should say "Requires elevated permissions."

jfantinhardesty · 2024-11-26T21:18:24Z

cmd/service_linux.go

+			return fmt.Errorf("error: [%s]", err.Error())
+		}
+
+		if strings.Contains(mountPath, ".") || strings.Contains(mountPath, "..") {


Rather than checking for dots, you could also use the go function filepath.IsAbs. And then you could also call filepath.Clean to get the shortest filepath if it not an absolute path.

jfantinhardesty · 2024-11-26T21:34:17Z

cmd/service_linux.go

+	RunE: func(cmd *cobra.Command, args []string) error {
+
+		// get absolute path of provided relative mount path
+		if strings.Contains(serviceName, ".") || strings.Contains(serviceName, "..") {


Since this is mostly the same as above, you could possibly abstract this type of logic into a separate function.

jfantinhardesty · 2024-11-26T23:00:47Z

cmd/service_linux.go

+	if err != nil {
+		if strings.Contains(err.Error(), "unknown user") {
+			//create the user
+			userAddCmd := exec.Command("sudo", "useradd", "-m", serviceUser)


I think you should user "-r" instead of "-m" since "-m" will create a user that has a home directory and we probably don't want to do that.

jfantinhardesty · 2024-11-26T23:01:24Z

cmd/service_linux.go

+			//add group to serviceUser group
+			usermodCmd := exec.Command("sudo", "usermod", "-aG", configFileGroup.Name, serviceUser)
+			err = usermodCmd.Run()
+			if err != nil {
+				return fmt.Errorf("failed to create user due to following error: [%s]", err.Error())
+			}
+			usermodCmd = exec.Command("sudo", "usermod", "-aG", mountPathGroup.Name, serviceUser)
+			err = usermodCmd.Run()
+			if err != nil {
+				return fmt.Errorf("failed to create user due to following error: [%s]", err.Error())
+			}
+
+			//set set folder permission on the mount path
+			chmodCmd := exec.Command("sudo", "chmod", "770", mountPath)
+			err = chmodCmd.Run()
+			if err != nil {
+				return fmt.Errorf("failed set permisions on mount path due to following error: [%s]", err.Error())
+			}


I agree. I think that makes it a bit easier and prevents us from doing something wrong to the users system.

jfantinhardesty · 2024-11-26T23:02:04Z

cmd/service_linux.go

+//--------------- command section ends
+
+func newServiceFile(mountPath string, configPath string, serviceUser string) (string, error) {
+	serviceTemplate := ` [Unit]


There shouldn't be a space here before [Unit]

jfantinhardesty · 2024-11-26T23:06:16Z

cmd/service_linux.go

+	# User service will run as.
+	User={{.ServiceUser}}
+	# Path to the location Cloudfuse will mount to. Note this folder must currently exist.
+	Environment=MountingPoint={{.MountPath}}


You could simplify this environment section. I only did it this way to make it easy for a user to edit. But if you write it then you could just put the mountPath in the mount and unmount commands directly.

jfantinhardesty · 2024-11-26T23:08:12Z

cmd/service_linux.go

+		}
+	} else {
+		//add group to serviceUser group
+		usermodCmd := exec.Command("sudo", "usermod", "-aG", configFileGroup.Name, serviceUser)


If the user exists, we probably should not modify the group permissions and assume the user has them set in a way to run cloudfuse. And if there is an error we should tell them how to fix that error.

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

foodprocessor requested changes Nov 26, 2024

View reviewed changes

jfantinhardesty requested changes Nov 26, 2024

View reviewed changes

Dabnsky added 11 commits December 19, 2024 11:45

updated long install description

bf51d9b

replaced relative path support with filepath.IsAbs

5ca9a39

removed "error" from error msg

b6bdefb

removed mount path empty check

3f78e7e

removed old TODO usage comment

63b1be9

updated short and long descriptions for uninstall

ac1a870

removed space before "[unit]" in template

43fd36d

removed unused dir variable

dac35d0

initiated err variable

77a1eea

corrected filepath.Abs usage

ae54de5

set up wrapper function for abs path

a07dd71

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

jfantinhardesty Nov 18, 2024

jfantinhardesty Nov 18, 2024

Dabnsky Nov 19, 2024 •

edited

Loading

foodprocessor left a comment

foodprocessor Nov 26, 2024

foodprocessor Nov 26, 2024

foodprocessor Nov 26, 2024

jfantinhardesty Nov 26, 2024

foodprocessor Nov 26, 2024

foodprocessor Nov 26, 2024

jfantinhardesty left a comment

jfantinhardesty Nov 26, 2024

jfantinhardesty Nov 26, 2024

jfantinhardesty Nov 26, 2024

jfantinhardesty Nov 26, 2024

jfantinhardesty Nov 26, 2024

jfantinhardesty Nov 26, 2024

jfantinhardesty Nov 26, 2024

jfantinhardesty Nov 26, 2024

		folderList := strings.Split(mountPath, "/")
		serviceName := folderList[len(folderList)-1] + ".service"

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

Dabnsky Nov 19, 2024 • edited Loading

Choose a reason for hiding this comment

foodprocessor left a 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

jfantinhardesty left a 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 commented Oct 10, 2024 •

edited

Loading

Dabnsky Nov 19, 2024 •

edited

Loading