manifest

Documentation

Index

• Constants
• func IsPluginDir(dir string) bool
• type ActiveState
  • func (s ActiveState) String() string
• type Category
  • func (cat Category) IsFramework() bool
  • func (cat Category) IsLibrary() bool
  • func (cat Category) IsService() bool
• type Endpoint
• type Plugin
  • func Load(path string) (*Plugin, error)
  • func Read(f io.Reader) (*Plugin, error)
  • func (p *Plugin) GetEndpoints(publicHost, serviceName, privateHost string) []*Endpoint
  • func (p *Plugin) IsFramework() bool
  • func (p *Plugin) IsLibrary() bool
  • func (p *Plugin) IsService() bool
• type ProxyMapping
• type SandboxInfo

Constants

const ManifestEntry = "manifest/plugin.yml"

Functions

func IsPluginDir

func IsPluginDir(dir string) bool

Types

type ActiveState

type ActiveState byte

const (
	StateNew ActiveState = iota
	StateStarting
	StateRestarting
	StateRunning
	StateStopping
	StateStopped
	StateBuilding
	StateFailed
	StateUnknown
)

func (ActiveState) String

func (s ActiveState) String() string

type Category

type Category string

const (
	Framework Category = "Framework"
	Service   Category = "Service"
	Library   Category = "Library"
)

func (Category) IsFramework

func (cat Category) IsFramework() bool

func (Category) IsLibrary

func (cat Category) IsLibrary() bool

func (Category) IsService

func (cat Category) IsService() bool

type Endpoint

type Endpoint struct {
	PrivateHostName string          `yaml:"Private-Host-Name"`
	PrivatePortName string          `yaml:"Private-Port-Name"`
	PublicHost      string          `yaml:"-" json:"-"`
	ServiceName     string          `yaml:"-" json:"-"`
	PrivateHost     string          `yaml:"-" json:"-"`
	PrivatePort     int32           `yaml:"Private-Port"`
	ProxyMappings   []*ProxyMapping `yaml:"Proxy-Mappings,omitempty" json:",omitempty"`
}

type Plugin

type Plugin struct {
	Path        string      `yaml:"-" json:",omitempty"`
	Tag         string      `yaml:"-" json:",omitempty"`
	Name        string      `yaml:"Name"`
	DisplayName string      `yaml:"Display-Name"`
	Description string      `yaml:"Description,omitempty"`
	Version     string      `yaml:"Version"`
	Vendor      string      `yaml:"Vendor"`
	Shared      bool        `yaml:"Shared,omitempty" json:",omitempty"`
	Logo        string      `yaml:"Logo,omitempty" json:",omitempty"`
	Category    Category    `yaml:"Category"`
	BaseImage   string      `yaml:"Base-Image"`
	BuildCache  []string    `yaml:"Build-Cache" json:",omitempty"`
	DependsOn   []string    `yaml:"Depends-On,omitempty" json:",omitempty"`
	User        string      `yaml:"User,omitempty" json:",omitempty"`
	Endpoints   []*Endpoint `yaml:"Endpoints,omitempty" json:",omitempty"`
}

func Load

func Load(path string) (*Plugin, error)

func Read

func Read(f io.Reader) (*Plugin, error)

func (*Plugin) GetEndpoints

func (p *Plugin) GetEndpoints(publicHost, serviceName, privateHost string) []*Endpoint

func (*Plugin) IsFramework

func (p *Plugin) IsFramework() bool

func (*Plugin) IsLibrary

func (p *Plugin) IsLibrary() bool

func (*Plugin) IsService

func (p *Plugin) IsService() bool

type ProxyMapping

type ProxyMapping struct {
	Frontend  string   `yaml:"Frontend"`
	Backend   string   `yaml:"Backend"`
	Protocols []string `yaml:"Protocols,omitempty" json:"-"`
	Protocol  string   `yaml:"-" json:"Protocol,omitempty"`
}

type SandboxInfo

type SandboxInfo struct {
	Env       map[string]string
	Endpoints []*Endpoint
	Plugins   []*Plugin
	State     ActiveState
}