config

Documentation

Index

• type CertSigner
• type Csv
• type Dora
• type Enc
• type FakeSigner
• type FilterParams
• type Graphite
• type Inventory
• type LemurSigner
• type Metrics
• type Params
  • func (p *Params) Load(cfgFile string)
• type Vault

Types

type CertSigner

type CertSigner struct {
	Client      string
	FakeSigner  *FakeSigner  `mapstructure:"fake"`
	LemurSigner *LemurSigner `mapstructure:"lemur"`
}

CertSigner struct

type Csv

type Csv struct {
	File string `mapstructure:"file"`
}

Csv declares config for a CSV file as an inventory source

type Dora

type Dora struct {
	URL string `mapstructure:"url"`
}

Dora declares config for Dora as a inventory source.

type Enc

type Enc struct {
	Bin          string   `mapstructure:"bin"`
	BMCNicPrefix []string `mapstructure:"bmcNicPrefix"`
}

Enc declares config for a ENC as an inventory source

type FakeSigner

type FakeSigner struct {
	Client     string   `mapstructure:"client"`
	Passphrase string   `mapstructure:"passphrase"`
	Bin        string   `mapstructure:"bin"`
	Args       []string `mapstructure:"args"`
}

FakeSigner struct holds SSL/TLS cert signing attributes.

type FilterParams

type FilterParams struct {
	Chassis bool
	Servers bool
	All     bool
	Serials string //can be one or more serials separated by commas.
	Ips     string
}

FilterParams struct holds various asset filter arguments that may be passed via cli args.

type Graphite

type Graphite struct {
	Host          string        `mapstructure:"host"`
	Port          int           `mapstructure:"port"`
	Prefix        string        `mapstructure:"prefix"`
	FlushInterval time.Duration `mapstructure:"flushInterval"`
}

Graphite struct holds attributes for the Graphite metrics emitter

type Inventory

type Inventory struct {
	Source string //dora, csv, enc
	Enc    *Enc   `mapstructure:"enc"`
	Dora   *Dora  `mapstructure:"dora"`
	Csv    *Csv   `mapstrucure:"csv"`
}

Inventory struct holds inventory configuration parameters.

type LemurSigner

type LemurSigner struct {
	Client        string `mapstructure:"client"`
	Authority     string `mapstructure:"authority"`
	ValidityYears string `mapstructure:"validity_years"`
	Owner         string `mapstructure:"owner_email"`
	Key           string `mapstructure:"auth_token"`
	Bin           string `mapstructure:"bin"`
	Endpoint      string `mapstructure:"endpoint"`
}

LemurSigner struct holds SSL/TLS cert signing attributes.

type Metrics

type Metrics struct {
	Client   string    //The metrics client.
	Graphite *Graphite `mapstructure:"graphite"`
}

Metrics struct holds metrics emitter configuration parameters.

type Params

type Params struct {
	ButlersToSpawn   int                 `mapstructure:"butlersToSpawn"`
	Credentials      []map[string]string `mapstructure:"credentials"`
	CertSigner       *CertSigner         `mapstructure:"cert_signer"`
	Inventory        *Inventory          `mapstructure:"inventory"`
	Locations        []string            `mapstructure:"locations"`
	Metrics          *Metrics            `mapstructure:"metrics"`
	FilterParams     *FilterParams
	CfgFile          string
	Configure        bool //indicates configure was invoked
	DryRun           bool //when set, don't carry out any actions, just log.
	Execute          bool //indicates execute was invoked
	IgnoreLocation   bool
	Resources        []string
	Version          string
	Debug            bool
	Trace            bool
	SecretsFromVault bool   `mapstructure:"secretsFromVault"`
	Vault            *Vault `mapstructure:"vault"`
}

Params struct holds all bmcbutler configuration parameters

func (*Params) Load

func (p *Params) Load(cfgFile string)

Load sets up bmcbutler configuration. nolint: gocyclo

type Vault

type Vault struct {
	TokenFromFile string `mapstructure:"tokenFromFile"`
	TokenFromEnv  bool   `mapstructure:"tokenFromEnv"`
	SecretsPath   string `mapstructure:"secretsPath"`
	HostAddress   string `mapstructure:"hostAddress"`
	Token         string `mapstructure:"token"`
}

Vault struct declares vault config attributes