generate

Documentation

Index

• type Generator
  • func NewGenerator(opts ...Opt) (*Generator, error)
  • func (g *Generator) Generate() error
  • func (g *Generator) TerraformModuleDir() string
  • func (g *Generator) TerraformModulePath() string
  • func (g *Generator) TerraformRCPath() string
• type Opt
  • func WithOutBaseDirectory(dir string) Opt
  • func WithScenario(s *flightplan.Scenario) Opt
  • func WithScenarioBaseDirectory(dir string) Opt
  • func WithUI(ui cli.Ui) Opt

Types

type Generator

type Generator struct {
	Scenario *flightplan.Scenario
	BaseDir  string
	OutDir   string
	UI       cli.Ui
}

Generator is a request to generate a Terraform module.

func NewGenerator

func NewGenerator(opts ...Opt) (*Generator, error)

NewGenerator takes options and returns a new validated generator.

func (*Generator) Generate

func (g *Generator) Generate() error

Generate converts the Scenario into a terraform module.

func (*Generator) TerraformModuleDir

func (g *Generator) TerraformModuleDir() string

TerraformModuleDir is the directory where the generated Terraform.

func (*Generator) TerraformModulePath

func (g *Generator) TerraformModulePath() string

TerraformModulePath is where the generated Terraform module file will be written.

func (*Generator) TerraformRCPath

func (g *Generator) TerraformRCPath() string

TerraformRCPath is where the generated terraform.rc configuration file will be written.

type Opt

type Opt func(*Generator) error

Opt is a generate module option.

func WithOutBaseDirectory

func WithOutBaseDirectory(dir string) Opt

WithOutBaseDirectory is the destination base directory where modules will be written.

func WithScenario

func WithScenario(s *flightplan.Scenario) Opt

WithScenario is the scenario to generate into a module.

func WithScenarioBaseDirectory

func WithScenarioBaseDirectory(dir string) Opt

WithScenarioBaseDirectory is base directory where the scenario defintions reside.

func WithUI

func WithUI(ui cli.Ui) Opt

WithUI is the UI to use for outputing information.