config

README

Config Engineering Notes

Internal code to manage config, including Cloud Driver parameters and Test Packs

Log Filter Guidelines

Probr Log Levels:

• ERROR - Behavior that is a result of a definite misconfiguration or code failure
• WARN - Behavior that is likely due to a misconfiguration, but is not fatal
• NOTICE - (1) User config information to prevent confusion, or (2) behavior that could result from a misconfiguration but also may be intentional
• INFO - Non-verbose information that doesn't fit the above criteria
• DEBUG - Any potentially helpful information that doesn't fit the above criteria

Multi-line logs should be formatted prior to log.Printf(...). By using this command multiple times, each line will get a separate timestamp and will appear to be separate entries.

For example, Results: could be read as if an empty string was being output.

However, by misusing log.Printf we may cause a similar appearance:

log.Printf("[NOTICE] Results:")
log.Printf("[NOTICE] %s", myVar)
// Prints:
// 2020/09/28 11:18:01 [NOTICE] Results:
// 2020/09/28 11:18:01 [NOTICE] {"some": "information"}

Config

Configuration docs are located in the README at the top level of the probr repository.

When creating new config vars, remember to do the following:

1. Add an entry to the struct ConfigVars in internal/config/config.go
2. Add an entry (matching the config vars struct) to setEnvOrDefaults in internal/config/defaults.go
3. If appropriate, add logic to cmd/probr-cli/flags.go

By following the above steps, you will have accomplished the following:

1. A new variable will be available across the entire probr codebase
2. That variable will have a default value
3. An environment variable can be set to override the default value
4. The env var can be overridden by a provided yaml config file
5. If set, a flag can be used to override the all other values

Documentation

Index

• Variables
• func GetPacks() (keys []string)
• func Init(configPath string) error
• func LineBreakReplacer(s string) string
• func LogConfigState()
• func SetLogFilter(minLevel string, writer io.Writer)
• func ValidateConfigPath(path string) error
• type APIM
  • func (a APIM) IsExcluded() bool
• type Azure
• type CloudProviders
• type ConfigVars
  • func NewConfig(c string) (ConfigVars, error)
  • func (ctx *ConfigVars) AuditDir() string
  • func (ctx *ConfigVars) CucumberDir() string
  • func (ctx *ConfigVars) GetTags() string
  • func (ctx *ConfigVars) GetWriteDirectory() string
  • func (ctx *ConfigVars) SetTags(tags map[string][]string)
  • func (ctx *ConfigVars) TmpDir() string
• type Excludable
• type Kubernetes
  • func (k Kubernetes) IsExcluded() bool
• type Meta
• type Probe
  • func (p Probe) IsExcluded() bool
• type Scenario
  • func (s Scenario) IsExcluded() bool
• type ServicePacks
• type Storage
  • func (s Storage) IsExcluded() bool

Variables

var Requirements = map[string][]string{
	"Storage":    []string{"Provider"},
	"APIM":       []string{"Provider"},
	"Kubernetes": []string{"AuthorisedContainerRegistry", "UnauthorisedContainerRegistry"},
}

var Spinner *spinner.Spinner

Functions

func GetPacks

func GetPacks() (keys []string)

Returns a list of pack names (as specified by internal/config/requirements.go)

func Init

func Init(configPath string) error

Init will override config.Vars with the content retrieved from a filepath

func LineBreakReplacer

func LineBreakReplacer(s string) string

LineBreakReplacer replaces carriage return (\r), linefeed (\n), formfeed (\f) and other similar characters with a space.

func LogConfigState

func LogConfigState()

func SetLogFilter

func SetLogFilter(minLevel string, writer io.Writer)

Override the minimum log level.

func ValidateConfigPath

func ValidateConfigPath(path string) error

ValidateConfigPath simply ensures the file exists

Types

type APIM

type APIM struct {
	Provider string  `yaml:"Provider"` // Placeholder!
	Probes   []Probe `yaml:"Probes"`
	// contains filtered or unexported fields
}

func (APIM) IsExcluded

func (a APIM) IsExcluded() bool

Log and return exclusion configuration

type Azure

type Azure struct {
	Excluded         string `yaml:"Excluded"`
	TenantID         string `yaml:"TenantID"`
	SubscriptionID   string `yaml:"SubscriptionID"`
	ClientID         string `yaml:"ClientID"`
	ClientSecret     string `yaml:"ClientSecret"`
	ResourceGroup    string `yaml:"ResourceGroup"`
	ResourceLocation string `yaml:"ResourceLocation"`
	ManagementGroup  string `yaml:"ManagementGroup"`
	Identity         struct {
		DefaultNamespaceAI  string `yaml:"DefaultNamespaceAI"`
		DefaultNamespaceAIB string `yaml:"DefaultNamespaceAIB"`
	}
}

type CloudProviders

type CloudProviders struct {
	Azure Azure `yaml:"Azure"`
}

type ConfigVars

type ConfigVars struct {
	// NOTE: Env and Defaults are ONLY available if corresponding logic is added to defaults.go and getters.go
	ServicePacks              ServicePacks   `yaml:"ServicePacks"`
	CloudProviders            CloudProviders `yaml:"CloudProviders"`
	OutputType                string         `yaml:"OutputType"`
	WriteDirectory            string         `yaml:"WriteDirectory"`
	AuditEnabled              string         `yaml:"AuditEnabled"`
	LogLevel                  string         `yaml:"LogLevel"`
	OverwriteHistoricalAudits string         `yaml:"OverwriteHistoricalAudits"`
	TagExclusions             []string       `yaml:"TagExclusions"`
	Tags                      string         // set by flags
	VarsFile                  string         // set by flags only
	NoSummary                 bool           // set by flags only
	Silent                    bool           // set by flags only
	Meta                      Meta           // set by CLI options only
	ResultsFormat             string         // set by flags only
}

ConfigVars contains all possible config vars

var Vars ConfigVars

Vars is a singleton instance of ConfigVars

func NewConfig

func NewConfig(c string) (ConfigVars, error)

NewConfig overrides the current config.Vars values

func (*ConfigVars) AuditDir

func (ctx *ConfigVars) AuditDir() string

AuditDir creates and returns -audit- directory within WriteDirectory

func (*ConfigVars) CucumberDir

func (ctx *ConfigVars) CucumberDir() string

CucumberDir creates and returns -cucumber- directory within WriteDirectory

func (*ConfigVars) GetTags

func (ctx *ConfigVars) GetTags() string

GetTags returns Tags, prioritising command line parameter over vars file

func (*ConfigVars) GetWriteDirectory

func (ctx *ConfigVars) GetWriteDirectory() string

GetWriteDirectory creates and returns the output folder specified in settings

func (*ConfigVars) SetTags

func (ctx *ConfigVars) SetTags(tags map[string][]string)

func (*ConfigVars) TmpDir

func (ctx *ConfigVars) TmpDir() string

TmpDir creates and returns -tmp- directory within WriteDirectory

type Excludable

type Excludable interface {
	IsExcluded() bool
}

For testing

type Kubernetes

type Kubernetes struct {
	KeepPods                          string   `yaml:"KeepPods"`
	Probes                            []Probe  `yaml:"Probes"`
	KubeConfigPath                    string   `yaml:"KubeConfig"`
	KubeContext                       string   `yaml:"KubeContext"`
	SystemClusterRoles                []string `yaml:"SystemClusterRoles"`
	AuthorisedContainerRegistry       string   `yaml:"AuthorisedContainerRegistry"`
	UnauthorisedContainerRegistry     string   `yaml:"UnauthorisedContainerRegistry"`
	ProbeImage                        string   `yaml:"ProbeImage"`
	ContainerRequiredDropCapabilities []string `yaml:"ContainerRequiredDropCapabilities"`
	ContainerAllowedAddCapabilities   []string `yaml:"ContainerAllowedAddCapabilities"`
	ApprovedVolumeTypes               []string `yaml:"ApprovedVolumeTypes"`
	UnapprovedHostPort                string   `yaml:"UnapprovedHostPort"`
	// contains filtered or unexported fields
}

func (Kubernetes) IsExcluded

func (k Kubernetes) IsExcluded() bool

Log and return exclusion configuration

type Meta

type Meta struct {
	RunOnly string // set by CLI 'run' option
}

type Probe

type Probe struct {
	Name      string     `yaml:"Name"`
	Excluded  string     `yaml:"Excluded"`
	Scenarios []Scenario `yaml:"Scenarios"`
}

func (Probe) IsExcluded

func (p Probe) IsExcluded() bool

Log and return exclusion configuration

type Scenario

type Scenario struct {
	Name     string `yaml:"Name"`
	Excluded string `yaml:"Excluded"`
}

func (Scenario) IsExcluded

func (s Scenario) IsExcluded() bool

Log and return exclusion configuration

type ServicePacks

type ServicePacks struct {
	Kubernetes Kubernetes `yaml:"Kubernetes"`
	Storage    Storage    `yaml:"Storage"`
	APIM       APIM       `yaml:"APIM"`
}

type Storage

type Storage struct {
	Provider string  `yaml:"Provider"` // Placeholder!
	Probes   []Probe `yaml:"Probes"`
	// contains filtered or unexported fields
}

func (Storage) IsExcluded

func (s Storage) IsExcluded() bool

Log and return exclusion configuration