config

Documentation

Index

• func AddAuthHeaders(apiKey string, req *http.Request)
• func AddNoAuthHeaders(req *http.Request)
• func CredentialsFilePath() string
• func IsFalsy(s string) bool
• func IsTruthy(s string) bool
• func RootDir() string
• func TraceID() string
• type Config
  • func DefaultConfig() *Config
  • func (c *Config) ConfigureLogger() error
  • func (c *Config) IsLogging() bool
  • func (c *Config) LoadFromEnv() error
  • func (c *Config) LoadFromFile(configFile string) error
• type Credentials
  • func (c Credentials) Save() error
• type CredentialsProfileSpec
• type Environment
  • func NewEnvironment() *Environment
  • func (e *Environment) SetOutputEnvironment(outputCfg *Output)
  • func (e *Environment) SetTerraformEnvironment(projectCfg *TerraformProject)
• type Output
• type Projects
• type State
  • func (s *State) Save() error
• type TerraformProject

Functions

func AddAuthHeaders

func AddAuthHeaders(apiKey string, req *http.Request)

func AddNoAuthHeaders

func AddNoAuthHeaders(req *http.Request)

func CredentialsFilePath

func CredentialsFilePath() string

func IsFalsy

func IsFalsy(s string) bool

func IsTruthy

func IsTruthy(s string) bool

func RootDir

func RootDir() string

func TraceID

func TraceID() string

Types

type Config

type Config struct {
	Environment *Environment
	State       *State
	Credentials Credentials

	Version         string `yaml:"version,omitempty" ignored:"true"`
	LogLevel        string `yaml:"log_level,omitempty" envconfig:"LOG_LEVEL"`
	NoColor         bool   `yaml:"no_color,omitempty" envconfig:"NO_COLOR"`
	SkipUpdateCheck bool   `yaml:"skip_update_check,omitempty" envconfig:"SKIP_UPDATE_CHECK"`

	APIKey                    string `envconfig:"API_KEY"`
	PricingAPIEndpoint        string `yaml:"pricing_api_endpoint,omitempty" envconfig:"PRICING_API_ENDPOINT"`
	DefaultPricingAPIEndpoint string `yaml:"default_pricing_api_endpoint,omitempty" envconfig:"DEFAULT_PRICING_API_ENDPOINT"`
	DashboardAPIEndpoint      string `yaml:"dashboard_api_endpoint,omitempty" envconfig:"DASHBOARD_API_ENDPOINT"`

	Projects Projects  `yaml:"projects" ignored:"true"`
	Outputs  []*Output `yaml:"outputs" ignored:"true"`
}

func DefaultConfig

func DefaultConfig() *Config

func (*Config) ConfigureLogger

func (c *Config) ConfigureLogger() error

func (*Config) IsLogging

func (c *Config) IsLogging() bool

func (*Config) LoadFromEnv

func (c *Config) LoadFromEnv() error

func (*Config) LoadFromFile

func (c *Config) LoadFromFile(configFile string) error

type Credentials

type Credentials map[string]CredentialsProfileSpec

func (Credentials) Save

func (c Credentials) Save() error

type CredentialsProfileSpec

type CredentialsProfileSpec struct {
	APIKey string `yaml:"api_key"`
}

type Environment

type Environment struct {
	Version                             string   `json:"version"`
	FullVersion                         string   `json:"fullVersion"`
	IsTest                              bool     `json:"isTest"`
	IsDev                               bool     `json:"isDev"`
	InstallID                           string   `json:"installId"`
	IsDefaultPricingAPIEndpoint         bool     `json:"isDefaultPricingAPIEndpoint"`
	OS                                  string   `json:"os"`
	CIPlatform                          string   `json:"ciPlatform,omitempty"`
	CIScript                            string   `json:"ciScript,omitempty"`
	Flags                               []string `json:"flags"`
	OutputFormat                        string   `json:"outputFormat"`
	TerraformBinary                     string   `json:"terraformBinary"`
	TerraformFullVersion                string   `json:"terraformFullVersion"`
	TerraformVersion                    string   `json:"terraformVersion"`
	TerraformRemoteExecutionModeEnabled bool     `json:"terraformRemoteExecutionModeEnabled"`
	TerraformInfracostProviderEnabled   bool     `json:"terraformInfracostProviderEnabled"`
	IsAWSChina                          bool     `json:"isAwsChina"`
	HasConfigFile                       bool     `json:"hasConfigFile"`
	HasUsageFile                        bool     `json:"hasUsageFile"`
}

func NewEnvironment

func NewEnvironment() *Environment

func (*Environment) SetOutputEnvironment

func (e *Environment) SetOutputEnvironment(outputCfg *Output)

func (*Environment) SetTerraformEnvironment

func (e *Environment) SetTerraformEnvironment(projectCfg *TerraformProject)

type Output

type Output struct {
	Format      string   `yaml:"format,omitempty" ignored:"true"`
	Columns     []string `yaml:"columns,omitempty" ignored:"true"`
	ShowSkipped bool     `yaml:"show_skipped,omitempty" ignored:"true"`
	Path        string   `yaml:"path,omitempty" ignored:"true"`
}

type Projects

type Projects struct {
	Terraform []*TerraformProject `yaml:"terraform,omitempty"`
}

type State

type State struct {
	InstallID              string `json:"installId"`
	LatestReleaseVersion   string `json:"latestReleaseVersion"`
	LatestReleaseCheckedAt string `json:"latestReleaseCheckedAt"`
}

func (*State) Save

func (s *State) Save() error

type TerraformProject

type TerraformProject struct {
	Name                string `yaml:"name,omitempty" ignored:"true"`
	Binary              string `yaml:"binary,omitempty" envconfig:"TERRAFORM_BINARY"`
	Workspace           string `yaml:"workspace,omitempty" envconfig:"TERRAFORM_WORKSPACE"`
	TerraformCloudHost  string `yaml:"terraform_cloud_host,omitempty" envconfig:"TERRAFORM_CLOUD_HOST"`
	TerraformCloudToken string `yaml:"terraform_cloud_token,omitempty" envconfig:"TERRAFORM_CLOUD_TOKEN"`
	UsageFile           string `yaml:"usage_file,omitempty" ignored:"true"`
	Dir                 string `yaml:"dir,omitempty" ignored:"true"`
	PlanFile            string `yaml:"plan_file,omitempty" ignored:"true"`
	JSONFile            string `yaml:"json_file,omitempty" ignored:"true"`
	PlanFlags           string `yaml:"plan_flags,omitempty" ignored:"true"`
	UseState            bool   `yaml:"use_state,omitempty" ignored:"true"`
}