core

Documentation

Index

• func BuildContainerfile(recipe *api.Recipe) error
• func BuildModule(recipe *api.Recipe, moduleInterface interface{}) (string, error)
• func BuildRecipe(recipePath string) (api.Recipe, error)
• func BuildShellModule(moduleInterface interface{}, recipe *api.Recipe) (string, error)
• func ChangeWorkingDirectory(workdir string, containerfile *os.File) error
• func CompileRecipe(recipePath string, runtime string, isRoot bool, origGid int, origUid int) error
• func GenModule(modulePath string) (map[string]interface{}, error)
• func GetContainerStorage(runtime string) (cstorage.Store, error)
• func GetImageID(name string, store cstorage.Store) (string, error)
• func GetTopLayerID(imageid string, store cstorage.Store) (string, error)
• func LoadRecipe(path string) (*api.Recipe, error)
• func MountImage(imagename string, imageid string, runtime string) (string, error)
• func RestoreWorkingDirectory(workdir string, containerfile *os.File) error
• func TestRecipe(path string) (*api.Recipe, error)
• type Finalize
• type IncludesModule
• type Module
• type ModuleCommand
  • func BuildModules(recipe *api.Recipe, modules []interface{}) ([]ModuleCommand, error)
• type Plugin
• type ShellModule
• type StorageConf

Functions

func BuildContainerfile

func BuildContainerfile(recipe *api.Recipe) error

BuildContainerfile builds a Containerfile from a recipe and a list of modules commands

func BuildModule

func BuildModule(recipe *api.Recipe, moduleInterface interface{}) (string, error)

BuildModule builds a module command from a module this is done by calling the appropriate module builder function based on the module type

func BuildRecipe

func BuildRecipe(recipePath string) (api.Recipe, error)

BuildRecipe builds a Containerfile from a recipe path

func BuildShellModule

func BuildShellModule(moduleInterface interface{}, recipe *api.Recipe) (string, error)

func ChangeWorkingDirectory

func ChangeWorkingDirectory(workdir string, containerfile *os.File) error

func CompileRecipe

func CompileRecipe(recipePath string, runtime string, isRoot bool, origGid int, origUid int) error

CompileRecipe compiles a recipe into a runnable image.

func GenModule

func GenModule(modulePath string) (map[string]interface{}, error)

GenModule generate a Module struct from a module path

func GetContainerStorage

func GetContainerStorage(runtime string) (cstorage.Store, error)

func GetImageID

func GetImageID(name string, store cstorage.Store) (string, error)

func GetTopLayerID

func GetTopLayerID(imageid string, store cstorage.Store) (string, error)

func LoadRecipe

func LoadRecipe(path string) (*api.Recipe, error)

LoadRecipe loads a recipe from a file and returns a Recipe Does not validate the recipe but it will catch some errors a proper validation will be done in the future

func MountImage

func MountImage(imagename string, imageid string, runtime string) (string, error)

func RestoreWorkingDirectory

func RestoreWorkingDirectory(workdir string, containerfile *os.File) error

func TestRecipe

func TestRecipe(path string) (*api.Recipe, error)

TestRecipe validates a recipe by loading it and checking for errors

Types

type Finalize

type Finalize struct {
	Name    string `json:"name"`
	Type    string `json:"type"`
	Content []byte // The entire module unparsed as a []byte, used by plugins
}

type IncludesModule

type IncludesModule struct {
	Name     string   `json:"name"`
	Type     string   `json:"type"`
	Includes []string `json:"includes"`
}

type Module

type Module struct {
	Name    string `json:"name"`
	Workdir string
	Type    string `json:"type"`
	Modules []map[string]interface{}
	Content []byte // The entire module unparsed as a []byte, used by plugins
}

type ModuleCommand

type ModuleCommand struct {
	Name    string
	Command string
	Workdir string
}

func BuildModules

func BuildModules(recipe *api.Recipe, modules []interface{}) ([]ModuleCommand, error)

BuildModules builds a list of modules commands from a list of modules

type Plugin

type Plugin struct {
	Name         string
	BuildFunc    func(*C.char, *C.char) string
	LoadedPlugin uintptr
}

type ShellModule

type ShellModule struct {
	Name     string `json:"name"`
	Type     string `json:"type"`
	Source   api.Source
	Commands []string
}

type StorageConf

type StorageConf struct {
	Driver    string
	Runroot   string
	Graphroot string
}