Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type BootstrapHandler ¶
type BootstrapHandler func( ctx context.Context, wg *sync.WaitGroup, startupTimer startup.Timer, dic *di.Container) (success bool)
BootstrapHandler defines the contract each bootstrap handler must fulfill. Implementation returns true if the handler completed successfully, false if it did not.
type CertificateProvider ¶
type CertificateProvider interface {
// GetCertificateKeyPair retrieves certificate pair.
GetCertificateKeyPair(path string) (config.CertKeyPair, error)
}
CertificateProvider interface provides an abstraction for obtaining certificate pair.
type Configuration ¶
type Configuration interface {
// 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.
UpdateFromRaw(rawConfig interface{}) bool
// 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().
EmptyWritablePtr() interface{}
// 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.
UpdateWritableFromRaw(rawWritable interface{}) bool
// GetBootstrap returns the configuration elements required by the bootstrap.
GetBootstrap() config.BootstrapConfiguration
// GetLogLevel returns the current ConfigurationStruct's log level.
GetLogLevel() string
// GetRegistryInfo gets the config.RegistryInfo field from the ConfigurationStruct.
GetRegistryInfo() config.RegistryInfo
}
Configuration interface provides an abstraction around a configuration struct.
type CredentialsProvider ¶
type CredentialsProvider interface {
// GetDatabaseCredentials retrieves database credentials.
GetDatabaseCredentials(database config.Database) (config.Credentials, error)
}
CredentialsProvider interface provides an abstraction for obtaining credentials.
Click to show internal directories.
Click to hide internal directories.