module

Documentation

Index

• type Module
  • func (m *Module) Apply(context.Context) (resource.TaskStatus, error)
  • func (m *Module) Check(context.Context, resource.Renderer) (resource.TaskStatus, error)
  • func (m *Module) String() string
• type Preparer
  • func NewPreparer(params map[string]resource.Value) *Preparer
  • func (p *Preparer) Prepare(ctx context.Context, render resource.Renderer) (resource.Task, error)

Types

type Module

type Module struct {
	resource.Status

	// the params configured for the module
	Params map[string]resource.Value `export:"params"`
}

Module holds stringified values for parameters

func (*Module) Apply

func (m *Module) Apply(context.Context) (resource.TaskStatus, error)

Apply doesn't do anything since modules are final values

func (*Module) Check

func (m *Module) Check(context.Context, resource.Renderer) (resource.TaskStatus, error)

Check just returns the current value of the moduleeter. It should never have to change.

func (*Module) String

func (m *Module) String() string

String is the final value of thie Module

type Preparer

type Preparer struct {
	// Params is a map of strings to anything you'd like. It will be passed to
	// the called module as the default values for the `param`s there.
	Params map[string]resource.Value `hcl:"params"`
}

Preparer for modules

Module remotely sources other modules and adds them to the tree

func NewPreparer

func NewPreparer(params map[string]resource.Value) *Preparer

NewPreparer returns a new preparer for modules

func (*Preparer) Prepare

func (p *Preparer) Prepare(ctx context.Context, render resource.Renderer) (resource.Task, error)

Prepare a new task