parameters

Documentation

Overview

Package parameters implements parameters for profiles

Index

• type AWS
• type Agent
• type CascadingValueStore
• type Config
• type ConfigParams
• type ParameterNotFoundError
  • func (e ParameterNotFoundError) Error() string
• type Pulumi
• type Store
  • func NewAWSStore(prefix string) Store
  • func NewCascadingStore(stores ...Store) Store
  • func NewConfigFileStore(path string) (Store, error)
  • func NewEnvStore(prefix string) Store
  • func (s Store) Get(key StoreKey) (string, error)
  • func (s Store) GetBool(key StoreKey) (bool, error)
  • func (s Store) GetBoolWithDefault(key StoreKey, def bool) (bool, error)
  • func (s Store) GetInt(key StoreKey) (int, error)
  • func (s Store) GetIntWithDefault(key StoreKey, def int) (int, error)
  • func (s Store) GetWithDefault(key StoreKey, def string) (string, error)
• type StoreKey

Types

type AWS

type AWS struct {
	Account            string `yaml:"account"`
	KeyPairName        string `yaml:"keyPairName"`
	PublicKeyPath      string `yaml:"publicKeyPath"`
	PrivateKeyPath     string `yaml:"privateKeyPath"`
	PrivateKeyPassword string `yaml:"privateKeyPassword"`
	TeamTag            string `yaml:"teamTag"`
}

AWS instance contains AWS related parameters

type Agent

type Agent struct {
	APIKey              string `yaml:"apiKey"`
	APPKey              string `yaml:"appKey"`
	VerifyCodeSignature string `yaml:"verifyCodeSignature"`
}

Agent instance contains agent related parameters

type CascadingValueStore

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

CascadingValueStore instance contains an array of valueStore ordered by priority. Parameters in a cascading value store are looked up iterating through all value stores and return at first match

type Config

type Config struct {
	ConfigParams ConfigParams                 `yaml:"configParams"`
	StackParams  map[string]map[string]string `yaml:"stackParams"`
}

Config instance contains ConfigParams and StackParams

type ConfigParams

type ConfigParams struct {
	AWS       AWS    `yaml:"aws"`
	Agent     Agent  `yaml:"agent"`
	OutputDir string `yaml:"outputDir"`
	Pulumi    Pulumi `yaml:"pulumi"`
	DevMode   string `yaml:"devMode"`
}

ConfigParams instance contains config relayed parameters

type ParameterNotFoundError

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

ParameterNotFoundError instance is an error related to a key not found in a valu store

func (ParameterNotFoundError) Error

func (e ParameterNotFoundError) Error() string

Error returns a printable ParameterNotFoundError

type Pulumi

type Pulumi struct {
	// Sets the log level for Pulumi operations
	// Be careful setting this value, as it can expose sensitive information in the logs.
	// https://www.pulumi.com/docs/support/troubleshooting/#verbose-logging
	LogLevel string `yaml:"logLevel"`
	// By default pulumi logs to /tmp, and creates symlinks to the most recent log, e.g. /tmp/pulumi.INFO
	// Set this option to true to log to stderr instead.
	// https://www.pulumi.com/docs/support/troubleshooting/#verbose-logging
	LogToStdErr string `yaml:"logToStdErr"`
	// To reduce logs noise in the CI, by default we display only the Pulumi error progress steam.
	// Set this option to true to display all the progress streams.
	VerboseProgressStreams string `yaml:"verboseProgressStreams"`
}

Pulumi instance contains pulumi related parameters

type Store

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

Store instance contains a valueStore

func NewAWSStore

func NewAWSStore(prefix string) Store

NewAWSStore creates a new AWS store

func NewCascadingStore

func NewCascadingStore(stores ...Store) Store

NewCascadingStore creates a new cascading store

func NewConfigFileStore

func NewConfigFileStore(path string) (Store, error)

NewConfigFileStore creates a store from configFileValueStore from a path

func NewEnvStore

func NewEnvStore(prefix string) Store

NewEnvStore creates a new store based on environment variables

func (Store) Get

func (s Store) Get(key StoreKey) (string, error)

Get returns a string value from the store

func (Store) GetBool

func (s Store) GetBool(key StoreKey) (bool, error)

GetBool returns a boolean value from the store

func (Store) GetBoolWithDefault

func (s Store) GetBoolWithDefault(key StoreKey, def bool) (bool, error)

GetBoolWithDefault returns a boolean value from the store with default on missing key

func (Store) GetInt

func (s Store) GetInt(key StoreKey) (int, error)

GetInt returns an integer value from the store

func (Store) GetIntWithDefault

func (s Store) GetIntWithDefault(key StoreKey, def int) (int, error)

GetIntWithDefault returns an integer value from the store with default on missing key

func (Store) GetWithDefault

func (s Store) GetWithDefault(key StoreKey, def string) (string, error)

GetWithDefault returns a string value from the store with default on missing key

type StoreKey

type StoreKey string

StoreKey alias to string

const (
	// APIKey config file parameter name
	APIKey StoreKey = "api_key"
	// APPKey config file parameter name
	APPKey StoreKey = "app_key"
	// Environments config file parameter name
	Environments StoreKey = "env"
	// ExtraResourcesTags config file parameter name
	ExtraResourcesTags StoreKey = "extra_resources_tags"
	// KeyPairName config file parameter name
	KeyPairName StoreKey = "key_pair_name"
	// PrivateKeyPassword config file parameter name
	PrivateKeyPassword StoreKey = "private_key_password"
	// PrivateKeyPath config file parameter name
	PrivateKeyPath StoreKey = "private_key_path"
	// Profile config file parameter name
	Profile StoreKey = "profile"
	// PublicKeyPath config file parameter name
	PublicKeyPath StoreKey = "public_key_path"
	// PulumiPassword config file parameter name
	PulumiPassword StoreKey = "pulumi_password"
	// SkipDeleteOnFailure config file parameter name
	SkipDeleteOnFailure StoreKey = "skip_delete_on_failure"
	// StackParameters config file parameter name
	StackParameters StoreKey = "stack_params"
	// PipelineID config file parameter name
	PipelineID StoreKey = "pipeline_id"
	// CommitSHA config file parameter name
	CommitSHA StoreKey = "commit_sha"
	// VerifyCodeSignature config file parameter name
	VerifyCodeSignature StoreKey = "verify_code_signature"
	// OutputDir config file parameter name
	OutputDir StoreKey = "output_dir"
	// PulumiLogLevel config file parameter name
	PulumiLogLevel StoreKey = "pulumi_log_level"
	// PulumiLogToStdErr config file parameter name
	PulumiLogToStdErr StoreKey = "pulumi_log_to_stderr"
	// PulumiVerboseProgressStreams config file parameter name
	PulumiVerboseProgressStreams StoreKey = "pulumi_verbose_progress_streams"
	// DevMode config flag parameter name
	DevMode StoreKey = "dev_mode"
)