config

Documentation

Index

• Constants
• func ReadIgnoredFiles(file string) ([]string, error)
• type Config
  • func ParseConfig(data []byte) (*Config, error)
  • func ReadConfig(path string) (*Config, error)
  • func (c *Config) GetFunctionName() string
  • func (c *Config) PromptConfig() (*Config, error)
  • func (c *Config) ToJson(name string) error
• type Go
  • func (g *Go) Build(config *Config) (string, error)
  • func (g *Go) Entry() string
• type Lambda
  • func (l *Lambda) Defaults() error
• type Node
  • func (n *Node) Build(config *Config) (string, error)
• type Python
  • func (p *Python) Build(config *Config) (string, error)
  • func (p *Python) Entry() string
  • func (p *Python) IsDjango() bool
• type Runtime
  • func (r *Runtime) Build(*Config) (string, error)
  • func (r *Runtime) Entry() string
• type RuntimeInterface
  • func NewGoRuntime() RuntimeInterface
  • func NewNodeRuntime() RuntimeInterface
  • func NewPythonRuntime() RuntimeInterface
  • func NewRuntime() RuntimeInterface
• type Stage

Constants

const (
	DefaultTimeout = 30
	DefaultMemory  = 512
)

const (
	RuntimeUnknown       = "unknown"
	RuntimePython        = "python"
	RuntimeGo            = "go"
	RuntimeNode          = "nodejs"
	DefaultNodeVersion   = "18.13.0"
	DefaultPythonVersion = "3.9.0"
	DefaultGoVersion     = "1.19.0"
)

Functions

func ReadIgnoredFiles

func ReadIgnoredFiles(file string) ([]string, error)

Types

type Config

type Config struct {
	Name   string  `json:"name"`
	Stage  string  `json:"stage"`
	Bucket string  `json:"bucket"`
	Region string  `json:"region"`
	Lambda *Lambda `json:"lambda"`
	Dir    string  `json:"dir"`
	Entry  string  `json:"entry"`
}

Config is the Jerm configuration details

func ParseConfig

func ParseConfig(data []byte) (*Config, error)

ParseConfig parses a configuration data to Config struct

func ReadConfig

func ReadConfig(path string) (*Config, error)

ReadConfig reads a configuration file

func (*Config) GetFunctionName

func (c *Config) GetFunctionName() string

func (*Config) PromptConfig

func (c *Config) PromptConfig() (*Config, error)

func (*Config) ToJson

func (c *Config) ToJson(name string) error

ToJson writes Config to json file

type Go

type Go struct {
	*Runtime
}

Go runtime

func (*Go) Build

func (g *Go) Build(config *Config) (string, error)

Builds the go deployment package

func (*Go) Entry

func (g *Go) Entry() string

Entry is the directory where the cloud function handler resides. The directory can be a file.

type Lambda

type Lambda struct {
	Runtime  string `json:"runtime"`
	Timeout  int    `json:"timeout"`
	Role     string `json:"role"`
	Memory   int    `json:"memory"`
	Handler  string `json:"handler"`
	KeepWarm bool   `json:"keep_warm"`
}

Lambda configuration.

func (*Lambda) Defaults

func (l *Lambda) Defaults() error

type Node

type Node struct {
	*Runtime
}

NodeJS runtime

func (*Node) Build

func (n *Node) Build(config *Config) (string, error)

Builds the nodejs deployment package

type Python

type Python struct {
	*Runtime
}

func (*Python) Build

func (p *Python) Build(config *Config) (string, error)

Builds the Python deployment package

func (*Python) Entry

func (p *Python) Entry() string

Entry is the directory where the cloud function handler resides. The directory can be a file.

func (*Python) IsDjango

func (p *Python) IsDjango() bool

Check if it's a Django project

type Runtime

type Runtime struct {
	Name    string
	Version string
}

Base Runtime

func (*Runtime) Build

func (r *Runtime) Build(*Config) (string, error)

func (*Runtime) Entry

func (r *Runtime) Entry() string

type RuntimeInterface

type RuntimeInterface interface {
	// Builds the deployment package for the underlying runtime
	Build(*Config) (string, error)

	// Entry is the directory where the cloud function handler resides.
	// The directory can be a file.
	Entry() string
	// contains filtered or unexported methods
}

func NewGoRuntime

func NewGoRuntime() RuntimeInterface

NewGoConfig instantiates a new Go runtime

func NewNodeRuntime

func NewNodeRuntime() RuntimeInterface

NewNodeConfig instantiates a new NodeJS runtime

func NewPythonRuntime

func NewPythonRuntime() RuntimeInterface

NewPythonConfig instantiates a new Python runtime

func NewRuntime

func NewRuntime() RuntimeInterface

NewRuntime instantiates a new runtime

type Stage

type Stage string

const (
	Dev           Stage = "dev"
	Production    Stage = "production"
	Staging       Stage = "staging"
	DefaultRegion       = "us-west-2"
	DefaultStage  Stage = Dev
)