mirror of
https://github.com/rcourtman/Pulse.git
synced 2026-09-11 22:12:23 +00:00
3355f7a671
Container update detection only ever negotiated anonymous pull tokens, so containers from registries that reject anonymous digest HEADs pinned a permanent "authentication required" badge (#1706). The agent already runs on the Docker host, so the checker now resolves the same credential store docker pull uses - config.json auths entries, credsStore/credHelpers credential helpers (docker-credential-<name> get), and Podman's auth.json - and presents the stored login: Basic auth on Bearer token negotiation and on the hardcoded Docker Hub / ghcr.io token endpoints, direct answers to Basic challenges, and the refresh-token grant for identity-token logins such as Azure ACR. Credentials never leave the host: they are only presented to the registry or its token endpoint, helper output stays out of reported check errors, and lookups are cached in memory for five minutes. Helper names are validated before exec, and a stale login falls back to the anonymous path so checks that used to work keep working. Set PULSE_DISABLE_REGISTRY_CREDENTIALS=true (--disable-registry-credentials) to keep detection anonymous-only. The agent-lifecycle and security-privacy subsystem contracts pin the host-local credential boundary.
1789 lines
52 KiB
Go
1789 lines
52 KiB
Go
package dockeragent
|
|
|
|
import (
|
|
"bytes"
|
|
"context"
|
|
"encoding/json"
|
|
"errors"
|
|
"fmt"
|
|
"net/http"
|
|
"os"
|
|
"os/exec"
|
|
"strings"
|
|
"sync"
|
|
"time"
|
|
|
|
systemtypes "github.com/moby/moby/api/types/system"
|
|
"github.com/moby/moby/client"
|
|
"github.com/rcourtman/pulse-go-rewrite/internal/agenttarget"
|
|
"github.com/rcourtman/pulse-go-rewrite/internal/agenttls"
|
|
"github.com/rcourtman/pulse-go-rewrite/internal/utils"
|
|
agentsdocker "github.com/rcourtman/pulse-go-rewrite/pkg/agents/docker"
|
|
"github.com/rs/zerolog"
|
|
)
|
|
|
|
// TargetConfig describes a single Pulse backend the agent should report to.
|
|
type TargetConfig struct {
|
|
Name string
|
|
URL string
|
|
Token string
|
|
InsecureSkipVerify bool
|
|
AllowPlaintextHTTP bool
|
|
CACertPath string
|
|
ServerFingerprint string
|
|
Authoritative bool
|
|
}
|
|
|
|
// Config describes runtime configuration for the Docker / Podman collection module.
|
|
type Config struct {
|
|
PulseURL string
|
|
APIToken string
|
|
Interval time.Duration
|
|
HostnameOverride string
|
|
AgentID string
|
|
AgentType string // "unified" when running as part of pulse-agent, empty for legacy standalone mode
|
|
AgentVersion string // Version to report; if empty, uses dockeragent.Version
|
|
InsecureSkipVerify bool
|
|
CACertPath string
|
|
ServerFingerprint string
|
|
DisableAutoUpdate bool
|
|
DisableUpdateChecks bool // Disable Docker image update detection (registry checks)
|
|
// DisableRegistryCredentials keeps update checks from reading the host's
|
|
// Docker credential store (config.json auths and credential helpers), so
|
|
// private-registry checks fall back to anonymous-only behavior.
|
|
DisableRegistryCredentials bool
|
|
Targets []TargetConfig
|
|
ContainerStates []string
|
|
SwarmScope string
|
|
Runtime string
|
|
IncludeServices bool
|
|
IncludeTasks bool
|
|
IncludeContainers bool
|
|
CollectDiskMetrics bool
|
|
DiskExclude []string // Mount points or path prefixes to exclude from disk monitoring
|
|
DiskInclude []string // Devices or mount points to opt into monitoring despite automatic filtering
|
|
LogLevel zerolog.Level
|
|
Logger *zerolog.Logger
|
|
}
|
|
|
|
var allowedContainerStates = map[string]string{
|
|
"created": "created",
|
|
"restarting": "restarting",
|
|
"running": "running",
|
|
"removing": "removing",
|
|
"paused": "paused",
|
|
"exited": "exited",
|
|
"dead": "dead",
|
|
"stopped": "exited",
|
|
}
|
|
|
|
type RuntimeKind string
|
|
|
|
const (
|
|
RuntimeAuto RuntimeKind = "auto"
|
|
RuntimeDocker RuntimeKind = "docker"
|
|
RuntimePodman RuntimeKind = "podman"
|
|
)
|
|
|
|
// backupContainerMarker is the substring used to identify backup containers
|
|
// created during container updates.
|
|
const backupContainerMarker = "_pulse_backup_"
|
|
|
|
// isBackupContainer reports whether any of the given container names contains
|
|
// the Pulse backup marker (e.g. "myapp_pulse_backup_20240101_120000").
|
|
func isBackupContainer(names []string) bool {
|
|
for _, name := range names {
|
|
if strings.Contains(name, backupContainerMarker) {
|
|
return true
|
|
}
|
|
}
|
|
return false
|
|
}
|
|
|
|
// setAgentHeaders sets the standard authentication and metadata headers for
|
|
// requests from the Docker / Podman module to a Pulse backend.
|
|
func setAgentHeaders(req *http.Request, token string) {
|
|
req.Header.Set("Content-Type", "application/json")
|
|
req.Header.Set("X-API-Token", token)
|
|
req.Header.Set("Authorization", "Bearer "+token)
|
|
req.Header.Set("User-Agent", "pulse-agent/"+Version)
|
|
}
|
|
|
|
// Agent collects Docker / Podman metrics and posts them to Pulse.
|
|
type Agent struct {
|
|
cfg Config
|
|
docker dockerClient
|
|
daemonHost string
|
|
daemonID string // Cached at init; Podman can return unstable IDs across calls
|
|
runtime RuntimeKind
|
|
runtimePref RuntimeKind // user-requested runtime preference, kept for reconnects
|
|
runtimeGoneStreak int // consecutive daemon-unavailable collects; guarded by collectMu
|
|
runtimeVer string
|
|
agentVersion string
|
|
supportsSwarm bool
|
|
httpClients map[bool]*http.Client
|
|
trustedHTTPClients map[string]*http.Client
|
|
logger zerolog.Logger
|
|
machineID string
|
|
hostName string
|
|
cpuCount int
|
|
targets []TargetConfig
|
|
allowedStates map[string]struct{}
|
|
stateFilters []string
|
|
hostID string
|
|
prevContainerCPU map[string]cpuSample
|
|
cpuMu sync.Mutex // protects prevContainerCPU
|
|
reportBuffer *utils.Queue[agentsdocker.Report]
|
|
reportBuffers map[string]*utils.Queue[agentsdocker.Report]
|
|
registryChecker *RegistryChecker // For checking container image updates
|
|
collectMu sync.Mutex // serializes collectOnce calls
|
|
manualCheckMu sync.Mutex // protects manualCheckActiveID and manualCheckResults
|
|
manualCheckActiveID string
|
|
manualCheckResults map[string]manualUpdateCheckResult
|
|
manualCheckCollect func(context.Context) (agentsdocker.Report, error) // test seam for bounded manual checks
|
|
newTimerFn func(time.Duration) *time.Timer // test seam; per-Agent so async goroutines never read a shared global (nil = time.NewTimer)
|
|
jsonMarshalFn func(any) ([]byte, error) // test seam; per-Agent so async goroutines never read a shared global (nil = json.Marshal)
|
|
backgroundMu sync.Mutex // protects updateCheckRunning, cleanupTaskRunning
|
|
updateCheckRunning bool
|
|
cleanupTaskRunning bool
|
|
asyncOnce sync.Once
|
|
asyncCtx context.Context
|
|
asyncCancel context.CancelFunc
|
|
asyncWG sync.WaitGroup
|
|
closeOnce sync.Once
|
|
closeErr error
|
|
}
|
|
|
|
// ErrStopRequested indicates the agent should terminate gracefully after acknowledging a stop command.
|
|
var ErrStopRequested = errors.New("docker host stop requested")
|
|
|
|
const (
|
|
manualUpdateCheckResultTTL = 10 * time.Minute
|
|
manualUpdateCheckResultLimit = 64
|
|
manualUpdateCheckAckAttempts = 3
|
|
manualUpdateCheckTerminalAckTime = 50 * time.Second
|
|
)
|
|
|
|
var (
|
|
manualUpdateCheckTimeout = dockerCollectCycleTimeout
|
|
manualUpdateCheckAckRetryDelay = 250 * time.Millisecond
|
|
)
|
|
|
|
type manualUpdateCheckResult struct {
|
|
status string
|
|
message string
|
|
finishedAt time.Time
|
|
}
|
|
|
|
type cpuSample struct {
|
|
totalUsage uint64
|
|
systemUsage uint64
|
|
onlineCPUs uint32
|
|
read time.Time
|
|
}
|
|
|
|
// New creates a new Docker / Podman module instance.
|
|
func New(cfg Config) (*Agent, error) {
|
|
targets, err := normalizeTargetsFn(cfg.Targets)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("dockeragent.New: normalize targets: %w", err)
|
|
}
|
|
|
|
if len(targets) == 0 {
|
|
url := strings.TrimSpace(cfg.PulseURL)
|
|
token := strings.TrimSpace(cfg.APIToken)
|
|
if url == "" || token == "" {
|
|
return nil, errors.New("at least one Pulse target is required")
|
|
}
|
|
|
|
targets, err = normalizeTargetsFn([]TargetConfig{{
|
|
Name: "primary",
|
|
URL: url,
|
|
Token: token,
|
|
InsecureSkipVerify: cfg.InsecureSkipVerify,
|
|
CACertPath: cfg.CACertPath,
|
|
ServerFingerprint: cfg.ServerFingerprint,
|
|
Authoritative: true,
|
|
}})
|
|
if err != nil {
|
|
return nil, fmt.Errorf("dockeragent.New: normalize fallback target: %w", err)
|
|
}
|
|
}
|
|
|
|
cfg.Targets = targets
|
|
cfg.PulseURL = targets[0].URL
|
|
cfg.APIToken = targets[0].Token
|
|
cfg.InsecureSkipVerify = targets[0].InsecureSkipVerify
|
|
cfg.CACertPath = targets[0].CACertPath
|
|
cfg.ServerFingerprint = targets[0].ServerFingerprint
|
|
|
|
stateFilters, err := normalizeContainerStates(cfg.ContainerStates)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("dockeragent.New: normalize container states: %w", err)
|
|
}
|
|
cfg.ContainerStates = stateFilters
|
|
|
|
scope, err := normalizeSwarmScope(cfg.SwarmScope)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("dockeragent.New: normalize swarm scope: %w", err)
|
|
}
|
|
cfg.SwarmScope = scope
|
|
|
|
if !cfg.IncludeContainers && !cfg.IncludeServices && !cfg.IncludeTasks {
|
|
cfg.IncludeContainers = true
|
|
cfg.IncludeServices = true
|
|
cfg.IncludeTasks = true
|
|
}
|
|
|
|
logger := cfg.Logger
|
|
if zerolog.GlobalLevel() == zerolog.DebugLevel && cfg.LogLevel != zerolog.DebugLevel {
|
|
zerolog.SetGlobalLevel(cfg.LogLevel)
|
|
}
|
|
|
|
if logger == nil {
|
|
defaultLogger := zerolog.New(os.Stdout).Level(cfg.LogLevel).With().Timestamp().Str("component", "pulse-agent-docker").Logger()
|
|
logger = &defaultLogger
|
|
} else {
|
|
scoped := logger.With().Str("component", "pulse-agent-docker").Logger()
|
|
logger = &scoped
|
|
}
|
|
|
|
runtimePref, err := normalizeRuntime(cfg.Runtime)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("dockeragent.New: normalize runtime: %w", err)
|
|
}
|
|
|
|
dockerClient, info, runtimeKind, err := connectRuntimeFn(runtimePref, logger)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("dockeragent.New: connect runtime: %w", err)
|
|
}
|
|
cfg.Runtime = string(runtimeKind)
|
|
|
|
if runtimeKind == RuntimePodman {
|
|
if cfg.IncludeServices {
|
|
logger.Warn().Msg("Podman runtime detected; disabling Swarm service collection")
|
|
}
|
|
if cfg.IncludeTasks {
|
|
logger.Warn().Msg("Podman runtime detected; disabling Swarm task collection")
|
|
}
|
|
cfg.IncludeServices = false
|
|
cfg.IncludeTasks = false
|
|
}
|
|
|
|
logger.Info().
|
|
Str("runtime", string(runtimeKind)).
|
|
Str("daemon_host", dockerClient.DaemonHost()).
|
|
Str("version", info.ServerVersion).
|
|
Msg("Connected to container runtime")
|
|
|
|
hasSecure := false
|
|
hasInsecure := false
|
|
for _, target := range cfg.Targets {
|
|
role := "observer"
|
|
if target.Authoritative {
|
|
role = "primary"
|
|
}
|
|
agenttarget.MarkConfigured("docker", target.Name, role)
|
|
if target.InsecureSkipVerify {
|
|
hasInsecure = true
|
|
} else {
|
|
hasSecure = true
|
|
}
|
|
}
|
|
|
|
httpClients := make(map[bool]*http.Client, 2)
|
|
trustedHTTPClients := make(map[string]*http.Client)
|
|
if hasSecure {
|
|
httpClients[false] = newHTTPClient(false)
|
|
}
|
|
if hasInsecure {
|
|
httpClients[true] = newHTTPClient(true)
|
|
}
|
|
for _, target := range cfg.Targets {
|
|
if target.CACertPath == "" && target.ServerFingerprint == "" {
|
|
continue
|
|
}
|
|
key := targetTrustKey(target)
|
|
if _, exists := trustedHTTPClients[key]; exists {
|
|
continue
|
|
}
|
|
client, err := newHTTPClientWithTrust(target.CACertPath, target.InsecureSkipVerify, target.ServerFingerprint)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("configure TLS for Pulse target %s: %w", target.URL, err)
|
|
}
|
|
trustedHTTPClients[key] = client
|
|
}
|
|
|
|
machineID, _ := readMachineID()
|
|
hostName := cfg.HostnameOverride
|
|
if hostName == "" {
|
|
if h, err := os.Hostname(); err == nil {
|
|
hostName = h
|
|
}
|
|
}
|
|
|
|
// Use configured version or fall back to package version
|
|
agentVersion := cfg.AgentVersion
|
|
if agentVersion == "" {
|
|
agentVersion = Version
|
|
}
|
|
|
|
const bufferCapacity = 60
|
|
|
|
reportBuffers := make(map[string]*utils.Queue[agentsdocker.Report], len(cfg.Targets))
|
|
for _, target := range cfg.Targets {
|
|
reportBuffers[target.Name] = utils.New[agentsdocker.Report](bufferCapacity)
|
|
}
|
|
primaryBuffer := reportBuffers["primary"]
|
|
if primaryBuffer == nil {
|
|
for _, target := range cfg.Targets {
|
|
if target.Authoritative {
|
|
primaryBuffer = reportBuffers[target.Name]
|
|
break
|
|
}
|
|
}
|
|
}
|
|
|
|
agent := &Agent{
|
|
cfg: cfg,
|
|
docker: newSwappableDockerClient(dockerClient),
|
|
daemonHost: dockerClient.DaemonHost(),
|
|
daemonID: info.ID, // Cache at init for stable agent ID
|
|
runtime: runtimeKind,
|
|
runtimePref: runtimePref,
|
|
runtimeVer: info.ServerVersion,
|
|
agentVersion: agentVersion,
|
|
supportsSwarm: runtimeKind == RuntimeDocker,
|
|
httpClients: httpClients,
|
|
trustedHTTPClients: trustedHTTPClients,
|
|
logger: *logger,
|
|
machineID: machineID,
|
|
hostName: hostName,
|
|
targets: cfg.Targets,
|
|
allowedStates: make(map[string]struct{}, len(stateFilters)),
|
|
stateFilters: stateFilters,
|
|
prevContainerCPU: make(map[string]cpuSample),
|
|
reportBuffer: primaryBuffer,
|
|
reportBuffers: reportBuffers,
|
|
registryChecker: newRegistryCheckerWithConfig(*logger, !cfg.DisableUpdateChecks),
|
|
}
|
|
|
|
agent.registryChecker.credentials = registryCredentialSourceForConfig(cfg, *logger)
|
|
|
|
for _, state := range stateFilters {
|
|
agent.allowedStates[state] = struct{}{}
|
|
}
|
|
|
|
agent.ensureAsyncLifecycle()
|
|
|
|
return agent, nil
|
|
}
|
|
|
|
// registryCredentialSourceForConfig returns the host credential source update
|
|
// checks should use, or nil when the operator disabled credential reads.
|
|
func registryCredentialSourceForConfig(cfg Config, logger zerolog.Logger) registryCredentialSource {
|
|
if cfg.DisableRegistryCredentials {
|
|
return nil
|
|
}
|
|
return newDockerConfigCredentials(logger)
|
|
}
|
|
|
|
func normalizeTargets(raw []TargetConfig) ([]TargetConfig, error) {
|
|
if len(raw) == 0 {
|
|
return nil, nil
|
|
}
|
|
|
|
normalized := make([]TargetConfig, 0, len(raw))
|
|
seen := make(map[string]struct{}, len(raw))
|
|
seenNames := make(map[string]struct{}, len(raw))
|
|
|
|
authoritativeCount := 0
|
|
for index, target := range raw {
|
|
targetURL := strings.TrimSpace(target.URL)
|
|
token := strings.TrimSpace(target.Token)
|
|
if targetURL == "" && token == "" {
|
|
continue
|
|
}
|
|
|
|
if targetURL == "" {
|
|
return nil, errors.New("pulse target URL is required")
|
|
}
|
|
if token == "" {
|
|
return nil, fmt.Errorf("pulse target %s is missing API token", targetURL)
|
|
}
|
|
|
|
if len(normalized) == 0 && !target.Authoritative {
|
|
target.Authoritative = true
|
|
}
|
|
normalizedURL, err := normalizeTargetURLWithPolicy(
|
|
targetURL,
|
|
target.Authoritative,
|
|
target.AllowPlaintextHTTP,
|
|
)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("invalid pulse target URL %q: %w", targetURL, err)
|
|
}
|
|
|
|
caCertPath := strings.TrimSpace(target.CACertPath)
|
|
serverFingerprint := strings.TrimSpace(target.ServerFingerprint)
|
|
name := strings.TrimSpace(target.Name)
|
|
if name == "" {
|
|
if len(normalized) == 0 {
|
|
name = "primary"
|
|
} else {
|
|
name = fmt.Sprintf("observer-%d", index)
|
|
}
|
|
}
|
|
if _, exists := seenNames[name]; exists {
|
|
return nil, fmt.Errorf("duplicate Pulse target name %q", name)
|
|
}
|
|
key := normalizedURL
|
|
if _, exists := seen[key]; exists {
|
|
continue
|
|
}
|
|
if target.Authoritative {
|
|
authoritativeCount++
|
|
}
|
|
seen[key] = struct{}{}
|
|
seenNames[name] = struct{}{}
|
|
|
|
normalized = append(normalized, TargetConfig{
|
|
Name: name,
|
|
URL: normalizedURL,
|
|
Token: token,
|
|
InsecureSkipVerify: target.InsecureSkipVerify,
|
|
AllowPlaintextHTTP: target.AllowPlaintextHTTP,
|
|
CACertPath: caCertPath,
|
|
ServerFingerprint: serverFingerprint,
|
|
Authoritative: target.Authoritative,
|
|
})
|
|
}
|
|
if len(normalized) > 0 && authoritativeCount != 1 {
|
|
return nil, fmt.Errorf("exactly one authoritative Pulse target is required (got %d)", authoritativeCount)
|
|
}
|
|
return normalized, nil
|
|
}
|
|
|
|
func normalizeTargetURL(raw string) (string, error) {
|
|
return normalizeTargetURLWithPolicy(raw, true, false)
|
|
}
|
|
|
|
func normalizeTargetURLWithPolicy(raw string, authoritative bool, allowPlaintext bool) (string, error) {
|
|
normalized, err := agenttarget.NormalizePulseURL(raw, authoritative, allowPlaintext)
|
|
if err != nil {
|
|
return "", err
|
|
}
|
|
if normalized == "" {
|
|
return "", errors.New("URL is empty after normalization")
|
|
}
|
|
|
|
return normalized, nil
|
|
}
|
|
|
|
func normalizeContainerStates(raw []string) ([]string, error) {
|
|
if len(raw) == 0 {
|
|
return nil, nil
|
|
}
|
|
|
|
normalized := make([]string, 0, len(raw))
|
|
seen := make(map[string]struct{}, len(raw))
|
|
|
|
for _, value := range raw {
|
|
state := strings.ToLower(strings.TrimSpace(value))
|
|
if state == "" {
|
|
continue
|
|
}
|
|
|
|
canonical, ok := allowedContainerStates[state]
|
|
if !ok {
|
|
return nil, fmt.Errorf("unsupported container state %q", value)
|
|
}
|
|
|
|
if _, exists := seen[canonical]; exists {
|
|
continue
|
|
}
|
|
|
|
seen[canonical] = struct{}{}
|
|
normalized = append(normalized, canonical)
|
|
}
|
|
|
|
return normalized, nil
|
|
}
|
|
|
|
func normalizeRuntime(value string) (RuntimeKind, error) {
|
|
runtime := strings.ToLower(strings.TrimSpace(value))
|
|
switch runtime {
|
|
case "", string(RuntimeAuto), "default":
|
|
return RuntimeAuto, nil
|
|
case string(RuntimeDocker):
|
|
return RuntimeDocker, nil
|
|
case string(RuntimePodman):
|
|
return RuntimePodman, nil
|
|
default:
|
|
return "", fmt.Errorf("unsupported runtime %q: must be auto, docker, or podman", value)
|
|
}
|
|
}
|
|
|
|
type runtimeCandidate struct {
|
|
host string
|
|
label string
|
|
applyDockerEnv bool
|
|
}
|
|
|
|
func connectRuntime(preference RuntimeKind, logger *zerolog.Logger) (dockerClient, systemtypes.Info, RuntimeKind, error) {
|
|
candidates := buildRuntimeCandidatesFn(preference)
|
|
var attempts []string
|
|
|
|
for _, candidate := range candidates {
|
|
opts := []client.Opt{client.WithAPIVersionNegotiation()}
|
|
if candidate.applyDockerEnv {
|
|
opts = append(opts, client.FromEnv)
|
|
}
|
|
if candidate.host != "" {
|
|
opts = append(opts, client.WithHost(candidate.host))
|
|
}
|
|
|
|
cli, info, err := tryRuntimeCandidateFn(opts)
|
|
if err != nil {
|
|
attempts = append(attempts, fmt.Sprintf("%s: %v", candidate.label, err))
|
|
continue
|
|
}
|
|
|
|
endpoint := cli.DaemonHost()
|
|
runtime := detectRuntime(info, endpoint, preference)
|
|
|
|
if preference == RuntimeDocker && runtime != preference {
|
|
attempts = append(attempts, fmt.Sprintf("%s: detected %s runtime", candidate.label, runtime))
|
|
if closeErr := cli.Close(); closeErr != nil {
|
|
attempts = append(attempts, fmt.Sprintf("%s: close client after runtime mismatch: %v", candidate.label, closeErr))
|
|
}
|
|
continue
|
|
}
|
|
|
|
// A podman preference is an ordering hint, not a hard requirement: the
|
|
// pin usually comes from install-time socket discovery, and a rootless
|
|
// podman API socket can be gone by the time the agent starts (#1647).
|
|
// If every podman candidate failed and the connection landed on a real
|
|
// Docker daemon, keep it and report the runtime truthfully so Swarm
|
|
// collection stays available.
|
|
if preference == RuntimePodman && runtime != preference && logger != nil {
|
|
logger.Warn().Str("host", endpoint).Msg("Podman runtime preferred but connected endpoint is Docker; reporting docker runtime")
|
|
}
|
|
|
|
if logger != nil {
|
|
logger.Debug().Str("host", endpoint).Str("runtime", string(runtime)).Msg("Connected to container runtime")
|
|
}
|
|
|
|
return cli, info, runtime, nil
|
|
}
|
|
|
|
if len(attempts) == 0 {
|
|
return nil, systemtypes.Info{}, RuntimeAuto, errors.New("no container runtime endpoints to try")
|
|
}
|
|
|
|
return nil, systemtypes.Info{}, RuntimeAuto, fmt.Errorf("failed to connect to container runtime: %s", strings.Join(attempts, "; "))
|
|
}
|
|
|
|
func tryRuntimeCandidate(opts []client.Opt) (dockerClient, systemtypes.Info, error) {
|
|
cli, err := newDockerClientFn(opts...)
|
|
if err != nil {
|
|
return nil, systemtypes.Info{}, err
|
|
}
|
|
|
|
ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
|
|
defer cancel()
|
|
|
|
info, err := cli.Info(ctx)
|
|
if err != nil {
|
|
if closeErr := cli.Close(); closeErr != nil {
|
|
return nil, systemtypes.Info{}, errors.Join(
|
|
err,
|
|
fmt.Errorf("close runtime client after info failure: %w", closeErr),
|
|
)
|
|
}
|
|
return nil, systemtypes.Info{}, err
|
|
}
|
|
|
|
return cli, info, nil
|
|
}
|
|
|
|
func buildRuntimeCandidates(preference RuntimeKind) []runtimeCandidate {
|
|
candidates := make([]runtimeCandidate, 0, 8)
|
|
seen := make(map[string]struct{})
|
|
|
|
add := func(candidate runtimeCandidate) {
|
|
hostKey := candidate.host
|
|
if hostKey == "" {
|
|
hostKey = "__default__"
|
|
}
|
|
if _, ok := seen[hostKey]; ok {
|
|
return
|
|
}
|
|
seen[hostKey] = struct{}{}
|
|
candidates = append(candidates, candidate)
|
|
}
|
|
|
|
// When podman is explicitly requested, try podman-specific sockets FIRST
|
|
// before falling back to environment defaults (which try /var/run/docker.sock)
|
|
if preference == RuntimePodman {
|
|
if host := utils.GetenvTrim("PODMAN_HOST"); host != "" {
|
|
add(runtimeCandidate{
|
|
host: host,
|
|
label: "PODMAN_HOST",
|
|
})
|
|
}
|
|
|
|
rootless := fmt.Sprintf("unix:///run/user/%d/podman/podman.sock", os.Getuid())
|
|
add(runtimeCandidate{
|
|
host: rootless,
|
|
label: "podman rootless socket",
|
|
})
|
|
|
|
add(runtimeCandidate{
|
|
host: "unix:///run/podman/podman.sock",
|
|
label: "podman system socket",
|
|
})
|
|
|
|
// Some distros (CoreOS, Fedora) use /var/run/podman instead of /run/podman
|
|
add(runtimeCandidate{
|
|
host: "unix:///var/run/podman/podman.sock",
|
|
label: "podman system socket (var/run)",
|
|
})
|
|
}
|
|
|
|
// Environment defaults (uses Docker client defaults)
|
|
add(runtimeCandidate{
|
|
label: "environment defaults",
|
|
applyDockerEnv: true,
|
|
})
|
|
|
|
if host := utils.GetenvTrim("DOCKER_HOST"); host != "" {
|
|
add(runtimeCandidate{
|
|
host: host,
|
|
label: "DOCKER_HOST",
|
|
applyDockerEnv: true,
|
|
})
|
|
}
|
|
|
|
if host := utils.GetenvTrim("CONTAINER_HOST"); host != "" {
|
|
add(runtimeCandidate{
|
|
host: host,
|
|
label: "CONTAINER_HOST",
|
|
})
|
|
}
|
|
|
|
// For auto mode, check podman after environment defaults
|
|
if preference == RuntimeAuto {
|
|
if host := utils.GetenvTrim("PODMAN_HOST"); host != "" {
|
|
add(runtimeCandidate{
|
|
host: host,
|
|
label: "PODMAN_HOST",
|
|
})
|
|
}
|
|
|
|
rootless := fmt.Sprintf("unix:///run/user/%d/podman/podman.sock", os.Getuid())
|
|
add(runtimeCandidate{
|
|
host: rootless,
|
|
label: "podman rootless socket",
|
|
})
|
|
|
|
add(runtimeCandidate{
|
|
host: "unix:///run/podman/podman.sock",
|
|
label: "podman system socket",
|
|
})
|
|
|
|
// Some distros (CoreOS, Fedora) use /var/run/podman instead of /run/podman
|
|
add(runtimeCandidate{
|
|
host: "unix:///var/run/podman/podman.sock",
|
|
label: "podman system socket (var/run)",
|
|
})
|
|
}
|
|
|
|
if preference == RuntimeDocker || preference == RuntimeAuto {
|
|
add(runtimeCandidate{
|
|
host: "unix:///var/run/docker.sock",
|
|
label: "default docker socket",
|
|
applyDockerEnv: true,
|
|
})
|
|
}
|
|
|
|
return candidates
|
|
}
|
|
|
|
func detectRuntime(info systemtypes.Info, endpoint string, preference RuntimeKind) RuntimeKind {
|
|
lowerEndpoint := strings.ToLower(endpoint)
|
|
if strings.Contains(lowerEndpoint, "podman") || strings.Contains(lowerEndpoint, "libpod") {
|
|
return RuntimePodman
|
|
}
|
|
|
|
if strings.Contains(strings.ToLower(info.InitBinary), "podman") {
|
|
return RuntimePodman
|
|
}
|
|
|
|
if strings.Contains(strings.ToLower(info.ServerVersion), "podman") {
|
|
return RuntimePodman
|
|
}
|
|
|
|
for _, pair := range info.DriverStatus {
|
|
if strings.Contains(strings.ToLower(pair[0]), "podman") || strings.Contains(strings.ToLower(pair[1]), "podman") {
|
|
return RuntimePodman
|
|
}
|
|
}
|
|
|
|
for _, option := range info.SecurityOptions {
|
|
if strings.Contains(strings.ToLower(option), "podman") {
|
|
return RuntimePodman
|
|
}
|
|
}
|
|
|
|
// No podman signal anywhere. A docker-named endpoint is authoritative even
|
|
// under a podman preference: the connection fell through to a real Docker
|
|
// daemon, and labeling it podman would disable Swarm collection (#1647).
|
|
if strings.Contains(lowerEndpoint, "docker") {
|
|
return RuntimeDocker
|
|
}
|
|
|
|
// Unlabeled endpoint with no signals either way: trust the preference so an
|
|
// explicit podman pin on a custom socket path keeps its podman semantics.
|
|
if preference == RuntimePodman {
|
|
return RuntimePodman
|
|
}
|
|
|
|
return RuntimeDocker
|
|
}
|
|
|
|
// Run starts the collection loop until the context is cancelled.
|
|
func (a *Agent) Run(ctx context.Context) error {
|
|
interval := a.cfg.Interval
|
|
if interval <= 0 {
|
|
interval = 30 * time.Second
|
|
a.cfg.Interval = interval
|
|
}
|
|
|
|
ticker := newTickerFn(interval)
|
|
defer ticker.Stop()
|
|
|
|
const (
|
|
updateInterval = 24 * time.Hour
|
|
startupJitterWindow = 2 * time.Minute
|
|
recurringJitterWindow = 5 * time.Minute
|
|
)
|
|
|
|
initialDelay := 5*time.Second + randomDurationFn(startupJitterWindow)
|
|
updateTimer := a.newTimer(initialDelay)
|
|
defer stopTimer(updateTimer)
|
|
|
|
// Periodic cleanup of orphaned backups (every 15 minutes)
|
|
cleanupTicker := newTickerFn(15 * time.Minute)
|
|
defer cleanupTicker.Stop()
|
|
|
|
// Perform cleanup of orphaned backup containers on startup
|
|
go a.cleanupOrphanedBackups(ctx)
|
|
|
|
if err := a.collectOnce(ctx); err != nil {
|
|
if errors.Is(err, ErrStopRequested) {
|
|
return nil
|
|
}
|
|
a.logger.Error().
|
|
Err(err).
|
|
Str("phase", "startup").
|
|
Int("targets", len(a.targets)).
|
|
Int("buffered_reports", a.bufferedReports()).
|
|
Msg("Failed to send docker report")
|
|
}
|
|
|
|
for {
|
|
select {
|
|
case <-ctx.Done():
|
|
stopTimer(updateTimer)
|
|
return ctx.Err()
|
|
case <-ticker.C:
|
|
if err := a.collectOnce(ctx); err != nil {
|
|
if errors.Is(err, ErrStopRequested) {
|
|
return nil
|
|
}
|
|
a.logger.Error().
|
|
Err(err).
|
|
Str("phase", "periodic").
|
|
Int("targets", len(a.targets)).
|
|
Int("buffered_reports", a.bufferedReports()).
|
|
Msg("Failed to send docker report")
|
|
}
|
|
case <-updateTimer.C:
|
|
go a.checkForUpdates(ctx)
|
|
nextDelay := updateInterval + randomDurationFn(recurringJitterWindow)
|
|
if nextDelay <= 0 {
|
|
nextDelay = updateInterval
|
|
}
|
|
updateTimer.Reset(nextDelay)
|
|
case <-cleanupTicker.C:
|
|
go a.cleanupOrphanedBackups(ctx)
|
|
}
|
|
}
|
|
}
|
|
|
|
func stopTimer(timer *time.Timer) {
|
|
if !timer.Stop() {
|
|
select {
|
|
case <-timer.C:
|
|
default:
|
|
}
|
|
}
|
|
}
|
|
|
|
func (a *Agent) ensureAsyncLifecycle() {
|
|
a.asyncOnce.Do(func() {
|
|
a.asyncCtx, a.asyncCancel = context.WithCancel(context.Background())
|
|
})
|
|
}
|
|
|
|
func (a *Agent) runAsync(task func(context.Context)) {
|
|
a.ensureAsyncLifecycle()
|
|
|
|
a.asyncWG.Add(1)
|
|
go func() {
|
|
defer a.asyncWG.Done()
|
|
task(a.asyncCtx)
|
|
}()
|
|
}
|
|
|
|
func (a *Agent) newTimer(delay time.Duration) *time.Timer {
|
|
if a.newTimerFn != nil {
|
|
return a.newTimerFn(delay)
|
|
}
|
|
return time.NewTimer(delay)
|
|
}
|
|
|
|
func (a *Agent) jsonMarshal(v any) ([]byte, error) {
|
|
if a.jsonMarshalFn != nil {
|
|
return a.jsonMarshalFn(v)
|
|
}
|
|
return json.Marshal(v)
|
|
}
|
|
|
|
func (a *Agent) waitForAsyncDelay(delay time.Duration) bool {
|
|
if delay <= 0 {
|
|
return true
|
|
}
|
|
|
|
a.ensureAsyncLifecycle()
|
|
timer := a.newTimer(delay)
|
|
defer stopTimer(timer)
|
|
|
|
select {
|
|
case <-a.asyncCtx.Done():
|
|
return false
|
|
case <-timer.C:
|
|
return true
|
|
}
|
|
}
|
|
|
|
func (a *Agent) collectOnce(ctx context.Context) error {
|
|
_, err := a.collectOnceWithReport(ctx)
|
|
return err
|
|
}
|
|
|
|
func (a *Agent) collectOnceWithReport(ctx context.Context) (agentsdocker.Report, error) {
|
|
a.collectMu.Lock()
|
|
defer a.collectMu.Unlock()
|
|
|
|
report, err := a.buildReport(ctx)
|
|
if err != nil && a.maybeReconnectRuntime(err) {
|
|
report, err = a.buildReport(ctx)
|
|
}
|
|
if err != nil {
|
|
return agentsdocker.Report{}, fmt.Errorf("build docker report: %w", err)
|
|
}
|
|
a.runtimeGoneStreak = 0
|
|
|
|
if err := a.deliverReport(ctx, report); err != nil {
|
|
return report, err
|
|
}
|
|
return report, nil
|
|
}
|
|
|
|
func (a *Agent) flushBuffer(ctx context.Context) {
|
|
a.ensureReportBuffers()
|
|
for _, target := range a.targets {
|
|
a.flushTargetBuffer(ctx, target)
|
|
}
|
|
}
|
|
|
|
func (a *Agent) deliverReport(ctx context.Context, report agentsdocker.Report) error {
|
|
a.ensureReportBuffers()
|
|
payload, err := json.Marshal(report)
|
|
if err != nil {
|
|
return fmt.Errorf("marshal report: %w", err)
|
|
}
|
|
compressed, err := utils.CompressJSON(payload)
|
|
if err != nil {
|
|
return fmt.Errorf("compress report: %w", err)
|
|
}
|
|
for _, target := range a.targets {
|
|
if err := a.sendReportToTarget(ctx, target, compressed, len(report.Containers)); err != nil {
|
|
agenttarget.MarkDelivery("docker", target.Name, targetRole(target), false)
|
|
if errors.Is(err, ErrStopRequested) && target.Authoritative {
|
|
return nil
|
|
}
|
|
a.reportBuffers[target.Name].Push(report)
|
|
a.logger.Warn().Err(err).Str("destination", target.Name).
|
|
Bool("authoritative", target.Authoritative).
|
|
Int("buffered_reports", a.reportBuffers[target.Name].Len()).
|
|
Msg("Failed to send docker report, buffering only for this destination")
|
|
continue
|
|
}
|
|
agenttarget.MarkDelivery("docker", target.Name, targetRole(target), true)
|
|
a.flushTargetBuffer(ctx, target)
|
|
}
|
|
return nil
|
|
}
|
|
|
|
func targetRole(target TargetConfig) string {
|
|
if target.Authoritative {
|
|
return "primary"
|
|
}
|
|
return "observer"
|
|
}
|
|
|
|
func (a *Agent) flushTargetBuffer(ctx context.Context, target TargetConfig) {
|
|
a.ensureReportBuffers()
|
|
queue := a.reportBuffers[target.Name]
|
|
if queue == nil {
|
|
return
|
|
}
|
|
for {
|
|
report, ok := queue.Peek()
|
|
if !ok {
|
|
return
|
|
}
|
|
payload, err := json.Marshal(report)
|
|
if err != nil {
|
|
queue.Pop()
|
|
continue
|
|
}
|
|
compressed, err := utils.CompressJSON(payload)
|
|
if err != nil {
|
|
return
|
|
}
|
|
if err := a.sendReportToTarget(ctx, target, compressed, len(report.Containers)); err != nil {
|
|
return
|
|
}
|
|
queue.Pop()
|
|
}
|
|
}
|
|
|
|
func (a *Agent) bufferedReports() int {
|
|
a.ensureReportBuffers()
|
|
total := 0
|
|
for _, queue := range a.reportBuffers {
|
|
if queue != nil {
|
|
total += queue.Len()
|
|
}
|
|
}
|
|
return total
|
|
}
|
|
|
|
func (a *Agent) ensureReportBuffers() {
|
|
if a.reportBuffers != nil {
|
|
return
|
|
}
|
|
a.reportBuffers = make(map[string]*utils.Queue[agentsdocker.Report], len(a.targets))
|
|
for index := range a.targets {
|
|
if strings.TrimSpace(a.targets[index].Name) == "" {
|
|
if index == 0 {
|
|
a.targets[index].Name = "primary"
|
|
} else {
|
|
a.targets[index].Name = fmt.Sprintf("observer-%d", index)
|
|
}
|
|
}
|
|
if index == 0 {
|
|
a.targets[index].Authoritative = true
|
|
}
|
|
queue := utils.New[agentsdocker.Report](60)
|
|
if index == 0 && a.reportBuffer != nil {
|
|
queue = a.reportBuffer
|
|
}
|
|
a.reportBuffers[a.targets[index].Name] = queue
|
|
}
|
|
}
|
|
|
|
func (a *Agent) sendReport(ctx context.Context, report agentsdocker.Report) error {
|
|
a.ensureReportBuffers()
|
|
payload, err := json.Marshal(report)
|
|
if err != nil {
|
|
return fmt.Errorf("marshal report: %w", err)
|
|
}
|
|
|
|
compressed, err := utils.CompressJSON(payload)
|
|
if err != nil {
|
|
return fmt.Errorf("compress report: %w", err)
|
|
}
|
|
|
|
containerCount := len(report.Containers)
|
|
a.logReportSize(containerCount, int64(len(compressed)), int64(len(payload)))
|
|
|
|
var errs []error
|
|
for _, target := range a.targets {
|
|
err := a.sendReportToTarget(ctx, target, compressed, containerCount)
|
|
if err == nil {
|
|
continue
|
|
}
|
|
if errors.Is(err, ErrStopRequested) {
|
|
return ErrStopRequested
|
|
}
|
|
errs = append(errs, err)
|
|
}
|
|
|
|
if len(errs) > 0 {
|
|
return errors.Join(errs...)
|
|
}
|
|
|
|
payloadSizeKB := len(payload) / 1024
|
|
a.logger.Debug().
|
|
Int("containers", containerCount).
|
|
Int("payloadSizeKB", payloadSizeKB).
|
|
Int("payloadBytes", len(payload)).
|
|
Int("reportEncodedBytes", len(compressed)).
|
|
Int64("reportEncodedLimitBytes", agentsdocker.ReportEncodedBodyLimitBytes).
|
|
Int64("reportDecodedLimitBytes", agentsdocker.ReportDecodedBodyLimitBytes).
|
|
Int("targets", len(a.targets)).
|
|
Msg("Report sent to Pulse targets")
|
|
return nil
|
|
}
|
|
|
|
func (a *Agent) logReportSize(containerCount int, encodedBytes, decodedBytes int64) {
|
|
assessment := agentsdocker.AssessReportSize(encodedBytes, decodedBytes)
|
|
if !assessment.ApproachingLimit() {
|
|
return
|
|
}
|
|
|
|
event := a.logger.Warn()
|
|
message := fmt.Sprintf(
|
|
"Docker / Podman report is approaching the server size limit (%s). Review the reported container inventory and remove stale containers if appropriate.",
|
|
agentsdocker.ReportSizeLimitDescription(),
|
|
)
|
|
if assessment.ExceedsLimit() {
|
|
event = a.logger.Error()
|
|
message = fmt.Sprintf(
|
|
"Docker / Podman report exceeds the server size limit (%s) and is expected to be rejected. Reduce the reported container inventory or metadata before the next cycle.",
|
|
agentsdocker.ReportSizeLimitDescription(),
|
|
)
|
|
}
|
|
|
|
event.
|
|
Int("containers", containerCount).
|
|
Int64("reportEncodedBytes", encodedBytes).
|
|
Int64("reportDecodedBytes", decodedBytes).
|
|
Int64("reportEncodedWarningBytes", agentsdocker.ReportEncodedBodyWarningBytes).
|
|
Int64("reportDecodedWarningBytes", agentsdocker.ReportDecodedBodyWarningBytes).
|
|
Int64("reportEncodedLimitBytes", agentsdocker.ReportEncodedBodyLimitBytes).
|
|
Int64("reportDecodedLimitBytes", agentsdocker.ReportDecodedBodyLimitBytes).
|
|
Bool("reportEncodedLimitExceeded", encodedBytes > agentsdocker.ReportEncodedBodyLimitBytes).
|
|
Bool("reportDecodedLimitExceeded", decodedBytes > agentsdocker.ReportDecodedBodyLimitBytes).
|
|
Msg(message)
|
|
}
|
|
|
|
func (a *Agent) sendReportToTarget(ctx context.Context, target TargetConfig, payload []byte, _ int) error {
|
|
url := fmt.Sprintf("%s/api/agents/docker/report", target.URL)
|
|
req, err := http.NewRequestWithContext(ctx, http.MethodPost, url, bytes.NewReader(payload))
|
|
if err != nil {
|
|
return fmt.Errorf("target %s: create request: %w", target.URL, err)
|
|
}
|
|
|
|
setAgentHeaders(req, target.Token)
|
|
req.Header.Set("Content-Encoding", "gzip")
|
|
|
|
client := a.httpClientFor(target)
|
|
resp, err := client.Do(req)
|
|
if err != nil {
|
|
return fmt.Errorf("target %s: send report: %w", target.URL, err)
|
|
}
|
|
defer func() {
|
|
if closeErr := resp.Body.Close(); closeErr != nil {
|
|
a.logger.Warn().Err(closeErr).Str("target", target.URL).Msg("Failed to close report response body")
|
|
}
|
|
}()
|
|
|
|
if resp.StatusCode >= 300 {
|
|
bodyBytes, readErr := readBodyWithLimit(resp.Body, maxPulseResponseBodyBytes)
|
|
if readErr != nil {
|
|
return fmt.Errorf("target %s: read error response: %w", target.URL, readErr)
|
|
}
|
|
if hostRemoved := detectHostRemovedError(bodyBytes); hostRemoved != "" {
|
|
a.logger.Warn().
|
|
Str("hostID", a.hostID).
|
|
Str("pulseURL", target.URL).
|
|
Str("detail", hostRemoved).
|
|
Msg("Pulse rejected docker report because monitoring was previously stopped for this host. Allow reconnect from the Pulse UI or rerun the installer with a docker:manage token.")
|
|
return ErrStopRequested
|
|
}
|
|
errMsg := strings.TrimSpace(string(bodyBytes))
|
|
if errMsg == "" {
|
|
errMsg = resp.Status
|
|
}
|
|
// Detect token-already-in-use error and log a clear warning
|
|
if strings.Contains(errMsg, "already in use") {
|
|
a.logger.Error().
|
|
Str("pulseURL", target.URL).
|
|
Msg("DOCKER REGISTRATION FAILED: This API token is already used by another Docker / Podman module. " +
|
|
"Each Docker host requires its own unique token. " +
|
|
"Generate a new token in Pulse Settings > Agents and reinstall with the new token.")
|
|
}
|
|
return fmt.Errorf("target %s: pulse responded %s: %s", target.URL, resp.Status, errMsg)
|
|
}
|
|
|
|
body, err := readBodyWithLimit(resp.Body, maxPulseResponseBodyBytes)
|
|
if err != nil {
|
|
return fmt.Errorf("target %s: read response: %w", target.URL, err)
|
|
}
|
|
|
|
if len(body) == 0 {
|
|
return nil
|
|
}
|
|
if !target.Authoritative && target.Name != "" {
|
|
return nil
|
|
}
|
|
|
|
var reportResp agentsdocker.ReportResponse
|
|
if err := json.Unmarshal(body, &reportResp); err != nil {
|
|
a.logger.Warn().Err(err).Str("target", target.URL).Msg("Failed to decode Pulse response")
|
|
return nil
|
|
}
|
|
|
|
for _, command := range reportResp.Commands {
|
|
err := a.handleCommand(ctx, target, command)
|
|
if err == nil {
|
|
continue
|
|
}
|
|
if errors.Is(err, ErrStopRequested) {
|
|
return ErrStopRequested
|
|
}
|
|
return fmt.Errorf("handle command from %s: %w", target.URL, err)
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
func (a *Agent) handleCommand(ctx context.Context, target TargetConfig, command agentsdocker.Command) error {
|
|
switch strings.ToLower(command.Type) {
|
|
case agentsdocker.CommandTypeStop:
|
|
return a.handleStopCommand(ctx, target, command)
|
|
case agentsdocker.CommandTypeUpdateContainer:
|
|
return a.handleUpdateContainerCommand(ctx, target, command)
|
|
case agentsdocker.CommandTypeUpdateAll:
|
|
return a.handleUpdateAllCommand(ctx, target, command)
|
|
case agentsdocker.CommandTypeCheckUpdates:
|
|
return a.handleCheckUpdatesCommand(ctx, target, command)
|
|
default:
|
|
a.logger.Warn().
|
|
Str("target", target.URL).
|
|
Str("command", command.Type).
|
|
Str("commandID", command.ID).
|
|
Msg("Received unsupported control command")
|
|
return nil
|
|
}
|
|
}
|
|
|
|
func (a *Agent) handleCheckUpdatesCommand(ctx context.Context, target TargetConfig, command agentsdocker.Command) error {
|
|
command.ID = strings.TrimSpace(command.ID)
|
|
if command.ID == "" {
|
|
a.logger.Warn().
|
|
Str("target", target.URL).
|
|
Msg("Ignoring check updates command without an identifier")
|
|
return nil
|
|
}
|
|
|
|
result, shouldStart := a.beginManualUpdateCheck(command.ID)
|
|
if !shouldStart {
|
|
a.logger.Info().
|
|
Str("commandID", command.ID).
|
|
Str("target", target.URL).
|
|
Str("status", result.status).
|
|
Msg("Received replayed or concurrent check updates command; registry scan will not be repeated")
|
|
if err := a.sendCommandAck(ctx, target, command.ID, result.status, result.message); err != nil {
|
|
a.logManualUpdateCheckAckFailure(err, target, command.ID, result.status)
|
|
}
|
|
return nil
|
|
}
|
|
|
|
a.logger.Info().
|
|
Str("commandID", command.ID).
|
|
Str("target", target.URL).
|
|
Msg("Received check updates command from Pulse")
|
|
|
|
if a.registryChecker != nil {
|
|
a.registryChecker.ForceCheck()
|
|
}
|
|
|
|
if err := a.sendCommandAck(ctx, target, command.ID, result.status, result.message); err != nil {
|
|
// The server dispatches each command once. An acknowledgement failure
|
|
// must not feed the enclosing report back into delivery/replay, and the
|
|
// terminal acknowledgement below gets its own bounded retry budget.
|
|
a.logManualUpdateCheckAckFailure(err, target, command.ID, result.status)
|
|
}
|
|
|
|
a.runAsync(func(asyncCtx context.Context) {
|
|
a.executeManualUpdateCheck(asyncCtx, target, command.ID)
|
|
})
|
|
|
|
return nil
|
|
}
|
|
|
|
func (a *Agent) beginManualUpdateCheck(commandID string) (manualUpdateCheckResult, bool) {
|
|
a.manualCheckMu.Lock()
|
|
defer a.manualCheckMu.Unlock()
|
|
|
|
now := time.Now()
|
|
if a.manualCheckResults == nil {
|
|
a.manualCheckResults = make(map[string]manualUpdateCheckResult)
|
|
}
|
|
a.pruneManualUpdateCheckResultsLocked(now)
|
|
|
|
if result, ok := a.manualCheckResults[commandID]; ok {
|
|
return result, false
|
|
}
|
|
|
|
if a.manualCheckActiveID != "" {
|
|
result := manualUpdateCheckResult{
|
|
status: agentsdocker.CommandStatusFailed,
|
|
message: "Another container update check is already running; this command was not executed",
|
|
finishedAt: now,
|
|
}
|
|
a.manualCheckResults[commandID] = result
|
|
a.trimManualUpdateCheckResultsLocked()
|
|
return result, false
|
|
}
|
|
|
|
result := manualUpdateCheckResult{
|
|
status: agentsdocker.CommandStatusInProgress,
|
|
message: "Checking container registries for updates",
|
|
}
|
|
a.manualCheckActiveID = commandID
|
|
a.manualCheckResults[commandID] = result
|
|
return result, true
|
|
}
|
|
|
|
func (a *Agent) finishManualUpdateCheck(commandID, status, message string) manualUpdateCheckResult {
|
|
a.manualCheckMu.Lock()
|
|
defer a.manualCheckMu.Unlock()
|
|
|
|
if a.manualCheckResults == nil {
|
|
a.manualCheckResults = make(map[string]manualUpdateCheckResult)
|
|
}
|
|
result := manualUpdateCheckResult{
|
|
status: status,
|
|
message: message,
|
|
finishedAt: time.Now(),
|
|
}
|
|
a.manualCheckResults[commandID] = result
|
|
if a.manualCheckActiveID == commandID {
|
|
a.manualCheckActiveID = ""
|
|
}
|
|
a.trimManualUpdateCheckResultsLocked()
|
|
return result
|
|
}
|
|
|
|
func (a *Agent) pruneManualUpdateCheckResultsLocked(now time.Time) {
|
|
cutoff := now.Add(-manualUpdateCheckResultTTL)
|
|
for commandID, result := range a.manualCheckResults {
|
|
if commandID == a.manualCheckActiveID || result.finishedAt.IsZero() {
|
|
continue
|
|
}
|
|
if result.finishedAt.Before(cutoff) {
|
|
delete(a.manualCheckResults, commandID)
|
|
}
|
|
}
|
|
a.trimManualUpdateCheckResultsLocked()
|
|
}
|
|
|
|
func (a *Agent) trimManualUpdateCheckResultsLocked() {
|
|
for len(a.manualCheckResults) > manualUpdateCheckResultLimit {
|
|
var oldestID string
|
|
var oldestFinishedAt time.Time
|
|
for commandID, result := range a.manualCheckResults {
|
|
if commandID == a.manualCheckActiveID || result.finishedAt.IsZero() {
|
|
continue
|
|
}
|
|
if oldestID == "" || result.finishedAt.Before(oldestFinishedAt) {
|
|
oldestID = commandID
|
|
oldestFinishedAt = result.finishedAt
|
|
}
|
|
}
|
|
if oldestID == "" {
|
|
return
|
|
}
|
|
delete(a.manualCheckResults, oldestID)
|
|
}
|
|
}
|
|
|
|
func (a *Agent) executeManualUpdateCheck(asyncCtx context.Context, target TargetConfig, commandID string) {
|
|
checkCtx, cancel := context.WithTimeout(asyncCtx, manualUpdateCheckTimeout)
|
|
report, err := a.collectManualUpdateCheck(checkCtx)
|
|
checkCtxErr := checkCtx.Err()
|
|
cancel()
|
|
|
|
status := agentsdocker.CommandStatusCompleted
|
|
message := summarizeManualUpdateCheck(report)
|
|
switch {
|
|
case errors.Is(err, context.DeadlineExceeded), errors.Is(checkCtxErr, context.DeadlineExceeded):
|
|
status = agentsdocker.CommandStatusFailed
|
|
message = fmt.Sprintf("Container update check timed out after %s", manualUpdateCheckTimeout)
|
|
case errors.Is(err, context.Canceled), errors.Is(checkCtxErr, context.Canceled):
|
|
status = agentsdocker.CommandStatusFailed
|
|
message = "Container update check was cancelled because the agent is shutting down"
|
|
case err != nil:
|
|
status = agentsdocker.CommandStatusFailed
|
|
message = fmt.Sprintf("Container update check failed: %v", err)
|
|
}
|
|
result := a.finishManualUpdateCheck(commandID, status, message)
|
|
|
|
a.logger.Info().
|
|
Str("commandID", commandID).
|
|
Str("target", target.URL).
|
|
Str("status", result.status).
|
|
Str("message", result.message).
|
|
Msg("Container update check finished")
|
|
|
|
ackCtx, ackCancel := context.WithTimeout(asyncCtx, manualUpdateCheckTerminalAckTime)
|
|
defer ackCancel()
|
|
if err := a.sendManualUpdateCheckAckWithRetry(ackCtx, target, commandID, result); err != nil {
|
|
a.logManualUpdateCheckAckFailure(err, target, commandID, result.status)
|
|
}
|
|
}
|
|
|
|
func (a *Agent) collectManualUpdateCheck(ctx context.Context) (agentsdocker.Report, error) {
|
|
if a.manualCheckCollect != nil {
|
|
return a.manualCheckCollect(ctx)
|
|
}
|
|
return a.collectOnceWithReport(ctx)
|
|
}
|
|
|
|
func summarizeManualUpdateCheck(report agentsdocker.Report) string {
|
|
var checked, updates, skipped, registryErrors, rateLimited int
|
|
for _, container := range report.Containers {
|
|
if container.UpdateStatus == nil {
|
|
skipped++
|
|
continue
|
|
}
|
|
updateError := strings.TrimSpace(container.UpdateStatus.Error)
|
|
if strings.EqualFold(updateError, "digest-pinned image") {
|
|
skipped++
|
|
continue
|
|
}
|
|
checked++
|
|
if container.UpdateStatus.UpdateAvailable {
|
|
updates++
|
|
}
|
|
if updateError != "" {
|
|
registryErrors++
|
|
if strings.Contains(strings.ToLower(updateError), "rate limit") {
|
|
rateLimited++
|
|
}
|
|
}
|
|
}
|
|
|
|
message := fmt.Sprintf("Container update check completed: %d checked, %d updates available", checked, updates)
|
|
if skipped > 0 {
|
|
message += fmt.Sprintf(", %d skipped", skipped)
|
|
}
|
|
if registryErrors > 0 {
|
|
message += fmt.Sprintf(", %d registry errors", registryErrors)
|
|
if rateLimited > 0 {
|
|
message += fmt.Sprintf(" (%d rate limited)", rateLimited)
|
|
}
|
|
}
|
|
return message
|
|
}
|
|
|
|
func (a *Agent) sendManualUpdateCheckAckWithRetry(ctx context.Context, target TargetConfig, commandID string, result manualUpdateCheckResult) error {
|
|
var err error
|
|
for attempt := 0; attempt < manualUpdateCheckAckAttempts; attempt++ {
|
|
err = a.sendCommandAck(ctx, target, commandID, result.status, result.message)
|
|
if err == nil {
|
|
return nil
|
|
}
|
|
if attempt+1 == manualUpdateCheckAckAttempts || !a.waitForContextDelay(ctx, manualUpdateCheckAckRetryDelay*time.Duration(1<<attempt)) {
|
|
break
|
|
}
|
|
}
|
|
return err
|
|
}
|
|
|
|
func (a *Agent) waitForContextDelay(ctx context.Context, delay time.Duration) bool {
|
|
if delay <= 0 {
|
|
return ctx.Err() == nil
|
|
}
|
|
timer := a.newTimer(delay)
|
|
defer stopTimer(timer)
|
|
select {
|
|
case <-ctx.Done():
|
|
return false
|
|
case <-timer.C:
|
|
return true
|
|
}
|
|
}
|
|
|
|
func (a *Agent) logManualUpdateCheckAckFailure(err error, target TargetConfig, commandID, status string) {
|
|
a.logger.Warn().
|
|
Err(err).
|
|
Str("commandID", commandID).
|
|
Str("target", target.URL).
|
|
Str("status", status).
|
|
Msg("Failed to send container update check acknowledgement")
|
|
}
|
|
|
|
func (a *Agent) handleStopCommand(ctx context.Context, target TargetConfig, command agentsdocker.Command) error {
|
|
a.logger.Info().
|
|
Str("commandID", command.ID).
|
|
Str("target", target.URL).
|
|
Msg("Received stop command from Pulse")
|
|
|
|
if err := a.disableSelf(ctx); err != nil {
|
|
a.logger.Error().
|
|
Err(err).
|
|
Str("target", target.URL).
|
|
Str("commandID", command.ID).
|
|
Msg("Failed to disable pulse-agent service")
|
|
if ackErr := a.sendCommandAck(ctx, target, command.ID, agentsdocker.CommandStatusFailed, err.Error()); ackErr != nil {
|
|
a.logger.Error().
|
|
Err(ackErr).
|
|
Str("target", target.URL).
|
|
Str("commandID", command.ID).
|
|
Msg("Failed to send failure acknowledgement to Pulse")
|
|
}
|
|
return nil
|
|
}
|
|
|
|
if err := a.sendCommandAck(ctx, target, command.ID, agentsdocker.CommandStatusCompleted, "Agent shutting down"); err != nil {
|
|
return fmt.Errorf("send stop acknowledgement: %w", err)
|
|
}
|
|
|
|
a.logger.Info().Str("commandID", command.ID).Msg("Stop command acknowledged; terminating agent")
|
|
|
|
// After sending the acknowledgement, stop the systemd service to prevent restart.
|
|
// This is done after the ack to ensure the acknowledgement is sent before the
|
|
// process is terminated by systemctl stop.
|
|
a.runAsync(func(asyncCtx context.Context) {
|
|
// Small delay to ensure the ack response completes.
|
|
if !a.waitForAsyncDelay(1 * time.Second) {
|
|
return
|
|
}
|
|
|
|
stopServiceCtx, cancel := context.WithTimeout(asyncCtx, 5*time.Second)
|
|
defer cancel()
|
|
if err := stopSystemdService(stopServiceCtx, "pulse-agent"); err != nil {
|
|
a.logger.Warn().
|
|
Err(err).
|
|
Str("commandID", command.ID).
|
|
Str("service", "pulse-agent").
|
|
Msg("Failed to stop systemd service, agent will exit normally")
|
|
}
|
|
})
|
|
|
|
return ErrStopRequested
|
|
}
|
|
|
|
func (a *Agent) disableSelf(ctx context.Context) error {
|
|
if err := disableSystemdService(ctx, "pulse-agent"); err != nil {
|
|
return fmt.Errorf("disable systemd service: %w", err)
|
|
}
|
|
|
|
// Remove Unraid startup script if present to prevent restart on reboot.
|
|
if err := removeFileIfExists(unraidStartupScriptPath); err != nil {
|
|
a.logger.Warn().
|
|
Err(err).
|
|
Str("path", unraidStartupScriptPath).
|
|
Msg("Failed to remove Unraid startup script")
|
|
}
|
|
|
|
// Best-effort log cleanup (ignore errors).
|
|
if err := removeFileIfExists(agentLogPath); err != nil {
|
|
a.logger.Warn().Err(err).Msg("Failed to remove agent log directory")
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
func disableSystemdService(ctx context.Context, service string) error {
|
|
return runSystemctlCommand(ctx, "disable", service)
|
|
}
|
|
|
|
func stopSystemdService(ctx context.Context, service string) error {
|
|
// Stop the service to terminate the current running instance.
|
|
// This prevents systemd from restarting the service (services stopped via
|
|
// systemctl stop are not restarted even with Restart=always).
|
|
return runSystemctlCommand(ctx, "stop", service)
|
|
}
|
|
|
|
func runSystemctlCommand(ctx context.Context, action, service string) error {
|
|
if _, err := exec.LookPath("systemctl"); err != nil {
|
|
// Not a systemd environment; nothing to do.
|
|
return nil
|
|
}
|
|
|
|
cmd := exec.CommandContext(ctx, "systemctl", action, service)
|
|
output, err := cmd.CombinedOutput()
|
|
if err != nil {
|
|
if exitErr, ok := err.(*exec.ExitError); ok {
|
|
exitCode := exitErr.ExitCode()
|
|
trimmedOutput := strings.TrimSpace(string(output))
|
|
lowerOutput := strings.ToLower(trimmedOutput)
|
|
if exitCode == 5 || strings.Contains(lowerOutput, "could not be found") || strings.Contains(lowerOutput, "not-found") {
|
|
return nil
|
|
}
|
|
if strings.Contains(lowerOutput, "access denied") || strings.Contains(lowerOutput, "permission denied") {
|
|
if action == "disable" {
|
|
return fmt.Errorf("systemctl disable %s: access denied. Run 'sudo systemctl disable --now %s' or rerun the installer with sudo so it can install the polkit rule (systemctl output: %s)", service, service, trimmedOutput)
|
|
}
|
|
return fmt.Errorf("systemctl %s %s: access denied. Run 'sudo systemctl %s %s' or rerun the installer with sudo so it can install the polkit rule (systemctl output: %s)", action, service, action, service, trimmedOutput)
|
|
}
|
|
}
|
|
return fmt.Errorf("systemctl %s %s: %w (%s)", action, service, err, strings.TrimSpace(string(output)))
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
func removeFileIfExists(path string) error {
|
|
if err := os.Remove(path); err != nil {
|
|
if errors.Is(err, os.ErrNotExist) {
|
|
return nil
|
|
}
|
|
return fmt.Errorf("remove %s: %w", path, err)
|
|
}
|
|
return nil
|
|
}
|
|
|
|
func (a *Agent) sendCommandAck(ctx context.Context, target TargetConfig, commandID, status, message string) error {
|
|
return a.sendCommandAckWithPayload(ctx, target, commandID, status, message, nil)
|
|
}
|
|
|
|
func (a *Agent) sendCommandAckWithPayload(ctx context.Context, target TargetConfig, commandID, status, message string, payload map[string]any) error {
|
|
if a.hostID == "" {
|
|
return fmt.Errorf("host identifier unavailable; cannot acknowledge command")
|
|
}
|
|
|
|
ackPayload := agentsdocker.CommandAck{
|
|
AgentID: a.hostID,
|
|
Status: status,
|
|
Message: message,
|
|
Payload: payload,
|
|
}
|
|
|
|
body, err := a.jsonMarshal(ackPayload)
|
|
if err != nil {
|
|
return fmt.Errorf("marshal command acknowledgement: %w", err)
|
|
}
|
|
|
|
url := fmt.Sprintf("%s/api/agents/docker/commands/%s/ack", target.URL, commandID)
|
|
req, err := http.NewRequestWithContext(ctx, http.MethodPost, url, bytes.NewReader(body))
|
|
if err != nil {
|
|
return fmt.Errorf("create acknowledgement request: %w", err)
|
|
}
|
|
|
|
setAgentHeaders(req, target.Token)
|
|
|
|
resp, err := a.httpClientFor(target).Do(req)
|
|
if err != nil {
|
|
return fmt.Errorf("send acknowledgement: %w", err)
|
|
}
|
|
defer func() {
|
|
if closeErr := resp.Body.Close(); closeErr != nil {
|
|
a.logger.Warn().Err(closeErr).Str("target", target.URL).Msg("Failed to close acknowledgement response body")
|
|
}
|
|
}()
|
|
|
|
if resp.StatusCode >= 300 {
|
|
bodyBytes, err := readBodyWithLimit(resp.Body, maxPulseResponseBodyBytes)
|
|
if err != nil {
|
|
return fmt.Errorf("read acknowledgement error response: %w", err)
|
|
}
|
|
return fmt.Errorf("pulse responded %s: %s", resp.Status, strings.TrimSpace(string(bodyBytes)))
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
func (a *Agent) primaryTarget() TargetConfig {
|
|
for _, target := range a.targets {
|
|
if target.Authoritative {
|
|
return target
|
|
}
|
|
}
|
|
if len(a.targets) > 0 {
|
|
return a.targets[0]
|
|
}
|
|
return TargetConfig{}
|
|
}
|
|
|
|
func (a *Agent) httpClientFor(target TargetConfig) *http.Client {
|
|
if client, ok := a.trustedHTTPClients[targetTrustKey(target)]; ok {
|
|
return client
|
|
}
|
|
if client, ok := a.httpClients[target.InsecureSkipVerify]; ok {
|
|
return client
|
|
}
|
|
if client, ok := a.httpClients[false]; ok {
|
|
return client
|
|
}
|
|
if client, ok := a.httpClients[true]; ok {
|
|
return client
|
|
}
|
|
return newHTTPClient(target.InsecureSkipVerify)
|
|
}
|
|
|
|
func targetTrustKey(target TargetConfig) string {
|
|
return fmt.Sprintf("%t|%s|%s", target.InsecureSkipVerify, strings.TrimSpace(target.CACertPath), strings.TrimSpace(target.ServerFingerprint))
|
|
}
|
|
|
|
func newHTTPClient(insecure bool) *http.Client {
|
|
client, err := newHTTPClientWithTrust("", insecure, "")
|
|
if err != nil {
|
|
panic(fmt.Sprintf("build default Pulse HTTP client: %v", err))
|
|
}
|
|
return client
|
|
}
|
|
|
|
func newHTTPClientWithTrust(caCertPath string, insecure bool, serverFingerprint string) (*http.Client, error) {
|
|
tlsConfig, err := agenttls.NewClientTLSConfig(caCertPath, insecure, serverFingerprint)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
return &http.Client{
|
|
Timeout: 15 * time.Second,
|
|
Transport: &http.Transport{
|
|
TLSClientConfig: tlsConfig,
|
|
},
|
|
// Disallow redirects for agent API calls. If a reverse proxy redirects
|
|
// HTTP to HTTPS, Go's default behavior converts POST to GET (per HTTP spec),
|
|
// causing 405 errors. Return an error with guidance instead.
|
|
CheckRedirect: func(req *http.Request, via []*http.Request) error {
|
|
return fmt.Errorf("server returned redirect to %s - if using a reverse proxy, ensure you use the correct protocol (https:// instead of http://) in your --url flag", req.URL)
|
|
},
|
|
}, nil
|
|
}
|
|
|
|
func (a *Agent) Close() error {
|
|
a.closeOnce.Do(func() {
|
|
a.ensureAsyncLifecycle()
|
|
a.asyncCancel()
|
|
|
|
done := make(chan struct{})
|
|
go func() {
|
|
a.asyncWG.Wait()
|
|
close(done)
|
|
}()
|
|
|
|
waitTimer := a.newTimer(2 * time.Second)
|
|
select {
|
|
case <-done:
|
|
stopTimer(waitTimer)
|
|
case <-waitTimer.C:
|
|
a.logger.Warn().Msg("Timed out waiting for Docker / Podman module background work to stop")
|
|
}
|
|
|
|
for _, client := range a.httpClients {
|
|
if client != nil {
|
|
client.CloseIdleConnections()
|
|
}
|
|
}
|
|
for _, client := range a.trustedHTTPClients {
|
|
if client != nil {
|
|
client.CloseIdleConnections()
|
|
}
|
|
}
|
|
if a.registryChecker != nil && a.registryChecker.httpClient != nil {
|
|
a.registryChecker.httpClient.CloseIdleConnections()
|
|
}
|
|
|
|
if a.docker != nil {
|
|
a.closeErr = a.docker.Close()
|
|
}
|
|
})
|
|
|
|
return a.closeErr
|
|
}
|
|
|
|
func (a *Agent) tryStartUpdateCheck() bool {
|
|
a.backgroundMu.Lock()
|
|
defer a.backgroundMu.Unlock()
|
|
if a.updateCheckRunning {
|
|
return false
|
|
}
|
|
a.updateCheckRunning = true
|
|
return true
|
|
}
|
|
|
|
func (a *Agent) finishUpdateCheck() {
|
|
a.backgroundMu.Lock()
|
|
a.updateCheckRunning = false
|
|
a.backgroundMu.Unlock()
|
|
}
|
|
|
|
func (a *Agent) tryStartCleanupTask() bool {
|
|
a.backgroundMu.Lock()
|
|
defer a.backgroundMu.Unlock()
|
|
if a.cleanupTaskRunning {
|
|
return false
|
|
}
|
|
a.cleanupTaskRunning = true
|
|
return true
|
|
}
|
|
|
|
func (a *Agent) finishCleanupTask() {
|
|
a.backgroundMu.Lock()
|
|
a.cleanupTaskRunning = false
|
|
a.backgroundMu.Unlock()
|
|
}
|
|
|
|
func readMachineID() (string, error) {
|
|
for _, path := range machineIDPaths {
|
|
data, err := osReadFileFn(path)
|
|
if err == nil {
|
|
machineID := strings.TrimSpace(string(data))
|
|
// Format as UUID if it's a 32-char hex string (like machine-id typically is),
|
|
// to match the behavior of the host agent.
|
|
if len(machineID) == 32 && utils.IsHexString(machineID) {
|
|
return fmt.Sprintf("%s-%s-%s-%s-%s",
|
|
machineID[0:8], machineID[8:12], machineID[12:16],
|
|
machineID[16:20], machineID[20:32]), nil
|
|
}
|
|
return machineID, nil
|
|
}
|
|
}
|
|
return "", errors.New("machine-id not found")
|
|
}
|
|
|
|
func readSystemUptime() int64 {
|
|
seconds, err := readProcUptime()
|
|
if err != nil {
|
|
return 0
|
|
}
|
|
return int64(seconds)
|
|
}
|
|
|
|
// detectHostRemovedError checks if the response body contains a host removal error
|
|
func detectHostRemovedError(body []byte) string {
|
|
if len(body) == 0 {
|
|
return ""
|
|
}
|
|
|
|
var payload struct {
|
|
Error string `json:"error"`
|
|
Code string `json:"code"`
|
|
}
|
|
if err := json.Unmarshal(body, &payload); err != nil {
|
|
return ""
|
|
}
|
|
if strings.ToLower(payload.Code) != "invalid_report" {
|
|
return ""
|
|
}
|
|
lowerError := strings.ToLower(payload.Error)
|
|
if !strings.Contains(lowerError, "was removed") &&
|
|
!strings.Contains(lowerError, "monitoring stopped") {
|
|
return ""
|
|
}
|
|
return payload.Error
|
|
}
|