Skip to content

Fix(agent): Improve tunnel preservation during agent upgrade when using tunnel. Housekeeping of shellhub-agent files in own directory #5943

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ltan10 wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Fix(agent): Improve tunnel preservation during agent upgrade when using tunnel. Housekeeping of shellhub-agent files in own directory #5943

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fe8160d
chore(agent): move agent config and key into dedicated directory
ltan10 Mar 4, 2026
35b4a99
fix(agent): Improve tunnel preservation when upgrading agent over tunnel
ltan10 Mar 11, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 18 additions & 8 deletions agent/installer.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ import (
)

const (
agentEnvFile = "/etc/shellhub-agent.env"
agentEnvFile = "/etc/shellhub-agent/shellhub-agent.env"
agentServiceFile = "/etc/systemd/system/shellhub-agent.service"
agentServiceName = "shellhub-agent"
)
Expand All @@ -26,7 +26,7 @@ Wants=network-online.target
Requires=local-fs.target

[Service]
EnvironmentFile=/etc/shellhub-agent.env
EnvironmentFile=/etc/shellhub-agent/shellhub-agent.env
ExecStart={{.BinaryPath}}
Restart=on-failure
RestartSec=5
Expand Down Expand Up @@ -83,12 +83,12 @@ func registerInstallerCommands(rootCmd *cobra.Command) {

installCmd.Flags().String("server-address", "", "ShellHub server address")
installCmd.Flags().String("tenant-id", "", "Namespace tenant ID")
installCmd.Flags().String("private-key", "/etc/shellhub.key", "Path to the agent private key file")
installCmd.Flags().String("private-key", "/etc/shellhub-agent/shellhub.key", "Path to the agent private key file")
installCmd.Flags().String("preferred-hostname", "", "Preferred device hostname")
installCmd.Flags().String("preferred-identity", "", "Preferred device identity")
installCmd.Flags().Uint("keepalive-interval", 30, "Keepalive interval in seconds")
installCmd.MarkFlagRequired("server-address") //nolint:errcheck
installCmd.MarkFlagRequired("tenant-id") //nolint:errcheck
installCmd.MarkFlagRequired("tenant-id") //nolint:errcheck

rootCmd.AddCommand(installCmd)

Expand Down Expand Up @@ -117,9 +117,9 @@ func agentInstall(cfg installerConfig) error {
return fmt.Errorf("systemd is not available on this system")
}

// Stop existing service before overwriting files (re-install / upgrade).
// Ignore error — service may not exist yet.
exec.Command("systemctl", "disable", "--now", agentServiceName).Run() //nolint:errcheck
// Best practice would be to disable service here before install/upgrade
// If upgrade performed over tunnel, ssh session disconnect, binary gets sighup.
// Service will restart at end of install/upgrade

exe, err := os.Executable()
if err != nil {
Expand All @@ -131,6 +131,10 @@ func agentInstall(cfg installerConfig) error {
return fmt.Errorf("failed to resolve symlinks: %w", err)
}

if err := os.MkdirAll(filepath.Dir(agentEnvFile), 0755); err != nil {
return fmt.Errorf("failed to create directory %s: %w", filepath.Dir(agentEnvFile), err)
}

if err := writeAgentEnvFile(cfg); err != nil {
return fmt.Errorf("failed to write env file: %w", err)
}
Expand All @@ -143,10 +147,16 @@ func agentInstall(cfg installerConfig) error {
return fmt.Errorf("failed to reload systemd daemon: %w", err)
}

if err := exec.Command("systemctl", "enable", "--now", agentServiceName).Run(); err != nil {
// For upgrade over tunnel support, just enable service, service reboot later
if err := exec.Command("systemctl", "enable", agentServiceName).Run(); err != nil {
return fmt.Errorf("failed to enable service: %w", err)
}

// Restarts service to upgraded binary, session dies but tunnel remains active.
if err := exec.Command("systemctl", "restart", agentServiceName).Run(); err != nil {
return fmt.Errorf("failed to restart service: %w", err)
}

return nil
}

Expand Down
2 changes: 1 addition & 1 deletion agent/packaging/config.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
"__PREFERRED_HOSTNAME__",
"__PREFERRED_IDENTITY__",
"__KEEPALIVE_INTERVAL__",
"SHELLHUB_PRIVATE_KEY=/host/etc/shellhub.key"
"SHELLHUB_PRIVATE_KEY=/host/etc/shellhub-agent/shellhub.key"
],
"cwd": "/",
"capabilities": {
Expand Down
6 changes: 3 additions & 3 deletions install.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ podman_install() {
esac

if [ -z "$MODE" ]; then
ARGS="$ARGS -e SHELLHUB_PRIVATE_KEY=${PRIVATE_KEY:-/host/etc/shellhub.key}"
ARGS="$ARGS -e SHELLHUB_PRIVATE_KEY=${PRIVATE_KEY:-/host/etc/shellhub-agent/shellhub.key}"

echo "🚀 Starting ShellHub container in Agent mode..."
fi
Expand Down Expand Up @@ -106,7 +106,7 @@ docker_install() {
esac

if [ -z "$MODE" ]; then
ARGS="$ARGS -e SHELLHUB_PRIVATE_KEY=${PRIVATE_KEY:-/host/etc/shellhub.key}"
ARGS="$ARGS -e SHELLHUB_PRIVATE_KEY=${PRIVATE_KEY:-/host/etc/shellhub-agent/shellhub.key}"

echo "🚀 Starting ShellHub container in Agent mode..."
fi
Expand Down Expand Up @@ -165,7 +165,7 @@ snap_install() {

sudo snap set shellhub server-address="$SERVER_ADDRESS"
sudo snap set shellhub tenant-id="$TENANT_ID"
sudo snap set shellhub private-key="${PRIVATE_KEY:-/etc/shellhub.key}"
sudo snap set shellhub private-key="${PRIVATE_KEY:-/etc/shellhub-agent/shellhub.key}"

sudo snap start shellhub
} || {
Expand Down