config

package
v0.1.26 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 19, 2021 License: MIT Imports: 22 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	AppTypeStatic = "static"

	StaticAppRoutingReact    = "react"
	StaticAppRoutingGatsby   = "gatsby"
	StaticAppRoutingDisabled = "disabled"

	DefaultStaticAppBuildDir = "build"
)
View Source 
const (
	ProjectYAMLName = "project.outblocks"
	AppYAMLName     = "outblocks"
	LockfileName    = "outblocks.lock"
)
View Source 
const (
	StateLocal     = "local"
	StateLocalPath = ".outblocks.state"
)
View Source 
const (
	AppTypeFunction = "function"
)
View Source 
const (
	AppTypeService = "service"
)

Variables

View Source 
var (
	ValidURLRegex   = regexp.MustCompile(`^(https?://)?([a-zA-Z][a-zA-Z0-9-]*)((\.)([a-zA-Z][a-zA-Z0-9-]*)){1,}(/[a-zA-Z0-9-_]+)*(/)?$`)
	ValidNameRegex  = regexp.MustCompile(`^[a-zA-Z][a-zA-Z0-9_-]{0,30}$`)
	ValidAppTypes   = []string{AppTypeStatic, AppTypeFunction, AppTypeService}
	RunPluginDirect = "direct"
)
View Source 
var (
	DefaultKnownTypes = map[string][]string{
		AppTypeFunction: {"functions"},
		AppTypeStatic:   {"statics"},
		AppTypeService:  {"services"},
	}
)
View Source 
var (
	ErrProjectConfigNotFound = errors.New("cannot find project config file, did you forget to initialize? run:\nok init")
)
View Source 
var (
	StaticAppRoutings = []string{StaticAppRoutingReact, StaticAppRoutingGatsby, StaticAppRoutingDisabled}
)

Functions

func DetectAppType added in v0.1.7 

func DetectAppType(data []byte) (string, error)

func KnownType 

func KnownType(typ string) string

Types

type App 

type App interface {
	ID() string
	Name() string
	Dir() string
	URL() *url.URL
	PathRedirect() string
	Normalize(cfg *Project) error
	Check(cfg *Project) error
	Type() string
	PluginType() *types.App
	RunInfo() *AppRun
	DeployInfo() *AppDeploy
	SupportsLocal() bool
	YAMLError(path, msg string) error

	DeployPlugin() *plugins.Plugin
	RunPlugin() *plugins.Plugin
	DNSPlugin() *plugins.Plugin
}

func LoadFunctionAppData 

func LoadFunctionAppData(path string, data []byte) (App, error)

func LoadServiceAppData 

func LoadServiceAppData(path string, data []byte) (App, error)

type AppDeploy added in v0.1.12 

type AppDeploy struct {
	Plugin string                 `json:"plugin,omitempty"`
	Other  map[string]interface{} `yaml:"-,remain"`
}

type AppNeed 

type AppNeed struct {
	Other map[string]interface{} `yaml:"-,remain"`
	// contains filtered or unexported fields
}

func (*AppNeed) Dependency 

func (n *AppNeed) Dependency() *Dependency

func (*AppNeed) Normalize 

func (n *AppNeed) Normalize(name string, cfg *Project, data []byte) error

func (*AppNeed) PluginType 

func (n *AppNeed) PluginType() *types.AppNeed

type AppRun added in v0.1.12 

type AppRun struct {
	Plugin  string                 `json:"plugin,omitempty"`
	Command string                 `json:"command,omitempty"`
	Port    int                    `json:"port,omitempty"`
	Env     map[string]string      `json:"env,omitempty"`
	Other   map[string]interface{} `yaml:"-,remain"`
}

type BasicApp 

type BasicApp struct {
	AppName         string                 `json:"name"`
	AppType         string                 `json:"type"`
	AppURL          string                 `json:"url"`
	AppPathRedirect string                 `json:"pathRedirect"`
	AppDir          string                 `json:"dir"`
	AppRun          *AppRun                `json:"run"`
	AppDeploy       *AppDeploy             `json:"deploy"`
	Needs           map[string]*AppNeed    `json:"needs"`
	Other           map[string]interface{} `yaml:"-,remain"`
	// contains filtered or unexported fields
}

func (*BasicApp) Check 

func (a *BasicApp) Check(cfg *Project) error

func (*BasicApp) DNSPlugin 

func (a *BasicApp) DNSPlugin() *plugins.Plugin

func (*BasicApp) DeployInfo added in v0.1.12 

func (a *BasicApp) DeployInfo() *AppDeploy

func (*BasicApp) DeployPlugin 

func (a *BasicApp) DeployPlugin() *plugins.Plugin

func (*BasicApp) Dir added in v0.1.17 

func (a *BasicApp) Dir() string

func (*BasicApp) ID 

func (a *BasicApp) ID() string

func (*BasicApp) Name 

func (a *BasicApp) Name() string

func (*BasicApp) Normalize 

func (a *BasicApp) Normalize(cfg *Project) error

func (*BasicApp) PathRedirect added in v0.1.12 

func (a *BasicApp) PathRedirect() string

func (*BasicApp) PluginType 

func (a *BasicApp) PluginType() *types.App

func (*BasicApp) RunInfo added in v0.1.12 

func (a *BasicApp) RunInfo() *AppRun

func (*BasicApp) RunPlugin 

func (a *BasicApp) RunPlugin() *plugins.Plugin

func (*BasicApp) SupportsLocal added in v0.1.12 

func (a *BasicApp) SupportsLocal() bool

func (*BasicApp) Type 

func (a *BasicApp) Type() string

func (*BasicApp) URL 

func (a *BasicApp) URL() *url.URL

func (*BasicApp) Validate added in v0.1.7 

func (a *BasicApp) Validate() error

func (*BasicApp) YAMLError added in v0.1.12 

func (a *BasicApp) YAMLError(path, msg string) error

type DNS 

type DNS struct {
	Domain string `json:"domain"`
	Plugin string `json:"plugin"`
	// contains filtered or unexported fields
}

func (*DNS) Check 

func (s *DNS) Check(i int, cfg *Project) error

func (*DNS) Normalize 

func (s *DNS) Normalize(i int, cfg *Project) error

type Defaults added in v0.1.23 

type Defaults struct {
	Run    DefaultsRun    `json:"run,omitempty"`
	Deploy DefaultsDeploy `json:"deploy,omitempty"`
}

type DefaultsDeploy added in v0.1.23 

type DefaultsDeploy struct {
	Plugin string                 `json:"plugin,omitempty"`
	Other  map[string]interface{} `yaml:"-,remain"`
}

type DefaultsRun added in v0.1.23 

type DefaultsRun struct {
	Plugin string                 `json:"plugin,omitempty"`
	Env    map[string]string      `json:"env,omitempty"`
	Other  map[string]interface{} `yaml:"-,remain"`
}

type Dependency 

type Dependency struct {
	Name   string                 `json:"-"`
	Type   string                 `json:"type"`
	Deploy *DependencyDeploy      `json:"deploy"`
	Run    *DependencyRun         `json:"run"`
	Other  map[string]interface{} `yaml:"-,remain"`
	// contains filtered or unexported fields
}

func (*Dependency) Check 

func (d *Dependency) Check(key string, cfg *Project) error

func (*Dependency) DeployPlugin 

func (d *Dependency) DeployPlugin() *plugins.Plugin

func (*Dependency) ID 

func (d *Dependency) ID() string

func (*Dependency) Normalize 

func (d *Dependency) Normalize(key string, cfg *Project) error

func (*Dependency) PluginType 

func (d *Dependency) PluginType() *types.Dependency

func (*Dependency) RunPlugin 

func (d *Dependency) RunPlugin() *plugins.Plugin

func (*Dependency) SupportsLocal added in v0.1.12 

func (d *Dependency) SupportsLocal() bool

func (*Dependency) Validate 

func (d *Dependency) Validate() error

type DependencyDeploy added in v0.1.12 

type DependencyDeploy struct {
	Plugin string                 `json:"plugin,omitempty"`
	Other  map[string]interface{} `yaml:"-,remain"`
}

type DependencyRun added in v0.1.12 

type DependencyRun struct {
	Plugin string                 `json:"plugin,omitempty"`
	Port   int                    `json:"port,omitempty"`
	Other  map[string]interface{} `yaml:"-,remain"`
}

type FunctionApp 

type FunctionApp struct {
	BasicApp `json:",inline"`
}

func (*FunctionApp) SupportsLocal added in v0.1.12 

func (s *FunctionApp) SupportsLocal() bool

func (*FunctionApp) Validate added in v0.1.18 

func (s *FunctionApp) Validate() error

type Plugin 

type Plugin struct {
	Name    string                 `json:"name"`
	Version string                 `json:"version"`
	Source  string                 `json:"source,omitempty"`
	Other   map[string]interface{} `yaml:"-,remain"`
	// contains filtered or unexported fields
}

func (*Plugin) Loaded added in v0.1.2 

func (p *Plugin) Loaded() *plugins.Plugin

func (*Plugin) Normalize 

func (p *Plugin) Normalize(i int, cfg *Project) error

func (*Plugin) Order 

func (p *Plugin) Order() uint

func (*Plugin) SetLoaded added in v0.1.2 

func (p *Plugin) SetLoaded(plug *plugins.Plugin)

func (*Plugin) VerConstr added in v0.1.5 

func (p *Plugin) VerConstr() *semver.Constraints

type Project 

type Project struct {
	Name         string                 `json:"name,omitempty"`
	State        *State                 `json:"state,omitempty"`
	Dependencies map[string]*Dependency `json:"dependencies,omitempty"`
	Plugins      []*Plugin              `json:"plugins,omitempty"`
	DNS          []*DNS                 `json:"dns,omitempty"`
	Defaults     *Defaults              `json:"defaults,omitempty"`

	Apps   []App          `json:"-"`
	AppMap map[string]App `json:"-"`
	Dir    string         `json:"-"`
	// contains filtered or unexported fields
}

func LoadProjectConfig 

func LoadProjectConfig(cfgPath string, vars map[string]interface{}, opts *ProjectOptions) (*Project, error)

func LoadProjectConfigData 

func LoadProjectConfigData(path string, data []byte, vars map[string]interface{}, opts *ProjectOptions, lock *lockfile.Lockfile) (*Project, error)

func (*Project) FindDNSPlugin 

func (p *Project) FindDNSPlugin(url string) *plugins.Plugin

func (*Project) FindDependency 

func (p *Project) FindDependency(n string) *Dependency

func (*Project) FindLoadedPlugin 

func (p *Project) FindLoadedPlugin(name string) *plugins.Plugin

func (*Project) FullCheck 

func (p *Project) FullCheck() error

Logic validation after everything is loaded, e.g. check for supported types.

func (*Project) ID added in v0.1.20 

func (p *Project) ID() string

func (*Project) LoadApps 

func (p *Project) LoadApps() error

func (*Project) LoadFile 

func (p *Project) LoadFile(file string) error

func (*Project) LoadFiles 

func (p *Project) LoadFiles(files []string) error

func (*Project) LoadPlugins added in v0.1.5 

func (p *Project) LoadPlugins(ctx context.Context, log logger.Logger, loader *plugins.Loader) error

func (*Project) LoadedPlugins 

func (p *Project) LoadedPlugins() []*plugins.Plugin

func (*Project) Lockfile 

func (p *Project) Lockfile() *lockfile.Lockfile

func (*Project) Normalize 

func (p *Project) Normalize() error

Initial first pass validation.

func (*Project) PluginLock 

func (p *Project) PluginLock(plug *Plugin) *lockfile.Plugin

func (*Project) RegisterApp 

func (p *Project) RegisterApp(app App) bool

func (*Project) SetLoadedPlugins added in v0.1.2 

func (p *Project) SetLoadedPlugins(plugs []*plugins.Plugin)

func (*Project) Validate 

func (p *Project) Validate() error

func (*Project) YAMLData 

func (p *Project) YAMLData() []byte

type ProjectOptions added in v0.1.5 

type ProjectOptions struct {
	Env string
}

type ServiceApp 

type ServiceApp struct {
	BasicApp   `json:",inline"`
	Build      *ServiceAppBuild `json:"build,omitempty"`
	DockerHash string           `json:"-"`
}

func (*ServiceApp) LocalDockerImage added in v0.1.18 

func (s *ServiceApp) LocalDockerImage() string

func (*ServiceApp) PluginType added in v0.1.18 

func (s *ServiceApp) PluginType() *types.App

func (*ServiceApp) SupportsLocal added in v0.1.12 

func (s *ServiceApp) SupportsLocal() bool

func (*ServiceApp) Validate added in v0.1.18 

func (s *ServiceApp) Validate() error

type ServiceAppBuild added in v0.1.18 

type ServiceAppBuild struct {
	Dockerfile    string `json:"dockerfile,omitempty"`
	DockerContext string `json:"context,omitempty"`
}

type State 

type State struct {
	Type  string                 `json:"type"`
	Path  string                 `json:"path"`
	Other map[string]interface{} `yaml:"-,remain"`
	// contains filtered or unexported fields
}

func (*State) Check 

func (s *State) Check(cfg *Project) error

func (*State) IsLocal 

func (s *State) IsLocal() bool

func (*State) LoadLocal 

func (s *State) LoadLocal() (*types.StateData, error)

func (*State) LocalPath 

func (s *State) LocalPath() string

func (*State) Normalize 

func (s *State) Normalize(cfg *Project) error

func (*State) Plugin 

func (s *State) Plugin() *plugins.Plugin

func (*State) SaveLocal 

func (s *State) SaveLocal(d *types.StateData) error

type StaticApp 

type StaticApp struct {
	BasicApp `json:",inline"`
	Build    *StaticAppBuild `json:"build,omitempty"`
	Routing  string          `json:"routing"`
}

func LoadStaticAppData 

func LoadStaticAppData(path string, data []byte) (*StaticApp, error)

func (*StaticApp) Normalize 

func (s *StaticApp) Normalize(cfg *Project) error

func (*StaticApp) PluginType 

func (s *StaticApp) PluginType() *types.App

func (*StaticApp) SupportsLocal added in v0.1.12 

func (s *StaticApp) SupportsLocal() bool

func (*StaticApp) Validate added in v0.1.7 

func (s *StaticApp) Validate() error

type StaticAppBuild 

type StaticAppBuild struct {
	Command string `json:"command,omitempty"`
	Dir     string `json:"dir,omitempty"`
}

type YAMLEvaluator 

type YAMLEvaluator struct {
	// contains filtered or unexported fields
}

func NewYAMLEvaluator 

func NewYAMLEvaluator(vars map[string]interface{}) *YAMLEvaluator

func (*YAMLEvaluator) Expand 

func (e *YAMLEvaluator) Expand(input []byte) ([]byte, error)

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.