apps

Documentation

Index

• type App
• type AppImageType
• type Apps
  • func (al *Apps) Count() int
  • func (al *Apps) Create(img string)
  • func (al *Apps) GetArgs() [][]string
  • func (al *Apps) GetImageIDs() []types.Hash
  • func (al *Apps) GetImages() []string
  • func (al *Apps) Last() *App
  • func (al *Apps) Reset()
  • func (al *Apps) Validate() error
  • func (al *Apps) Walk(f func(*App) error) error

Types

type App

type App struct {
	Image       string                            // the image reference as supplied by the user on the cli
	ImType      AppImageType                      // the type of the image reference (to be guessed, url, path or hash)
	Args        []string                          // any arguments the user supplied for this app
	Asc         string                            // signature file override for image verification (if fetching occurs)
	Exec        string                            // exec override for image
	Mounts      []schema.Mount                    // mounts for this app (superseding any mounts in rktApps.mounts of same MountPoint)
	MemoryLimit *types.ResourceMemory             // memory isolator override
	CPULimit    *types.ResourceCPU                // cpu isolator override
	User, Group string                            // user, group overrides
	CapsRetain  *types.LinuxCapabilitiesRetainSet // os/linux/capabilities-retain-set overrides
	CapsRemove  *types.LinuxCapabilitiesRevokeSet // os/linux/capabilities-remove-set overrides

	// TODO(jonboulle): These images are partially-populated hashes, this should be clarified.
	ImageID types.Hash // resolved image identifier
}

type AppImageType

type AppImageType int

AppImageType describes a type of an image reference. The reference can either be guessed or be a hash, a URL, a path, or a name. The first option means that the application will have to deduce the actual type (one of the last four).

const (
	AppImageGuess AppImageType = iota // image type to be guessed
	AppImageHash                      // image hash
	AppImageURL                       // image URL with a scheme
	AppImagePath                      // absolute or relative path
	AppImageName                      // image name
)

type Apps

type Apps struct {
	Mounts  []schema.Mount // global mounts applied to all apps
	Volumes []types.Volume // volumes available to all apps
	// contains filtered or unexported fields
}

func (*Apps) Count

func (al *Apps) Count() int

Count returns the number of apps in al

func (*Apps) Create

func (al *Apps) Create(img string)

Create creates a new app in al and returns a pointer to it

func (*Apps) GetArgs

func (al *Apps) GetArgs() [][]string

GetArgs returns a list of lists of arguments in al, one list of args per app. The order reflects the app order in al.

func (*Apps) GetImageIDs

func (al *Apps) GetImageIDs() []types.Hash

GetImageIDs returns a list of the imageIDs in al, one per app. The order reflects the app order in al.

func (*Apps) GetImages

func (al *Apps) GetImages() []string

GetImages returns a list of the images in al, one per app. The order reflects the app order in al.

func (*Apps) Last

func (al *Apps) Last() *App

Last returns a pointer to the top app in al

func (*Apps) Reset

func (al *Apps) Reset()

Reset creates a new slice for al.apps, needed by tests

func (*Apps) Validate

func (al *Apps) Validate() error

Validate validates al for things like referential integrity of mounts<->volumes.

func (*Apps) Walk

func (al *Apps) Walk(f func(*App) error) error

Walk iterates on al.apps calling f for each app walking stops if f returns an error, the error is simply returned