config

Documentation

Index

• type AzureConfig
  • func GetAzureConfig() (AzureConfig, error)
• type BasicAuthConfig
  • func GetBasicAuthConfig() (BasicAuthConfig, error)
• type CryptoConfig
  • func GetCryptoConfig() (CryptoConfig, error)
• type LogConfig
  • func GetLogConfig() (LogConfig, error)
• type ModulesConfig
  • func GetModulesConfig() (ModulesConfig, error)
• type RedisConfig
  • func GetRedisConfig() (RedisConfig, error)

Types

type AzureConfig

type AzureConfig interface {
	GetEnvironment() azure.Environment
	GetSubscriptionID() string
	GetTenantID() string
	GetClientID() string
	GetClientSecret() string
	GetDefaultLocation() string
	GetDefaultResourceGroup() string
}

AzureConfig represents details necessary for the broker to interact with an Azure subscription

func GetAzureConfig

func GetAzureConfig() (AzureConfig, error)

GetAzureConfig returns Azure subscription configuration

type BasicAuthConfig

type BasicAuthConfig interface {
	GetUsername() string
	GetPassword() string
}

BasicAuthConfig represents details such as username and password that will be used to secure the broker using basic auth

func GetBasicAuthConfig

func GetBasicAuthConfig() (BasicAuthConfig, error)

GetBasicAuthConfig returns basic auth configuration

type CryptoConfig

type CryptoConfig interface {
	GetEncryptionScheme() string
	GetAES256Key() string
}

CryptoConfig represents details (e.g. key) for encrypting and decrypting any (potentially) sensitive information

func GetCryptoConfig

func GetCryptoConfig() (CryptoConfig, error)

GetCryptoConfig returns crypto configuration

type LogConfig

type LogConfig interface {
	GetLevel() log.Level
}

LogConfig represents configuration options for the broker's leveled logging

func GetLogConfig

func GetLogConfig() (LogConfig, error)

GetLogConfig returns log configuration

type ModulesConfig

type ModulesConfig interface {
	GetMinStability() service.Stability
}

ModulesConfig represents details re: which modules should be included or excluded when the broker is started

func GetModulesConfig

func GetModulesConfig() (ModulesConfig, error)

GetModulesConfig returns modules configuration

type RedisConfig

type RedisConfig interface {
	GetHost() string
	GetPort() int
	GetPassword() string
	GetStorageDB() int
	GetAsyncDB() int
	IsTLSEnabled() bool
}

RedisConfig represents details for connecting to the Redis instance that the broker itself relies on for storing state and orchestrating asynchronous processes

func GetRedisConfig

func GetRedisConfig() (RedisConfig, error)

GetRedisConfig returns Redis configuration