terrago

README

Terrago

This git repository contains one Go module with:

• One public Go package at the root directory.
• Two internal Go packages generated by the make dag-code target.

The module path is github.com/h0tbird/terrago which is also the import path used for the root directory. It is intended to be consumed as a library by adding the import "github.com/h0tbird/terrago" statement to your code.

Architecture

A Manifest is a collection of Resources (stored in a hash table) and its corresponding dependency DAG. When a Manifest is applied, the DAG is generated and walked and that's when Resources are reconciled.

Development

Upgrade all dependencies at once:

go mod edit -go=1.16
go get -u ./...
go mod tidy

Documentation

Index

• type Manifest
  • func NewManifest() *Manifest
  • func (h *Manifest) Apply(ctx context.Context, p *schema.Provider, s State) error
• type Resource
  • func (h *Resource) Reconcile(ctx context.Context, p *schema.Provider, s State, r map[string]*Resource) error
• type State

Types

type Manifest

type Manifest struct {
	Resources map[string]*Resource
	Dag       dag.AcyclicGraph
}

Manifest ...

func NewManifest

func NewManifest() *Manifest

NewManifest ...

func (*Manifest) Apply

func (h *Manifest) Apply(ctx context.Context, p *schema.Provider, s State) error

Apply ...

type Resource

type Resource struct {
	ResourceLogicalID string
	ResourceType      string
	ResourceConfig    map[string]interface{}
	ResourceState     *terraform.InstanceState
}

Resource ...

func (*Resource) Reconcile

func (h *Resource) Reconcile(ctx context.Context, p *schema.Provider, s State, r map[string]*Resource) error

Reconcile ...

type State

type State interface {
	Read(string, interface{}) error
	Write(string, interface{}) error
}

State ...