config

Documentation

Index

• type ConfigurationStruct
  • func (c *ConfigurationStruct) EmptyWritablePtr() any
  • func (c *ConfigurationStruct) GetBootstrap() bootstrapConfig.BootstrapConfiguration
  • func (c *ConfigurationStruct) GetDatabaseInfo() bootstrapConfig.Database
  • func (c *ConfigurationStruct) GetInsecureSecrets() bootstrapConfig.InsecureSecrets
  • func (c *ConfigurationStruct) GetLogLevel() string
  • func (c *ConfigurationStruct) GetRegistryInfo() bootstrapConfig.RegistryInfo
  • func (c *ConfigurationStruct) GetTelemetryInfo() *bootstrapConfig.TelemetryInfo
  • func (c *ConfigurationStruct) GetWritablePtr() any
  • func (c *ConfigurationStruct) UpdateFromRaw(rawConfig any) bool
  • func (c *ConfigurationStruct) UpdateWritableFromRaw(rawWritable any) bool
• type RecordRetention
• type WritableInfo

Types

type ConfigurationStruct

type ConfigurationStruct struct {
	Writable   WritableInfo
	Database   bootstrapConfig.Database
	Registry   bootstrapConfig.RegistryInfo
	Service    bootstrapConfig.ServiceInfo
	Clients    bootstrapConfig.ClientsCollection
	MessageBus bootstrapConfig.MessageBusInfo
	Retention  RecordRetention
}

ConfigurationStruct contains the configuration properties for the Support Scheduler Service

func (*ConfigurationStruct) EmptyWritablePtr

func (c *ConfigurationStruct) EmptyWritablePtr() any

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.yaml's structure -- until we can make backwards-breaking configuration.yaml changes (which would consolidate these fields into an bootstrapConfig.BootstrapConfiguration struct contained within ConfigurationStruct).

func (*ConfigurationStruct) GetDatabaseInfo

func (c *ConfigurationStruct) GetDatabaseInfo() bootstrapConfig.Database

GetDatabaseInfo returns a database information map.

func (*ConfigurationStruct) GetInsecureSecrets

func (c *ConfigurationStruct) GetInsecureSecrets() bootstrapConfig.InsecureSecrets

GetInsecureSecrets returns the service's InsecureSecrets.

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) GetTelemetryInfo

func (c *ConfigurationStruct) GetTelemetryInfo() *bootstrapConfig.TelemetryInfo

GetTelemetryInfo returns the service's Telemetry settings.

func (*ConfigurationStruct) GetWritablePtr

func (c *ConfigurationStruct) GetWritablePtr() any

GetWritablePtr returns pointer to the writable section

func (*ConfigurationStruct) UpdateFromRaw

func (c *ConfigurationStruct) UpdateFromRaw(rawConfig any) 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 any) 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 RecordRetention

type RecordRetention struct {
	Enabled  bool
	Interval string
	MaxCap   uint32
	MinCap   uint32
}

type WritableInfo

type WritableInfo struct {
	LogLevel        string
	InsecureSecrets bootstrapConfig.InsecureSecrets
	Telemetry       bootstrapConfig.TelemetryInfo
}