Documentation
¶
Overview ¶
Package config contains the implementation and data structures related to configurations and configuration (log and adapter config) parsing. If a new configuration is introduced to the adapter configuration file, the corresponding change needs to be added to the relevant data stucture as well.
Index ¶
- Constants
- Variables
- func ClearLogConfigInstance()
- func GetControlPlaneConnectedTenantDomain() string
- func GetKeyLocations() (string, string, string)
- func GetLogConfigPath() (string, error)
- func GetMgwHome() string
- func GetServerCertificate(tlsCertificate string, tlsCertificateKey string) (tls.Certificate, error)
- func GetTrustedCertPool(truststoreLocation string) *x509.CertPool
- func IsPublicCertificate(certContent []byte) bool
- func NewReceiver() chan string
- func NewSender() chan string
- func ReadLogConfigs() *pkgconf.LogConfig
- func SetConfig(conf *Config)
- func SetDefaultConfig()
- func UpdateLoggers()
- type Config
- type WireLogConfig
Constants ¶
const DefaultGatewayName = "Default"
DefaultGatewayName represents the name of the default gateway
const DefaultGatewayVHost = "localhost"
DefaultGatewayVHost represents the default vhost of default gateway environment if it is not configured For /testtoken and /health check, if user not configured default env, we have no vhost
const ( //UnassignedAsDeprecated is used by the configurations which are deprecated. UnassignedAsDeprecated string = "unassigned-as-deprecated" )
Variables ¶
var (
C chan string // better to be interface{} type which could send any type of data.
)
C represents the channel to identify modifications added to the configuration file TODO: (VirajSalaka) remove this as unused.
Functions ¶
func ClearLogConfigInstance ¶
func ClearLogConfigInstance()
ClearLogConfigInstance removes the existing configuration. Then the log configuration can be re-initialized.
func GetControlPlaneConnectedTenantDomain ¶
func GetControlPlaneConnectedTenantDomain() string
GetControlPlaneConnectedTenantDomain returns the tenant domain of the user used to authenticate with event hub.
func GetKeyLocations ¶
GetKeyLocations function returns the public key path and private key path
func GetLogConfigPath ¶
GetLogConfigPath returns the file location of the log-config path
func GetMgwHome ¶
func GetMgwHome() string
GetMgwHome reads the MGW_HOME environmental variable and returns the value. This represent the directory where the distribution is located. If the env variable is not present, the directory from which the executable is triggered will be assigned.
func GetServerCertificate ¶
func GetServerCertificate(tlsCertificate string, tlsCertificateKey string) (tls.Certificate, error)
GetServerCertificate returns the certificate (used for the restAPI server and GRPC server) created based on configuration values. Move to pkg. remove config and read from a file path
func GetTrustedCertPool ¶
GetTrustedCertPool returns the trusted certificate (used for the restAPI server and xds server) created based on the provided directory/file path. Move to pkg
func IsPublicCertificate ¶
IsPublicCertificate checks if the file content represents valid public certificate in PEM format. Move to pkg
func NewReceiver ¶
func NewReceiver() chan string
NewReceiver initializes the channel if it is not created an returns
func NewSender ¶
func NewSender() chan string
NewSender initializes the channel if it is not created an returns
func ReadLogConfigs ¶
ReadLogConfigs implements adapter/proxy log-configuration read operation.The read operation will happen only once, hence the consistancy is ensured.
If the "MGW_HOME" variable is set, the log configuration file location would be picked relative to the variable's value ("/conf/log_config.toml"). otherwise, the "MGW_HOME" variable would be set to the directory from where the executable is called from.
Returns the log configuration object mapped from the configuration file during the startup.
func SetConfig ¶
func SetConfig(conf *Config)
SetConfig sets the given configuration to the adapter configuration
func SetDefaultConfig ¶
func SetDefaultConfig()
SetDefaultConfig sets the default configuration to the adapter configuration
Types ¶
type Config ¶
type Config struct {
ControlPlane controlPlane `toml:"controlPlane"`
DataPlane dataPlane `toml:"dataPlane"`
Agent agent `toml:"agent"`
// Metric represents configurations to expose/export go metrics
Metrics metrics `toml:"metrics"`
}
Config represents the adapter configuration. It is created directly from the configuration toml file. Note :
Don't use toml tag for configuration properties as it may affect environment variable based config resolution.
func ReadConfigs ¶
ReadConfigs implements adapter configuration read operation. The read operation will happen only once, hence the consistancy is ensured.
If the "MGW_HOME" variable is set, the configuration file location would be picked relative to the variable's value ("/conf/config.toml"). otherwise, the "MGW_HOME" variable would be set to the directory from where the executable is called from.
Returns the configuration object that is initialized with default values. Changes to the default configuration object is achieved through the configuration file.
type WireLogConfig ¶
WireLogConfig is the config holder for wire logs
func GetWireLogConfig ¶
func GetWireLogConfig() *WireLogConfig
GetWireLogConfig converts the wire log configs read from the config file
Source Files