install

package

Go to main page

Versions in this module

v0

v0.0.7

Oct 27, 2026

v0.0.6

Oct 16, 2026

v0.0.5

Oct 12, 2026

Changes in this version

+ const ChannelEnv

+ const MaxSettleSeconds

+ const PacketFilterHint

+ const RequestMaxAge

+ const UpgradeRequestFileName

+ var ErrNoRequest = errors.New("install: no upgrade request is waiting")

+ var ErrRollback = errors.New("install: refusing to roll this device back to a build earlier on main")

+ func ChannelDropIn(s Spec, c provenance.Channel) string

+ func FileUpgradeRequest(s Spec, req UpgradeRequest) error

+ func PacketFilterDropIn(s Spec) string

+ func UpgradeHelperPathUnit(s Spec) string

+ func UpgradeHelperService(s Spec) string

type BinaryIdentity

+ Commit string

+ Sequence int

type BootstrapParams

+ EdgeCommit string

+ EdgeUnavailable string

+ HubProtocol int

+ HubVersion string

type Installer

+ func (in *Installer) DeviceChannel(s Spec) (provenance.Channel, error)

+ func (in *Installer) HelperInstalled(s Spec) bool

+ type PacketFilterChange int

+ const PacketFilterGrant

+ const PacketFilterKeep

+ const PacketFilterWithdraw

type Plan

+ Remove []string

+ type RemoteUpgradeChange int

+ const RemoteUpgradeGrant

+ const RemoteUpgradeKeep

+ const RemoteUpgradeWithdraw

type Spec

+ Channel provenance.Channel

+ PacketFilter bool

+ RemoteUpgrade bool

+ func (s Spec) ChannelDropInPath() string

+ func (s Spec) DropInDir() string

+ func (s Spec) PacketFilterDropInPath() string

+ func (s Spec) UpgradeHelperName() string

+ func (s Spec) UpgradeHelperPathUnitName() string

+ func (s Spec) UpgradeHelperPathUnitPath() string

+ func (s Spec) UpgradeHelperServicePath() string

+ func (s Spec) UpgradeHelperStateDir() string

+ func (s Spec) UpgradeRequestPath() string

type UpgradeOptions

+ AllowRollback bool

+ Channel provenance.Channel

+ ExpectCommit string

+ ExpectSequence int

+ ExpectVersion string

+ PacketFilter PacketFilterChange

+ RemoteUpgrade RemoteUpgradeChange

+ type UpgradeRequest struct

+ Force bool

+ Reason string

+ RequestedAt string

+ SettleSeconds int

+ TargetVersion string

+ func TakeUpgradeRequest(s Spec, now time.Time) (UpgradeRequest, error)

type UpgradeResult

+ BinaryCurrent bool

+ Channel provenance.Channel

+ ChannelChanged bool

+ PacketFilterChange string

+ PacketFilterChanged bool

+ PacketFilterGranted bool

+ RemoteUpgradeChanged bool

+ RemoteUpgradeInstalled bool

+ UnitChanges []string

v0.0.4

Sep 27, 2026

v0.0.3

Sep 27, 2026

Changes in this version

type UpgradeOptions

+ ProvenanceEstablished bool

v0.0.2

Sep 17, 2026

Changes in this version

+ const ProbeTimeout

+ var ErrBinaryUnusable = errors.New("install: the staged binary failed verification")

+ var ErrDowngrade = errors.New("install: refusing to install an older build")

+ type BinaryIdentity struct

+ Arch string

+ MinProtocol int

+ OS string

+ Protocol int

+ Structured bool

+ Version string

+ func (id BinaryIdentity) String() string

type Installer

+ Exec Prober

+ type Prober func(ctx context.Context, path string, args ...string) ([]byte, error)

type UpgradeOptions

+ Bundle string

+ SettleTimeout time.Duration

+ SkipVerify bool

type UpgradeResult

+ BackupPath string

+ InstalledBuild BinaryIdentity

+ ProvenanceVerified bool

+ RolledBack bool

+ StagedBuild BinaryIdentity

+ Verified bool

v0.0.1

Sep 13, 2026

Changes in this version

+ const BinaryMode

+ const CredentialFileMode

+ const DefaultBinaryPath

+ const DefaultImage

+ const DefaultInitDir

+ const DefaultServiceName

+ const DefaultStateRoot

+ const DefaultUnitDir

+ const DefaultUser

+ const ScriptFileMode

+ const StateDirMode

+ const SystemDirMode

+ const UnitFileMode

+ var ErrNotInstalled = errors.New("install: no existing agent install found")

+ func BootstrapScript(p BootstrapParams) string

+ func ComposeFragment(s Spec) string

+ func ContainerFragment(s Spec) string

+ func InitScript(s Spec) string

+ func PodmanRun(s Spec) string

+ func SystemdUnit(s Spec) string

+ type Artifact struct

+ Content string

+ Mode os.FileMode

+ Owned bool

+ Path string

+ Secret bool

+ type BootstrapParams struct

+ Pin string

+ Server string

+ ServiceName string

+ type Dir struct

+ Mode os.FileMode

+ Path string

+ type Installer struct

+ Logf func(format string, args ...any)

+ Root string

+ Run Runner

+ func (in *Installer) Apply(p Plan) error

+ func (in *Installer) Uninstall(spec Spec, out Output, purgeState bool) error

+ func (in *Installer) Upgrade(spec Spec, out Output, opts UpgradeOptions) (UpgradeResult, error)

+ type Output string

+ const OutputDocker

+ const OutputShell

+ const OutputSystemd

+ func ParseOutput(s string) (Output, error)

+ type Plan struct

+ Artifacts []Artifact

+ Dirs []Dir

+ Display string

+ Next []string

+ Output Output

+ Spec Spec

+ func BuildPlan(spec Spec, out Output) (Plan, error)

+ type Runner func(name string, args ...string) error

+ type Spec struct

+ AgentCredential string

+ BinaryPath string

+ Bundle string

+ CredentialsFile string

+ Group string

+ Image string

+ InitDir string

+ Labels map[string]string

+ MaxConcurrent int

+ NoStart bool

+ Pin string

+ RootCAFile string

+ Server string

+ ServiceName string

+ StateDir string

+ Token string

+ UnitDir string

+ User string

+ WorkDirRoot string

+ func (s Spec) InitScriptPath() string

+ func (s Spec) Normalize() (Spec, error)

+ func (s Spec) NormalizeForRemoval() (Spec, error)

+ func (s Spec) UnitFileName() string

+ func (s Spec) UnitPath() string

+ type UpgradeOptions struct

+ DryRun bool

+ Force bool

+ Source string

+ type UpgradeResult struct

+ AlreadyCurrent bool

+ BinaryReplaced bool

+ DryRun bool

+ NewChecksum string

+ Output Output

+ PreviousChecksum string

+ Restarted bool

+ Source string

+ Spec Spec

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL