null

Documentation

Overview

Package null implements a Laforge Builder module that is effectively a NOOP. It should be used as the spec reference for building builder modules as it's probably got the easiest learning curve.

Index

• Constants
• type Builder
  • func New() *Builder
  • func (b *Builder) Author() string
  • func (b *Builder) CheckRequirements() error
  • func (b *Builder) Description() string
  • func (b *Builder) GenerateScripts() error
  • func (b *Builder) Get(key string) string
  • func (b *Builder) ID() string
  • func (b *Builder) Name() string
  • func (b *Builder) PrepareAssets() error
  • func (b *Builder) Render() error
  • func (b *Builder) Set(key string, val interface{})
  • func (b *Builder) SetLaforge(base *core.Laforge) error
  • func (b *Builder) StageDependencies() error
  • func (b *Builder) Validations() validations.Validations
  • func (b *Builder) Version() string

Constants

const (
	ID          = `null`
	Name        = `Null Builder`
	Description = `NOOP builder used for testing, debugging, and research.`
	Author      = `Alex Levinson <github.com/gen0cide>`
	Version     = `0.0.1`
)

Definition of builder meta-data.

Types

type Builder

type Builder struct {
	Base   *core.Laforge
	Logger logger.Logger
}

Builder implements a laforge builder that packages an environment into a terraform configuration targeting AWS with each team isolated into their own VPC.

func New

func New() *Builder

New creates an empty Builder

func (*Builder) Author

func (b *Builder) Author() string

Author implements the Builder interface (author's name and contact info)

func (*Builder) CheckRequirements

func (b *Builder) CheckRequirements() error

CheckRequirements implements the Builder interface

func (*Builder) Description

func (b *Builder) Description() string

Description implements the Builder interface (returns the builder's description)

func (*Builder) GenerateScripts

func (b *Builder) GenerateScripts() error

GenerateScripts implements the Builder interface

func (*Builder) Get

func (b *Builder) Get(key string) string

Get implements the Builder interface

func (*Builder) ID

func (b *Builder) ID() string

ID implements the Builder interface (returns the ID of the builder - usually the go package name)

func (*Builder) Name

func (b *Builder) Name() string

Name implements the Builder interface (returns the name of the builder - usually titleized version of the type)

func (*Builder) PrepareAssets

func (b *Builder) PrepareAssets() error

PrepareAssets implements the Builder interface

func (*Builder) Render

func (b *Builder) Render() error

Render implements the Builder interface

func (*Builder) Set

func (b *Builder) Set(key string, val interface{})

Set implements the Builder interface

func (*Builder) SetLaforge

func (b *Builder) SetLaforge(base *core.Laforge) error

SetLaforge implements the Builder interface

func (*Builder) StageDependencies

func (b *Builder) StageDependencies() error

StageDependencies implements the Builder interface

func (*Builder) Validations

func (b *Builder) Validations() validations.Validations

Validations implements the Builder interface (builder checks)

func (*Builder) Version

func (b *Builder) Version() string

Version implements the Builder interface (builder version)