jerm

README

Jerm

Jerm is an open source tool that helps you deploy serverless apps seamlessly across all clouds.

Quickstart

This guide will get you up and running in a few minutes.

Install

To install Jerm run

$ go install github.com/spatocode/jerm/cmd/jerm@latest

Usage

Deploy your app

$ jerm deploy

Contributing

Jerm is still under early development and all contributions are welcomed.

License

Jerm is licensed under the BSD-3-Clause license

Documentation

Index

• Constants
• Variables
• func Configure(configFile string) (*config.Config, error)
• func Verbose(cmd *cobra.Command)
• type CloudMonitor
• type CloudPlatform
• type CloudStorage
• type Config
• type Project
  • func New(cfg *config.Config) (*Project, error)
  • func (p *Project) Deploy()
  • func (p *Project) Invoke(command string)
  • func (p *Project) Logs()
  • func (p *Project) Rollback(steps int)
  • func (p *Project) SetPlatform(cloud CloudPlatform)
  • func (p *Project) Undeploy()
  • func (p *Project) Update(zipPath *string) error

Constants

const (
	Version           = "0.1.3"
	DefaultConfigFile = "jerm.json"
	ArchiveFile       = "jerm.zip"
)

Variables

var (
	ReadConfig  = config.ReadConfig
	ParseConfig = config.ParseConfig
)

Functions

func Configure

func Configure(configFile string) (*config.Config, error)

Configure sets up Jerm using jerm.json configuration file. If the configuration file is not found, it prompts the user for setup.

func Verbose

func Verbose(cmd *cobra.Command)

Types

type CloudMonitor

type CloudMonitor interface {
	Monitor()
	DeleteLog()
}

type CloudPlatform

type CloudPlatform interface {
	Deploy(string) (bool, error)
	Update(string) error
	Undeploy() error
	Build() (string, error)
	Rollback(int) error
	Logs()
	Invoke(string) error
}

type CloudStorage

type CloudStorage interface {
	Delete(string) error
	Upload(string) error
}

type Config

type Config config.Config

Config is the Jerm configuration

type Project

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

Project holds details of a Jerm project

func New

func New(cfg *config.Config) (*Project, error)

New creates a new Jerm project

func (*Project) Deploy

func (p *Project) Deploy()

Deploy deploys the project to the cloud

func (*Project) Invoke

func (p *Project) Invoke(command string)

Invoke a function

func (*Project) Logs

func (p *Project) Logs()

Logs shows the deployment logs

func (*Project) Rollback

func (p *Project) Rollback(steps int)

Rollback rolls back a deployment to previous versions

func (*Project) SetPlatform

func (p *Project) SetPlatform(cloud CloudPlatform)

SetPlatform sets the cloud platform

func (*Project) Undeploy

func (p *Project) Undeploy()

Undeploy terminates a deployment

func (*Project) Update

func (p *Project) Update(zipPath *string) error

Update updates the deployed project