runtime

Documentation

Index

• type Client
  • func NewClient(location Location) (Client, error)
• type CustomRuntime
  • func (runtime CustomRuntime) Build(ctx context.Context) error
  • func (runtime CustomRuntime) DockerfilePath() string
  • func (runtime CustomRuntime) DryRun() (string, error)
• type Details
  • func (details Details) Directory() string
  • func (details Details) Image() string
• type GeneratedRuntime
  • func (runtime GeneratedRuntime) Build(ctx context.Context) error
  • func (runtime GeneratedRuntime) DockerfilePath() string
  • func (runtime GeneratedRuntime) DryRun() (string, error)
  • func (runtime GeneratedRuntime) Slug() string
• type GoGit
  • func (client *GoGit) ReadFile(path string) (string, error)
  • func (client *GoGit) WriteFiles(directory string) error
• type Location
• type Repository
  • func NewRepository(address string) *Repository
• type Runtime
  • func New(details Details) Runtime
• type Template
  • func (template Template) Parse() (string, error)
  • func (template Template) Write() error

Types

type Client

type Client interface {
	WriteFiles(directory string) error
	ReadFile(path string) (string, error)
}

func NewClient

func NewClient(location Location) (Client, error)

type CustomRuntime

type CustomRuntime struct {
	Details
}

func (CustomRuntime) Build

func (runtime CustomRuntime) Build(ctx context.Context) error

Build runtime, in case of a custom runtime just log the action

func (CustomRuntime) DockerfilePath

func (runtime CustomRuntime) DockerfilePath() string

Return an expected path to a custom Dockerfile

func (CustomRuntime) DryRun

func (runtime CustomRuntime) DryRun() (string, error)

Build runtime DryRun

type Details

type Details struct {
	FunctionName    string
	FunctionFile    string
	FunctionHandler string
	RuntimeAddress  string
	CodeDirectory   string
	ResultingImage  string
}

func (Details) Directory

func (details Details) Directory() string

func (Details) Image

func (details Details) Image() string

type GeneratedRuntime

type GeneratedRuntime struct {
	Details
}

func (GeneratedRuntime) Build

func (runtime GeneratedRuntime) Build(ctx context.Context) error

Build runtime files and persist them in CodeDirectory

func (GeneratedRuntime) DockerfilePath

func (runtime GeneratedRuntime) DockerfilePath() string

func (GeneratedRuntime) DryRun

func (runtime GeneratedRuntime) DryRun() (string, error)

func (GeneratedRuntime) Slug

func (runtime GeneratedRuntime) Slug() string

type GoGit

type GoGit struct {
	Location
	*git.Repository
}

func (*GoGit) ReadFile

func (client *GoGit) ReadFile(path string) (string, error)

func (*GoGit) WriteFiles

func (client *GoGit) WriteFiles(directory string) error

type Location

type Location struct {
	Address   string
	Reference string
}

type Repository

type Repository struct {
	Location
	Client
}

func NewRepository

func NewRepository(address string) *Repository

type Runtime

type Runtime interface {
	DryRun() (string, error)
	Build(ctx context.Context) error
	Directory() string
	Image() string
	DockerfilePath() string
}

func New

func New(details Details) Runtime

Creates a new runtime using Runtime Details.

If a runtime contains a runtime address it means that this is a runtime we need to generate. Otherwise it is mostly likely the CustomRuntime, meaning that there should be Dockerfile provided by a user.

type Template

type Template struct {
	Filename   string
	Contents   string
	Attributes Details
}

func (Template) Parse

func (template Template) Parse() (string, error)

Parse a template, and return a string

func (Template) Write

func (template Template) Write() error

Write parsed template to a file on disk