Documentation
¶
Overview ¶
Package snap manages installing and running snaps.
Index ¶
- Constants
- func SetSnapConfig(snap string, key string, value string) error
- type App
- type BackgroundService
- type ConfinementPolicy
- type Installable
- type Runnable
- type Service
- func (s Service) ConfigOverride() error
- func (s Service) Exists() (bool, error)
- func (s Service) Install() error
- func (s Service) Installed() (bool, error)
- func (s Service) Name() string
- func (s Service) Restart() error
- func (s Service) Running() (bool, error)
- func (s Service) Start() error
- func (s Service) StartCommands() ([]string, error)
- func (s Service) Stop() error
- func (s Service) Validate() error
Constants ¶
const (
// Command is a path to the snap binary, or to one that can be detected by os.Exec
Command = "snap"
)
Variables ¶
This section is empty.
Functions ¶
Types ¶
type App ¶
type App struct {
// contains filtered or unexported fields
}
App is a wrapper around a single snap
func NewApp ¶
func NewApp(name string, channel string, policy ConfinementPolicy, services []BackgroundService, prerequisites []Installable) *App
NewApp creates a application along with it's dependencies.
func NewNamedApp ¶
NewNamedApp creates a new application from a given name.
func (*App) BackgroundServices ¶
func (a *App) BackgroundServices() []BackgroundService
BackgroundServices returns a list of background services that are required to be installed for the main application to run.
func (*App) Prerequisites ¶
func (a *App) Prerequisites() []Installable
Prerequisites defines a list of all the Prerequisites required before the application also needs to be installed.
func (*App) StartCommands ¶
StartCommands returns a list if shell commands that should be executed (in order) to start App and its background services. executeable is a path to the snap executable. If the app has prerequisite applications defined, then take care to call StartCommands on those apps also.
type BackgroundService ¶
type BackgroundService struct {
// name is the name of the service, without the snap name.
// For example , for the`juju-db.daemon` service, use the name `daemon`.
Name string
// enableAtStartup determines whether services provided
// by the snap should be started with the `--enable` flag
EnableAtStartup bool
}
BackgroundService represents the a service that snaps define. For example, the multipass snap includes the libvirt-bin and multipassd background services.
func (*BackgroundService) Validate ¶
func (backgroundService *BackgroundService) Validate() error
Validate checks that the construction parameters of backgroundService are valid. Successful validation returns nil.
type ConfinementPolicy ¶
type ConfinementPolicy string
ConfinementPolicy describes the confinement policy for installing a given snap application.
const ( // StrictPolicy confined snaps run in complete isolation, up to a minimal // access level that’s deemed always safe. StrictPolicy ConfinementPolicy = "strict" // ClassicPolicy allows access to your system’s resources in much the same // way traditional packages do ClassicPolicy ConfinementPolicy = "classic" // DevModePolicy is a special mode for snap creators and developers. // A devmode snap runs as a strictly confined snap with full access to // system resources, and produces debug output to identify unspecified // interfaces. DevModePolicy ConfinementPolicy = "devmode" // JailModePolicy enforces the confinement model for a snap to ensure that // the confinement is enforced. JailModePolicy ConfinementPolicy = "jailmode" )
func (ConfinementPolicy) String ¶
func (p ConfinementPolicy) String() string
String representation of the confinement policy.
func (ConfinementPolicy) Validate ¶
func (p ConfinementPolicy) Validate() error
Validate validates a given confinement policy to ensure it matches the ones we expect.
type Installable ¶
type Installable interface {
// Name returns the name of the application
Name() string
// Install returns a way to install one application with all it's settings.
Install() []string
// Validate will validate a given application for any potential issues.
Validate() error
// StartCommands returns a list if shell commands that should be executed
// (in order) to start App and its background services.
StartCommands(executable string) []string
// Prerequisites defines a list of all the Prerequisites required before the
// application also needs to be installed.
Prerequisites() []Installable
// BackgroundServices returns a list of background services that are
// required to be installed for the main application to run.
BackgroundServices() []BackgroundService
}
Installable represents an installable snap.
type Runnable ¶
Runnable expects to be able to run a given command with a series of arguments and return the output and/or error from that executing command.
type Service ¶
type Service struct {
// contains filtered or unexported fields
}
Service is a type for services that are being managed by snapd as snaps.
func NewService ¶
func NewService(mainSnap, serviceName string, conf common.Conf, snapPath, configDir, channel string, confinementPolicy ConfinementPolicy, backgroundServices []BackgroundService, prerequisites []Installable) (Service, error)
NewService returns a new Service defined by `conf`, with the name `serviceName`. The Service abstracts service(s) provided by a snap.
`serviceName` defaults to `snapName`. These two parameters are distinct to allow for a file path to provided as a `mainSnap`, implying that a local snap will be installed by snapd.
If no BackgroundServices are provided, Service will wrap all of the snap's background services.
func (Service) ConfigOverride ¶
ConfigOverride writes a systemd override to enable the specified limits to be used by the snap.
func (Service) Name ¶
Name returns the service's name. It should match snap's naming conventions, e.g. <snap> for all services provided by <snap> and `<snap>.<app>` for a specific service under the snap's control.For example, the `juju-db` snap provides a `daemon` service. Its name is `juju-db.daemon`.
func (Service) Restart ¶
Restart restarts the service, or starts if it's not currently running.
Restart is part of the service.RestartableService interface
func (Service) Running ¶
Running returns (true, nil) when snap indicates that service is currently active.
func (Service) Start ¶
Start starts the service, returning nil when successful. If the service is already running, Start does not restart it.
func (Service) StartCommands ¶
StartCommands returns a slice of strings. that are shell commands to be executed by a shell which start the service.
Source Files