data

type Access string

type BuildFile struct {

	// the URI of the Git repo
	GitURI string `yaml:"git_uri,omitempty"`
	// the runtime to use to run functions
	Runtime string `yaml:"runtime,omitempty"`
	// the environment variables that apply to the build
	// any variables defined at this level will be available to all build profiles
	// in addition, the defined variables are added on top of the existing environment
	Env map[string]string `yaml:"env,omitempty"`
	// a list of labels to be added to the package seal
	// they should be used to document key aspects of the package in a generic way
	Labels map[string]string `yaml:"labels,omitempty"`
	// any input required by functions
	Input *Input `yaml:"input,omitempty"`
	// a list of build configurations in the form of labels, commands to run and environment variables
	Profiles []*Profile `yaml:"profiles,omitempty"`
	// a list of functions containing a list of commands to execute
	Functions []*Function `yaml:"functions"`
	// include other build files
	Includes []interface{}     `yaml:"includes"`
	SKU      string            `yaml:"sku"`
	X        map[string]string `json:"x,omitempty"`
	// contains filtered or unexported fields
}

type File struct {
	// the unique reference for the file
	Name string `yaml:"name"`
	// a description of the intended use of this file
	Description string `yaml:"description"`
	// path to the file within the Artisan registry
	Path string
	// the file content
	Content string
}

type Files []*File

type Function struct {
	// the name of the function
	Name string `yaml:"name"`
	// the description for the function
	Description string `yaml:"description,omitempty"`
	// a set of environment variables required by the run commands
	Env map[string]string `yaml:"env,omitempty"`
	// the commands to be executed by the function
	Run []string `yaml:"run,omitempty"`
	// is this function to be available in the manifest
	Export *bool `yaml:"export,omitempty"`
	// defines any bindings to inputs required to run this function
	Input *InputBinding `yaml:"input,omitempty"`
	// the runtime to run this function
	Runtime string   `yaml:"runtime,omitempty"`
	Credits int      `yaml:"credits,omitempty"`
	Network *Network `json:"network,omitempty"`
}

type FxInfo struct {
	Name        string   `json:"name"`
	Description string   `json:"description"`
	Input       *Input   `json:"input,omitempty"`
	Credits     int      `json:"credits,omitempty"`
	Runtime     string   `json:"runtime,omitempty"` // runtime image that should be used to execute functions in the package
	Network     *Network `json:"network,omitempty"`
}

type Group struct {
	Tags []string `yaml:"tags"`
	IPs  []string `yaml:"ips"`
}

type GroupInfo struct {
	Group string
	Tags  []string
	Min   int
	Max   int
	IPs   []string
}

type GroupsInfo []GroupInfo

type Input struct {
	// required by configuration files
	File Files `yaml:"file,omitempty" json:"file,omitempty"`
	// required string value secrets
	Secret Secrets `yaml:"secret,omitempty" json:"secret,omitempty"`
	// required variables
	Var Vars `yaml:"var,omitempty" json:"var,omitempty"`
}

type InputBinding struct {
	Var    []string `yaml:"var"`
	Secret []string `yaml:"secret"`
	Key    []string `yaml:"key"`
	File   []string `yaml:"file"`
}

type Manifest struct {
	// the author of the package
	Author string `json:"author,omitempty"`
	// the signing and verification authority for the package
	Authority []string `json:"authority,omitempty"`
	// the package type
	Type string `json:"type,omitempty"`
	// the license associated to the package
	License string `json:"license,omitempty"`
	// the target OS for the package
	OS string `json:"os"`
	// the name of the package file
	Ref string `json:"ref"`
	// the build profile used
	Profile string `json:"profile"`
	// runtime image that should be used to execute exported functions in the package
	Runtime string `json:"runtime,omitempty"`
	// the labels assigned to the package
	Labels map[string]string `json:"labels,omitempty"`
	// the URI of the package source
	Source string `json:"source,omitempty"`
	// the path within the source where the project is (for uber repos)
	SourcePath string `json:"source_path,omitempty"`
	// the commit hash
	Commit string `json:"commit,omitempty"`
	// repo branch
	Branch string `json:"branch,omitempty"`
	// the name of the file or folder that has been packaged
	Target string `json:"target,omitempty"`
	// the timestamp
	Time string `json:"time"`
	// the size of the package
	Size string `json:"size"`
	// the Stock Keeping Unit code
	SKU string `json:"SKU,omitempty"`
	// what functions are available to call?
	Functions  []*FxInfo `json:"functions,omitempty"`
	OpenPolicy string    `json:"open_policy,omitempty"`
	RunPolicy  string    `json:"run_policy,omitempty"`
	SignPolicy string    `json:"sign_policy,omitempty"`
}

type Network struct {
	Groups []string `yaml:"groups"`
	Rules  []string `yaml:"rules"`
}

type Profile struct {
	// the name of the profile
	Name string `yaml:"name"`
	// whether this is the default profile
	Default bool `yaml:"default"`
	// the name of the application
	Application string `yaml:"application"`
	// the type of license used by the application
	// if not empty, it is added to the package seal
	License string `yaml:"license"`
	// the type of technology used by the application that can be used to determine the tool chain to use
	// e.g. java, nodejs, golang, python, php, etc
	Type string `yaml:"type"`
	// the pipeline Icon
	Icon string `yaml:"icon"`
	// a set of labels associated with the profile
	Labels map[string]string `yaml:"labels"`
	// a set of environment variables required by the run commands
	Env map[string]string `yaml:"env"`
	// the commands to be executed to build the application
	Run []string `yaml:"run"`
	// the output of the build process, namely either a file or a folder, that has to be compressed
	// as part of the packaging process
	Target string `yaml:"target"`
	// merged target if existed, internal use only
	MergedTarget string
}

type Role struct {
	Name string `yaml:"name"`
	Min  int    `yaml:"min,omitempty"`
	Max  int    `yaml:"max,omitempty"`
	Tag  []Tag  `yaml:"tag,omitempty"`
}

type RunHandler func(name *core.PackageName, fx string, seal *Seal) error

type Seal struct {
	// the package metadata
	Manifest *Manifest `json:"manifest"`
	// the combined checksum of the package and its metadata
	Digest string `json:"digest"`
	// the map of digital seals for this package
	Seal map[string]string `json:"seal,omitempty"`
}

type Secret struct {
	// the unique reference for the secret
	Name string `yaml:"name" json:"name"`
	// a description of the intended use or meaning of this secret
	Description string `yaml:"description" json:"description"`
	// the value of the secret
	Value string `yaml:"value,omitempty" json:"value,omitempty"`
	// the value is required
	Required bool `yaml:"required,omitempty" json:"required,omitempty"`
}

type Secrets []*Secret

type Tag struct {
	Name string `yaml:"name"`
	Min  int    `yaml:"min,omitempty"`
	Max  int    `yaml:"max,omitempty"`
}

type Var struct {
	Name        string `yaml:"name" json:"name"`
	Description string `yaml:"description" json:"description"`
	Required    bool   `yaml:"required" json:"required"`
	Type        string `yaml:"type" json:"type"`
	Value       string `yaml:"value,omitempty" json:"value,omitempty"`
	Default     string `yaml:"default,omitempty" json:"default,omitempty"`
}

type Vars []*Var

type VerifyHandler func(name *core.PackageName, seal *Seal, path string, authorisedAuthors []string, flags uint8) error