config

Documentation

Index

• Variables
• type APIConfig
• type Config
  • func DefaultConfig() Config
  • func Load(path string) (config *Config, err error)
• type File
• type NotifierConfig
• type RegistrableComponentConfig
• type UpdaterConfig

Variables

var ErrDatasourceNotLoaded = errors.New("could not load configuration: no database source specified")

ErrDatasourceNotLoaded is returned when the datasource variable in the configuration file is not loaded properly

Types

type APIConfig

type APIConfig struct {
	Port                      int
	HealthPort                int
	Timeout                   time.Duration
	PaginationKey             string
	CertFile, KeyFile, CAFile string
}

APIConfig is the configuration for the API service.

type Config

type Config struct {
	Database RegistrableComponentConfig
	Updater  *UpdaterConfig
	Notifier *NotifierConfig
	API      *APIConfig
}

Config is the global configuration for an instance of Clair.

func DefaultConfig

func DefaultConfig() Config

DefaultConfig is a configuration that can be used as a fallback value.

func Load

func Load(path string) (config *Config, err error)

Load is a shortcut to open a file, read it, and generate a Config. It supports relative and absolute paths. Given "", it returns DefaultConfig.

type File

type File struct {
	Clair Config `yaml:"clair"`
}

File represents a YAML configuration file that namespaces all Clair configuration under the top-level "clair" key.

type NotifierConfig

type NotifierConfig struct {
	Attempts         int
	RenotifyInterval time.Duration
	Params           map[string]interface{} `yaml:",inline"`
}

NotifierConfig is the configuration for the Notifier service and its registered notifiers.

type RegistrableComponentConfig

type RegistrableComponentConfig struct {
	Type    string
	Options map[string]interface{}
}

RegistrableComponentConfig is a configuration block that can be used to determine which registrable component should be initialized and pass custom configuration to it.

type UpdaterConfig

type UpdaterConfig struct {
	Interval time.Duration
}

UpdaterConfig is the configuration for the Updater service.