configuration

Documentation

Overview

Package configuration is in charge of the validation and extraction of all the configuration details from a configuration file.

Index

• type Data
  • func GetData() (*Data, error)
  • func NewData() (*Data, error)
  • func (c *Data) GetAuthServiceURL() string
  • func (c *Data) GetDevModePrivateKey() []byte
  • func (c *Data) GetHTTPAddress() string
  • func (c *Data) GetLogLevel() string
  • func (c *Data) GetMadrillAPIKey() string
  • func (c *Data) GetMetricsHTTPAddress() string
  • func (c *Data) GetServiceAccountID() string
  • func (c *Data) GetServiceAccountSecret() string
  • func (c *Data) GetWITURL() string
  • func (c *Data) GetWebURL() string
  • func (c *Data) IsDeveloperModeEnabled() bool
  • func (c *Data) IsLogJSON() bool
  • func (c *Data) String() string
  • func (c *Data) Validate() error

Types

type Data

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

Data encapsulates the Viper configuration object which stores the configuration data in-memory.

func GetData

func GetData() (*Data, error)

GetData is a wrapper over NewData which reads configuration file path from the environment variable.

func NewData

func NewData() (*Data, error)

NewData creates a configuration reader object using a configurable configuration file path

func (*Data) GetAuthServiceURL

func (c *Data) GetAuthServiceURL() string

GetAuthServiceURL return the base Auth API URL

func (*Data) GetDevModePrivateKey

func (c *Data) GetDevModePrivateKey() []byte

GetDevModePrivateKey returns the private key and its ID used in tests

func (*Data) GetHTTPAddress

func (c *Data) GetHTTPAddress() string

GetHTTPAddress returns the HTTP address (as set via default, config file, or environment variable) that the notification server binds to (e.g. "0.0.0.0:8080")

func (*Data) GetLogLevel

func (c *Data) GetLogLevel() string

GetLogLevel returns the loggging level (as set via config file or environment variable)

func (*Data) GetMadrillAPIKey

func (c *Data) GetMadrillAPIKey() string

GetMadrillAPIKey returns the API key used by the email sender

func (*Data) GetMetricsHTTPAddress

func (c *Data) GetMetricsHTTPAddress() string

GetMetricsHTTPAddress returns the address the /metrics endpoing will be mounted. By default GetMetricsHTTPAddress is the same as GetHTTPAddress

func (*Data) GetServiceAccountID

func (c *Data) GetServiceAccountID() string

GetServiceAccountID returns service account ID for the notification service. This will be used by the notification service to request for a service account token from the Auth service.

func (*Data) GetServiceAccountSecret

func (c *Data) GetServiceAccountSecret() string

GetServiceAccountSecret returns service account secret for the notification service. This will be used by the notification service to request for a service account token from the Auth service.

func (*Data) GetWITURL

func (c *Data) GetWITURL() string

GetWITURL return the base WorkItemTracker API URL

func (*Data) GetWebURL

func (c *Data) GetWebURL() string

GetWebURL returns the base URL for the Web v

func (*Data) IsDeveloperModeEnabled

func (c *Data) IsDeveloperModeEnabled() bool

IsDeveloperModeEnabled returns if development related features (as set via default, config file, or environment variable), e.g. token generation endpoint are enabled

func (*Data) IsLogJSON

func (c *Data) IsLogJSON() bool

IsLogJSON returns if we should log json format (as set via config file or environment variable)

func (*Data) String

func (c *Data) String() string

String returns the current configuration as a string

func (*Data) Validate

func (c *Data) Validate() error