config

Documentation

Index

• Variables
• func BindPFlag(key string, flag *pflag.Flag) error
• func Get(key string) interface{}
• func GetAnalyzerServiceAddresses() ([]common.ServiceAddress, error)
• func GetBool(key string) bool
• func GetConfig() *viper.Viper
• func GetEtcdServerAddrs() []string
• func GetInt(key string) int
• func GetOneAnalyzerServiceAddress() (common.ServiceAddress, error)
• func GetString(key string) string
• func GetStringMapString(key string) map[string]string
• func GetStringSlice(key string) []string
• func GetTLSClientConfig(setupRootCA bool) (*tls.Config, error)
• func GetTLSServerConfig(setupRootCA bool) (*tls.Config, error)
• func GetURL(protocol string, addr string, port int, path string) *url.URL
• func InitConfig(backend string, paths []string) error
• func InitLogging() error
• func InitRBAC(kapi etcd.KeysAPI) error
• func IsSet(key string) bool
• func IsTLSEnabled() bool
• func NewAuthenticationBackendByName(name string) (backend shttp.AuthenticationBackend, err error)
• func NewHTTPServer(serviceType common.ServiceType) (*shttp.Server, error)
• func NewWSClient(clientType common.ServiceType, url *url.URL, opts websocket.ClientOpts) (*websocket.Client, error)
• func NewWSServer(server *shttp.Server, endpoint string, authBackend shttp.AuthenticationBackend) *websocket.Server
• func Set(key string, value interface{})
• func SetDefault(key string, value interface{})

Variables

var ErrNoAnalyzerSpecified = errors.New("No analyzer specified in the configuration file")

ErrNoAnalyzerSpecified error no analyzer section is specified in the configuration file

Functions

func BindPFlag

func BindPFlag(key string, flag *pflag.Flag) error

BindPFlag binds a command line flag to a configuration value

func Get

func Get(key string) interface{}

Get returns a value of the configuration as in interface

func GetAnalyzerServiceAddresses

func GetAnalyzerServiceAddresses() ([]common.ServiceAddress, error)

GetAnalyzerServiceAddresses returns a list of connectable Analyzers

func GetBool

func GetBool(key string) bool

GetBool returns a boolean from the configuration

func GetConfig

func GetConfig() *viper.Viper

GetConfig get current config

func GetEtcdServerAddrs

func GetEtcdServerAddrs() []string

GetEtcdServerAddrs returns the ETCD server address specified in the configuration file or embedded

func GetInt

func GetInt(key string) int

GetInt returns an interger from the configuration

func GetOneAnalyzerServiceAddress

func GetOneAnalyzerServiceAddress() (common.ServiceAddress, error)

GetOneAnalyzerServiceAddress returns a random connectable Analyzer

func GetString

func GetString(key string) string

GetString returns a string from the configuration

func GetStringMapString

func GetStringMapString(key string) map[string]string

GetStringMapString returns a map of strings from the configuration

func GetStringSlice

func GetStringSlice(key string) []string

GetStringSlice returns a slice of strings from the configuration

func GetTLSClientConfig

func GetTLSClientConfig(setupRootCA bool) (*tls.Config, error)

GetTLSClientConfig returns TLS config to be used by client

func GetTLSServerConfig

func GetTLSServerConfig(setupRootCA bool) (*tls.Config, error)

GetTLSServerConfig returns TLS config to be used by server

func GetURL

func GetURL(protocol string, addr string, port int, path string) *url.URL

GetURL constructs a URL from a tuple of protocol, address, port and path If TLS is enabled, it will return the https (or wss) version of the URL.

func InitConfig

func InitConfig(backend string, paths []string) error

InitConfig with a backend

func InitLogging

func InitLogging() error

InitLogging set up logging based on the section "logging" of the configuration file

func InitRBAC

func InitRBAC(kapi etcd.KeysAPI) error

InitRBAC inits the RBAC mechanism. It load - the model from the configuration - a policy on etcd - a policy bundled in the executable - additional policy rules from the configuration

func IsSet

func IsSet(key string) bool

IsSet returns wether a key is set

func IsTLSEnabled

func IsTLSEnabled() bool

IsTLSEnabled returns true is the client / server certificates are set

func NewAuthenticationBackendByName

func NewAuthenticationBackendByName(name string) (backend shttp.AuthenticationBackend, err error)

NewAuthenticationBackendByName creates a new auth backend based on the name

func NewHTTPServer

func NewHTTPServer(serviceType common.ServiceType) (*shttp.Server, error)

NewHTTPServer returns a new HTTP server based on the configuration

func NewWSClient

func NewWSClient(clientType common.ServiceType, url *url.URL, opts websocket.ClientOpts) (*websocket.Client, error)

NewWSClient creates a Client based on the configuration

func NewWSServer

func NewWSServer(server *shttp.Server, endpoint string, authBackend shttp.AuthenticationBackend) *websocket.Server

NewWSServer creates a Server based on the configuration

func Set

func Set(key string, value interface{})

Set a value of the configuration

func SetDefault

func SetDefault(key string, value interface{})

SetDefault set the default configuration value for a key