configuration

Documentation

Index

• func Template(kind string, provisioner string) (string, error)
• type Configuration
  • func Parse(path string) (*Configuration, error)
• type Metadata
• type StateConfiguration
• type TerraformExecutor

Functions

func Template

func Template(kind string, provisioner string) (string, error)

Template generates a yaml with a sample configuration requested by the client

Types

type Configuration

type Configuration struct {
	Kind        string            `yaml:"kind"`
	Metadata    Metadata          `yaml:"metadata"`
	Spec        interface{}       `yaml:"spec"`
	Executor    TerraformExecutor `yaml:"executor"`
	Provisioner string            `yaml:"provisioner"`
}

Configuration represents the base of the configuration file

func Parse

func Parse(path string) (*Configuration, error)

Parse parses a yaml configuration file (path) returning the parsed configuration file as a Configuration struct

type Metadata

type Metadata struct {
	Name   string                 `yaml:"name"`
	Labels map[string]interface{} `yaml:"labels"`
}

Metadata represents a set of metadata information to be used while performing operations

type StateConfiguration

type StateConfiguration struct {
	Backend string            `yaml:"backend"`
	Config  map[string]string `yaml:"config"`
}

StateConfiguration represents the terraform state configuration to be used

type TerraformExecutor

type TerraformExecutor struct {
	// Local Path
	Path string `yaml:"path"`
	// Version to download
	Version string `yaml:"version"`
	// StateConfiguration configures the terraform state to use
	StateConfiguration StateConfiguration `yaml:"state"`
}

TerraformExecutor represents the terraform executor configuration to be used