terraform

Documentation

Overview

Package terraform contains the utilities that's used for invoking terraform executable under the given directory with the given templates.

Index

• Constants
• func Apply(dir string, platform string, extraArgs ...string) (path string, err error)
• func Destroy(dir string, platform string, extraArgs ...string) (err error)
• func Version() (version string, err error)

Constants

const (
	// StateFileName is the default name for Terraform state files.
	StateFileName string = "terraform.tfstate"

	// VarFileName is the default name for Terraform var file.
	VarFileName string = "terraform.tfvars"
)

Functions

func Apply

func Apply(dir string, platform string, extraArgs ...string) (path string, err error)

Apply unpacks the platform-specific Terraform modules into the given directory and then runs 'terraform init' and 'terraform apply'. It returns the absolute path of the tfstate file, rooted in the specified directory, along with any errors from Terraform.

func Destroy

func Destroy(dir string, platform string, extraArgs ...string) (err error)

Destroy unpacks the platform-specific Terraform modules into the given directory and then runs 'terraform init' and 'terraform destroy'.

func Version

func Version() (version string, err error)

Version gets the output of 'terrraform version'.