module

Documentation

Index

• type Module
• type TerraformModule
  • func (m *TerraformModule) Clone(cachePath string) error
  • func (m *TerraformModule) Update(cachePath string) error

Types

type Module

type Module interface {
	//Clone the module, specifying the cache directory as a parameter
	Clone(string) error
	//Update the module, specifying the cache directory as a parameter
	Update(string) error
}

Module interface defining operations that can be performed on a module

type TerraformModule

type TerraformModule struct {
	Repo   string `yaml:"repo,omitempty"`
	Branch string `yaml:"branch,omitempty"`
	Tag    string `yaml:"tag,omitempty"`
	Path   string `yaml:"path,omitempty"`
}

TerraformModule is an implimentation of Module for Terraform Modules hosted in git repos

func (*TerraformModule) Clone

func (m *TerraformModule) Clone(cachePath string) error

Clone will clone the module and checkout the specified branch/tag

func (*TerraformModule) Update

func (m *TerraformModule) Update(cachePath string) error

Update will update the local cache with the latest changes for the module branch/tag