config

Documentation

Index

• type ConfigurationStruct
  • func (c *ConfigurationStruct) EmptyWritablePtr() interface{}
  • func (c *ConfigurationStruct) GetBootstrap() bootstrapConfig.BootstrapConfiguration
  • func (c *ConfigurationStruct) GetDatabaseInfo() map[string]bootstrapConfig.Database
  • func (c *ConfigurationStruct) GetLogLevel() string
  • func (c *ConfigurationStruct) GetRegistryInfo() bootstrapConfig.RegistryInfo
  • func (c *ConfigurationStruct) UpdateFromRaw(rawConfig interface{}) bool
  • func (c *ConfigurationStruct) UpdateWritableFromRaw(rawWritable interface{}) bool
• type SmtpInfo
  • func (s SmtpInfo) CheckUsername() string
• type WritableInfo

Types

type ConfigurationStruct

type ConfigurationStruct struct {
	Writable    WritableInfo
	Clients     map[string]bootstrapConfig.ClientInfo
	Databases   map[string]bootstrapConfig.Database
	Logging     bootstrapConfig.LoggingInfo
	Registry    bootstrapConfig.RegistryInfo
	Service     bootstrapConfig.ServiceInfo
	Smtp        SmtpInfo
	SecretStore bootstrapConfig.SecretStoreInfo
}

func (*ConfigurationStruct) EmptyWritablePtr

func (c *ConfigurationStruct) EmptyWritablePtr() interface{}

EmptyWritablePtr returns a pointer to a service-specific empty WritableInfo struct. It is used by the bootstrap to provide the appropriate structure to registry.Client's WatchForChanges().

func (*ConfigurationStruct) GetBootstrap

func (c *ConfigurationStruct) GetBootstrap() bootstrapConfig.BootstrapConfiguration

GetBootstrap returns the configuration elements required by the bootstrap. Currently, a copy of the configuration data is returned. This is intended to be temporary -- since ConfigurationStruct drives the configuration.toml's structure -- until we can make backwards-breaking configuration.toml changes (which would consolidate these fields into an bootstrapConfig.BootstrapConfiguration struct contained within ConfigurationStruct).

func (*ConfigurationStruct) GetDatabaseInfo

func (c *ConfigurationStruct) GetDatabaseInfo() map[string]bootstrapConfig.Database

GetDatabaseInfo returns a database information map.

func (*ConfigurationStruct) GetLogLevel

func (c *ConfigurationStruct) GetLogLevel() string

GetLogLevel returns the current ConfigurationStruct's log level.

func (*ConfigurationStruct) GetRegistryInfo

func (c *ConfigurationStruct) GetRegistryInfo() bootstrapConfig.RegistryInfo

GetRegistryInfo returns the RegistryInfo from the ConfigurationStruct.

func (*ConfigurationStruct) UpdateFromRaw

func (c *ConfigurationStruct) UpdateFromRaw(rawConfig interface{}) bool

UpdateFromRaw converts configuration received from the registry to a service-specific configuration struct which is then used to overwrite the service's existing configuration struct.

func (*ConfigurationStruct) UpdateWritableFromRaw

func (c *ConfigurationStruct) UpdateWritableFromRaw(rawWritable interface{}) bool

UpdateWritableFromRaw converts configuration received from the registry to a service-specific WritableInfo struct which is then used to overwrite the service's existing configuration's WritableInfo struct.

type SmtpInfo

type SmtpInfo struct {
	Host                 string
	Username             string
	Password             string
	Port                 int
	Sender               string
	EnableSelfSignedCert bool
	Subject              string
}

func (SmtpInfo) CheckUsername

func (s SmtpInfo) CheckUsername() string

The earlier releases do not have Username field and are using Sender field where Usename will be used now, to make it backward compatible fallback to Sender, which is signified by the empty Username field.

type WritableInfo

type WritableInfo struct {
	ResendLimit int
	LogLevel    string
}