daemon

Documentation

Index

• Variables
• func AppNotFound(format string, v ...interface{}) *apiError
• func AuthCancelled(format string, v ...interface{}) *apiError
• func BadQuery() *apiError
• func InsufficientSpace(dserr *snapstate.InsufficientSpaceError) *apiError
• func InterfacesUnchanged(format string, v ...interface{}) *apiError
• func QuotaChangeConflict(qce *servicestate.QuotaChangeConflictError) *apiError
• func SnapChangeConflict(cce *snapstate.ChangeConflictError) *apiError
• func SnapNotFound(snapName string, err error) *apiError
• func SnapNotInstalled(snapName string, err error) *apiError
• func SnapRevisionNotAvailable(snapName string, rnaErr *store.RevisionNotAvailableError) *apiError
• type Command
  • func (c *Command) ServeHTTP(w http.ResponseWriter, r *http.Request)
• type Daemon
  • func New() (*Daemon, error)
  • func (d *Daemon) Dying() <-chan struct{}
  • func (d *Daemon) HandleRestart(t restart.RestartType, rebootInfo *boot.RebootInfo)
  • func (d *Daemon) Init() error
  • func (d *Daemon) RebootAsExpected(st *state.State) error
  • func (d *Daemon) RebootDidNotHappen(st *state.State) error
  • func (d *Daemon) SetDegradedMode(err error)
  • func (d *Daemon) Start(ctx context.Context) (err error)
  • func (d *Daemon) Stop(sigCh chan<- os.Signal) error
• type FileReference
• type Form
  • func (f *Form) GetSnapFiles() ([]*uploadedSnap, *apiError)
  • func (f *Form) RemoveAllExcept(paths []string)
• type Response
  • func AssertResponse(asserts []asserts.Assertion, bundle bool) Response
  • func AsyncResponse(result map[string]interface{}, change string) Response
  • func SyncResponse(result interface{}) Response
• type ResponseFunc
• type ResponseType
• type StructuredResponse

Variables

var (
	Unauthorized     = makeErrorResponder(401)
	NotFound         = makeErrorResponder(404)
	BadRequest       = makeErrorResponder(400)
	MethodNotAllowed = makeErrorResponder(405)
	InternalError    = makeErrorResponder(500)
	NotImplemented   = makeErrorResponder(501)
	Forbidden        = makeErrorResponder(403)
	Conflict         = makeErrorResponder(409)
)

standard error responses

var ErrNoFailureRecoveryNeeded = fmt.Errorf("no failure recovery needed")

var ErrRestartSocket = fmt.Errorf("daemon stop requested to wait for socket activation")

Functions

func AppNotFound

func AppNotFound(format string, v ...interface{}) *apiError

AppNotFound is an error responder used when an operation is requested on a app that doesn't exist.

func AuthCancelled

func AuthCancelled(format string, v ...interface{}) *apiError

AuthCancelled is an error responder used when a user cancelled the auth process.

func BadQuery

func BadQuery() *apiError

BadQuery is an error responder used when a bad query was provided to the store.

func InsufficientSpace

func InsufficientSpace(dserr *snapstate.InsufficientSpaceError) *apiError

InsufficientSpace is an error responder used when an operation cannot be performed due to low disk space.

func InterfacesUnchanged

func InterfacesUnchanged(format string, v ...interface{}) *apiError

InterfacesUnchanged is an error responder used when an operation that would normally change interfaces finds it has nothing to do

func QuotaChangeConflict

func QuotaChangeConflict(qce *servicestate.QuotaChangeConflictError) *apiError

QuotaChangeConflict is an error responder used when an operation would conflict with another ongoing change.

func SnapChangeConflict

func SnapChangeConflict(cce *snapstate.ChangeConflictError) *apiError

SnapChangeConflict is an error responder used when an operation would conflict with another ongoing change.

func SnapNotFound

func SnapNotFound(snapName string, err error) *apiError

SnapNotFound is an error responder used when an operation is requested on a snap that doesn't exist.

func SnapNotInstalled

func SnapNotInstalled(snapName string, err error) *apiError

SnapNotInstalled is an error responder used when an operation is requested on a snap that is not in the system but expected to be.

func SnapRevisionNotAvailable

func SnapRevisionNotAvailable(snapName string, rnaErr *store.RevisionNotAvailableError) *apiError

SnapRevisionNotAvailable is an error responder used when an operation is requested for which no revivision can be found in the given context (e.g. request an install from a stable channel when this channel is empty).

Types

type Command

type Command struct {
	Path       string
	PathPrefix string
	//
	GET  ResponseFunc
	PUT  ResponseFunc
	POST ResponseFunc

	// Access control.
	ReadAccess  accessChecker
	WriteAccess accessChecker
	// contains filtered or unexported fields
}

A Command routes a request to an individual per-verb ResponseFunc

func (*Command) ServeHTTP

func (c *Command) ServeHTTP(w http.ResponseWriter, r *http.Request)

type Daemon

type Daemon struct {
	Version string
	// contains filtered or unexported fields
}

A Daemon listens for requests and routes them to the right command

func New

func New() (*Daemon, error)

New Daemon

func (*Daemon) Dying

func (d *Daemon) Dying() <-chan struct{}

Dying is a tomb-ish thing

func (*Daemon) HandleRestart

func (d *Daemon) HandleRestart(t restart.RestartType, rebootInfo *boot.RebootInfo)

HandleRestart implements overlord.RestartBehavior.

func (*Daemon) Init

func (d *Daemon) Init() error

Init sets up the Daemon's internal workings. Don't call more than once.

func (*Daemon) RebootAsExpected

func (d *Daemon) RebootAsExpected(st *state.State) error

RebootAsExpected implements part of overlord.RestartBehavior.

func (*Daemon) RebootDidNotHappen

func (d *Daemon) RebootDidNotHappen(st *state.State) error

RebootDidNotHappen implements part of overlord.RestartBehavior.

func (*Daemon) SetDegradedMode

func (d *Daemon) SetDegradedMode(err error)

SetDegradedMode puts the daemon into a degraded mode. In this mode it will return the error given in the "err" argument for commands that are not pure HTTP GETs.

This is useful to report errors to the client when the daemon cannot work because e.g. a snapd squashfs precondition check failed or the system is out of diskspace.

When the system is fine again, calling "SetDegradedMode(nil)" is enough to put the daemon into full operation again.

func (*Daemon) Start

func (d *Daemon) Start(ctx context.Context) (err error)

Start the Daemon. Takes a context which will be used as the base request context in the embedded http.Server.

func (*Daemon) Stop

func (d *Daemon) Stop(sigCh chan<- os.Signal) error

Stop shuts down the Daemon

type FileReference

type FileReference struct {
	Filename string
	TmpPath  string
}

type Form

type Form struct {
	// Values holds non-file parts keyed by their "name" parameter (from the
	// part's Content-Disposition header).
	Values map[string][]string

	// FileRefs holds file parts keyed by their "name" parameter (from the
	// part's Content-Disposition header). Each reference contains a filename
	// (the "filename" parameter) and the path to a file with the part's contents.
	FileRefs map[string][]*FileReference
}

Form is a multipart form that holds file and non-file parts

func (*Form) GetSnapFiles

func (f *Form) GetSnapFiles() ([]*uploadedSnap, *apiError)

GetSnapFiles returns the original name and temp path for each snap file in the form. Optionally, it might include a requested instance name, but only if the was only one file in the form.

func (*Form) RemoveAllExcept

func (f *Form) RemoveAllExcept(paths []string)

RemoveAllExcept removes all temporary files uploaded with form, except for the given paths. Should be called once the files uploaded with the form are no longer needed.

type Response

type Response interface {
	ServeHTTP(w http.ResponseWriter, r *http.Request)
}

Response knows how to serve itself.

func AssertResponse

func AssertResponse(asserts []asserts.Assertion, bundle bool) Response

AssertResponse builds a response whose ServerHTTP method serves one or a bundle of assertions.

func AsyncResponse

func AsyncResponse(result map[string]interface{}, change string) Response

AsyncResponse builds an "async" response for a created change

func SyncResponse

func SyncResponse(result interface{}) Response

SyncResponse builds a "sync" response from the given result.

type ResponseFunc

type ResponseFunc func(*Command, *http.Request, *auth.UserState) Response

A ResponseFunc handles one of the individual verbs for a method

type ResponseType

type ResponseType string

ResponseType is the response type

const (
	ResponseTypeSync  ResponseType = "sync"
	ResponseTypeAsync ResponseType = "async"
	ResponseTypeError ResponseType = "error"
)

"there are three standard return types: Standard return value, Background operation, Error", each returning a JSON object with the following "type" field:

type StructuredResponse

type StructuredResponse interface {
	Response

	JSON() *respJSON
}

A StructuredResponse serializes itself to our standard JSON response format.