serverless

Documentation

Index

• Constants
• type Definition
• type Deployer
• type Function
  • func (function Function) ToRuntime() runtime.Runtime
• type Manifest
  • func NewServerlessConfig() (Manifest, error)
  • func NewServerlessConfigYAML(path string) (Manifest, error)
  • func (manifest Manifest) BaseDirectory() string
  • func (manifest Manifest) ToFunctions() (functions []Function)
  • func (manifest Manifest) Validate() error

Constants

const ServerlessFile = "serverless.yml"

Default serverless configuration file

Types

type Definition

type Definition struct {
	Service     string
	Description string
	Provider    struct {
		Name        string // see `providers` variable for supported providers
		Registry    string
		Envs        map[string]string
		Environment map[string]string // legacy entry
		Secrets     []string
		EnvSecrets  []string `yaml:"env-secrets"` // legacy entry
		Annotations map[string]string
	}
	Functions map[string]struct {
		Handler     string
		Source      string
		Runtime     string
		Description string
		Labels      []string
		Envs        map[string]string
		Environment map[string]string // legacy entry
		Secrets     []string
		EnvSecrets  []string `yaml:"env-secrets"` // legacy entry
		Annotations map[string]string
	}
}

type Deployer

type Deployer interface {
	DeployDryRun() (string, error)
	Deploy(ctx context.Context) (string, error)
}

Deployer is an interface that we use to perform a serverless deployment

type Function

type Function struct {
	Name        string // Function name
	Service     string // Function service name
	Directory   string // Function base directory
	Handler     string
	Image       string // Source or destination image
	Runtime     string // Function runtime address
	Description string
	Labels      []string
	Secrets     []string
	Envs        map[string]string
	Annotations map[string]string
}

func (Function) ToRuntime

func (function Function) ToRuntime() runtime.Runtime

type Manifest

type Manifest struct {
	Definition
}

Manifest represents serverless file format

func NewServerlessConfig

func NewServerlessConfig() (Manifest, error)

NewServerlessConfig returns a new serverless config struct

func NewServerlessConfigYAML

func NewServerlessConfigYAML(path string) (Manifest, error)

NewServerlessConfigYAML parses a serverless config file

func (Manifest) BaseDirectory

func (manifest Manifest) BaseDirectory() string

Returns a current working directory that is a config base

func (Manifest) ToFunctions

func (manifest Manifest) ToFunctions() (functions []Function)

ToFunctions returns definitions of functions from the serverless configuration

func (Manifest) Validate

func (manifest Manifest) Validate() error