packaging

Documentation

Overview

package packaging provides tools for buildin Orbit installation packages.

Index

• func BuildDeb(opt Options) error
• func BuildMSI(opt Options) error
• func BuildPkg(opt Options) error
• func BuildRPM(opt Options) error
• type Options

Functions

func BuildDeb

func BuildDeb(opt Options) error

func BuildMSI

func BuildMSI(opt Options) error

BuildMSI builds a Windows .msi.

func BuildPkg

func BuildPkg(opt Options) error

BuildPkg builds a macOS .pkg. So far this is tested only on macOS but in theory it works with bomutils on Linux.

func BuildRPM

func BuildRPM(opt Options) error

Types

type Options

type Options struct {
	// FleetURL is the URL to the Fleet server.
	FleetURL string
	// EnrollSecret is the enroll secret used to authenticate to the Fleet
	// server.
	EnrollSecret string
	// Version is the version number for this package.
	Version string
	// Identifier is the identifier (eg. com.fleetdm.orbit) for the package product.
	Identifier string
	// StartService is a boolean indicating whether to start a system-specific
	// background service.
	StartService bool
	// Insecure enables insecure TLS connections for the generated package.
	Insecure bool
	// SignIdentity is the codesigning identity to use (only macOS at this time)
	SignIdentity string
	// Notarize sets whether macOS packages should be Notarized.
	Notarize bool
	// FleetCertificate is a path to a server certificate to include in the package.
	FleetCertificate string
	// OrbitChannel is the update channel to use for Orbit.
	OrbitChannel string
	// OsquerydChannel is the update channel to use for Osquery (osqueryd).
	OsquerydChannel string
	// UpdateURL is the base URL of the update server (TUF repository).
	UpdateURL string
	// UpdateRoots is the root JSON metadata for update server (TUF repository).
	UpdateRoots string
	// Debug determines whether to enable debug logging for the agent.
	Debug bool
}

Options are the configurable options provided for the package.