tfstate

Documentation

Index

• Constants
• func FuncMap(ctx context.Context, stateLoc string) (template.FuncMap, error)
• func FuncMapWithName(ctx context.Context, name string, stateLoc string) (template.FuncMap, error)
• func JsonnetNativeFuncs(ctx context.Context, prefix, stateLoc string) ([]*jsonnet.NativeFunction, error)
• func MustFuncMap(ctx context.Context, stateLoc string) template.FuncMap
• func MustFuncMapWithName(ctx context.Context, name string, stateLoc string) template.FuncMap
• type Object
  • func (a *Object) Bytes() []byte
  • func (a *Object) MarshalJSON() ([]byte, error)
  • func (a *Object) Query(query string) (*Object, error)
  • func (a *Object) String() string
• type S3Option
• type TFState
  • func Read(ctx context.Context, src io.Reader) (*TFState, error)
  • func ReadFile(ctx context.Context, file string) (*TFState, error)
  • func ReadURL(ctx context.Context, loc string) (*TFState, error)
  • func ReadWithWorkspace(ctx context.Context, src io.Reader, ws string) (*TFState, error)
  • func (s *TFState) Dump() (map[string]*Object, error)
  • func (s *TFState) FuncMap(ctx context.Context) template.FuncMap
  • func (s *TFState) FuncMapWithName(ctx context.Context, name string) template.FuncMap
  • func (s *TFState) JsonnetNativeFuncs(ctx context.Context) []*jsonnet.NativeFunction
  • func (s *TFState) JsonnetNativeFuncsWithPrefix(ctx context.Context, prefix string) []*jsonnet.NativeFunction
  • func (s *TFState) List() ([]string, error)
  • func (s *TFState) Lookup(key string) (*Object, error)

Constants

const S3EndpointEnvKey = "AWS_ENDPOINT_URL_S3"

const (
	StateVersion = 4
)

Functions

func FuncMap

func FuncMap(ctx context.Context, stateLoc string) (template.FuncMap, error)

FuncMap provides a template.FuncMap tfstate based on URL and provide

func FuncMapWithName

func FuncMapWithName(ctx context.Context, name string, stateLoc string) (template.FuncMap, error)

FuncMapWithName provides a template.FuncMap. can lockup values from tfstate.

func JsonnetNativeFuncs

func JsonnetNativeFuncs(ctx context.Context, prefix, stateLoc string) ([]*jsonnet.NativeFunction, error)

JsonnetNativeFuncs provides the native functions for go-jsonnet.

func MustFuncMap

func MustFuncMap(ctx context.Context, stateLoc string) template.FuncMap

MustFuncMap is similar to FuncMap, but panics if it cannot get and parse tfstate.

func MustFuncMapWithName

func MustFuncMapWithName(ctx context.Context, name string, stateLoc string) template.FuncMap

MustFuncMapWithName is similar to FuncMapWithName, but panics if it cannot get and parse tfstate.

Types

type Object

type Object struct {
	Value interface{}
}

func (*Object) Bytes

func (a *Object) Bytes() []byte

func (*Object) MarshalJSON

func (a *Object) MarshalJSON() ([]byte, error)

func (*Object) Query

func (a *Object) Query(query string) (*Object, error)

Query queries object by go-jq

func (*Object) String

func (a *Object) String() string

type S3Option

type S3Option struct {
	AccessKey string
	SecretKey string
	Region    string
	RoleArn   string
	Endpoint  string
}

type TFState

type TFState struct {
	// contains filtered or unexported fields
}

TFState represents a tfstate

func Read

func Read(ctx context.Context, src io.Reader) (*TFState, error)

Read reads a tfstate from io.Reader

func ReadFile

func ReadFile(ctx context.Context, file string) (*TFState, error)

ReadFile reads terraform.tfstate from the file (Firstly, a workspace reads TF_WORKSPACE environment variable. if it doesn't exist, it reads from environment file in the same directory)

func ReadURL

func ReadURL(ctx context.Context, loc string) (*TFState, error)

ReadURL reads terraform.tfstate from the URL.

func ReadWithWorkspace

func ReadWithWorkspace(ctx context.Context, src io.Reader, ws string) (*TFState, error)

ReadWithWorkspace reads a tfstate from io.Reader with workspace

func (*TFState) Dump

func (s *TFState) Dump() (map[string]*Object, error)

Dump dumps all resources, outputs, and data sources in tfstate

func (*TFState) FuncMap

func (s *TFState) FuncMap(ctx context.Context) template.FuncMap

func (*TFState) FuncMapWithName

func (s *TFState) FuncMapWithName(ctx context.Context, name string) template.FuncMap

func (*TFState) JsonnetNativeFuncs

func (s *TFState) JsonnetNativeFuncs(ctx context.Context) []*jsonnet.NativeFunction

TFState provides a tfstate.

func (*TFState) JsonnetNativeFuncsWithPrefix

func (s *TFState) JsonnetNativeFuncsWithPrefix(ctx context.Context, prefix string) []*jsonnet.NativeFunction

JsonnetNativeFuncsWithPrefix provides the native functions for go-jsonnet with prefix.

func (*TFState) List

func (s *TFState) List() ([]string, error)

List lists resource and output names in tfstate

func (*TFState) Lookup

func (s *TFState) Lookup(key string) (*Object, error)

Lookup lookups attributes of the specified key in tfstate