devise

Documentation

Index

• Variables
• func Implement(opts *ImplementOptions) (err error)
• func PrintLongVersion()
• func PrintShortVersion()
• func Start(opts *ServeOptions)
• type ImplementOptions
• type Plan
• type Renderer
  • func (t *Renderer) Render(w io.Writer, name string, data interface{}, c echo.Context) error
• type ServeOptions
• type Server
• type Template
• type Version

Variables

var (
	// Tag is set at build time.
	Tag string
	// SHA is set at build time.
	SHA string
	// Built is set at build time.
	Built string
)

Functions

func Implement

func Implement(opts *ImplementOptions) (err error)

Implement executes the plan.

func PrintLongVersion

func PrintLongVersion()

PrintLongVersion prints verbose version information.

func PrintShortVersion

func PrintShortVersion()

PrintShortVersion prints the tag and sha.

func Start

func Start(opts *ServeOptions)

Start starts the server.

Types

type ImplementOptions

type ImplementOptions struct {
	Address    string
	Plan       string
	VaultToken string
}

ImplementOptions is used to configure the client.

type Plan

type Plan struct {
	Templates map[string]*Template `yaml:"templates"`
	Script    *string              `yaml:"script,omitempty"`
}

Plan represents a plan.

type Renderer

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

Renderer implements echo.Renderer

func (*Renderer) Render

func (t *Renderer) Render(w io.Writer, name string, data interface{}, c echo.Context) error

Render implements echo.Renderer

type ServeOptions

type ServeOptions struct {
	Storage      string
	BackendPort  string
	UIPort       string
	VaultAddress string
	Discoverers  []string
}

ServeOptions is used to configure the server.

type Server

type Server struct {
	Storage datastore.Datastore
}

Server represents the Devise server.

type Template

type Template struct {
	Destination string      `yaml:"destination"`
	Permissions os.FileMode `yaml:"permissions"`
}

Template represents a template.

type Version

type Version struct {
	Tag       string
	SHA       string
	Built     string
	GoVersion string
	Os        string
	Arch      string
}

Version contains verbose version information.