add caddy server as system install #1070

nitishkumar71 · 2024-05-11T15:14:07Z

Description

Motivation and Context

I have raised an issue to propose this change, which has been given a label of design/approved by a maintainer (required)
Closes Add Caddy Server as System install #1069

How Has This Been Tested?

Executed the command arkade system install caddy produced below output

Installing Caddy Server to /usr/local/bin
Installing version: v2.7.6 for: amd64
Downloading from: https://github.com/caddyserver/caddy/releases/download/v2.7.6/caddy_2.7.6_linux_amd64.tar.gz
13.98 MiB / 13.98 MiB [--------------------------------------------------------------------------------------------------------------------------------------------------------------] 100.00%
Downloaded to: /tmp/arkade-345065249/caddy_2.7.6_linux_amd64.tar.gz
Unpacking Caddy to: /usr/local/bin/caddy

If updating or adding a new CLI to arkade get, run:

go build && ./hack/test-tool.sh TOOL_NAME

Types of changes

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to change)

Documentation

I have updated the list of tools in README.md if (required) with ./arkade get --format markdown
I have updated the list of apps in README.md if (required) with ./arkade install --help

Checklist:

My code follows the code style of this project.
My change requires a change to the documentation.
I have updated the documentation accordingly.
I've read the CONTRIBUTION guide
I have signed-off my commits with git commit -s

I have tested this on arm, or have added code to prevent deployment

alexellis · 2024-05-13T13:08:39Z

cmd/system/caddy.go

+	}
+
+	command.Flags().StringP("version", "v", "", "The version or leave blank to determine the latest available version")
+	command.Flags().String("path", "/usr/local/bin", "Installation path, where a caddy subfolder will be created")


It's not the usual pattern, but Caddy installs to /usr/bin/

Have a look at the faasd script to see what else may be missing, including adding users etc.

For adding users, we will need to detect the OS from /etc/os-release and reject the command if it's not debian or ubuntu.

In the future, if someone needs this for Alpine or Fedora, they can add a patch to run useradd with the correct syntax for their distro.

There are also some directories created and chmod is run.

alexellis

Good start, but there's more needed for a system install to match how Caddy is installed with faasd: https://github.com/openfaas/faasd/blob/master/hack/install.sh

alexellis · 2024-05-29T14:38:58Z

The new changes look like what I was expecting.

Could you test this and see if Caddy starts up correctly on a new Linux VM you create somewhere?

If you need a sample Caddyfile, you can change the domains for the below:

faasd.example.com {
    reverse_proxy 127.0.0.1:8080
}

alexellis · 2024-05-29T15:58:04Z

cmd/system/caddy.go

+		}
+
+		commands := strings.Join(shellCmds, "; ")
+		if err = exec.Command(commands).Run(); err != nil {


Could you try go-execute which is used elsewhere? It has a shell option if needed.

alexellis · 2024-05-29T15:58:49Z

cmd/system/caddy.go

+		// TODO: Add empty CaddyFile and if required FAAS_DOMAIN setup too
+
+		shellCmds := []string{
+			"$SUDO chown --recursive caddy:caddy /var/lib/caddy",


I think $SUDO could be removed, and arkade could be run as sudo arkade if needed.

alexellis · 2024-05-29T15:59:14Z

cmd/system/caddy.go

+
+		caddyUser := "caddy"
+		if _, err = user.Lookup(caddyUser); errors.Is(err, user.UnknownUserError(caddyUser)) {
+			addUserCmd := fmt.Sprintf("$SUDO useradd --system --home %s --shell /bin/false %s", caddyHomeDir, caddyUser)


Try go-execute again which splits out cmd vs args

alexellis · 2024-05-29T16:01:17Z

@nitishkumar71 suggested using the "get" method from the tools code. I think it would be worth trying out as an experiment.

nitishkumar71 · 2024-06-01T20:23:14Z

Re-executing system install produced below output

Installing Caddy Server to /usr/bin
Downloading: https://github.com/caddyserver/caddy/releases/download/v2.8.1/caddy_2.8.1_linux_amd64.tar.gz
13.92 MiB / 13.92 MiB [-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------] 100.00%
/tmp/arkade-2170843838/caddy_2.8.1_linux_amd64.tar.gz written.
2024/06/02 01:51:25 Extracted: /tmp/arkade-2170843838/caddy
2024/06/02 01:51:25 Copying /tmp/arkade-2170843838/caddy to /usr/bin/caddy
Downloaded caddy.service file to /tmp/arkade-2005628698/caddy.service
Copied caddy.service file to /etc/systemd/system/caddy.service
Created caddy home /var/lib/caddy and Conf /etc/caddy directory
User created for caddy server.
Created symlink /etc/systemd/system/multi-user.target.wants/caddy.service → /etc/systemd/system/caddy.service.

alexellis · 2024-06-05T15:53:31Z

cmd/system/caddy.go

+			return err
+		}
+
+		if _, err = executeShellCmd(context.Background(), "systemctl", "start", "caddy"); err != nil {


Skip the start, and then you can also omit createCaddyConf

alexellis · 2024-06-05T15:54:44Z

cmd/system/caddy.go

+			return fmt.Errorf("this app only supports Linux")
+		}
+
+		tools := get.MakeTools()


Does this change mean that "caddy" also appears via arkade get caddy?

In the case of things like Go or Node, we won't that because it won't do the right thing. We could have an additional flag or bool etc on each Tool to hide them from the arkade get command

Agree. will start working toward migrating system apps to use this new approach and enable apps which we want as system install only

alexellis · 2024-06-05T15:55:18Z

cmd/system/caddy.go

+
+		tools := get.MakeTools()
+		var tool *get.Tool
+		for _, t := range tools {


I like this approach. Could you create an issue to retrofit this into the existing system install apps?

Sure. I would try to progressively apply this approach in system install apps.

alexellis

Could you see the suggestions please?

Signed-off-by: Nitishkumar Singh <[email protected]>

alexellis

LGTM

alexellis reviewed May 13, 2024

View reviewed changes

alexellis requested changes May 13, 2024

View reviewed changes

nitishkumar71 marked this pull request as draft May 29, 2024 13:23

alexellis reviewed May 29, 2024

View reviewed changes

nitishkumar71 force-pushed the caddy_system branch from 600ee14 to 94f6f54 Compare June 1, 2024 20:22

nitishkumar71 marked this pull request as ready for review June 1, 2024 20:24

nitishkumar71 requested a review from alexellis June 1, 2024 20:24

alexellis reviewed Jun 5, 2024

View reviewed changes

alexellis requested changes Jun 5, 2024

View reviewed changes

add caddy server as system install

c5b031f

Signed-off-by: Nitishkumar Singh <[email protected]>

nitishkumar71 force-pushed the caddy_system branch from 94f6f54 to 405fa7b Compare June 6, 2024 12:21

add caddy system install

a484094

Signed-off-by: Nitishkumar Singh <[email protected]>

nitishkumar71 force-pushed the caddy_system branch from 405fa7b to a484094 Compare June 6, 2024 12:29

nitishkumar71 requested a review from alexellis June 6, 2024 12:31

alexellis approved these changes Jun 12, 2024

View reviewed changes

alexellis merged commit 4dd1d54 into alexellis:master Jun 12, 2024
2 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add caddy server as system install #1070

add caddy server as system install #1070

nitishkumar71 commented May 11, 2024

alexellis May 13, 2024

alexellis left a comment •

edited

Loading

alexellis commented May 29, 2024 •

edited

Loading

alexellis May 29, 2024

nitishkumar71 Jun 1, 2024

alexellis May 29, 2024

nitishkumar71 Jun 1, 2024

alexellis May 29, 2024

nitishkumar71 Jun 1, 2024

alexellis commented May 29, 2024

nitishkumar71 commented Jun 1, 2024

alexellis Jun 5, 2024

nitishkumar71 Jun 6, 2024

alexellis Jun 5, 2024 •

edited

Loading

nitishkumar71 Jun 6, 2024

alexellis Jun 5, 2024

nitishkumar71 Jun 6, 2024

alexellis left a comment

alexellis left a comment

add caddy server as system install #1070

add caddy server as system install #1070

Conversation

nitishkumar71 commented May 11, 2024

Description

Motivation and Context

How Has This Been Tested?

Types of changes

Documentation

Checklist:

Choose a reason for hiding this comment

alexellis left a comment • edited Loading

Choose a reason for hiding this comment

alexellis commented May 29, 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

alexellis commented May 29, 2024

nitishkumar71 commented Jun 1, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

alexellis Jun 5, 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

alexellis left a comment

Choose a reason for hiding this comment

alexellis left a comment

Choose a reason for hiding this comment

alexellis left a comment •

edited

Loading

alexellis commented May 29, 2024 •

edited

Loading

alexellis Jun 5, 2024 •

edited

Loading